Create and run a company verification

POST

/run_company_verifications/

Create a new company verification, run it immediately, and return the full result.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Body Params application/json

Examples

Responses

🟢201

application/json

Ran verification result

Bodyapplication/json

🟠400

🟠403Forbidden

🔴500UnknownError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/run_company_verifications/' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "company_name": "string",
    "company_number": "string",
    "country_code": "string",
    "pep_type": "RESIDENTIAL",
    "consent": true
}'

Response Example

201 - Example 1

{
    "signature_key": "string",
    "url": "http://example.com",
    "type": "quick_id",
    "email": "user@example.com",
    "phone": "+6412312312",
    "org_name": "string",
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "notes": "string",
    "reference": "string",
    "company_name": "string",
    "company_number": "string",
    "country": "string",
    "pep_type": "RESIDENTIAL",
    "unique_ip_addresses": [
        "string"
    ],
    "completed_at": "2019-08-24T14:15:22.123Z",
    "consented_at": "2019-08-24T14:15:22.123Z",
    "created_at": "2019-08-24T14:15:22.123Z",
    "report_pdf_url_TEMP": "string",
    "result": "PASS",
    "is_cancelled": true,
    "is_completed": true,
    "pep_overall_result": "NO_MATCH",
    "pep_user_overrode_result": true,
    "pep_notes": "string",
    "pep_hits": [
        {
            "name": "string",
            "title": "string",
            "country": "string",
            "risk_types": "string",
            "birth_date": "string",
            "matched_fields": "string",
            "match_percentage": "string",
            "deceased": "string",
            "links": [
                "string"
            ],
            "pdf_links": [
                "string"
            ],
            "images": [
                "string"
            ],
            "roles": [
                "string"
            ],
            "nationalities": [
                "string"
            ],
            "locations": [
                "string"
            ],
            "official_lists": [
                "string"
            ],
            "disqualified_directors": [
                "string"
            ],
            "profile_of_interests": [
                "string"
            ]
        }
    ]
}

Create and run a verification

Approve FaceMatch result (deprecated)