Create a verification

POST

/verifications/

Create a new verification and return a signature key and URL.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Body Params application/json

Examples

Responses

🟢201

application/json

Created verification

Bodyapplication/json

🟠400

🟠403Forbidden

🔴500UnknownError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/verifications/' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone": "+6412312312",
    "email": "abc@example.com",
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "birth_date": "1985-12-30",
    "unit_no": "string",
    "address_line_1": "string",
    "address_line_2": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "latitude": "string",
    "longitude": "string",
    "national_id": "string",
    "national_id_secondary": "string",
    "national_id_tertiary": "string",
    "national_id_type": "TAX",
    "national_id_secondary_type": "TAX",
    "national_id_tertiary_type": "TAX",
    "national_id_country_code": "AU",
    "algorithm_to_use": "2x1_no_address",
    "country_code": "AT",
    "callback_url": "https://realaml.com",
    "group_verification_signature_key": "string",
    "group_via_metadata_key": "string",
    "notify_email": "abc@example.com",
    "redirect_url": "https://realaml.com",
    "org_name": "string",
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "notes": "string",
    "reference": "string",
    "dia_code": "string",
    "dvs_code": "string",
    "ca_code": "string",
    "type": "quick_id",
    "facematch_collect_secondary_id": true,
    "facematch_run_pep": true,
    "run_mobile_2fa": true,
    "run_bank_ownership": true,
    "run_phone_ownership": true,
    "run_bank_phone_ownership": true,
    "ca_title_insurance_consent": true,
    "pep_type": "RESIDENTIAL"
}'

Response Example

201 - Example 1

{
    "signature_key": "string",
    "url": "http://example.com",
    "type": "quick_id",
    "email": "user@example.com",
    "phone": "+6412312312",
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "contact_name": "string",
    "birth_date": "1985-12-30",
    "unit_no": "string",
    "address_line_1": "string",
    "address_line_2": "string",
    "city": "string",
    "state": "string",
    "postal_code": "string",
    "latitude": "string",
    "longitude": "string",
    "other_countries": [
        "string"
    ],
    "national_id": "string",
    "national_id_secondary": "string",
    "national_id_tertiary": "string",
    "national_id_type": "TAX",
    "national_id_secondary_type": "TAX",
    "national_id_tertiary_type": "TAX",
    "created_at": "2019-08-24T14:15:22.123Z",
    "org_name": "string",
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "algorithm_to_use": "2x1_no_address",
    "algorithm_used": "2x1_no_address",
    "notes": "string",
    "reference": "string"
}

Landing

Get a verification