Documentation Index

Fetch the complete documentation index at: https://devdocs.veriff.com/llms.txt

Use this file to discover all available pages before exploring further.

Metadata Database Verification

Updated
  • Updated on Jul 9, 2026
  • Published on Apr 8, 2026
Prev Next

Available via API

Available via SDK

Needs configuration on Veriff's side

Needs a separate integration

Needs a separate webhook

✅

❌

✅

✅

❌

Metadata Database Verification validates end-user’s identity data (name, DOB, address, national ID, phone, document numbers, etc) against authoritative external government, consumer, credit bureau, utility, and phone registry databases via the DataZoo aggregation platform. It returns field-level validation statuses for granular, programmable decision-making.

*This solution can be:

  • an add-on to your document-based Identity Verification (IDV), or

  • used separately as a stand-alone check. In this case a separate integration is needed, the whole flow is done over the API and you need to input all the data in initData.

All session-related info is returned via decision webhook and can be polled from different API endpoints. The results of the verification can also be viewed in the Veriff Customer Portal, in the Webhook tab.

Contact your solutions engineer for info and configuration.

Prerequisites

  • You have an integration set up with Veriff

  • The database check is configured for that integration by your Solutions Engineer

  • You have configured the decision webhook to get responses from Veriff (see the how-to in webhooks' Set up webhooks section)

  • If using the API, you are ready to collect and send Veriff your end-user's data

The data you need to send when creating a session depends on the database. Check regional databases' documentation for the exact list of fields.

Key terminology

Term

Description

DataZoo

Third-party registry aggregation platform that Veriff uses to query government and commercial databases worldwide

Registry

A specific external database source (e.g., "Australia Consumer", "Chile National ID")

Registry Key

The identifier for each registry result in the webhook, formatted as <COUNTRY_CODE>_<REGISTRY_NAME>.

In the examples below, indicated as placeholder <REGISTRY_KEY>.

initData

The data object sent by the customer in the POST /v1/sessions request body, containing person, document, address, and consent information (if applicable)

End-user data sources

The "end-user data sources" refer to the origins from which the end-user's information can be collected for database verification. This solution is performed using initData.

InitData

This is data that you provide when creating a verification session, i.e. the parameters you specify in the POST /sessions request. Includes information like names, date of birth, address, phone number, ID number, gender etc.

General overview of the parameters sent via initData:

  • person.firstName: string End-user's first name

  • person.lastName: string End-user's last name

  • person.fullName: string End-user’s first and last name

  • person.dateOfBirth: string Date of birth in YYYY-MM-DD format

  • person.middleName: string Middle name

  • person.gender: string Gender (M/F)

  • person.email: string Email address

  • person.phoneNumber: string Mobile phone number

  • person.landLinePhoneNumber: string Landline phone number

  • person.idNumber: string National ID number

  • person.citizenship: string Citizenship status

  • person.partnerFirstName: string Partner’s first name

  • person.partnerLastName: string Partner’s last name

  • person.marriageDateOfEvent: string Marriage date

  • person.secondLastName: string Second last name

  • document.number: string Document number

  • document.type: string Document type

  • document.country: string Document issuing country (ISO 3166-1 alpha-2)

  • document.validFrom: string Document issue/valid-from date

  • document.validUntil: string Document expiry date

  • document.cardNumber: string Physical card number

  • document.cardType: string Card type

  • document.stateOfIssue: string State of issue

  • document.referenceNumber: string Reference number

  • document.registrationNumber: string Registration number

  • document.version: string Document version

  • address.fullAddress: string Full address string

  • address.street: string Street name

  • address.neighbourhood: string Usually an unofficial neighbourhood name

  • address.city: string City name

  • address.state: string A first-level administrative division

  • address.postcode: string Postcode number

  • address.suburb: string Suburb (used by AU/NZ registries; equivalent to address.neighbourhood in some registries)

  • address.country: string 2-letter ISO country code

  • consents: array List of consent objects

    • type: string Consent type see Consent types for the full list of valid values per registry

    • approved: boolean Whether consent was obtained

The data you need to send when creating a session depends on the database. Check regional databases' documentation for the exact list of fields.

Flow overview

Database flow

Step 1: you input end-user's data (initData) in POST /sessions API call

Step 2: system queries the appropriate database(s) based on country/region

Step 3: validation analysis, aka field-by-field comparison between input data and registry data, leading to validation of multiple data points (name, DOB, address, etc.)

Step 4: validation decision

Step 5: webhook is sent, containing:

  • Validation conclusion per field sent and supported by registry

  • Info about decision influence based on selected compared fields

Session flow

This solution is available only via API. You are responsible for gathering and passing all required initData.

Use via API

  1. Generate a verification session using the API keys and the baseURL of your integration (see the API Documentation and API Reference how to find these).

  2. Patch session status to submitted status using PATCH /sessions/{sessionId} call.

Sample request payload

curl -X PATCH 'https://stationapi.veriff.com/v1/sessions/fd5c1563-1d23-4b1a-ae46-7ba429927ed8' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-CLIENT: your-api-key' \
  -H 'x-hmac-signature: 034c6da2bb31fd9e6892516c6d7b90ebe10f79b47cfb3d155d77b4d9b66e1d53' \
  -d '{
  "verification": {
    "status": "submitted"
  }
}'

  1. Database checks are run.

  1. Check the decision data and/or session related info from the decision webhook and/or query the data from the GET /decisions endpoint. Check each database's documentation to see an example of the webhook and API response payload.

You can get the data from three sources:

The data you see in the webhook / API response payload depends on the database. Check regional databases' documentation for the exact list of fields.

Note about object and field visibility

Some objects and fields within the registryValidations are optional.

You should expect that any key may be omitted from the payload or return a null value.

A field is included in the response only when it is not skipped. If a validation was configured but skipped, it is omitted from the webhook.

Because the response schema is dynamic and based on both your specific configuration and the quality of the initData provided, your application logic must account for omitted keys and null values as a standard part of the verification workflow.

Note on session outcomes

An approved session is identified by a verification.status of approved. Depending on your configuration, a "clean" result may also include:

  • All configured validations returned success or not_applicable

If a validation is not enabled, it is omitted from the payload and do not impact the approved status.

Webhook/API response general structure

The example below uses placeholder data to show only the part that is relevant to Metadata Database Verification solution.

{
  "verification": {
    "registryValidations": {
      "<REGISTRY_KEY>": {
        "status": "success | failure | error",
        "data": { ... } | null,
        "error": null | {
          "code": "enum string",
          "message": "string"
        },
        "timestamp": null,
        "validations": {
          "<validation_check>": {
            "result": "enum string",
            "reason": "string | null"
          }
        }
      }
    }
  }
}

Parameters explained

  • verification : object Parent container for verification results

    • registryValidations : object Metadata Database Verification results container

      • <REGISTRY_KEY> : object Combination of country code and registry name. Parent container for the specific registry results

        • status: string Overall result. Enum:success, failure, or error

        • data: object | null Data returned from the registry (e.g., visa details, person status). null if registry only performs matching without returning data

        • error: object | null Structured error when <REGISTRY_KEY>.status is error. null otherwise

          • code: string Machine-readable error info, see more info below

          • message: string Human-readable error info, see more info below

        • timestamp: Always returns null

        • validations: object | null Map of <validation_check> to the validations matching outcome as shown in result. null when <REGISTRY_KEY>.status is error

          • <validation_check> : object See more info below for enum

            • result: string Machine-readable result of validation. See more info below

            • reason: string Machine-readable reason for the result value. See more info below

Available data object values

The data object in each registry result is populated from the canonical field mapping. A field is present only if the registry returned a non-empty value for it; otherwise the key is omitted. The full set of possible keys is listed below, grouped by category.

Person

  • firstName First name

  • middleName Middle name

  • lastName Last name

  • fullName Full name

  • otherNames Other / alternative names (array)

  • gender Gender

  • yearOfBirth Year of birth indicator

  • personStatus Registry-recorded person status

Address

  • address Address as a single string

  • address1 First address line (street + number)

  • matchedAddress Address line that matched in the registry

  • city City / town

  • suburb Suburb or neighbourhood

  • postCode Postal / ZIP code

  • location Free-form location string

Contact

  • homePhoneNo Home / landline phone number

  • phoneData Structured phone records (array of objects)

  • phoneStatus Phone status (active / disconnected / etc.)

  • carrierName Telephone carrier name

Identification

  • nationalIdNo National ID number returned by the registry

  • nationalIdNoStatus National ID status (valid / expired / etc.)

  • verificationRequestNumber DVS verification request reference

  • scanId Scan / search identifier

Visa and work entitlement (AU_VEVO and similar)

  • visaClass Visa class code

  • visaStream Visa stream / category description

  • visaGrantDate Visa grant date

  • visaExpiryDate Visa expiry date

  • workEntitlementStatus Numeric work-entitlement status

  • workEntitlementStatusText Work-entitlement status description

Identity quality and match scores

  • identityFraud Identity-fraud indicator

  • identityStrength Identity-strength score / band

  • identityValidity Identity-validity indicator

  • altAddressMatchScore Alternative address-match score (object)

  • altDobScore Alternative date-of-birth match score

  • altNameMatchScore Alternative name-match score (object)

  • dataSourceId Source registry identifier

  • dataSourceScore Source-data confidence score (float)

Death and deceased-records signals

  • dateOfDeath Recorded date of death

  • dateOfRegistration Death-record registration date

  • deathIndex Death-index identifier

  • deathRegistration Death registration found (boolean)

  • deceasedRecord Deceased-record found (boolean)

  • possibleDeceasedRecord Possible deceased-record match (boolean)

  • possibleDeceasedRecordName Name on the possible deceased record

  • possibleDeceasedRecordAddress Address on the possible deceased record

  • possibleDeceasedRecordPartialMatching Partial-match indicator (boolean)

Fraud and risk signals

  • amberhill Amberhill fraud-list match (boolean)

  • fraudVictimAlert Fraud-victim alert on file (boolean)

  • fraudulentActivityAddress Address linked to fraudulent activity (boolean)

  • overallFraudRisk Overall fraud-risk flag (boolean)

  • siraFraud SIRA fraud indicator (boolean)

  • siraImpersonation SIRA impersonation indicator (boolean)

  • synthIdNoMatch Synthetic-identity number-match flag (boolean)

  • whitelist Whitelist match (boolean)

Credit-file and records signals (US, CA, GB credit registries)

  • newCreditFile Newly created credit file (boolean)

  • thinFile Thin credit file (boolean)

  • hasBankruptcyRecords Bankruptcy records present (boolean)

  • hasBusinessRecords Business records present (boolean)

  • hasEvictionsRecords Eviction records present (boolean)

  • hasForeclosuresRecords Foreclosure records present (boolean)

  • hasJudgmentRecords Judgment records present (boolean)

  • hasLienRecords Lien records present (boolean)

  • hasUccRecords UCC records present (boolean)

  • hasWorkplaceRecords Workplace records present (boolean)

Account and registry-specific

  • accountClass Account classification

  • accountType Account type

  • activationDate Account / record activation date

  • activityHistory Activity history summary

  • additionalInfoUrl URL pointing to additional registry information

  • brandName Brand or product name

  • category Registry-defined category

  • dpId Data-provider identifier

  • source Registry source label

  • subscriberId Subscriber identifier

  • statusMessage Free-form status message from the registry

  • registrationNumber Registration-number presence indicator

  • registrationState Registration-state presence indicator

  • registrationStatus Registration status

Available validation_check values

Note that if a validation is skipped, it does not appear in webhook.

  • processing System-level execution status

  • is_input_valid Whether end-user data passed format validation

    • (Note: has details array on failure)

  • consent_obtained Whether required consent was provided

  • identity_is_valid Whether the person was found/verified in the registry

  • first_name_match First name comparison result

  • middle_name_match Middle name comparison result

  • last_name_match Last name comparison result

  • full_name_match Full name comparison result

  • first_partner_name_match Partner’s first name comparison result

  • last_partner_name_match Partner’s last name comparison result

  • date_of_birth_match Date of birth comparison result

  • gender_match Gender comparison result

  • email_match Email comparison result

  • phone_number_match Phone number comparison result

  • land_line_phone_number_match Landline phone comparison result

  • id_number_match National ID number comparison result

  • marriage_date_of_event_matchMarriage date comparison result

  • address_full_address_match Full address comparison result

  • address_street_match Street comparison result

  • address_city_match City comparison result

  • address_state_match State comparison result

  • address_postcode_match Postcode comparison result

  • address_neighbourhood_match Neighbourhood comparison result

  • document_number_match Document number comparison result

  • document_card_number_match Card number comparison result

  • document_version_match Document version comparison result

  • document_reference_number_match Reference number comparison result

  • document_valid_from_match Document valid-from date comparison result

validation_check.result statuses and meanings

  • success The submitted value matches the registry record

  • failure with:

    • reason: value_mismatch The submitted value does not match the registry record

  • not_applicable with:

    • reason: input_not_provided The input value was not provided for this validation

    • reason: output_not_received The registry did not return data for this field

validation_check.reason values

  • null On success

  • value_mismatch Provided value does not match registry

  • input_not_provided Input value was not provided

  • output_not_received Registry didn't return the data point

  • person_not_found Person not found in registry

  • consent_not_obtained Required consent was not given

  • input_invalid Input data was provided but in incorrect format

  • registry_unavailable Registry could not be reached

  • technical_issues Internal error occurred

Special case: is_input_valid has a details array on failure

When the is_input_valid validation fails, the response includes a details array (string[]) listing the format problems found:

"is_input_valid": {
  "result": "failure",
  "reason": "input_invalid",
  "details": [
    "Invalid value for document_number should be: 10 digits"
  ]
}

error.code and error.message values

Note that:

  • These appear when status is error

  • error is null when registry status is success or failure

error.code

error.message

registry_unavailable

Two possible values:

  • Provider returned unexpected response

  • Registry request timed out

technical_issues

Internal error occurred

Some registries require explicit end-user consent before the registry can be queried. When a registry requires consent, you must include a consents array in the verification object of your POST /sessions payload. The type field of each consent object must match one of the values below.

Consent type

Used by

au-dvs

AU DVS registries: Driver Licence, Passport, Birth Certificate, Citizenship Certificate, Centrelink Card, Electoral Roll, ImmiCard, Marriage Certificate, Medicare Card, Change of Name Certificate, Travel Document

au-consent

AU non-DVS registries: VEVO, Visa, Residential, Residential Lookup, Citizens, Consumer, Credit Bureau, Death Check, ASIC, Phone, Superannuation, TICA

ca-consent

Canada registries: Residential, Credit Bureau, Credit Bureau 2, Consumer, Phone

nz-consent

New Zealand DIA registries: DIA Birth, DIA Citizenship, DIA Passport

dia-consent

New Zealand DIA alternate consent type (used for some DIA-registered databases)

general

Catch-all for registries requiring generic consent (e.g. Colombia National ID, India Aadhaar, Malaysia National ID)

(none)

Most European, Asian, African, and LATAM registries do not require consent. See each registry's section for details.

"consents": [
  {
    "type": "au-dvs",
    "approved": true
  }
]

Databases by regions

APAC

LATAM

EMEA

NORTHAM

APAC

🇦🇺 Australia - ASIC Personal Name Register (AU_ASIC_PERSONAL_NAME_REGISTER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Sarah",
      "lastName": "Thompson",
      "middleName": "Jane",
      "dateOfBirth": "1985-07-14"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object.

{
  "AU_ASIC_PERSONAL_NAME_REGISTER": {
    "status": "success",
    "data": {
      "firstName": "Sarah",
      "lastName": "Thompson",
      "middleName": "Jane"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - Citizens (AU_CITIZENS)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Conditionally required in addition to mandatory data

  • Group A

  • Date of birth via person.dateOfBirth

  • Group B

  • Street via address.street

  • Postcode via address.postcode

Optional

  • Email via person.email

  • Gender via person.gender

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

Group A

{
  "verification": {
    "person": {
      "firstName": "Sarah",
      "lastName": "Thompson",
      "dateOfBirth": "1988-11-02",
      "email": "sarah.thompson@example.com.au",
      "gender": "F",
      "middleName": "Jane",
      "phoneNumber": "+61412345678"
    }
  }
}

Group B with parsed address fields

{
  "verification": {
    "person": {
      "firstName": "Sarah",
      "lastName": "Thompson",
      "email": "sarah.thompson@example.com.au",
      "gender": "F",
      "middleName": "Jane",
      "phoneNumber": "+61412345678"
    },
    "address": {
      "street": "15 Queen Street"
      "postcode": "4000"
    }
  }
}

Group B with fullAddress parameter

{
  "verification": {
    "person": {
      "firstName": "Sarah",
      "lastName": "Thompson",
      "email": "sarah.thompson@example.com.au",
      "gender": "F",
      "middleName": "Jane",
      "phoneNumber": "+61412345678"
    },
    "address": {
      "fullAddress": "15 Queen Street, 4000"
    }
  }
}

To send address info, you can send the data using EITHER parsed address.street + address.postcode parameters OR the full address via fullAddress parameter.

Do not send both parsed address data AND the full address data.

Sample response payload - Group B

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object.

{
  "AU_CITIZENS": {
    "status": "success",
    "data": {
      "address1": "15 Queen Street",
      "city": "Brisbane",
      "postCode": "4000",
      "dataSourceScore": 0.92,
      "firstName": "Sarah",
      "lastName": "Thompson",
      "middleName": "Jane"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "middle_name_match": { "result": "success", "reason": null },
      "gender_match": { "result": "not_applicable", "reason": "output_not_received" },
      "email_match": { "result": "not_applicable", "reason": "output_not_received" },
      "phone_number_match": { "result": "not_applicable", "reason": "output_not_received" },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺Australia Consumer (AU_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • Neighbourhood via address.neighbourhood

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

  • Email via person.email

  • Phone number via person.phoneNumber

With parsed address elements

{
  "verification": {
    "person": {
      "firstName": "Michael",
      "lastName": "Brown",
      "dateOfBirth": "1975-06-20",
      "email": "m.brown@example.com",
      "phoneNumber": "+61400123456"
    },
    "address": {
      "street": "8 Pitt Street",
      "neighbourhood": "Sydney CBD",
      "city": "Sydney",
      "state": "NSW",
      "postcode": "2000"
    }
  }
}

With fullAddress parameter

{
  "verification": {
    "person": {
      "firstName": "Michael",
      "lastName": "Brown",
      "dateOfBirth": "1975-06-20",
      "email": "m.brown@example.com",
      "phoneNumber": "+61400123456"
    },
    "address": {
      "fullAddress": "8 Pitt Street, Sydney CBD NSW 2000"
    }
  }
}

To send address info, you can send the data using EITHER parsed address.street + address.neighbourhood + address.city + address.state + address.postcode parameters OR the full address via fullAddress parameter.

Do not send both parsed address data AND the full address data.

Sample response payload - address scenario

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object.

{
  "AU_CONSUMER": {
    "status": "success",
    "data": {
      "address1": "8 Pitt Street",
      "city": "Sydney",
      "firstName": "Michael",
      "lastName": "Brown"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "email_match": { "result": "not_applicable", "reason": "output_not_received" },
      "phone_number_match": { "result": "not_applicable", "reason": "output_not_received" },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - Credit Bureau (AU_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Address via address.street + address.city + address.postcode OR address.fullAddress

  • Consent via consents array

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

With parsed address fields

{
  "verification": {
    "person": {
      "firstName": "Patricia",
      "lastName": "Henderson",
      "dateOfBirth": "1983-04-07",
      "email": "p.henderson@example.com",
      "phoneNumber": "+61411987654"
    },
    "address": {
      "street": "18 Bourke Street",
      "city": "Melbourne",
      "postcode": "3000"
    },
    "consents": [
      {
        "type": "au-consent",
        "approved": true
      }
    ]
  }
}

With fullAddress parameter

{
  "verification": {
    "person": {
      "firstName": "Patricia",
      "lastName": "Henderson",
      "dateOfBirth": "1983-04-07",
      "email": "p.henderson@example.com",
      "phoneNumber": "+61411987654"
    },
    "address": {
      "fullAddress": "18 Bourke Street, Melbourne VIC 3000"
    },
    "consents": [
      {
        "type": "au-consent",
        "approved": true
      }
    ]
  }
}

To send address info, you can use either parsed address.street + address.city + address.postcode parameters or the full address via address.fullAddress. Do not send both.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_CREDIT_BUREAU": {
    "status": "success",
    "data": {
      "address1": "18 Bourke Street",
      "city": "Melbourne",
      "postCode": "3000",
      "firstName": "Patricia",
      "lastName": "Henderson"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null },
      "email_match": { "result": "not_applicable", "reason": "output_not_received" },
      "phone_number_match": { "result": "not_applicable", "reason": "output_not_received" }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - Death Check (AU_DEATH_CHECK)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Consent via consents array

Optional

  • Middle name via person.middleName

With mandatory fields

{
  "verification": {
    "person": {
      "firstName": "Margaret",
      "lastName": "Collins",
      "dateOfBirth": "1942-03-18"
    },
    "consents": [
      {
        "type": "au-consent",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_DEATH_CHECK": {
    "status": "success",
    "data": {
      "firstName": "Margaret",
      "lastName": "Collins"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": {"result": "success", "reason": null},
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - DVS - Australia Driver Licence (AU_DRIVER_LICENCE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Licence number via document.number

  • Consent via consents array

Optional

  • Card number via document.cardNumber

  • State of issue via document.stateOfIssue

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Jason",
      "lastName": "Murphy",
      "middleName": "Paul",
      "dateOfBirth": "1986-02-17"
    },
    "document": {
      "number": "12345678",
      "cardNumber": "98765432",
      "stateOfIssue": "VIC"
    },
    "consents": [
      {
        "type": "au-dvs",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_DRIVER_LICENCE": {
    "status": "success",
    "data": {
      "firstName": "Jason",
      "lastName": "Murphy",
      "middleName": "Paul",
      "verificationRequestNumber": "VRN-20260415-00325"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null },
      "document_card_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - DVS - Australia Medicare Card (AU_MEDICARE_CARD)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • Consent via consents array

Optional

  • First name via person.firstName

  • Last name via person.lastName

  • Medicare card number via document.cardNumber

  • Medicare card type via document.cardType

  • Medicare card expiry via document.validUntil

  • Medicare individual reference number via document.referenceNumber

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Laura",
      "lastName": "Harrison",
      "middleName": "Kate",
      "dateOfBirth": "1987-04-19"
    },
    "document": {
      "cardNumber": "2123456701",
      "cardType": "G",
      "validUntil": "2028-06",
      "referenceNumber": "1"
    },
    "consents": [
      {
        "type": "au-dvs",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_MEDICARE_CARD": {
    "status": "success",
    "data": {
      "firstName": "Laura",
      "lastName": "Harrison",
      "middleName": "Kate",
      "fullName": "Laura Kate Harrison",
      "verificationRequestNumber": "VRN-20260415-00337"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_card_number_match": { "result": "success", "reason": null },
      "document_reference_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - DVS - Australia Passport (AU_PASSPORT)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Passport number via document.number

  • Consent via consents array

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Sophie",
      "lastName": "Bennett",
      "middleName": "Louise",
      "dateOfBirth": "1993-11-28"
    },
    "document": {
      "number": "PA1234567"
    },
    "consents": [
      {
        "type": "au-dvs",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_PASSPORT": {
    "status": "success",
    "data": {
      "firstName": "Sophie",
      "lastName": "Bennett",
      "middleName": "Louise",
      "verificationRequestNumber": "VRN-20260415-00331"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - DVS - Australia Visa (AU_VISA)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Passport number via document.number

  • Document issuing country via document.country

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Amara",
      "lastName": "Okafor",
      "dateOfBirth": "1989-07-03"
    },
    "document": {
      "number": "A12345678",
      "country": "AL"
    },
    "consents": [
      {
        "type": "au-dvs",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_VISA": {
    "status": "success",
    "data": {
      "firstName": "Amara",
      "lastName": "Okafor",
      "verificationRequestNumber": "VRN-20260415-00343"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - DVS - Birth Certificate (AU_BIRTH_CERTIFICATE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Consent via consents array

Optional

  • Birth certificate number via document.number

  • Birth registration date via document.validFrom

  • Birth registration number via document.registrationNumber

  • Birth registration state via document.stateOfIssue

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Emily",
      "lastName": "Clarke",
      "middleName": "Rose",
      "dateOfBirth": "1990-06-24"
    },
    "document": {
      "number": "BC4872910",
      "validFrom": "1990-07-15",
      "registrationNumber": "REG-1990-48729",
      "stateOfIssue": "NSW"
    },
    "consents": [
      {
        "type": "au-dvs",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_BIRTH_CERTIFICATE": {
    "status": "success",
    "data": {
      "firstName": "Emily",
      "lastName": "Clarke",
      "middleName": "Rose",
      "verificationRequestNumber": "VRN-20260415-00312"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null },
      "document_valid_from_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Card type via document.cardType

  • Card expiry via document.validUntil

  • Customer reference number via document.referenceNumber

  • Consent via consents array

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Barbara",
      "lastName": "Nguyen",
      "middleName": "Anne",
      "dateOfBirth": "1958-09-11"
    },
    "document": {
      "cardType": "PEN",
      "validUntil": "2027-06-30",
      "referenceNumber": "123456789A"
    },
    "consents": [
      {
        "type": "au-dvs",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_CENTRELINK_CARD": {
    "status": "success",
    "data": {
      "firstName": "Barbara",
      "lastName": "Nguyen",
      "middleName": "Anne",
      "verificationRequestNumber": "VRN-20260415-00318"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_reference_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - DVS - Change of Name Certificate (AU_CHANGE_OF_NAME_CERTIFICATE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Certificate number via document.number

  • Registration date via document.validFrom

  • Registration number via document.registrationNumber

  • Registration state via document.stateOfIssue

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Rachel",
      "lastName": "Greenwood",
      "dateOfBirth": "1985-08-12"
    },
    "document": {
      "number": "CN-20100045",
      "validFrom": "2010-04-22",
      "registrationNumber": "REG-2010-00045",
      "stateOfIssue": "QLD"
    },
    "consents": [
      {
        "type": "au-dvs",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_CHANGE_OF_NAME_CERTIFICATE": {
    "status": "success",
    "data": {
      "firstName": "Rachel",
      "lastName": "Greenwood",
      "middleName": "Anne",
      "verificationRequestNumber": "VRN-20260415-00355"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null },
      "document_valid_from_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - DVS - Citizenship Certificate (AU_CITIZENSHIP_CERTIFICATE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Citizenship certificate number via document.number

  • Citizenship certificate date via document.validFrom

  • Consent via consents array

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Lena",
      "lastName": "Petrova",
      "middleName": "Maria",
      "dateOfBirth": "1978-05-30"
    },
    "document": {
      "number": "CERT-1234567",
      "validFrom": "2005-03-14"
    },
    "consents": [
      {
        "type": "au-dvs",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_CITIZENSHIP_CERTIFICATE": {
    "status": "success",
    "data": {
      "firstName": "Lena",
      "lastName": "Petrova",
      "middleName": "Maria",
      "verificationRequestNumber": "VRN-20260415-00349"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null },
      "document_valid_from_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - DVS - ImmiCard (AU_IMMICARD)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Card number via document.number

  • Card expiry via document.validUntil

  • Consent via consents array

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Thanh",
      "lastName": "Nguyen",
      "middleName": "Van",
      "dateOfBirth": "1982-10-05"
    },
    "document": {
      "number": "HAA123456",
      "validUntil": "2029-03-15"
    },
    "consents": [
      {
        "type": "au-dvs",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_IMMICARD": {
    "status": "success",
    "data": {
      "firstName": "Thanh",
      "lastName": "Nguyen",
      "middleName": "Van",
      "verificationRequestNumber": "VRN-20260415-00361"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - DVS - Marriage Certificate (AU_MARRIAGE_CERTIFICATE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Partner's first name via person.partnerFirstName

  • Partner's last name via person.partnerLastName

  • Marriage date via person.marriageDateOfEvent

  • Registration state via document.stateOfIssue

  • Consent via consents array

Optional

  • Certificate number via document.number

  • Registration date via document.validFrom

  • Registration number via document.registrationNumber

{
  "verification": {
    "person": {
      "firstName": "Claire",
      "lastName": "Sutton",
      "dateOfBirth": "1984-09-17",
      "partnerFirstName": "Daniel",
      "partnerLastName": "Sutton",
      "marriageDateOfEvent": "2012-11-03"
    },
    "document": {
      "number": "MC-2012-00891",
      "validFrom": "2012-11-10",
      "registrationNumber": "REG-2012-00891",
      "stateOfIssue": "SA"
    },
    "consents": [
      {
        "type": "au-dvs",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_MARRIAGE_CERTIFICATE": {
    "status": "success",
    "data": {
      "firstName": "Claire",
      "lastName": "Sutton",
      "verificationRequestNumber": "VRN-20260415-00367"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "first_partner_name_match": { "result": "success", "reason": null },
      "last_partner_name_match": { "result": "success", "reason": null },
      "marriage_date_of_event_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null },
      "document_valid_from_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - DVS - Travel Document (AU_TRAVEL_DOCUMENT)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Consent via consents array

Optional

  • Travel document number via document.number

  • Document issuing country via document.country

{
  "verification": {
    "person": {
      "firstName": "Fatima",
      "lastName": "Al-Rashid",
      "dateOfBirth": "1991-02-14"
    },
    "document": {
      "number": "TD9876543",
      "country": "AE"
    },
    "consents": [
      {
        "type": "au-dvs",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_TRAVEL_DOCUMENT": {
    "status": "success",
    "data": {
      "firstName": "Fatima",
      "lastName": "Al-Rashid",
      "middleName": "Zara",
      "verificationRequestNumber": "VRN-20260415-00373"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - Electoral Roll (AU_ELECTORAL_ROLL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Address via address.street + address.city + address.postcode OR address.fullAddress

  • Consent via consents array

With parsed address fields

{
  "verification": {
    "person": {
      "firstName": "Robert",
      "lastName": "Mitchell",
      "dateOfBirth": "1979-08-22"
    },
    "address": {
      "street": "27 Flinders Street",
      "city": "Melbourne",
      "postcode": "3000"
    },
    "consents": [
      {
        "type": "au-consent",
        "approved": true
      }
    ]
  }
}

With fullAddress parameter

{
  "verification": {
    "person": {
      "firstName": "Robert",
      "lastName": "Mitchell",
      "dateOfBirth": "1979-08-22"
    },
    "address": {
      "fullAddress": "27 Flinders Street, Melbourne VIC 3000"
    },
    "consents": [
      {
        "type": "au-consent",
        "approved": true
      }
    ]
  }
}

To send address info, you can use either parsed address.street + address.city + address.postcode parameters or the full address via address.fullAddress. Do not send both.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_ELECTORAL_ROLL": {
    "status": "success",
    "data": {
      "address1": "27 Flinders Street",
      "city": "Melbourne",
      "postCode": "3000",
      "firstName": "Robert",
      "lastName": "Mitchell"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - Phone (AU_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Address via address.street + address.city + address.postcode OR address.fullAddress

With parsed address fields

{
  "verification": {
    "person": {
      "firstName": "Gregory",
      "lastName": "Walsh"
    },
    "address": {
      "street": "14 Park Road",
      "city": "Brisbane",
      "postcode": "4000"
    }
  }
}

With fullAddress parameter

{
  "verification": {
    "person": {
      "firstName": "Gregory",
      "lastName": "Walsh"
    },
    "address": {
      "fullAddress": "14 Park Road, Brisbane QLD 4000"
    }
  }
}

To send address info, you can use either parsed address.street + address.city + address.postcode parameters or the full address via address.fullAddress. Do not send both.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_PHONE": {
    "status": "success",
    "data": {
      "address1": "14 Park Road",
      "city": "Brisbane",
      "postCode": "4000",
      "firstName": "Gregory",
      "lastName": "Walsh",
      "middleName": "Alan",
      "homePhoneNo": "+61731234567"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - Residential (AU_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Date of birth via person.dateOfBirth OR

    address.street + address.city + address.postcode / address.fullAddress

  • Email via person.email

  • Gender via person.gender

  • Middle name via person.middleName

  • Landline number via person.landLinePhoneNumber

  • Phone number via person.phoneNumber

With date of birth and other optional data

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Wilson",
      "dateOfBirth": "1974-05-05"
      "email": "james.wilson@example.com",
      "gender": "M",
      "middleName": "Robert",
      "landLinePhoneNumber": "+61298765432",
      "phoneNumber": "+61412345678"
    }
  }
}

With parsed address fields and other optional data

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Wilson",
      "email": "james.wilson@example.com",
      "gender": "M",
      "middleName": "Robert",
      "landLinePhoneNumber": "+61298765432",
      "phoneNumber": "+61412345678"
    },
    "address": {
      "street": "42 George Street",
      "city": "Sydney",
      "postcode": "2000"
    }
  }
}

With fullAddress parameter and other optional data

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Wilson",
      "email": "james.wilson@example.com",
      "gender": "M",
      "middleName": "Robert",
      "landLinePhoneNumber": "+61298765432",
      "phoneNumber": "+61412345678"
    },
    "address": {
      "fullAddress": "42 George Street, Sydney NSW 2000"
    }
  }
}

Note that you should send EITHER the date of birth info OR the address info.

To send address info, you can send the data using EITHER parsed address.street + address.city + address.postcode parameters OR the full address via fullAddress parameter.

Do not sent both date of birth data and address data.

Do not send both parsed address data AND the full address data.

Sample response payload - address scenario

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_RESIDENTIAL": {
    "status": "success",
    "data": {
      "address1": "42 George Street",
      "city": "Sydney",
      "postCode": "2000",
      "dataSourceScore": 0.95,
      "firstName": "James",
      "lastName": "Wilson",
      "middleName": "Robert"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "gender_match": { "result": "not_applicable", "reason": "output_not_received" },
      "email_match": { "result": "not_applicable", "reason": "output_not_received" },
      "phone_number_match": { "result": "not_applicable", "reason": "output_not_received" },
      "land_line_phone_number_match": { "result": "not_applicable", "reason": "output_not_received" },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - Residential Lookup (AU_RESIDENTIAL_LOOKUP)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Landline number via person.landLinePhoneNumber

  • Phone number via person.phoneNumber

Optional

  • Middle name via person.middleName

  • Gender via person.gender

  • Address via address.street + address.city + address.postcode OR address.fullAddress

Mandatory fields only

{
  "verification": {
    "person": {
      "firstName": "David",
      "lastName": "Anderson",
      "dateOfBirth": "1968-11-15",
      "landLinePhoneNumber": "+61398765432",
      "phoneNumber": "+61412345678"
    }
  }
}

With all optional fields

{
  "verification": {
    "person": {
      "firstName": "David",
      "lastName": "Anderson",
      "dateOfBirth": "1968-11-15",
      "middleName": "James",
      "gender": "M",
      "landLinePhoneNumber": "+61398765432",
      "phoneNumber": "+61412345678"
    },
    "address": {
      "street": "5 Collins Street",
      "city": "Melbourne",
      "postcode": "3000"
    }
  }
}

If sending address, you can use either parsed address.street + address.city + address.postcode parameters or the full address via address.fullAddress. Do not send both.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_RESIDENTIAL_LOOKUP": {
    "status": "success",
    "data": {
      "address1": "5 Collins Street",
      "city": "Melbourne",
      "postCode": "3000",
      "firstName": "David",
      "lastName": "Anderson",
      "middleName": "James"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "not_applicable", "reason": "output_not_received" },
      "land_line_phone_number_match": { "result": "not_applicable", "reason": "output_not_received" },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - Superannuation & Payroll (AU_SUPERANNUATION_PAYROLL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Consent via consents array

Optional

  • Address via address.street + address.city + address.postcode OR address.fullAddress

Mandatory fields only

{
  "verification": {
    "person": {
      "firstName": "Andrew",
      "lastName": "Fletcher",
      "dateOfBirth": "1971-09-03"
    },
    "consents": [
      {
        "type": "au-consent",
        "approved": true
      }
    ]
  }
}

With optional address

{
  "verification": {
    "person": {
      "firstName": "Andrew",
      "lastName": "Fletcher",
      "dateOfBirth": "1971-09-03"
    },
    "address": {
      "street": "33 King Street",
      "city": "Perth",
      "postcode": "6000"
    },
    "consents": [
      {
        "type": "au-consent",
        "approved": true
      }
    ]
  }
}

If sending address, you can use either parsed address.street + address.city + address.postcode parameters or the full address via address.fullAddress. Do not send both.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_SUPERANNUATION_PAYROLL": {
    "status": "success",
    "data": {
      "address1": "33 King Street",
      "city": "Perth",
      "postCode": "6000",
      "firstName": "Andrew",
      "lastName": "Fletcher"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - TICA Tenancy Register (AU_TICA_TENANCY_REGISTER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Tom",
      "lastName": "Evans",
      "middleName": "Michael",
      "dateOfBirth": "1984-02-24"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object.

{
  "AU_TICA_TENANCY_REGISTER": {
    "status": "success",
    "data": {
      "firstName": "Tom",
      "lastName": "Evans",
      "middleName": "Michael"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia - VEVO (AU_VEVO)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Passport number via document.number

  • Passport issuing country via document.country

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Wei",
      "lastName": "Chen",
      "dateOfBirth": "1995-03-12"
    },
    "document": {
      "number": "EH1234567",
      "country": "CN"
    },
    "consents": [
      {
        "type": "au-dvs",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AU_VEVO": {
    "status": "success",
    "data": {
      "visaClass": "500",
      "visaGrantDate": "2023-07-15",
      "visaExpiryDate": "2026-07-15",
      "visaStream": "Student",
      "workEntitlementStatus": "entitled",
      "workEntitlementStatusText": "May work up to 48 hours per fortnight while course is in session",
      "location": "Australia"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇰🇭 Cambodia - National ID (KH_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Gender via person.gender

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Sokha",
      "lastName": "Chan",
      "dateOfBirth": "1991-05-22",
      "idNumber": "012345678",
      "gender": "M"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "KH_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇨🇳 China - Bank Card (CN_BANK_CARD)

Input parameters

POST /sessions example

Mandatory

  • Full name via person.fullName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Card number via document.cardNumber

  • Consent via consents array

{
  "verification": {
    "person": {
      "fullName": "Li Wei",
      "dateOfBirth": "1990-03-21",
      "idNumber": "110101199003213456"
    },
    "document": {
      "cardNumber": "CARD-001234"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CN_BANK_CARD": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "document_card_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇨🇳 China - National ID (CN_ID_VERIFICATION)

Input parameters

POST /sessions example

Mandatory

  • Full name via person.fullName

  • National ID number via person.idNumber

  • Date of birth via person.dateOfBirth

Optional

  • Consent via consents array

{
  "verification": {
    "person": {
      "fullName": "Li Wei",
      "idNumber": "110101199003213456",
      "dateOfBirth": "1990-03-21"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CN_ID_VERIFICATION": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇨🇳 China - Passport Verification (CN_PASSPORT_VERIFICATION)

Input parameters

POST /sessions example

Mandatory

  • Full name via person.fullName

  • National ID number via person.idNumber

  • Date of birth via person.dateOfBirth

  • Document number via document.number

Optional

  • Consent via consents array

{
  "verification": {
    "person": {
      "fullName": "Li Wei",
      "idNumber": "110101199003213456",
      "dateOfBirth": "1990-03-21"
    },
    "document": {
      "number": "E12345678"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CN_PASSPORT_VERIFICATION": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇨🇳 China - Phone (CN_PHONE)

Input parameters

POST /sessions example

Mandatory

  • Full name via person.fullName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Phone number via person.phoneNumber

  • Consent via consents array

{
  "verification": {
    "person": {
      "fullName": "Li Wei",
      "dateOfBirth": "1990-03-21",
      "idNumber": "110101199003213456",
      "phoneNumber": "+8613812345678"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CN_PHONE": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇭🇰 Hong Kong - Residential (HK_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

  • Suburb via address.suburb

{
  "verification": {
    "person": {
      "firstName": "Wing",
      "lastName": "Chan",
      "middleName": ""
    },
    "address": {
      "street": "1 Queen's Road",
      "city": "Central",
      "state": "CA",
      "postcode": "999077",
      "suburb": "Downtown"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "HK_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇮🇩 Indonesia - Phone (ID_PHONE)

Input parameters

POST /sessions example

Mandatory

  • Full name via person.fullName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

{
  "verification": {
    "person": {
      "fullName": "Budi Santoso",
      "dateOfBirth": "1987-08-17",
      "phoneNumber": "+6281234567890",
      "email": "budi.santoso@example.com"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "ID_PHONE": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇮🇩 Indonesia - Residential Identity Card (ID_RESIDENT_IDENTITY_CARD)

Input parameters

POST /sessions example

Mandatory

  • Full name via person.fullName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Gender via person.gender

  • Full address via address.fullAddress

  • Street via address.street

  • Postcode via address.postcode

  • Suburb via address.suburb

  • Consent via consents array

{
  "verification": {
    "person": {
      "fullName": "Budi Santoso",
      "dateOfBirth": "1987-08-17",
      "idNumber": "3173012345678901",
      "gender": "M"
    },
    "address": {
      "fullAddress": "100 Main Street, Centerville",
      "street": "Jl. Sudirman No. 1",
      "postcode": "10220",
      "suburb": "Downtown"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "ID_RESIDENT_IDENTITY_CARD": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇮🇳 India - Aadhaar (IN_AADHAAR)

Input parameters

POST /sessions example

Mandatory

  • Full name via person.fullName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

  • Document number via document.number

Optional

  • Consent via consents array

{
  "verification": {
    "person": {
      "fullName": "Aarav Kumar Sharma",
      "dateOfBirth": "1992-08-14",
      "idNumber": "234567890123"
    },
    "document": {
      "number": "ABCDE1234F"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IN_AADHAAR": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇮🇳 India - Drivers Licence (IN_DRIVERS_LICENCE)

Input parameters

POST /sessions example

Mandatory

  • Full name via person.fullName

  • Date of birth via person.dateOfBirth

  • Document number via document.number

Optional

  • Consent via consents array

{
  "verification": {
    "person": {
      "fullName": "Aarav Kumar Sharma",
      "dateOfBirth": "1992-08-14"
    },
    "document": {
      "number": "ABCDE1234F"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IN_DRIVERS_LICENCE": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇮🇳 India - EPIC (Voter's Registration) (IN_EPIC)

Input parameters

POST /sessions example

Mandatory

  • Full name via person.fullName

  • Date of birth via person.dateOfBirth

  • Document number via document.number

Optional

  • Gender via person.gender

  • Consent via consents array

{
  "verification": {
    "person": {
      "fullName": "Aarav Kumar Sharma",
      "dateOfBirth": "1992-08-14",
      "gender": "M"
    },
    "document": {
      "number": "ABCDE1234F"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IN_EPIC": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇮🇳 India - PAN (Permanent Account Number) (IN_PAN)

Input parameters

POST /sessions example

Mandatory

  • Full name via person.fullName

  • Date of birth via person.dateOfBirth

  • Document number via document.number

Optional

  • Consent via consents array

{
  "verification": {
    "person": {
      "fullName": "Aarav Kumar Sharma",
      "dateOfBirth": "1992-08-14"
    },
    "document": {
      "number": "ABCDE1234F"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IN_PAN": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇮🇳 India - Passport (IN_PASSPORT)

Input parameters

POST /sessions example

Mandatory

  • Full name via person.fullName

  • Date of birth via person.dateOfBirth

  • Document number via document.number

Optional

  • Reference number via document.referenceNumber

  • Issue/valid-from date via document.validFrom

  • Consent via consents array

{
  "verification": {
    "person": {
      "fullName": "Aarav Kumar Sharma",
      "dateOfBirth": "1992-08-14"
    },
    "document": {
      "number": "ABCDE1234F",
      "referenceNumber": "REF-2024-001234",
      "validFrom": "2020-01-15"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IN_PASSPORT": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null },
      "document_reference_number_match": { "result": "success", "reason": null },
      "document_valid_from_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇲🇾 Malaysia - Credit Bureau (MY_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Full address via address.fullAddress

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

  • City via address.city

{
  "verification": {
    "person": {
      "dateOfBirth": "1987-04-15",
      "idNumber": "870415-08-1234",
      "fullName": "Ahmad bin Abdullah",
      "firstName": "Ahmad",
      "lastName": "bin Abdullah",
      "middleName": ""
    },
    "address": {
      "fullAddress": "100 Main Street, Centerville",
      "street": "100 Main Street",
      "suburb": "Downtown",
      "state": "CA",
      "postcode": "00000",
      "city": "Centerville"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "MY_CREDIT_BUREAU": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "last_name_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇲🇾 Malaysia - National ID (MY_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Gender via person.gender

  • Phone number via person.phoneNumber

  • Full address via address.fullAddress

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

  • City via address.city

  • Consent via consents array

{
  "verification": {
    "person": {
      "dateOfBirth": "1987-04-15",
      "idNumber": "870415-08-1234",
      "fullName": "Ahmad bin Abdullah",
      "firstName": "Ahmad",
      "lastName": "bin Abdullah",
      "middleName": "",
      "gender": "M",
      "phoneNumber": "+60123456789"
    },
    "address": {
      "fullAddress": "100 Main Street, Centerville",
      "street": "100 Main Street",
      "suburb": "Downtown",
      "state": "CA",
      "postcode": "00000",
      "city": "Centerville"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "MY_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "last_name_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇳🇿 New Zealand - Companies Office (NZ_COMPANIES_OFFICE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Liam",
      "lastName": "Wilson",
      "dateOfBirth": "1991-04-08",
      "middleName": "James",
      "phoneNumber": "+64211234567",
      "landLinePhoneNumber": "+15555550000"
    },
    "address": {
      "street": "1 Queen Street",
      "suburb": "Downtown",
      "state": "Auckland",
      "postcode": "1010"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NZ_COMPANIES_OFFICE": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "land_line_phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇳🇿 New Zealand - Consumer (NZ_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Liam",
      "lastName": "Wilson",
      "dateOfBirth": "1991-04-08",
      "phoneNumber": "+64211234567",
      "email": "liam.wilson@example.com"
    },
    "address": {
      "street": "1 Queen Street",
      "suburb": "Downtown",
      "state": "Auckland",
      "postcode": "1010"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NZ_CONSUMER": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇳🇿 New Zealand - Credit Bureau (NZ_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Liam",
      "lastName": "Wilson",
      "dateOfBirth": "1991-04-08"
    },
    "address": {
      "street": "1 Queen Street",
      "suburb": "Downtown",
      "state": "Auckland",
      "postcode": "1010"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NZ_CREDIT_BUREAU": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇳🇿 New Zealand - Death Check (NZ_DEATH_CHECK)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Liam",
      "lastName": "Wilson"
    },
    "address": {
      "street": "1 Queen Street",
      "suburb": "Downtown",
      "state": "Auckland",
      "postcode": "1010"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NZ_DEATH_CHECK": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇳🇿 New Zealand - DIA Births (NZ_DIA_BIRTH)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Liam",
      "lastName": "Wilson",
      "dateOfBirth": "1991-04-08",
      "middleName": "James"
    },
    "consents": [
      {
        "type": "nz-consent",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NZ_DIA_BIRTH": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇳🇿 New Zealand - DIA Citizenship (NZ_DIA_CITIZENSHIP)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Liam",
      "lastName": "Wilson",
      "dateOfBirth": "1991-04-08",
      "middleName": "James"
    },
    "consents": [
      {
        "type": "nz-consent",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NZ_DIA_CITIZENSHIP": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇳🇿 New Zealand - DIA Passport (NZ_DIA_PASSPORT)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Document number via document.number

Optional

  • Middle name via person.middleName

  • Expiry date via document.validUntil

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Liam",
      "lastName": "Wilson",
      "dateOfBirth": "1991-04-08",
      "middleName": "James"
    },
    "document": {
      "number": "DL1234567",
      "validUntil": "2030-01-15"
    },
    "consents": [
      {
        "type": "nz-consent",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NZ_DIA_PASSPORT": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇳🇿 New Zealand - Drivers Licence (NZ_DRIVER_LICENCE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Document number via document.number

Optional

  • Middle name via person.middleName

  • Document version via document.version

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Liam",
      "lastName": "Wilson",
      "dateOfBirth": "1991-04-08",
      "middleName": "James"
    },
    "document": {
      "number": "DL1234567",
      "version": "1"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NZ_DRIVER_LICENCE": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null },
      "document_version_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇳🇿 New Zealand - LINZ Property (NZ_LINZ_PROPERTY)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Liam",
      "lastName": "Wilson",
      "dateOfBirth": "1991-04-08",
      "middleName": "James",
      "phoneNumber": "+64211234567",
      "landLinePhoneNumber": "+15555550000"
    },
    "address": {
      "street": "1 Queen Street",
      "suburb": "Downtown",
      "state": "Auckland",
      "postcode": "1010"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NZ_LINZ_PROPERTY": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "land_line_phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇳🇿 New Zealand - Residential (NZ_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Liam",
      "lastName": "Wilson",
      "dateOfBirth": "1991-04-08",
      "middleName": "James",
      "phoneNumber": "+64211234567",
      "landLinePhoneNumber": "+15555550000"
    },
    "address": {
      "street": "1 Queen Street",
      "suburb": "Downtown",
      "state": "Auckland",
      "postcode": "1010"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NZ_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "land_line_phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇳🇿 New Zealand - Utility (NZ_UTILITY)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Liam",
      "lastName": "Wilson",
      "dateOfBirth": "1991-04-08"
    },
    "address": {
      "street": "1 Queen Street",
      "suburb": "Downtown",
      "state": "Auckland",
      "postcode": "1010"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NZ_UTILITY": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇳🇿 New Zealand - Yellow Pages (NZ_YELLOW_PAGES)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Landline phone number via person.landLinePhoneNumber

  • Postcode via address.postcode

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Liam",
      "lastName": "Wilson",
      "landLinePhoneNumber": "+15555550000"
    },
    "address": {
      "postcode": "1010",
      "street": "1 Queen Street",
      "suburb": "Downtown",
      "state": "Auckland"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NZ_YELLOW_PAGES": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "land_line_phone_number_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇵🇭 Philippines - Credit Bureau (PH_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Card type via document.cardType

  • Full address via address.fullAddress

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

  • Suburb via address.suburb

  • Consent via consents array

{
  "verification": {
    "person": {
      "dateOfBirth": "1989-06-12",
      "idNumber": "12345678",
      "fullName": "Juan Dela Cruz",
      "firstName": "Juan",
      "lastName": "Dela Cruz",
      "middleName": "Cruz"
    },
    "address": {
      "fullAddress": "100 Main Street, Centerville",
      "street": "123 Ayala Avenue",
      "city": "Makati",
      "state": "Metro Manila",
      "postcode": "1226",
      "suburb": "Downtown"
    },
    "document": {
      "cardType": "health"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "PH_CREDIT_BUREAU": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇵🇭 Philippines - Residential (PH_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Full address via address.fullAddress

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

  • Suburb via address.suburb

  • Consent via consents array

{
  "verification": {
    "person": {
      "dateOfBirth": "1989-06-12",
      "fullName": "Juan Dela Cruz",
      "firstName": "Juan",
      "lastName": "Dela Cruz",
      "middleName": "Cruz"
    },
    "address": {
      "fullAddress": "100 Main Street, Centerville",
      "street": "123 Ayala Avenue",
      "city": "Makati",
      "state": "Metro Manila",
      "postcode": "1226",
      "suburb": "Downtown"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "PH_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇸🇬 Singapore - Credit Bureau (SG_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • State via address.state

  • Suburb via address.suburb

  • Consent via consents array

{
  "verification": {
    "person": {
      "dateOfBirth": "1989-05-04",
      "idNumber": "S8905041A",
      "fullName": "Tan Wei Ming",
      "firstName": "Wei Ming",
      "lastName": "Tan",
      "middleName": ""
    },
    "address": {
      "street": "1 Marina Boulevard",
      "city": "Singapore",
      "state": "CA",
      "suburb": "Downtown"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "SG_CREDIT_BUREAU": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "last_name_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇸🇬 Singapore - Utility (SG_UTILITY)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • State via address.state

  • Suburb via address.suburb

{
  "verification": {
    "person": {
      "dateOfBirth": "1989-05-04",
      "fullName": "Tan Wei Ming",
      "firstName": "Wei Ming",
      "lastName": "Tan",
      "middleName": "",
      "phoneNumber": "+6591234567"
    },
    "address": {
      "street": "1 Marina Boulevard",
      "city": "Singapore",
      "state": "CA",
      "suburb": "Downtown"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "SG_UTILITY": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "last_name_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇹🇭 Thailand - National ID (TH_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Full address via address.fullAddress

  • Street via address.street

  • City via address.city

  • State via address.state

  • Suburb via address.suburb

  • Consent via consents array

{
  "verification": {
    "person": {
      "dateOfBirth": "1988-03-12",
      "idNumber": "1234567890123",
      "fullName": "Somchai Saetang",
      "firstName": "Somchai",
      "lastName": "Saetang",
      "middleName": ""
    },
    "address": {
      "fullAddress": "100 Main Street, Centerville",
      "street": "100 Main Street",
      "city": "Centerville",
      "state": "CA",
      "suburb": "Downtown"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "TH_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "last_name_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

LATAM

🇦🇷 Argentina - Citizens (AR_CITIZENS)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Mateo",
      "lastName": "González",
      "dateOfBirth": "1988-04-22",
      "idNumber": "23456789",
      "middleName": "Luis"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AR_CITIZENS": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇦🇷 Argentina - Credit Bureau (AR_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Mateo",
      "lastName": "González",
      "dateOfBirth": "1988-04-22",
      "idNumber": "23456789",
      "middleName": "Luis"
    },
    "address": {
      "street": "Av. Corrientes 1234",
      "city": "Buenos Aires",
      "postcode": "C1043AAZ"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AR_CREDIT_BUREAU": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇦🇷 Argentina - National ID (AR_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

  • Gender via person.gender

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Mateo",
      "lastName": "González",
      "dateOfBirth": "1988-04-22",
      "idNumber": "23456789",
      "middleName": "Luis",
      "gender": "M"
    },
    "address": {
      "street": "Av. Corrientes 1234",
      "city": "Buenos Aires",
      "state": "Buenos Aires",
      "postcode": "C1043AAZ"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AR_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇦🇷 Argentina - Tax Registration (AR_TAX_REGISTRATION)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Mateo",
      "lastName": "González",
      "dateOfBirth": "1988-04-22",
      "idNumber": "23456789",
      "middleName": "Luis"
    },
    "address": {
      "street": "Av. Corrientes 1234",
      "city": "Buenos Aires",
      "state": "Buenos Aires",
      "postcode": "C1043AAZ"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AR_TAX_REGISTRATION": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇧🇷 Brazil - National ID (BR_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Lucas",
      "lastName": "Silva",
      "dateOfBirth": "1987-08-30",
      "idNumber": "123.456.789-09",
      "middleName": "Eduardo"
    },
    "address": {
      "street": "Av. Paulista 1000",
      "city": "São Paulo",
      "state": "SP",
      "postcode": "01310-100"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "BR_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇧🇷 Brazil - National ID 2 (BR_NATIONAL_ID_2)

Input parameters

POST /sessions example

Mandatory

  • National ID number via person.idNumber

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

  • Suburb via address.suburb

{
  "verification": {
    "person": {
      "idNumber": "123.456.789-09",
      "fullName": "Lucas Eduardo Silva",
      "firstName": "Lucas",
      "lastName": "Silva",
      "dateOfBirth": "1987-08-30",
      "middleName": "Eduardo"
    },
    "address": {
      "street": "Av. Paulista 1000",
      "city": "São Paulo",
      "state": "SP",
      "postcode": "01310-100",
      "suburb": "Downtown"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "BR_NATIONAL_ID_2": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇧🇷 Brazil - Phone (BR_PHONE)

Input parameters

POST /sessions example

Mandatory

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "fullName": "Lucas Eduardo Silva",
      "firstName": "Lucas",
      "lastName": "Silva",
      "dateOfBirth": "1987-08-30",
      "phoneNumber": "+5511987654321",
      "middleName": "Eduardo"
    },
    "address": {
      "street": "Av. Paulista 1000",
      "city": "São Paulo",
      "state": "SP",
      "postcode": "01310-100"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "BR_PHONE": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇧🇷 Brazil - Residential (BR_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

  • State via address.state

  • Suburb via address.suburb

{
  "verification": {
    "person": {
      "dateOfBirth": "1987-08-30",
      "fullName": "Lucas Eduardo Silva",
      "firstName": "Lucas",
      "lastName": "Silva",
      "idNumber": "123.456.789-09",
      "middleName": "Eduardo",
      "phoneNumber": "+5511987654321"
    },
    "address": {
      "street": "Av. Paulista 1000",
      "city": "São Paulo",
      "postcode": "01310-100",
      "state": "SP",
      "suburb": "Downtown"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "BR_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇧🇷 Brazil - Tax Registration (BR_TAX_REGISTRATION)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "dateOfBirth": "1987-08-30",
      "idNumber": "123.456.789-09",
      "fullName": "Lucas Eduardo Silva",
      "firstName": "Lucas",
      "lastName": "Silva",
      "middleName": "Eduardo"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "BR_TAX_REGISTRATION": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇨🇱 Chile National ID (CL_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number (RUT/RUN) via person.idNumber

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Carlos",
      "lastName": "Gonzalez",
      "dateOfBirth": "1991-07-14",
      "idNumber": "12345678-9",
      "middleName": "Andrés"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object.

{
  "CL_NATIONAL_ID": {
    "status": "success",
    "data": {
      "firstName": "Carlos",
      "lastName": "Gonzalez",
      "middleName": "Andrés",
      "nationalIdNo": "12345678-9",
      "nationalIdNoStatus": "VALID"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null }
    },
    "error": null, "timestamp": null
  }
}

🇨🇱 Chile Residential (CL_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Street via address.street

  • City via address.city

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Valentina",
      "lastName": "Muñoz",
      "middleName": "Isabel"
    },
    "address": {
      "street": "Avenida Libertador Bernardo O'Higgins 1234",
      "city": "Santiago"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object.

{
  "CL_RESIDENTIAL": {
    "status": "failure",
    "data": {
      "address1": "Av Libertador Bernardo O'Higgins 1234",
      "firstName": "Valentina",
      "lastName": "Muñoz",
      "middleName": "Isabel"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "failure", "reason": "person_not_found" },
      "first_name_match": { "result": "not_applicable", "reason": "output_not_received" },
      "last_name_match": { "result": "not_applicable", "reason": "output_not_received" },
      "middle_name_match": { "result": "not_applicable", "reason": "output_not_received" },
      "address_street_match": { "result": "not_applicable", "reason": "output_not_received" },
      "address_city_match": { "result": "not_applicable", "reason": "output_not_received" }
    },
    "error": null, "timestamp": null
  }
}

🇨🇴 Colombia - National ID (CO_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Consent via consents array

{
  "verification": {
    "person": {
      "dateOfBirth": "1989-06-10",
      "idNumber": "1020304050",
      "fullName": "Carlos Andrés Ramírez",
      "firstName": "Carlos",
      "lastName": "Ramírez",
      "middleName": "Andrés"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CO_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null }
    }
  }
}

🇲🇽 Mexico - National ID (MX_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

  • Gender via person.gender

{
  "verification": {
    "person": {
      "firstName": "Diego",
      "lastName": "Hernández",
      "dateOfBirth": "1988-02-29",
      "idNumber": "HEGD880229HDFRNG09",
      "middleName": "",
      "gender": "M"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "MX_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "date_of_birth_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null }
    }
  }
}

🇲🇽 Mexico - Residential (MX_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Diego",
      "lastName": "Hernández",
      "middleName": "",
      "phoneNumber": "+525512345678"
    },
    "address": {
      "street": "Av. Reforma 100",
      "city": "Ciudad de México",
      "state": "CDMX",
      "postcode": "06600"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "MX_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    }
  }
}

🇵🇪 Peru - National ID (PE_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Carlos",
      "lastName": "Quispe",
      "dateOfBirth": "1990-09-15",
      "idNumber": "12345678",
      "middleName": "Alberto"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "PE_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null }
    }
  }
}

🇵🇪 Peru - Residential (PE_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Gender via person.gender

  • Landline phone number via person.landLinePhoneNumber

  • Street via address.street

  • City via address.city

{
  "verification": {
    "person": {
      "firstName": "Carlos",
      "lastName": "Quispe",
      "middleName": "Alberto",
      "gender": "M",
      "landLinePhoneNumber": "+15555550000"
    },
    "address": {
      "street": "Av. Larco 1000",
      "city": "Lima"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "PE_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "land_line_phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null }
    }
  }
}

🇵🇪 Peru - Tax Registration (PE_TAX_REGISTRATION)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Carlos",
      "lastName": "Quispe",
      "dateOfBirth": "1990-09-15",
      "idNumber": "12345678",
      "middleName": "Alberto"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "PE_TAX_REGISTRATION": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null }
    }
  }
}

EMEA

🇦🇹 Austria - Credit Bureau (AT_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Lukas",
      "lastName": "Huber",
      "dateOfBirth": "1985-11-09"
    },
    "address": {
      "street": "Mariahilfer Straße 45",
      "city": "Vienna",
      "postcode": "1060"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "AT_CREDIT_BUREAU": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    }
  }
}

🇧🇪 Belgium - Consumer (BE_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Lucas",
      "lastName": "Dubois",
      "dateOfBirth": "1990-02-14",
      "phoneNumber": "+32470123456",
      "email": "lucas.dubois@example.com"
    },
    "address": {
      "street": "Rue Royale 100",
      "city": "Brussels",
      "state": "Brussels-Capital",
      "postcode": "1000"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "BE_CONSUMER": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    }
  }
}

🇧🇪 Belgium - Residential (BE_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • Postcode via address.postcode

  • City via address.city

{
  "verification": {
    "person": {
      "firstName": "Lucas",
      "lastName": "Dubois",
      "dateOfBirth": "1990-02-14",
      "middleName": "Jean",
      "phoneNumber": "+32470123456",
      "email": "lucas.dubois@example.com"
    },
    "address": {
      "street": "Rue Royale 100",
      "postcode": "1000",
      "city": "Brussels"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "BE_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null }
    }
  }
}

🇧🇪 Belgium - Utility (BE_UTILITY)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Lucas",
      "lastName": "Dubois",
      "dateOfBirth": "1990-02-14",
      "phoneNumber": "+32470123456",
      "email": "lucas.dubois@example.com"
    },
    "address": {
      "street": "Rue Royale 100",
      "city": "Brussels",
      "postcode": "1000"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "BE_UTILITY": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    }
  }
}

🇨🇿 Czech Republic - Residential (CZ_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • Postcode via address.postcode

  • City via address.city

{
  "verification": {
    "person": {
      "firstName": "Jan",
      "lastName": "Novák",
      "dateOfBirth": "1985-04-27"
    },
    "address": {
      "street": "Václavské náměstí 1",
      "postcode": "110 00",
      "city": "Prague"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CZ_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null }
    }
  }
}

🇨🇿 Czech Republic - Residential 2 (CZ_RESIDENTIAL_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • City via address.city

{
  "verification": {
    "person": {
      "firstName": "Jan",
      "lastName": "Novák",
      "dateOfBirth": "1985-04-27"
    },
    "address": {
      "street": "Václavské náměstí 1",
      "city": "Prague"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CZ_RESIDENTIAL_2": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null }
    }
  }
}

🇩🇰 Denmark - Consumer (DK_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Mads",
      "lastName": "Jensen",
      "dateOfBirth": "1988-12-04",
      "phoneNumber": "+4520123456",
      "email": "mads.jensen@example.com"
    },
    "address": {
      "street": "Strøget 12",
      "city": "Copenhagen",
      "state": "Capital Region",
      "postcode": "1160"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "DK_CONSUMER": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇩🇰 Denmark - National ID (DK_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Mads",
      "lastName": "Jensen",
      "dateOfBirth": "1988-12-04",
      "idNumber": "041288-1234"
    },
    "address": {
      "street": "Strøget 12",
      "city": "Copenhagen",
      "postcode": "1160"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "DK_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇫🇮 Finland - Consumer (FI_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Mikko",
      "lastName": "Virtanen",
      "dateOfBirth": "1985-06-21",
      "phoneNumber": "+358401234567",
      "email": "mikko.virtanen@example.com"
    },
    "address": {
      "street": "Mannerheimintie 10",
      "city": "Helsinki",
      "state": "Uusimaa",
      "postcode": "00100"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "FI_CONSUMER": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇫🇮 Finland - National ID (FI_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "dateOfBirth": "1985-06-21",
      "idNumber": "210685-123A",
      "fullName": "Mikko Virtanen",
      "firstName": "Mikko",
      "lastName": "Virtanen"
    },
    "address": {
      "street": "Mannerheimintie 10",
      "city": "Helsinki",
      "postcode": "00100"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "FI_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇫🇷 France - Consumer (FR_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Pierre",
      "lastName": "Dupont",
      "dateOfBirth": "1984-07-19",
      "phoneNumber": "+33612345678",
      "email": "pierre.dupont@example.com"
    },
    "address": {
      "street": "Avenue des Champs-Élysées 50",
      "city": "Paris",
      "postcode": "75008"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "FR_CONSUMER": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇫🇷 France - Phone (FR_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Postcode via address.postcode

  • Street via address.street

  • City via address.city

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Pierre",
      "lastName": "Dupont",
      "dateOfBirth": "1984-07-19",
      "phoneNumber": "+33612345678"
    },
    "address": {
      "postcode": "75008",
      "street": "Avenue des Champs-Élysées 50",
      "city": "Paris",
      "state": "Île-de-France"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "FR_PHONE": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇫🇷 France - Residential (FR_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Pierre",
      "lastName": "Dupont",
      "dateOfBirth": "1984-07-19",
      "phoneNumber": "+33612345678"
    },
    "address": {
      "street": "Avenue des Champs-Élysées 50",
      "city": "Paris",
      "postcode": "75008"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "FR_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇫🇷 France - Residential 2 (FR_RESIDENTIAL_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Pierre",
      "lastName": "Dupont",
      "phoneNumber": "+33612345678",
      "email": "pierre.dupont@example.com"
    },
    "address": {
      "street": "Avenue des Champs-Élysées 50",
      "city": "Paris",
      "postcode": "75008",
      "state": "Île-de-France"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "FR_RESIDENTIAL_2": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇫🇷 France - Residential 3 (FR_RESIDENTIAL_3)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Pierre",
      "lastName": "Dupont",
      "dateOfBirth": "1984-07-19"
    },
    "address": {
      "street": "Avenue des Champs-Élysées 50",
      "city": "Paris",
      "postcode": "75008"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "FR_RESIDENTIAL_3": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇫🇷 France - Utility (FR_UTILITY)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Pierre",
      "lastName": "Dupont",
      "dateOfBirth": "1984-07-19"
    },
    "address": {
      "street": "Avenue des Champs-Élysées 50",
      "city": "Paris",
      "postcode": "75008"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "FR_UTILITY": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇫🇷 France - Utility 2 (FR_UTILITY_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Pierre",
      "lastName": "Dupont",
      "dateOfBirth": "1984-07-19",
      "phoneNumber": "+33612345678",
      "email": "pierre.dupont@example.com"
    },
    "address": {
      "street": "Avenue des Champs-Élysées 50",
      "city": "Paris",
      "postcode": "75008"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "FR_UTILITY_2": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇩🇪 Germany - Credit Bureau (DE_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Lukas",
      "lastName": "Schmidt",
      "dateOfBirth": "1986-03-15",
      "middleName": "Andreas"
    },
    "address": {
      "street": "Friedrichstraße 100",
      "city": "Berlin",
      "postcode": "10117"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "DE_CREDIT_BUREAU": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    }
  }
}

🇩🇪 Germany - Phone (DE_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Lukas",
      "lastName": "Schmidt",
      "middleName": "Andreas",
      "phoneNumber": "+4915123456789",
      "email": "lukas.schmidt@example.com"
    },
    "address": {
      "street": "Friedrichstraße 100",
      "city": "Berlin",
      "postcode": "10117",
      "state": "Berlin"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "DE_PHONE": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    }
  }
}

🇩🇪 Germany - Phone 2 (DE_PHONE_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Phone number via person.phoneNumber

  • Postcode via address.postcode

  • Street via address.street

  • City via address.city

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Lukas",
      "lastName": "Schmidt",
      "phoneNumber": "+4915123456789"
    },
    "address": {
      "postcode": "10117",
      "street": "Friedrichstraße 100",
      "city": "Berlin",
      "state": "Berlin"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "DE_PHONE_2": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    }
  }
}

🇩🇪 Germany - Residential (DE_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Lukas",
      "lastName": "Schmidt",
      "dateOfBirth": "1986-03-15",
      "middleName": "Andreas"
    },
    "address": {
      "street": "Friedrichstraße 100",
      "city": "Berlin",
      "postcode": "10117"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "DE_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    }
  }
}

🇩🇪 Germany - Utility (DE_UTILITY)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Lukas",
      "lastName": "Schmidt",
      "dateOfBirth": "1986-03-15"
    },
    "address": {
      "street": "Friedrichstraße 100",
      "city": "Berlin",
      "state": "Berlin",
      "postcode": "10117"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "DE_UTILITY": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    }
  }
}

🇩🇪 Germany - Utility 2 (DE_UTILITY_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Lukas",
      "lastName": "Schmidt",
      "dateOfBirth": "1986-03-15"
    },
    "address": {
      "street": "Friedrichstraße 100",
      "city": "Berlin",
      "postcode": "10117"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "DE_UTILITY_2": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    }
  }
}

🇬🇷 Greece - Consumer (GR_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Nikos",
      "lastName": "Papadopoulos",
      "dateOfBirth": "1988-05-25",
      "phoneNumber": "+306912345678"
    },
    "address": {
      "street": "Ermou 100",
      "city": "Athens",
      "postcode": "105 63"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "GR_CONSUMER": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇬🇷 Greece - Credit Bureau (GR_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • City via address.city

  • Street via address.street

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Nikos",
      "lastName": "Papadopoulos",
      "dateOfBirth": "1988-05-25",
      "idNumber": "12345678",
      "middleName": "",
      "phoneNumber": "+306912345678"
    },
    "address": {
      "city": "Athens",
      "street": "Ermou 100",
      "state": "Attica",
      "postcode": "105 63"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "GR_CREDIT_BUREAU": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇮🇪 Ireland - Citizens (IE_CITIZENS)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Gender via person.gender

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Aoife",
      "lastName": "O'Brien",
      "middleName": "Mary",
      "gender": "F",
      "phoneNumber": "+353871234567"
    },
    "address": {
      "street": "Grafton Street 50",
      "city": "Dublin",
      "state": "Leinster"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IE_CITIZENS": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇮🇪 Ireland - Credit Bureau (IE_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Gender via person.gender

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Aoife",
      "lastName": "O'Brien",
      "dateOfBirth": "1990-03-17",
      "gender": "F"
    },
    "address": {
      "street": "Grafton Street 50",
      "city": "Dublin",
      "postcode": "D02 X285"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IE_CREDIT_BUREAU": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇮🇪 Ireland - Residential (IE_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

  • Gender via person.gender

  • Street via address.street

  • City via address.city

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Aoife",
      "lastName": "O'Brien",
      "dateOfBirth": "1990-03-17",
      "middleName": "Mary",
      "gender": "F"
    },
    "address": {
      "street": "Grafton Street 50",
      "city": "Dublin",
      "state": "Leinster"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IE_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇮🇪 Ireland - Utility (IE_UTILITY)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Gender via person.gender

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Aoife",
      "lastName": "O'Brien",
      "middleName": "Mary",
      "gender": "F",
      "phoneNumber": "+353871234567"
    },
    "address": {
      "street": "Grafton Street 50",
      "city": "Dublin",
      "state": "Leinster"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IE_UTILITY": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇮🇪 Ireland - Utility 2 (IE_UTILITY_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Aoife",
      "lastName": "O'Brien",
      "dateOfBirth": "1990-03-17",
      "phoneNumber": "+353871234567"
    },
    "address": {
      "street": "Grafton Street 50",
      "city": "Dublin",
      "state": "Leinster",
      "postcode": "D02 X285"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IE_UTILITY_2": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇮🇪 Ireland - Voter Registration (IE_VOTER_REGISTRATION)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

  • Gender via person.gender

  • Street via address.street

  • City via address.city

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Aoife",
      "lastName": "O'Brien",
      "idNumber": "12345678",
      "middleName": "Mary",
      "gender": "F"
    },
    "address": {
      "street": "Grafton Street 50",
      "city": "Dublin",
      "state": "Leinster"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IE_VOTER_REGISTRATION": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇮🇹 Italy - Consumer (IT_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Marco",
      "lastName": "Rossi",
      "dateOfBirth": "1986-06-11",
      "phoneNumber": "+393331234567",
      "email": "marco.rossi@example.com"
    },
    "address": {
      "street": "Via Roma 1",
      "city": "Milan",
      "state": "Lombardia",
      "postcode": "20121"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IT_CONSUMER": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇮🇹 Italy - Credit Bureau (IT_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Gender via person.gender

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Marco",
      "lastName": "Rossi",
      "dateOfBirth": "1986-06-11",
      "idNumber": "RSSMRC86H11H501Z",
      "gender": "M"
    },
    "address": {
      "street": "Via Roma 1",
      "city": "Milan",
      "state": "Lombardia",
      "postcode": "20121"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IT_CREDIT_BUREAU": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇮🇹 Italy - Credit Bureau 2 (IT_CREDIT_BUREAU_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Street via address.street

  • Postcode via address.postcode

  • City via address.city

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Marco",
      "lastName": "Rossi",
      "dateOfBirth": "1986-06-11",
      "phoneNumber": "+393331234567"
    },
    "address": {
      "street": "Via Roma 1",
      "postcode": "20121",
      "city": "Milan",
      "state": "Lombardia"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IT_CREDIT_BUREAU_2": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇮🇹 Italy - Residential (IT_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Marco",
      "lastName": "Rossi",
      "dateOfBirth": "1986-06-11"
    },
    "address": {
      "street": "Via Roma 1",
      "city": "Milan",
      "postcode": "20121"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "IT_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇰🇪 Kenya - National ID (KE_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

  • Gender via person.gender

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Mwangi",
      "dateOfBirth": "1990-04-12",
      "idNumber": "12345678",
      "middleName": "",
      "gender": "M"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "KE_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "date_of_birth_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇲🇦 Morocco - Residential (MA_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Gender via person.gender

  • Phone number via person.phoneNumber

  • Email via person.email

  • City via address.city

  • Postcode via address.postcode

  • Street via address.street

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Youssef",
      "lastName": "El Amrani",
      "dateOfBirth": "1988-10-08",
      "gender": "M",
      "phoneNumber": "+212661234567",
      "email": "youssef.elamrani@example.com"
    },
    "address": {
      "city": "Casablanca",
      "postcode": "20000",
      "street": "Avenue Mohammed V 12",
      "state": "Casablanca-Settat"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "MA_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇳🇱 Netherlands - Consumer (NL_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Lucas",
      "lastName": "de Vries",
      "dateOfBirth": "1986-12-04",
      "phoneNumber": "+31612345678",
      "email": "lucas.devries@example.com"
    },
    "address": {
      "street": "Damrak 100",
      "city": "Amsterdam",
      "state": "Noord-Holland",
      "postcode": "1012 LN"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NL_CONSUMER": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇳🇱 Netherlands - Residential (NL_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

  • Gender via person.gender

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

  • Email via person.email

  • Street via address.street

  • Postcode via address.postcode

  • Suburb via address.suburb

{
  "verification": {
    "person": {
      "firstName": "Lucas",
      "lastName": "de Vries",
      "dateOfBirth": "1986-12-04",
      "middleName": "",
      "gender": "M",
      "phoneNumber": "+31612345678",
      "landLinePhoneNumber": "+15555550000",
      "email": "lucas.devries@example.com"
    },
    "address": {
      "street": "Damrak 100",
      "postcode": "1012 LN",
      "suburb": "Downtown"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NL_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "gender_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "land_line_phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇳🇱 Netherlands - Utility (NL_UTILITY)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • Suburb via address.suburb

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Lucas",
      "lastName": "de Vries",
      "dateOfBirth": "1986-12-04"
    },
    "address": {
      "street": "Damrak 100",
      "suburb": "Downtown",
      "postcode": "1012 LN"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NL_UTILITY": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇳🇬 Nigeria - Bank Verification Number (NG_BANK_VERIFICATION)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Reference number via document.referenceNumber

{
  "verification": {
    "person": {
      "firstName": "Chinedu",
      "lastName": "Okeke",
      "dateOfBirth": "1989-08-30"
    },
    "document": {
      "referenceNumber": "REF-2024-001234"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NG_BANK_VERIFICATION": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "document_reference_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇳🇬 Nigeria - National ID (NG_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • National ID number via person.idNumber

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Chinedu",
      "lastName": "Okeke",
      "idNumber": "12345678901",
      "dateOfBirth": "1989-08-30"
    },
    "address": {
      "street": "100 Main Street",
      "suburb": "Downtown",
      "state": "CA"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NG_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇳🇴 Norway - Consumer (NO_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Erik",
      "lastName": "Hansen",
      "dateOfBirth": "1987-11-23",
      "phoneNumber": "+4791234567",
      "email": "erik.hansen@example.com"
    },
    "address": {
      "street": "Karl Johans gate 1",
      "suburb": "Downtown",
      "state": "Oslo",
      "postcode": "0154"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NO_CONSUMER": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇳🇴 Norway - Residential (NO_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

  • National ID number via person.idNumber

Optional

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "dateOfBirth": "1987-11-23",
      "fullName": "John Doe",
      "firstName": "Erik",
      "lastName": "Hansen",
      "idNumber": "12345678"
    },
    "address": {
      "street": "Karl Johans gate 1",
      "suburb": "Downtown",
      "state": "Oslo",
      "postcode": "0154"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NO_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇳🇴 Norway - Utility (NO_UTILITY)

Input parameters

POST /sessions example

Mandatory

  • Last name via person.lastName

  • First name via person.firstName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • Postcode via address.postcode

  • Suburb via address.suburb

{
  "verification": {
    "person": {
      "lastName": "Hansen",
      "firstName": "Erik",
      "dateOfBirth": "1987-11-23",
      "phoneNumber": "+4791234567",
      "email": "erik.hansen@example.com"
    },
    "address": {
      "street": "Karl Johans gate 1",
      "postcode": "0154",
      "suburb": "Downtown"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "NO_UTILITY": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇵🇱 Poland - Consumer (PL_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Piotr",
      "lastName": "Kowalski",
      "dateOfBirth": "1987-04-19",
      "phoneNumber": "+48501234567",
      "email": "piotr.kowalski@example.com"
    },
    "address": {
      "street": "Nowy Świat 10",
      "suburb": "Downtown",
      "state": "Mazovia",
      "postcode": "00-497"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "PL_CONSUMER": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇵🇱 Poland - Credit Bureau (PL_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Piotr",
      "lastName": "Kowalski",
      "dateOfBirth": "1987-04-19"
    },
    "address": {
      "street": "Nowy Świat 10",
      "city": "Warsaw",
      "postcode": "00-497"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "PL_CREDIT_BUREAU": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇵🇹 Portugal - Residential (PT_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "João",
      "lastName": "Silva",
      "dateOfBirth": "1988-07-30"
    },
    "address": {
      "street": "Avenida da Liberdade 100",
      "city": "Lisbon",
      "postcode": "1250-145"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "PT_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇸🇰 Slovakia - Residential (SK_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Street via address.street

  • City via address.city

  • Suburb via address.suburb

{
  "verification": {
    "person": {
      "firstName": "Martin",
      "lastName": "Horváth"
    },
    "address": {
      "street": "Hlavná 10",
      "city": "Bratislava",
      "suburb": "Downtown"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "SK_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇿🇦 South Africa - National ID (ZA_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Thabo",
      "lastName": "Mokoena",
      "dateOfBirth": "1989-07-19",
      "idNumber": "8907195123083",
      "middleName": ""
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "ZA_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇪🇸 Spain - Consumer (ES_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Javier",
      "lastName": "García",
      "dateOfBirth": "1987-10-09",
      "phoneNumber": "+34612345678",
      "email": "javier.garcia@example.com"
    },
    "address": {
      "street": "Gran Vía 28",
      "city": "Madrid",
      "state": "Madrid",
      "postcode": "28013"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "ES_CONSUMER": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇪🇸 Spain - Consumer 2 (ES_CONSUMER_2)

Input parameters

POST /sessions example

Mandatory

  • Last name via person.lastName

  • First name via person.firstName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • Postcode via address.postcode

  • City via address.city

{
  "verification": {
    "person": {
      "lastName": "García",
      "firstName": "Javier",
      "dateOfBirth": "1987-10-09",
      "phoneNumber": "+34612345678",
      "email": "javier.garcia@example.com"
    },
    "address": {
      "street": "Gran Vía 28",
      "postcode": "28013",
      "city": "Madrid"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "ES_CONSUMER_2": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇪🇸 Spain - National ID (ES_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

  • State via address.state

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Javier",
      "lastName": "García",
      "dateOfBirth": "1987-10-09",
      "idNumber": "12345678Z",
      "phoneNumber": "+34612345678"
    },
    "address": {
      "street": "Gran Vía 28",
      "city": "Madrid",
      "postcode": "28013",
      "state": "Madrid"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "ES_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇪🇸 Spain - Phone (ES_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Javier",
      "lastName": "García",
      "phoneNumber": "+34612345678"
    },
    "address": {
      "street": "Gran Vía 28",
      "city": "Madrid",
      "postcode": "28013",
      "state": "Madrid"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "ES_PHONE": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇪🇸 Spain - Phone 2 (ES_PHONE_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Javier",
      "lastName": "García",
      "dateOfBirth": "1987-10-09",
      "phoneNumber": "+34612345678"
    },
    "address": {
      "street": "Gran Vía 28",
      "city": "Madrid",
      "state": "Madrid",
      "postcode": "28013"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "ES_PHONE_2": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇪🇸 Spain - Residential (ES_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Javier",
      "lastName": "García",
      "dateOfBirth": "1987-10-09"
    },
    "address": {
      "street": "Gran Vía 28",
      "city": "Madrid",
      "postcode": "28013"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "ES_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇪🇸 Spain - Utility (ES_UTILITY)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • National ID number via person.idNumber

Optional

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Javier",
      "lastName": "García",
      "idNumber": "12345678Z",
      "phoneNumber": "+34612345678",
      "landLinePhoneNumber": "+15555550000"
    },
    "address": {
      "street": "Gran Vía 28",
      "city": "Madrid",
      "state": "Madrid",
      "postcode": "28013"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "ES_UTILITY": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "land_line_phone_number_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇸🇪 Sweden - Consumer (SE_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Erik",
      "lastName": "Andersson",
      "dateOfBirth": "1986-08-11",
      "phoneNumber": "+46701234567",
      "email": "erik.andersson@example.com"
    },
    "address": {
      "street": "Drottninggatan 1",
      "city": "Stockholm",
      "state": "Stockholm",
      "postcode": "111 51"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "SE_CONSUMER": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇸🇪 Sweden - National ID (SE_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • National ID number via person.idNumber

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Erik",
      "lastName": "Andersson",
      "idNumber": "198608112345",
      "dateOfBirth": "1986-08-11",
      "middleName": ""
    },
    "address": {
      "street": "Drottninggatan 1",
      "city": "Stockholm",
      "state": "Stockholm",
      "postcode": "111 51"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "SE_NATIONAL_ID": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇸🇪 Sweden - Phone (SE_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Phone number via person.phoneNumber

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Erik",
      "lastName": "Andersson",
      "dateOfBirth": "1986-08-11",
      "idNumber": "198608112345",
      "phoneNumber": "+46701234567",
      "middleName": ""
    },
    "address": {
      "street": "Drottninggatan 1",
      "city": "Stockholm",
      "postcode": "111 51"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "SE_PHONE": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "not_applicable", "reason": "input_not_provided" },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇨🇭 Switzerland - Consumer (CH_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Lukas",
      "lastName": "Müller",
      "dateOfBirth": "1986-09-12",
      "phoneNumber": "+41791234567",
      "email": "lukas.mueller@example.com"
    },
    "address": {
      "street": "Bahnhofstrasse 22",
      "city": "Zurich",
      "state": "Zürich",
      "postcode": "8001"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CH_CONSUMER": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    }
  }
}

🇨🇭 Switzerland - Credit Bureau (CH_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Gender via person.gender

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

  • Suburb via address.suburb

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "Lukas",
      "lastName": "Müller",
      "dateOfBirth": "1986-09-12",
      "gender": "M"
    },
    "address": {
      "street": "Bahnhofstrasse 22",
      "city": "Zurich",
      "postcode": "8001",
      "suburb": "Downtown"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CH_CREDIT_BUREAU": {
    "status": "success",
    "data": null,
    "error": null,
    "timestamp": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "gender_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null }
    }
  }
}

🇬🇧 United Kingdom Citizens (GB_CITIZENS)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Address via address.street + address.city + address.postcode OR address.fullAddress

With parsed address fields

{
  "verification": {
    "person": {
      "firstName": "Oliver",
      "lastName": "Thornton",
      "dateOfBirth": "1980-04-11"
    },
    "address": {
      "street": "22 Baker Street",
      "city": "London",
      "postcode": "NW1 6XE"
    }
  }
}

With fullAddress parameter

{
  "verification": {
    "person": {
      "firstName": "Oliver",
      "lastName": "Thornton",
      "dateOfBirth": "1980-04-11"
    },
    "address": {
      "fullAddress": "22 Baker Street, London NW1 6XE"
    }
  }
}

To send address info, you can use either parsed address.street + address.city + address.postcode parameters or the full address via address.fullAddress. Do not send both.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object.

{
  "GB_CITIZENS": {
    "status": "success",
    "data": {
      "firstName": "Oliver",
      "lastName": "Thornton"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇬🇧 United Kingdom Consumer (GB_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • Neighbourhood via address.neighbourhood

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

  • Email via person.email

  • Phone number via person.phoneNumber

With all optional data

{
  "verification": {
    "person": {
      "firstName": "Emma",
      "lastName": "Clark",
      "dateOfBirth": "1995-04-18",
      "email": "emma.clark@example.co.uk",
      "phoneNumber": "+447911123456"
    },
    "address": {
      "street": "25 Baker Street",
      "neighbourhood": "Marylebone",
      "city": "London",
      "state": "England",
      "postcode": "W1U 8EW"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object.

{
  "GB_CONSUMER": {
    "status": "success",
    "data": {
      "address1": "25 Baker Street",
      "city": "London",
      "postCode": "W1U 8EW",
      "firstName": "Emma",
      "lastName": "Clark"
    },
    "validations": {
      "processing": {"result": "success", "reason": null},
      "is_input_valid": {"result": "success", "reason": null},
      "identity_is_valid": {"result": "success", "reason": null},
      "first_name_match": {"result": "success", "reason": null},
      "last_name_match": {"result": "success", "reason": null},
      "date_of_birth_match": {"result": "success", "reason": null}
    },
    "error": null,
    "timestamp": null
  }
}

🇬🇧 United Kingdom Credit Bureau (GB_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Address via address.street + address.city + address.postcode OR address.fullAddress

  • Consent via consents array

With parsed address fields

{
  "verification": {
    "person": {
      "firstName": "Charlotte",
      "lastName": "Pemberton",
      "dateOfBirth": "1977-06-19"
    },
    "address": {
      "street": "45 Threadneedle Street",
      "city": "London",
      "postcode": "EC2R 8AH"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

With fullAddress parameter

{
  "verification": {
    "person": {
      "firstName": "Charlotte",
      "lastName": "Pemberton",
      "dateOfBirth": "1977-06-19"
    },
    "address": {
      "fullAddress": "45 Threadneedle Street, London EC2R 8AH"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

To send address info, you can use either parsed address.street + address.city + address.postcode parameters or the full address via address.fullAddress. Do not send both.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object.

{
  "GB_CREDIT_BUREAU": {
    "status": "success",
    "data": {
      "address1": "45 Threadneedle Street",
      "city": "London",
      "postCode": "EC2R 8AH",
      "firstName": "Charlotte",
      "lastName": "Pemberton",
      "middleName": "Anne"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇬🇧 United Kingdom Financial Services (GB_FINANCIAL_SERVICES)

Input parameters

POST /sessions example

Mandatory

  • Last name via person.lastName

  • Address via address.street + address.city + address.postcode OR address.fullAddress

Optional

  • First name via person.firstName

  • Date of birth via person.dateOfBirth

  • Phone number via person.phoneNumber

With parsed address fields

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Whitfield",
      "dateOfBirth": "1975-03-22",
      "phoneNumber": "+447911123456"
    },
    "address": {
      "street": "8 Canary Wharf",
      "city": "London",
      "postcode": "E14 5AB"
    }
  }
}

With fullAddress parameter

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Whitfield",
      "dateOfBirth": "1975-03-22",
      "phoneNumber": "+447911123456"
    },
    "address": {
      "fullAddress": "8 Canary Wharf, London E14 5AB"
    }
  }
}

To send address info, you can use either parsed address.street + address.city + address.postcode parameters or the full address via address.fullAddress. Do not send both.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object.

{
  "GB_FINANCIAL_SERVICES": {
    "status": "success",
    "data": {
      "address1": "8 Canary Wharf",
      "city": "London",
      "postCode": "E14 5AB",
      "firstName": "James",
      "lastName": "Whitfield",
      "identityStrength": 85,
      "identityValidity": "valid",
      "identityFraud": false,
      "activityHistory": "established",
      "deathRegistration": false,
      "amberhill": false,
      "siraFraud": false,
      "siraImpersonation": false,
      "synthIdNoMatch": false
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇬🇧 United Kingdom Phone (GB_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Phone number via person.phoneNumber

Optional

  • Address via address.street + address.city + address.postcode OR address.fullAddress

Mandatory fields only

{
  "verification": {
    "person": {
      "firstName": "Thomas",
      "lastName": "Hargreaves",
      "phoneNumber": "+447700900456"
    }
  }
}

With optional address

{
  "verification": {
    "person": {
      "firstName": "Thomas",
      "lastName": "Hargreaves",
      "phoneNumber": "+447700900456"
    },
    "address": {
      "street": "37 Victoria Street",
      "city": "Manchester",
      "postcode": "M2 3BQ"
    }
  }
}

If sending address, you can use either parsed address.street + address.city + address.postcode parameters or the full address via address.fullAddress. Do not send both.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object.

{
  "GB_PHONE": {
    "status": "success",
    "data": {
      "address1": "37 Victoria Street",
      "city": "Manchester",
      "postCode": "M2 3BQ",
      "firstName": "Thomas",
      "lastName": "Hargreaves",
      "homePhoneNo": "+447700900456"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇬🇧 United Kingdom Phone 2 (GB_PHONE_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Phone number via person.phoneNumber

  • Address via address.street + address.city + address.postcode OR address.fullAddress

Optional

  • Date of birth via person.dateOfBirth

With parsed address and optional DOB

{
  "verification": {
    "person": {
      "firstName": "Fiona",
      "lastName": "MacAllister",
      "dateOfBirth": "1983-12-05",
      "phoneNumber": "+447911654321"
    },
    "address": {
      "street": "19 Princes Street",
      "city": "Edinburgh",
      "postcode": "EH2 2BY"
    }
  }
}

With fullAddress parameter

{
  "verification": {
    "person": {
      "firstName": "Fiona",
      "lastName": "MacAllister",
      "dateOfBirth": "1983-12-05",
      "phoneNumber": "+447911654321"
    },
    "address": {
      "fullAddress": "19 Princes Street, Edinburgh EH2 2BY"
    }
  }
}

To send address info, you can use either parsed address.street + address.city + address.postcode parameters or the full address via address.fullAddress. Do not send both.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object.

{
  "GB_PHONE_2": {
    "status": "success",
    "data": {
      "address1": "19 Princes Street",
      "city": "Edinburgh",
      "postCode": "EH2 2BY",
      "firstName": "Fiona",
      "lastName": "MacAllister",
      "homePhoneNo": "+447911654321",
      "statusMessage": "Match found"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇬🇧 United Kingdom Residential (GB_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Date of birth via person.dateOfBirth

  • Street via address.street

  • Neighbourhood via address.neighbourhood

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

  • Drivers licence version via document.version

  • Landline number via person.landLinePhoneNumber

  • Phone number via person.phoneNumber

With all optional data

{
  "verification": {
    "person": {
      "firstName": "William",
      "lastName": "Davies",
      "dateOfBirth": "1982-01-30",
      "phoneNumber": "+447700900123",
      "landLinePhoneNumber": "+442071234567"
    },
    "document": {
      "version": "1"
    },
    "address": {
      "street": "10 Downing Street",
      "neighbourhood": "Westminster",
      "city": "London",
      "state": "England",
      "postcode": "SW1A 2AA"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object.

{
  "GB_RESIDENTIAL": {
    "status": "success",
    "data": {
      "address1": "10 Downing Street",
      "city": "London",
      "postCode": "SW1A 2AA",
      "firstName": "William",
      "lastName": "Davies",
      "matchedAddress": "10 Downing Street"
    },
    "validations": {
      "processing": {"result": "success", "reason": null},
      "is_input_valid": {"result": "success", "reason": null},
      "identity_is_valid": {"result": "success", "reason": null},
      "first_name_match": {"result": "success", "reason": null},
      "last_name_match": {"result": "success", "reason": null},
      "date_of_birth_match": {"result": "success", "reason": null},
      "address_full_address_match": {"result": "success", "reason": null},
      "phone_number_match": {"result": "success", "reason": null},
      "land_line_phone_number_match": {"result": "success", "reason": null}
    },
    "error": null,
    "timestamp": null
  }
}

NORTHAM

🇨🇦 Canada - Consumer (CA_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Anderson",
      "dateOfBirth": "1982-05-18",
      "phoneNumber": "+14165551234",
      "email": "james.anderson@example.com"
    },
    "address": {
      "street": "123 Bay Street",
      "suburb": "Downtown",
      "state": "ON",
      "postcode": "M5J 2T3"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CA_CONSUMER": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇨🇦 Canada - Credit Bureau (FINTRAC) (CA_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Anderson",
      "dateOfBirth": "1982-05-18",
      "middleName": "William"
    },
    "address": {
      "street": "123 Bay Street",
      "city": "Toronto",
      "state": "ON",
      "postcode": "M5J 2T3"
    },
    "consents": [
      {
        "type": "ca-consent",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CA_CREDIT_BUREAU": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇨🇦 Canada - Credit Bureau 2 (Non-FINTRAC) (CA_CREDIT_BUREAU_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

  • Suburb via address.suburb

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Anderson",
      "dateOfBirth": "1982-05-18",
      "middleName": "William"
    },
    "address": {
      "street": "123 Bay Street",
      "city": "Toronto",
      "state": "ON",
      "postcode": "M5J 2T3",
      "suburb": "Downtown"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CA_CREDIT_BUREAU_2": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇨🇦 Canada - Phone (CA_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Anderson",
      "middleName": "William",
      "phoneNumber": "+14165551234"
    },
    "address": {
      "street": "123 Bay Street",
      "city": "Toronto",
      "state": "ON",
      "postcode": "M5J 2T3"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CA_PHONE": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇨🇦 Canada - Residential (CA_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

  • Consent via consents array

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Anderson",
      "dateOfBirth": "1982-05-18",
      "phoneNumber": "+14165551234",
      "middleName": "William"
    },
    "address": {
      "street": "123 Bay Street",
      "city": "Toronto",
      "state": "ON",
      "postcode": "M5J 2T3"
    },
    "consents": [
      {
        "type": "ca-consent",
        "approved": true
      }
    ]
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CA_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇺🇸 United States - Consumer (US_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1985-06-15",
      "phoneNumber": "+14155551234",
      "email": "john.smith@example.com"
    },
    "address": {
      "street": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "postcode": "94103"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "US_CONSUMER": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇺🇸 United States - Credit Bureau (US_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1985-06-15",
      "idNumber": "123-45-6789",
      "middleName": "Michael",
      "phoneNumber": "+14155551234",
      "email": "john.smith@example.com"
    },
    "address": {
      "street": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "postcode": "94103"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "US_CREDIT_BUREAU": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇺🇸 United States - Death Check (US_DEATH_CHECK)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1985-06-15",
      "idNumber": "123-45-6789",
      "middleName": "Michael"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "US_DEATH_CHECK": {
    "status": "success",
    "data": {
      "dateOfDeath": "2025-01-04",
      "possibleDeceasedRecord": true,
      "possibleDeceasedRecordName": "John Michael Carter"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇺🇸 United States - Financial Services (US_FINANCIAL_SERVICES)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • National ID number via person.idNumber

  • Document number via document.number

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1985-06-15",
      "idNumber": "123-45-6789",
      "middleName": "Michael",
      "phoneNumber": "+14155551234",
      "email": "john.smith@example.com"
    },
    "address": {
      "street": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "postcode": "94103"
    },
    "document": {
      "number": "ABC123456"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "US_FINANCIAL_SERVICES": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "document_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇺🇸 United States - Phone (US_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "John",
      "lastName": "Smith",
      "middleName": "Michael",
      "phoneNumber": "+14155551234"
    },
    "address": {
      "street": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "postcode": "94103"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "US_PHONE": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇺🇸 United States - Phone 2 (US_PHONE_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Phone number via person.phoneNumber

  • Street via address.street

  • Postcode via address.postcode

  • City via address.city

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1985-06-15",
      "idNumber": "123-45-6789",
      "phoneNumber": "+14155551234"
    },
    "address": {
      "street": "123 Main Street",
      "postcode": "94103",
      "city": "San Francisco",
      "state": "CA"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "US_PHONE_2": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇺🇸 United States - Residential (US_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • National ID number via person.idNumber

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1985-06-15",
      "idNumber": "123-45-6789",
      "middleName": "Michael",
      "phoneNumber": "+14155551234",
      "email": "john.smith@example.com"
    },
    "address": {
      "street": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "postcode": "94103"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "US_RESIDENTIAL": {
    "status": "success",
    "data": null,
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "middle_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

Status and reason codes

For info about the session, see:

  • verification.code about verification session decision code, one of 9001, 9102, 9103, 9104, 9121.

  • verification.status about verification status, one of approved, declined, resubmission_requested, expired, abandoned.

If the Metadata Database Verification session was declined or resubmission_requested, you can find additional information by checking:

  1. verification.reason for the reason why the verification failed.

  2. verification.reasonCode for reason code of the failed verification and cross-reference it with Granular reason codes (table).

verification.status

verification.reasonCode

verification.reason

What does it mean?

declined

529

Unable to validate National Id data

The registry check failed. The person was not found or data did not match. Check registryValidations for field-level failures.

declined

9102

Declined

Generic decline. Check registryValidations for details on which validations failed.

Full validation → rejection category code mapping

When the verification result is declined, the verification.reasonCode reflects the most impactful failed validation. Use this table to map each validation_check failure to its rejection category code:

Validation

Rejection category code

is_input_valid failure

529

processing failure

566

consent_obtained failure

570

identity_is_valid failure

529

first_name_match, middle_name_match, last_name_match, full_name_match, first_partner_name_match, last_partner_name_match failures

541

date_of_birth_match failure

576

gender_match failure

578

email_match, phone_number_match, land_line_phone_number_match, marriage_date_of_event_match, document_version_match, document_valid_from_match failures

529

id_number_match failure

577

address_*_match failures (any of street/city/state/postcode/suburb/full address)

573

document_number_match, document_card_number_match, document_reference_number_match failures

572

The table above aims to list the most common reasons why you may see the decline or resubmission_requested reason for a Metadata Database Verification session. However, the session may be declined due to a reason that is not inherently related to this solution's flow (e.g. uploaded document's quality is low). In that case, to find info about the codes you are seeing, refer to:

Additional data

Best practices

  1. In API flow, ensure that initData is present, especially the mandatory fields.

  2. Ensure correct data formats to reduce the possibility of session going to resubmission_requested.

  3. Document image quality: ensure that end-user's document image is of good quality. This will reduce the possibility of session going to resubmission_requested.

  4. Person's ID number is always sent in the document.number parameter (not person.idNumber).

  5. Error handling: implement proper error handling for all possible validation results.

  6. Session declined due to third-party provider issues: implement proper session handling flow when possibly legitimate end-user's session is declined due to the third-party service provider having issues, as indicated by session code registry_unavailable, technical_issue, or registry_timeout.

  7. Webhook security: secure your webhook endpoint and verify request signatures.

  8. User experience: provide clear feedback to users about validation results.

  9. Ensure backwards compatibility for webhooks and API connections.

FAQ

Can I query multiple registries in a single session?

Yes. The workflow can be configured with multiple Metadata Database Verification steps, each targeting a different registry. Results for each registry appear under their respective <REGISTRY_KEY> in registryValidations.

What happens if I send a field that the registry does not support?

Extra fields are ignored. Only the fields relevant to the configured registry are used.

How do I know which fields are mandatory for a specific registry?

See the per-registry documentation in the Databases by Regions section. Mandatory fields are listed for each database.

What if the registry returns data about the person?

Returned data appears in the data object of the registry result. Not all registries return data, some only perform matching.

Changelog

Date

Description

Jul 9, 2026

US_DEATH_CHECK response payload example updated

Jun 16, 2026

US_FINANCIAL_SERVICES mandatory parameters updated

May 29, 2026

Databases by regions order updated

May 27, 2026

New databases added

May 25, 2026

Edited Data Sources

Apr 20, 2026

Documentation updated

Apr 16, 2026

Documentation updated

Apr 8, 2026

Documentation published