Metadata Database Verification

Prev Next

Available via API

Available via SDK

Needs configuration on Veriff's side

Needs a separate integration

Needs a solution-specific 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. It returns field-level validation statuses for granular, programmable decision-making.

This solution can be used only as a stand-alone check. 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. Mandatory fields must be present and correctly formatted: if a mandatory field is missing, is_input_valid fails and the session is declined.

Key terminology

Term

Description

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 or male / F or female)

  • person.email: string Email address

  • person.phoneNumber: string Mobile phone number

  • person.landLinePhoneNumber: string Landline phone number

  • person.idNumber: string National ID number (also tax ID, SSN, CPF, etc., depending on the registry)

  • person.partnerFirstName: string Partner's first name

  • person.partnerLastName: string Partner's last name

  • person.marriageDateOfEvent: string Marriage date in YYYY-MM-DD format

  • person.secondLastName: string Second last name

  • document.number: string Document number

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

  • document.validFrom: string Document issue/valid-from date in YYYY-MM-DD format

  • document.validUntil: string Document expiry date in YYYY-MM-DD format

  • 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. When sent, it is parsed into the individual address fields; parsed values only fill fields you did not send

  • address.street: string Street name and number

  • address.houseNumber: string House number (used by registries that take it separately, e.g. CH, TH, ID)

  • address.unit: string Unit, flat or floor (used e.g. by HK, CA, SK)

  • address.buildingName: string A name given to a building or a property

  • address.suburb: string A specific named area within a city or a town. For AU and NZ registries this is the locality (suburb/town) of the postal address

  • address.subDistrict: string An entity at a lower level than district

  • address.city: string City name

  • address.state: string A first-level administrative division (for AU: NSW, VIC, QLD, WA, SA, TAS, ACT, NT)

  • address.postcode: string Postcode number

  • consents: array List of consent objects

  • type: string Consent type, see Consent types for the valid value per registry

  • approved: boolean Whether consent was obtained

Fields that a registry does not use are ignored. An ignored field does not satisfy a mandatory one: for example, Australian registries use address.suburb, so sending only address.city leaves the suburb missing.


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. Check each database's documentation to see which initData parameters are required and allowed to be sent.

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

    1. This endpoint requires endpoint level authentication via x-hmac-signature header. See HMAC Authentication and Endpoint Security article for general info about signature creation.

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.

  2. 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 does 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 a registry result is populated from a canonical field mapping. They are all conditional: a field is present only if the registry returned a non-empty value for it; otherwise the key is omitted.

Field names are in camelCase.

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 Status of the returned address (current, previous)

  • city City / town

  • suburb Suburb or neighbourhood

  • postCode Postal / ZIP code

  • location Free-form working-rights values string, such as onshore

Contact

  • homePhoneNo Home / landline phone number

  • phoneData Structured phone records (array of objects)

  • phoneStatus Phone status (active, disconnected)

  • carrierName Telephone carrier name

Identification

  • nationalIdNo National ID number returned by the registry

  • nationalIdNoStatus National ID status (active/inactive)

  • 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 Work-entitlement status as integer

  • workEntitlementStatusText Work-entitlement status description

Identity quality and match scores

  • identityFraud Identity-fraud indicator, string

  • identityStrength Identity-strength score / band, string

  • identityValidity Identity-validity indicator, string

  • altAddressMatchScore Alternative address-match score (object)

  • altDobScore Alternative date-of-birth match score, string

  • 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, present only when the registry returns it. Passed through unchanged in YYYY-MM-DD format.

  • dateOfRegistration Death-record registration date, passed through unchanged in YYYY-MM-DD format

  • 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, values: business, personal, corporate, unknown

  • accountType Account type, values: postpaid, prepaid, unknown

  • activationDate Account / record activation date

  • activityHistory Activity history summary, string

  • 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, e.g., regular, canceled, suspended, pending, null

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_match Marriage 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 Suburb (address.suburb) 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, or was sent with a different type than the registry requires

  • input_invalid Input data was provided but in incorrect format, or a mandatory field is missing

  • 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, with approved: true and the type listed for that registry below. The type must match exactly: if consent is missing, not approved, or sent with a different type, consent_obtained fails and the session is declined. Consent objects sent to a registry that does not require consent are ignored.

Consent type

Used by

au-dvs

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

au-consent

AU Electoral Roll, AU Superannuation & Payroll

ca-consent

Canada Residential, Canada Credit Bureau (FINTRAC)

nz-consent

New Zealand Credit Bureau

dia-consent

New Zealand DIA Births, DIA Citizenship, DIA Passport

general

AU VEVO, AU Credit Bureau, AU Death Check; Cambodia National ID; China Bank Card, National ID, Passport Verification, Phone; Indonesia Residential Identity Card; India Aadhaar, Drivers Licence, EPIC, PAN, Passport; Malaysia National ID; New Zealand Utility, Drivers Licence; Philippines Credit Bureau, Residential; Singapore Credit Bureau; Thailand National ID; Argentina Credit Bureau; Colombia National ID; Austria, Germany, Poland, Switzerland and United Kingdom Credit Bureau; Spain National ID; Canada Credit Bureau 2 (Non-FINTRAC)

(none)

All other registries, including AU Consumer, Citizens, Residential, Residential Lookup, ASIC, Phone and TICA, Canada Consumer and Phone, and Malaysia Credit Bureau

"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 verification.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_ASIC_PERSONAL_NAME_REGISTER": {
    "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 }
    },
    "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 (or address.fullAddress)

Optional

  • Middle name via person.middleName

  • Gender via person.gender

  • Email via person.email

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

  • Suburb via address.suburb

  • State via address.state

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",
      "middleName": "Jane"
    },
    "address": {
      "street": "15 Queen Street",
      "suburb": "Brisbane City",
      "state": "QLD",
      "postcode": "4000"
    }
  }
}

Group B with fullAddress parameter

{
  "verification": {
    "person": {
      "firstName": "Sarah",
      "lastName": "Thompson",
      "middleName": "Jane"
    },
    "address": {
      "fullAddress": "15 Queen Street, Brisbane City QLD 4000"
    }
  }
}

Send Group A, Group B, or both.

To send address info, use either the parsed address fields or the full address via address.fullAddress. Do not send both.

Australian registries take the locality in address.suburb and the state code in address.state. address.city is not used by Australian registries.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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_CITIZENS": {
    "status": "success",
    "data": {
      "altAddressMatchScore": "0",
      "altNameMatchScore": "a1",
      "dpId": "63233056",
      "source": "dz1"
    },
    "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 },
      "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

  • Email via person.email

  • Phone number via person.phoneNumber

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

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

To send address info, use either the parsed address fields or the full address via address.fullAddress. Do not send both.

Australian registries take the locality in address.suburb and the state code in address.state. address.city is not used by Australian registries.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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_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 },
      "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.suburb + address.state + address.postcode OR address.fullAddress

  • Consent via consents array (type: general)

Optional

  • Middle name via person.middleName

With parsed address fields

{
  "verification": {
    "person": {
      "firstName": "Patricia",
      "lastName": "Henderson",
      "dateOfBirth": "1983-04-07"
    },
    "address": {
      "street": "18 Bourke Street",
      "suburb": "Melbourne",
      "state": "VIC",
      "postcode": "3000"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

With fullAddress parameter

{
  "verification": {
    "person": {
      "firstName": "Patricia",
      "lastName": "Henderson",
      "dateOfBirth": "1983-04-07"
    },
    "address": {
      "fullAddress": "18 Bourke Street, Melbourne VIC 3000"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

To send address info, use either the parsed address fields or the full address via address.fullAddress. Do not send both.

Australian registries take the locality in address.suburb and the state code in address.state. address.city is not used by Australian registries.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": 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_full_address_match": { "result": "success", "reason": null }
    },
    "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 (type: general)

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Margaret",
      "lastName": "Collins",
      "dateOfBirth": "1942-03-18"
    },
    "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 verification.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": {
      "dateOfDeath": "2019-06-12",
      "possibleDeceasedRecord": true,
      "possibleDeceasedRecordName": "Margaret Collins",
      "possibleDeceasedRecordPartialMatching": false,
      "registrationNumber": true,
      "registrationState": true
    },
    "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

  • Card number via document.cardNumber

  • State of issue via document.stateOfIssue

  • Consent via consents array (type: au-dvs)

Optional

  • 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 verification.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": {
      "verificationRequestNumber": "DZ-08706458-292"
    },
    "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

  • Medicare card number via document.cardNumber

  • Medicare card type (G green, B blue, Y yellow) via document.cardType

  • Medicare card expiry via document.validUntil

  • Individual reference number via document.referenceNumber

  • Consent via consents array (type: au-dvs)

Optional

  • Name line 1 via person.firstName

  • Name line 2 via person.middleName

  • Name line 3 via person.lastName

  • Name line 4 via person.secondLastName

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

The name fields are matched against the name lines printed on the card, not against first/middle/last name semantics. Send each printed line of the individual's name in the corresponding field.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "verificationRequestNumber": "DZ-08706458-292"
    },
    "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 },
      "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 (type: au-dvs)

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 verification.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": {
      "verificationRequestNumber": "DZ-08706458-292"
    },
    "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 (type: au-dvs)

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Amara",
      "lastName": "Okafor",
      "dateOfBirth": "1989-07-03"
    },
    "document": {
      "number": "A12345678",
      "country": "NG"
    },
    "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 verification.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": {
      "verificationRequestNumber": "DZ-08706458-292"
    },
    "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

  • Birth registration state via document.stateOfIssue

  • Consent via consents array (type: au-dvs)

Conditionally required in addition to mandatory data

  • At least one of: Birth certificate number via document.number, Birth registration number via document.registrationNumber, Birth registration date via document.validFrom

Optional

  • Middle name via person.middleName

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

Which document field the registry needs depends on the state of registration. NSW, VIC, ACT, NT, SA, WA: registration number or certificate number. QLD, TAS: registration date or certificate number. Sending the certificate number works for every state.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "verificationRequestNumber": "DZ-08706458-292"
    },
    "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
  }
}

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 (type: au-dvs)

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 verification.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": {
      "verificationRequestNumber": "DZ-08706458-292"
    },
    "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

  • Registration state via document.stateOfIssue

  • Consent via consents array (type: au-dvs)

Conditionally required in addition to mandatory data

  • At least one of: Certificate number via document.number, Registration number via document.registrationNumber, Registration date via document.validFrom

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

Which document field the registry needs depends on the state of registration. QLD: registration date or certificate number. Other states: registration number or certificate number.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "verificationRequestNumber": "DZ-08706458-292"
    },
    "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 (type: au-dvs)

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 verification.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": {
      "verificationRequestNumber": "DZ-08706458-292"
    },
    "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

  • ImmiCard number via document.number

  • Consent via consents array (type: au-dvs)

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Thanh",
      "lastName": "Nguyen",
      "middleName": "Van",
      "dateOfBirth": "1982-10-05"
    },
    "document": {
      "number": "HAA123456"
    },
    "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 verification.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": {
      "verificationRequestNumber": "DZ-08706458-292"
    },
    "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 (type: au-dvs)

Conditionally required in addition to mandatory data

  • At least one of: Certificate number via document.number, Registration number via document.registrationNumber, Registration date via document.validFrom

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

Which document field the registry needs depends on the state of registration. ACT, NT, SA, VIC, WA, NSW, TAS: registration number or certificate number. QLD: registration date or certificate number.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "verificationRequestNumber": "DZ-08706458-292"
    },
    "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 }
    },
    "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

  • Travel document number via document.number

  • Document issuing country via document.country

  • Consent via consents array (type: au-dvs)

Optional

  • Middle name via person.middleName

{
  "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 verification.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": {
      "verificationRequestNumber": "DZ-08706458-292"
    },
    "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.suburb + address.state + address.postcode OR address.fullAddress

  • Consent via consents array (type: au-consent)

Optional

  • Middle name via person.middleName

  • Street (send it if the person is enrolled with a street address) via address.street

  • Building name via address.buildingName

With parsed address fields

{
  "verification": {
    "person": {
      "firstName": "Robert",
      "lastName": "Mitchell",
      "dateOfBirth": "1979-08-22"
    },
    "address": {
      "street": "27 Flinders Street",
      "suburb": "Melbourne",
      "state": "VIC",
      "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, use either the parsed address fields or the full address via address.fullAddress. Do not send both.

Australian registries take the locality in address.suburb and the state code in address.state. address.city is not used by Australian registries.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "verificationRequestNumber": "DZ-08706458-292"
    },
    "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

  • Street via address.street OR address.fullAddress

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

With parsed address fields

{
  "verification": {
    "person": {
      "firstName": "Gregory",
      "lastName": "Walsh",
      "phoneNumber": "+61412345678"
    },
    "address": {
      "street": "14 Park Road",
      "suburb": "Milton",
      "state": "QLD",
      "postcode": "4064"
    }
  }
}

With fullAddress parameter

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

To send address info, use either the parsed address fields or the full address via address.fullAddress. Do not send both.

Australian registries take the locality in address.suburb and the state code in address.state. address.city is not used by Australian registries.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": 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_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

Conditionally required in addition to mandatory data

  • Date of birth via person.dateOfBirth and/or address via address.street + address.postcode (or address.fullAddress)

Optional

  • Middle name via person.middleName

  • Gender via person.gender

  • Email via person.email

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

  • Suburb via address.suburb

  • State via address.state

With date of birth

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Wilson",
      "dateOfBirth": "1974-05-05",
      "middleName": "Robert",
      "phoneNumber": "+61412345678"
    }
  }
}

With parsed address fields

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Wilson",
      "middleName": "Robert"
    },
    "address": {
      "street": "42 George Street",
      "suburb": "Sydney",
      "state": "NSW",
      "postcode": "2000"
    }
  }
}

With fullAddress parameter

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Wilson",
      "middleName": "Robert"
    },
    "address": {
      "fullAddress": "42 George Street, Sydney NSW 2000"
    }
  }
}

Send the date of birth, the address, or both.

To send address info, use either the parsed address fields or the full address via address.fullAddress. Do not send both.

Australian registries take the locality in address.suburb and the state code in address.state. address.city is not used by Australian registries.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "altAddressMatchScore": "0",
      "altNameMatchScore": "a1",
      "dpId": "63233056",
      "source": "dz1"
    },
    "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" },
      "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

  • Phone number (mobile or landline) via person.phoneNumber

Optional

  • Middle name via person.middleName

  • Date of birth via person.dateOfBirth

  • Address via address.street + address.suburb + address.state + address.postcode OR address.fullAddress

{
  "verification": {
    "person": {
      "firstName": "David",
      "lastName": "Anderson",
      "middleName": "James",
      "dateOfBirth": "1968-11-15",
      "phoneNumber": "+61398765432"
    },
    "address": {
      "street": "5 Collins Street",
      "suburb": "Melbourne",
      "state": "VIC",
      "postcode": "3000"
    }
  }
}

To send address info, use either the parsed address fields or the full address via address.fullAddress. Do not send both.

Australian registries take the locality in address.suburb and the state code in address.state. address.city is not used by Australian registries.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "source": "dz1"
    },
    "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": "not_applicable", "reason": "output_not_received" },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

๐Ÿ‡ฆ๐Ÿ‡บ Australia - Superannuation & Payroll (AU_SUPERANNUATION_AND_PAYROLL)

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.state + address.postcode OR address.fullAddress

  • Consent via consents array (type: au-consent)

Optional

  • Suburb via address.suburb

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

To send address info, use either the parsed address fields or the full address via address.fullAddress. Do not send both.

Australian registries take the locality in address.suburb and the state code in address.state. address.city is not used by Australian registries.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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_AND_PAYROLL": {
    "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_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 verification.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_TICA_TENANCY_REGISTER": {
    "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 }
    },
    "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 (type: general)

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "Wei",
      "lastName": "Chen",
      "dateOfBirth": "1995-03-12"
    },
    "document": {
      "number": "EH1234567",
      "country": "CN"
    },
    "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 verification.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": {
      "location": "onshore",
      "visaClass": "500",
      "visaStream": "Student",
      "visaGrantDate": "2023-07-15T00:00:00+00:00",
      "visaExpiryDate": "2026-07-15T00:00:00+00:00",
      "workEntitlementStatus": 1,
      "workEntitlementStatusText": "May work up to 48 hours per fortnight while course is in session"
    },
    "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

  • Consent via consents array (type: general)

Optional

  • Gender via person.gender

{
  "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 verification.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 },
      "id_number_match": { "result": "success", "reason": null },
      "gender_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

  • Bank card number via document.cardNumber

  • Consent via consents array (type: general)

{
  "verification": {
    "person": {
      "fullName": "ๆŽไผŸ",
      "dateOfBirth": "1990-03-21",
      "idNumber": "110101199003213456"
    },
    "document": {
      "cardNumber": "6222021234567890123"
    },
    "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 verification.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

  • Consent via consents array (type: general)

{
  "verification": {
    "person": {
      "fullName": "ๆŽไผŸ",
      "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 verification.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": {
      "address": "88 Chang'an Avenue, Beijing",
      "gender": "M",
      "source": "dz4"
    },
    "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 },
      "id_number_match": { "result": "success", "reason": null },
      "date_of_birth_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

  • Passport number via document.number

  • Consent via consents array (type: general)

Optional

  • Date of birth via person.dateOfBirth

{
  "verification": {
    "person": {
      "fullName": "ๆŽไผŸ",
      "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 verification.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 },
      "id_number_match": { "result": "success", "reason": null },
      "date_of_birth_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

  • Phone number via person.phoneNumber

  • Consent via consents array (type: general)

{
  "verification": {
    "person": {
      "fullName": "ๆŽไผŸ",
      "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 verification.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

  • Full name via person.fullName

  • First name via person.firstName

  • Last name via person.lastName

  • Street via address.street

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • District via address.city

  • Territory (Hong Kong Island, Kowloon, New Territories) via address.state

{
  "verification": {
    "person": {
      "fullName": "Wing Chan",
      "firstName": "Wing",
      "lastName": "Chan",
      "phoneNumber": "+85291234567"
    },
    "address": {
      "street": "1 Queen's Road Central",
      "city": "Central and Western",
      "state": "Hong Kong Island"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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_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 },
      "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
  }
}

๐Ÿ‡ฎ๐Ÿ‡ฉ Indonesia - Phone (ID_PHONE)

Input parameters

POST /sessions example

Mandatory

  • Full name via person.fullName

  • Date of birth via person.dateOfBirth

  • Phone number via person.phoneNumber

Optional

  • 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 verification.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": {
      "fullName": "Budi Santoso"
    },
    "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 (NIK) via person.idNumber

  • Consent via consents array (type: general)

Optional

  • Gender via person.gender

  • Address via address.street + address.houseNumber + address.subDistrict + address.suburb + address.postcode OR address.fullAddress

{
  "verification": {
    "person": {
      "fullName": "Budi Santoso",
      "dateOfBirth": "1987-08-17",
      "idNumber": "3173012345678901",
      "gender": "M"
    },
    "address": {
      "street": "Jl. Jenderal Sudirman",
      "houseNumber": "1",
      "suburb": "Karet Tengsin",
      "postcode": "10220"
    },
    "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 verification.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": {
      "address": "Jl. Jenderal Sudirman No. 1, Jakarta 10220",
      "fullName": "Budi Santoso"
    },
    "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 },
      "gender_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
  }
}

๐Ÿ‡ฎ๐Ÿ‡ณ India - Aadhaar (IN_AADHAAR)

Input parameters

POST /sessions example

Mandatory

  • Full name via person.fullName

  • Date of birth via person.dateOfBirth

  • Aadhaar number via person.idNumber

  • PAN via document.number

  • Consent via consents array (type: general)

{
  "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 verification.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

  • Driving licence number via document.number

  • Consent via consents array (type: general)

Optional

  • Street via address.street

  • Suburb via address.suburb

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "fullName": "Aarav Kumar Sharma",
      "dateOfBirth": "1992-08-14"
    },
    "document": {
      "number": "KA0120201234567"
    },
    "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 verification.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": {
      "address": "12 MG Road, Bengaluru, Karnataka 560001"
    },
    "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

  • EPIC number via document.number

  • Consent via consents array (type: general)

Optional

  • Gender via person.gender

{
  "verification": {
    "person": {
      "fullName": "Aarav Kumar Sharma",
      "dateOfBirth": "1992-08-14",
      "gender": "M"
    },
    "document": {
      "number": "ABC1234567"
    },
    "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 verification.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

  • PAN via document.number

  • Consent via consents array (type: general)

{
  "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 verification.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": {
      "source": "dz1"
    },
    "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

  • Passport number via document.number

  • Passport file number (printed on the last page) via document.referenceNumber

  • Consent via consents array (type: general)

Optional

  • Date of issue via document.validFrom

{
  "verification": {
    "person": {
      "fullName": "Aarav Kumar Sharma",
      "dateOfBirth": "1992-08-14"
    },
    "document": {
      "number": "J8369854",
      "referenceNumber": "BN1068123456789",
      "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 verification.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

  • Name via person.fullName OR person.firstName + person.lastName

Optional

  • Middle name via person.middleName

  • Address via address.street + address.suburb (area / town) + address.city + address.postcode OR address.fullAddress

{
  "verification": {
    "person": {
      "dateOfBirth": "1987-04-15",
      "idNumber": "870415-08-1234",
      "fullName": "Ahmad bin Abdullah"
    },
    "address": {
      "street": "12 Jalan Ampang",
      "suburb": "Kampung Baru",
      "city": "Kuala Lumpur",
      "postcode": "50450"
    }
  }
}

Send either person.fullName or both person.firstName and person.lastName. You can send all three.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "address": "12 Jalan Ampang, Kuala Lumpur 50450",
      "fullName": "Ahmad bin Abdullah"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "full_name_match": { "result": "success", "reason": null },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_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

  • Name via person.fullName OR person.firstName + person.lastName

  • Consent via consents array (type: general)

Optional

  • Middle name via person.middleName

  • Gender via person.gender

  • Phone number via person.phoneNumber

  • Address via address.street + address.suburb (area / town) + address.city + address.postcode OR address.fullAddress

{
  "verification": {
    "person": {
      "dateOfBirth": "1987-04-15",
      "idNumber": "870415-08-1234",
      "fullName": "Ahmad bin Abdullah",
      "gender": "M",
      "phoneNumber": "+60123456789"
    },
    "address": {
      "street": "12 Jalan Ampang",
      "suburb": "Kampung Baru",
      "city": "Kuala Lumpur",
      "postcode": "50450"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Send either person.fullName or both person.firstName and person.lastName. You can send all three.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "address": "12 Jalan Ampang, Kuala Lumpur 50450",
      "fullName": "Ahmad bin Abdullah"
    },
    "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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "full_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_neighbourhood_match": { "result": "success", "reason": null },
      "address_city_match": { "result": "success", "reason": null },
      "address_postcode_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

  • Street via address.street

Conditionally required in addition to mandatory data

  • At least one of address.suburb, address.state, address.postcode

Optional

  • Middle name via person.middleName

  • Date of birth via person.dateOfBirth

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

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

Send address.street plus at least one of address.suburb, address.state or address.postcode.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "dpId": "578086"
    },
    "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": "Auckland Central",
      "state": "Auckland",
      "postcode": "1010"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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

  • Street via address.street

  • Consent via consents array (type: nz-consent)

Conditionally required in addition to mandatory data

  • At least one of address.suburb, address.state, address.postcode

Optional

  • Date of birth via person.dateOfBirth

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

Send address.street plus at least one of address.suburb, address.state or address.postcode.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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

  • Street via address.street

Conditionally required in addition to mandatory data

  • At least one of address.suburb, address.state, address.postcode

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

Send address.street plus at least one of address.suburb, address.state or address.postcode.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "dateOfDeath": "2017-02-03",
      "possibleDeceasedRecord": true,
      "possibleDeceasedRecordAddress": "1 Queen Street, Auckland 1010",
      "possibleDeceasedRecordName": "Liam Wilson"
    },
    "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

  • Middle name via person.middleName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Consent via consents array (type: dia-consent)

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

Send all given names exactly as registered: first given name in person.firstName, the remaining given names in person.middleName.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "last_name_match": { "result": "success", "reason": null },
      "middle_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

  • Middle name via person.middleName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Consent via consents array (type: dia-consent)

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

Send all given names exactly as registered: first given name in person.firstName, the remaining given names in person.middleName.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "last_name_match": { "result": "success", "reason": null },
      "middle_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

  • Passport number via document.number

  • Passport expiry date via document.validUntil

  • Consent via consents array (type: dia-consent)

Optional

  • Middle name (mandatory if printed on the passport) via person.middleName

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

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "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
  }
}

๐Ÿ‡ณ๐Ÿ‡ฟ New Zealand - Drivers Licence (NZ_DRIVER_LICENCE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Middle name* via person.middleName

  • Date of birth via person.dateOfBirth

  • Licence number via document.number

  • Licence version via document.version

  • Consent via consents array (type: general)

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

*Mandatory only if present on the driver's licence.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "dpId": "578086"
    },
    "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 },
      "middle_name_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

  • Street via address.street

Conditionally required in addition to mandatory data

  • At least one of address.suburb, address.state, address.postcode

Optional

  • Middle name via person.middleName

  • Date of birth via person.dateOfBirth

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

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

Send address.street plus at least one of address.suburb, address.state or address.postcode.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "dpId": "370673"
    },
    "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

  • Street via address.street

Conditionally required in addition to mandatory data

  • At least one of address.suburb, address.state, address.postcode

Optional

  • Middle name via person.middleName

  • Date of birth via person.dateOfBirth

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

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

Send address.street plus at least one of address.suburb, address.state or address.postcode.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "dpId": "578086"
    },
    "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

  • Street via address.street

  • Consent via consents array (type: general)

Conditionally required in addition to mandatory data

  • At least one of address.suburb, address.state, address.postcode

Optional

  • Date of birth via person.dateOfBirth

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

Send address.street plus at least one of address.suburb, address.state or address.postcode.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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

  • Street via address.street

  • Postcode via address.postcode

Optional

  • Landline phone number via person.landLinePhoneNumber

  • Suburb via address.suburb

  • State via address.state

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

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "phoneData": [
        {
          "address1": "1 Queen Street",
          "city": "Auckland",
          "suburb": "Auckland Central",
          "postCode": "1010",
          "firstName": "Liam",
          "middleName": "",
          "lastName": "Wilson",
          "homePhoneNo": "093001234"
        }
      ]
    },
    "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_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
  }
}

๐Ÿ‡ต๐Ÿ‡ญ Philippines - Credit Bureau (PH_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • Name via person.fullName OR person.firstName + person.lastName

  • National ID number (SSS, TIN or GSIS) via person.idNumber

  • ID type of person.idNumber via document.cardType

  • Consent via consents array (type: general)

Optional

  • Middle name via person.middleName

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

{
  "verification": {
    "person": {
      "dateOfBirth": "1989-06-12",
      "fullName": "Juan Cruz Dela Cruz",
      "idNumber": "3412345678"
    },
    "document": {
      "cardType": "SSS"
    },
    "address": {
      "street": "123 Ayala Avenue",
      "suburb": "San Lorenzo",
      "city": "Makati",
      "state": "Metro Manila",
      "postcode": "1226"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Send either person.fullName or both person.firstName and person.lastName. You can send all three.

document.cardType must identify the ID sent in person.idNumber: SSS (10 digits), TIN (9โ€“12 digits) or GSIS (11 digits).

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "address": "123 Ayala Avenue, Makati, Metro Manila 1226"
    },
    "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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "full_name_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_city_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null },
      "address_postcode_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

  • Name via person.fullName OR person.firstName + person.lastName

  • Consent via consents array (type: general)

Optional

  • Middle name via person.middleName

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

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

Send either person.fullName or both person.firstName and person.lastName. You can send all three.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "address": "123 Ayala Avenue, Makati, Metro Manila 1226",
      "fullName": "Juan Cruz Dela Cruz"
    },
    "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 },
      "date_of_birth_match": { "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 },
      "address_street_match": { "result": "success", "reason": null },
      "address_neighbourhood_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
  }
}

๐Ÿ‡ธ๐Ÿ‡ฌ Singapore - Credit Bureau (SG_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • National ID number (NRIC / FIN) via person.idNumber

  • Name via person.fullName OR person.firstName + person.lastName

  • Consent via consents array (type: general)

Optional

  • Middle name via person.middleName

  • Street via address.street

  • Building name via address.buildingName

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "dateOfBirth": "1989-05-04",
      "idNumber": "S8905041A",
      "fullName": "Tan Wei Ming"
    },
    "address": {
      "street": "1 Marina Boulevard",
      "city": "Singapore",
      "postcode": "018989"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Send either person.fullName or both person.firstName and person.lastName. You can send all three.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "full_name_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
  }
}

๐Ÿ‡ธ๐Ÿ‡ฌ Singapore - Utility (SG_UTILITY)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • Name via person.fullName OR person.firstName + person.lastName

  • Street via address.street

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Building name via address.buildingName

  • City via address.city

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "dateOfBirth": "1989-05-04",
      "fullName": "Tan Wei Ming",
      "phoneNumber": "+6591234567"
    },
    "address": {
      "street": "1 Marina Boulevard",
      "city": "Singapore",
      "postcode": "018989"
    }
  }
}

Send either person.fullName or both person.firstName and person.lastName. You can send all three.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "full_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 }
    },
    "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

  • Name via person.fullName OR person.firstName + person.lastName

  • Consent via consents array (type: general)

Optional

  • Middle name via person.middleName

  • Street via address.street

  • House number via address.houseNumber

  • Sub-district (tambon / khwaeng) via address.subDistrict

  • District (amphoe / khet) via address.suburb

{
  "verification": {
    "person": {
      "dateOfBirth": "1988-03-12",
      "idNumber": "1234567890123",
      "firstName": "Somchai",
      "lastName": "Saetang"
    },
    "address": {
      "street": "Rama I Road",
      "houseNumber": "999",
      "subDistrict": "Pathum Wan",
      "suburb": "Pathum Wan"
    },
    "consents": [
      {
        "type": "general",
        "approved": true
      }
    ]
  }
}

Send either person.fullName or both person.firstName and person.lastName. You can send all three.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "address": "999 Rama I Road, Bangkok 10330",
      "fullName": "Somchai Saetang"
    },
    "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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "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 }
    },
    "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 verification.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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "middle_name_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

  • Consent via consents array (type: general)

Optional

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

  • 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",
      "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 verification.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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "middle_name_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 verification.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": {
      "possibleDeceasedRecord": 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 },
      "id_number_match": { "result": "success", "reason": null },
      "middle_name_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_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 verification.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": {
      "possibleDeceasedRecord": 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 },
      "id_number_match": { "result": "success", "reason": null },
      "middle_name_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 (CPF) 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 verification.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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "middle_name_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 (CPF) via person.idNumber

  • Name via person.fullName OR person.firstName + person.lastName

Optional

  • Middle name via person.middleName

  • Date of birth via person.dateOfBirth

  • Street via address.street

  • Suburb via address.suburb

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "idNumber": "123.456.789-09",
      "fullName": "Lucas Eduardo Silva",
      "dateOfBirth": "1987-08-30"
    },
    "address": {
      "street": "Av. Paulista 1000",
      "city": "Sรฃo Paulo",
      "state": "SP",
      "postcode": "01310-100",
      "suburb": "Bela Vista"
    }
  }
}

Send either person.fullName or both person.firstName and person.lastName. You can send all three.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "id_number_match": { "result": "success", "reason": null },
      "full_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
  }
}

๐Ÿ‡ง๐Ÿ‡ท Brazil - Phone (BR_PHONE)

Input parameters

POST /sessions example

Mandatory

  • Name via person.fullName OR person.firstName + person.lastName

  • Phone number via person.phoneNumber

  • Street via address.street

Optional

  • Middle name via person.middleName

  • Date of birth via person.dateOfBirth

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

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

Send either person.fullName or both person.firstName and person.lastName. You can send all three.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "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

  • Name via person.fullName OR person.firstName + person.lastName

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

Optional

  • Middle name via person.middleName

  • National ID number (CPF) via person.idNumber

  • Phone number via person.phoneNumber

  • Suburb via address.suburb

  • State via address.state

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

Send either person.fullName or both person.firstName and person.lastName. You can send all three.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "full_name_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_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 - Tax Registration (BR_TAX_REGISTRATION)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • National ID number (CPF) via person.idNumber

  • Name via person.fullName OR person.firstName + person.lastName

Optional

  • Middle name via person.middleName

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

Send either person.fullName or both person.firstName and person.lastName. You can send all three.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "full_name_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 verification.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CL_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 },
      "middle_name_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

  • Middle name via person.middleName

  • Street via address.street

  • City via address.city

{
  "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 verification.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "CL_RESIDENTIAL": {
    "status": "failure",
    "data": null,
    "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

  • Name via person.fullName OR person.firstName + person.lastName

  • Consent via consents array (type: general)

Optional

  • Middle name via person.middleName

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

Send either person.fullName or both person.firstName and person.lastName. You can send all three.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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,
    "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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "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 }
    },
    "error": null,
    "timestamp": 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 (CURP) 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",
      "gender": "M"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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,
    "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 },
      "gender_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

๐Ÿ‡ฒ๐Ÿ‡ฝ Mexico - Residential (MX_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Street via address.street

Conditionally required in addition to mandatory data

  • At least two of address.city, address.state, address.postcode

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

{
  "verification": {
    "person": {
      "firstName": "Diego",
      "lastName": "Hernรกndez",
      "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 verification.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,
    "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_state_match": { "result": "success", "reason": null },
      "address_postcode_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": 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 (DNI) 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 verification.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,
    "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 },
      "middle_name_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

๐Ÿ‡ต๐Ÿ‡ช Peru - Residential (PE_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Street via address.street

  • City via address.city

Optional

  • Middle name via person.middleName

  • Gender via person.gender

  • Landline phone number via person.landLinePhoneNumber

{
  "verification": {
    "person": {
      "firstName": "Carlos",
      "lastName": "Quispe",
      "middleName": "Alberto",
      "gender": "M",
      "landLinePhoneNumber": "+5114123456"
    },
    "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 verification.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,
    "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 }
    },
    "error": null,
    "timestamp": 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

  • Tax ID (RUC) via person.idNumber

Optional

  • Middle name via person.middleName

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

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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,
    "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 },
      "middle_name_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": 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

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

  • Consent via consents array (type: general)

{
  "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 verification.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,
    "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
  }
}

๐Ÿ‡ง๐Ÿ‡ช 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",
      "postcode": "1000",
      "state": "Brussels-Capital"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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,
    "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 },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": 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

  • Street via address.street

  • Postcode via address.postcode

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Email via person.email

  • City via address.city

{
  "verification": {
    "person": {
      "firstName": "Lucas",
      "lastName": "Dubois",
      "dateOfBirth": "1990-02-14",
      "middleName": "Jean",
      "phoneNumber": "+32470123456"
    },
    "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 verification.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,
    "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 },
      "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
  }
}

๐Ÿ‡ง๐Ÿ‡ช 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

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

{
  "verification": {
    "person": {
      "firstName": "Lucas",
      "lastName": "Dubois",
      "dateOfBirth": "1990-02-14",
      "phoneNumber": "+32470123456"
    },
    "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 verification.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,
    "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
  }
}

๐Ÿ‡จ๐Ÿ‡ฟ Czech Republic - Residential (CZ_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Street via address.street

  • Postcode via address.postcode

Optional

  • Date of birth via person.dateOfBirth

  • 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 verification.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,
    "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 }
    },
    "error": null,
    "timestamp": null
  }
}

๐Ÿ‡จ๐Ÿ‡ฟ Czech Republic - Residential 2 (CZ_RESIDENTIAL_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Street via address.street

  • City via address.city

Optional

  • Date of birth via person.dateOfBirth

{
  "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 verification.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,
    "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 }
    },
    "error": null,
    "timestamp": 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 verification.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 (CPR) 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 verification.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": {
      "personStatus": "active",
      "nationalIdNo": "0412881234"
    },
    "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
  }
}

๐Ÿ‡ฉ๐Ÿ‡ฐ Denmark - Utility (DK_UTILITY)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Street via address.street

  • Postcode via address.postcode

Optional

  • Date of birth via person.dateOfBirth

  • City/town via address.city

{
  "verification": {
    "person": {
      "firstName": "Frederik",
      "lastName": "Nielsen",
      "dateOfBirth": "1985-03-21"
    },
    "address": {
      "street": "Nรธrrebrogade 42",
      "city": "Kรธbenhavn",
      "postcode": "2200"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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_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
  }
}

๐Ÿ‡ซ๐Ÿ‡ฎ 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"
    },
    "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 verification.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 },
      "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 (HETU) via person.idNumber

  • Name via person.fullName OR person.firstName + person.lastName

Optional

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

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

Send either person.fullName or both person.firstName and person.lastName. You can send all three.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "personStatus": "active",
      "nationalIdNo": "210685-123A"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "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_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": "50 Avenue des Champs-ร‰lysรฉes",
      "city": "Paris",
      "postcode": "75008"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 - Consumer 2 (FR_CONSUMER_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Street via address.street

  • Postcode via address.postcode

Optional

  • Date of birth via person.dateOfBirth

  • Phone number via person.phoneNumber

  • Email via person.email

  • City/town via address.city

{
  "verification": {
    "person": {
      "firstName": "Camille",
      "lastName": "Laurent",
      "dateOfBirth": "1990-07-11",
      "phoneNumber": "+33612345678",
      "email": "camille.laurent@example.fr"
    },
    "address": {
      "street": "12 Rue de Rivoli",
      "city": "Paris",
      "postcode": "75001"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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_2": {
    "status": "success",
    "data": {
      "altDobScore": 0.92
    },
    "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 },
      "phone_number_match": { "result": "success", "reason": null },
      "email_match": { "result": "not_applicable", "reason": "output_not_received" }
    },
    "error": null,
    "timestamp": null
  }
}

๐Ÿ‡ซ๐Ÿ‡ท France - Phone (FR_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Phone number via person.phoneNumber

  • Postcode via address.postcode

Optional

  • Date of birth via person.dateOfBirth

  • 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": "50 Avenue des Champs-ร‰lysรฉes",
      "city": "Paris"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "statusMessage": "Success"
    },
    "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 }
    },
    "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

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

Optional

  • Phone number via person.phoneNumber

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

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "altDobScore": "0.88"
    },
    "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

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Pierre",
      "lastName": "Dupont",
      "phoneNumber": "+33612345678",
      "email": "pierre.dupont@example.com"
    },
    "address": {
      "street": "50 Avenue des Champs-ร‰lysรฉes",
      "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 verification.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

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

Optional

  • Date of birth via person.dateOfBirth

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

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "altDobScore": "0.88"
    },
    "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

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

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

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

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

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 - Consumer (DE_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

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Anna",
      "lastName": "Mรผller",
      "dateOfBirth": "1990-07-21",
      "phoneNumber": "+4915112345678",
      "email": "anna.mueller@example.com"
    },
    "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 verification.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_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
  }
}

๐Ÿ‡ฉ๐Ÿ‡ช 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

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

  • Consent via consents array (type: general)

Optional

  • Middle name via person.middleName

{
  "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 verification.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": {
      "altAddressMatchScore": {
        "addressElement1": "1.000",
        "addressElement3": "1.000",
        "addressElement5": "1.000"
      },
      "altNameMatchScore": {
        "firstName": "1.000",
        "lastName": "1.000"
      }
    },
    "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 },
      "middle_name_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 - Phone (DE_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Email via person.email

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Lukas",
      "lastName": "Schmidt",
      "middleName": "Andreas",
      "phoneNumber": "+4915123456789"
    },
    "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 verification.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": {
      "altAddressMatchScore": {
        "addressElement1": "1.000",
        "addressElement3": "1.000",
        "addressElement5": "1.000"
      },
      "altNameMatchScore": {
        "firstName": "1.000",
        "lastName": "1.000"
      }
    },
    "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_postcode_match": { "result": "success", "reason": null },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

๐Ÿ‡ฉ๐Ÿ‡ช Germany - Phone 2 (DE_PHONE_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Phone number via person.phoneNumber

  • Postcode via address.postcode

Optional

  • 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"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "altAddressMatchScore": {
        "addressElement1": "1.000",
        "addressElement3": "1.000",
        "addressElement5": "1.000"
      },
      "altNameMatchScore": {
        "firstName": "1.000",
        "lastName": "1.000"
      },
      "statusMessage": "Success"
    },
    "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 }
    },
    "error": null,
    "timestamp": null
  }
}

๐Ÿ‡ฉ๐Ÿ‡ช Germany - Residential (DE_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

Optional

  • Middle name via person.middleName

  • Date of birth via person.dateOfBirth

{
  "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 verification.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": {
      "altAddressMatchScore": {
        "addressElement1": "1.000",
        "addressElement3": "1.000",
        "addressElement5": "1.000"
      },
      "altNameMatchScore": {
        "firstName": "1.000",
        "lastName": "1.000"
      }
    },
    "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 },
      "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 - Utility (DE_UTILITY)

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

  • 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",
      "postcode": "10117",
      "state": "Berlin"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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,
    "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 },
      "address_state_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

๐Ÿ‡ฉ๐Ÿ‡ช Germany - Utility 2 (DE_UTILITY_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Street via address.street

  • Postcode via address.postcode

Optional

  • Date of birth via person.dateOfBirth

  • City via address.city

{
  "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 verification.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,
    "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
  }
}

๐Ÿ‡ฌ๐Ÿ‡ท Greece - Consumer (GR_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Date of birth via person.dateOfBirth

  • 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 verification.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

  • City via address.city

Optional

  • Middle name via person.middleName

  • Tax ID (AFM) via person.idNumber

  • Phone number via person.phoneNumber

  • Street via address.street

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Nikos",
      "lastName": "Papadopoulos",
      "dateOfBirth": "1988-05-25",
      "idNumber": "123456789",
      "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 verification.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": {
      "altAddressMatchScore": {
        "addressElement1": "1.000",
        "addressElement3": "1.000",
        "addressElement4": "1.000",
        "addressElement5": "1.000"
      },
      "altNameMatchScore": {
        "firstName": "1.000",
        "lastName": "1.000"
      }
    },
    "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 },
      "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
  }
}

๐Ÿ‡ฌ๐Ÿ‡ท Greece - Utility (GR_UTILITY)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Street via address.street

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Eleni",
      "lastName": "Papadopoulou"
    },
    "address": {
      "street": "Ermou 100",
      "postcode": "105 63"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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_UTILITY": {
    "status": "success",
    "data": {
      "altAddressMatchScore": {
        "addressElement1": "1.000",
        "addressElement5": "1.000"
      },
      "altNameMatchScore": {
        "firstName": "1.000",
        "lastName": "1.000"
      }
    },
    "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_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": "50 Grafton Street",
      "city": "Dublin",
      "state": "Leinster"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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

Optional

  • Date of birth via person.dateOfBirth

  • 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": "50 Grafton Street",
      "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 verification.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 },
      "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 }
    },
    "error": null,
    "timestamp": null
  }
}

๐Ÿ‡ฎ๐Ÿ‡ช Ireland - Residential (IE_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Date of birth via person.dateOfBirth

  • 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": "50 Grafton Street",
      "city": "Dublin",
      "state": "Leinster"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "middle_name_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_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": "50 Grafton Street",
      "city": "Dublin",
      "state": "Leinster"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": "50 Grafton Street",
      "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 verification.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

Optional

  • National ID number via person.idNumber

  • 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",
      "middleName": "Mary",
      "gender": "F"
    },
    "address": {
      "street": "50 Grafton Street",
      "city": "Dublin",
      "state": "Leinster"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "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": "MI",
      "postcode": "20121"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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

  • Tax ID (codice fiscale) via person.idNumber

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

Optional

  • Gender via person.gender

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

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "id_number_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_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

  • Phone number via person.phoneNumber

  • Street via address.street

  • Postcode via address.postcode

Optional

  • Date of birth via person.dateOfBirth

  • 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",
      "city": "Milan",
      "state": "MI",
      "postcode": "20121"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "statusMessage": "Success"
    },
    "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
  }
}

๐Ÿ‡ฎ๐Ÿ‡น 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

  • 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 verification.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",
      "gender": "M"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "id_number_match": { "result": "success", "reason": null },
      "gender_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

  • City via address.city

  • Postcode via address.postcode

Optional

  • Gender via person.gender

  • Phone number via person.phoneNumber

  • Email via person.email

  • Street via address.street

  • State via address.state

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

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "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"
    },
    "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 verification.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 },
      "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

  • Street via address.street

  • Postcode via address.postcode

Optional

  • Date of birth via person.dateOfBirth

  • Middle name via person.middleName

  • Gender via person.gender

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

  • Email via person.email

  • Suburb via address.suburb

{
  "verification": {
    "person": {
      "firstName": "Lucas",
      "lastName": "de Vries",
      "dateOfBirth": "1986-12-04",
      "gender": "M",
      "phoneNumber": "+31612345678"
    },
    "address": {
      "street": "Damrak 100",
      "postcode": "1012 LN"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "date_of_birth_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_postcode_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

  • Street via address.street

  • Postcode via address.postcode

Optional

  • Date of birth via person.dateOfBirth

  • Suburb via address.suburb

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

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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_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

  • Bank Verification Number (BVN) via document.referenceNumber

Optional

  • Date of birth via person.dateOfBirth

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

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 (NIN) via person.idNumber

Optional

  • Date of birth via person.dateOfBirth

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Chinedu",
      "lastName": "Okeke",
      "dateOfBirth": "1989-08-30",
      "idNumber": "12345678901"
    },
    "address": {
      "street": "10 Awolowo Road",
      "suburb": "Ikoyi",
      "state": "Lagos"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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"
    },
    "address": {
      "street": "Karl Johans gate 1",
      "suburb": "Sentrum",
      "state": "Oslo",
      "postcode": "0154"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "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

  • Name via person.fullName OR person.firstName + person.lastName

Optional

  • National ID number via person.idNumber

  • Street via address.street

  • Suburb via address.suburb

  • State via address.state

  • Postcode via address.postcode

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

Send either person.fullName or both person.firstName and person.lastName. You can send all three.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_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

  • Street via address.street

  • Postcode via address.postcode

Optional

  • First name via person.firstName

  • Date of birth via person.dateOfBirth

  • Phone number via person.phoneNumber

  • Email via person.email

  • Suburb via address.suburb

{
  "verification": {
    "person": {
      "firstName": "Erik",
      "lastName": "Hansen",
      "dateOfBirth": "1987-11-23",
      "phoneNumber": "+4791234567"
    },
    "address": {
      "street": "Karl Johans gate 1",
      "postcode": "0154"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "address_street_match": { "result": "success", "reason": null },
      "address_postcode_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"
    },
    "address": {
      "street": "Nowy ลšwiat 10",
      "suburb": "ลšrรณdmieล›cie",
      "state": "Mazowieckie",
      "postcode": "00-497"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "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

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

  • Consent via consents array (type: general)

{
  "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 verification.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

  • Street via address.street

  • Postcode via address.postcode

Optional

  • Date of birth via person.dateOfBirth

  • City via address.city

{
  "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 verification.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

  • House / unit number via address.unit

  • City via address.city

{
  "verification": {
    "person": {
      "firstName": "Martin",
      "lastName": "Horvรกth"
    },
    "address": {
      "street": "Hlavnรก",
      "unit": "10",
      "city": "Bratislava"
    }
  }
}

For the best results send address.street and address.city.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 }
    },
    "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"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "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"
    },
    "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 verification.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 },
      "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 - Consumer 2 (ES_CONSUMER_2)

Input parameters

POST /sessions example

Mandatory

  • Last name via person.lastName

  • Street via address.street

  • Postcode via address.postcode

Optional

  • First name via person.firstName

  • Date of birth via person.dateOfBirth

  • Phone number via person.phoneNumber

  • Email via person.email

  • City via address.city

{
  "verification": {
    "person": {
      "firstName": "Javier",
      "lastName": "Garcรญa",
      "dateOfBirth": "1987-10-09",
      "phoneNumber": "+34612345678"
    },
    "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 verification.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 },
      "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 - 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

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

  • Consent via consents array (type: general)

Optional

  • National ID number (DNI / NIE) via person.idNumber

  • Phone number via person.phoneNumber

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Javier",
      "lastName": "Garcรญa",
      "dateOfBirth": "1987-10-09",
      "idNumber": "12345678Z"
    },
    "address": {
      "street": "Gran Vรญa 28",
      "city": "Madrid",
      "postcode": "28013"
    },
    "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 verification.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 },
      "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 - Phone (ES_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

Optional

  • Phone number via person.phoneNumber

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Javier",
      "lastName": "Garcรญa",
      "phoneNumber": "+34612345678"
    },
    "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 verification.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 }
    },
    "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

  • Phone number via person.phoneNumber

  • Street via address.street

Optional

  • 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",
      "postcode": "28013"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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_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

  • 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 verification.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

  • Street via address.street

Optional

  • Last name via person.lastName

  • National ID number (DNI / NIE) via person.idNumber

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Javier",
      "lastName": "Garcรญa",
      "phoneNumber": "+34612345678"
    },
    "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 verification.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 },
      "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
  }
}

๐Ÿ‡ธ๐Ÿ‡ช 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"
    },
    "address": {
      "street": "Drottninggatan 1",
      "city": "Stockholm",
      "postcode": "111 51",
      "state": "Stockholm"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 },
      "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
  }
}

๐Ÿ‡ธ๐Ÿ‡ช 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 (personnummer) via person.idNumber

Optional

  • Middle name via person.middleName

  • Date of birth via person.dateOfBirth

  • 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",
      "idNumber": "198608112345"
    },
    "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 verification.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": {
      "nationalIdNoStatus": "active"
    },
    "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
  }
}

๐Ÿ‡ธ๐Ÿ‡ช Sweden - Phone (SE_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • Postcode via address.postcode

Optional

  • Middle name via person.middleName

  • Date of birth via person.dateOfBirth

  • National ID number (personnummer) via person.idNumber

{
  "verification": {
    "person": {
      "firstName": "Erik",
      "lastName": "Andersson",
      "dateOfBirth": "1986-08-11",
      "idNumber": "198608112345",
      "phoneNumber": "+46701234567"
    },
    "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 verification.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": {
      "nationalIdNoStatus": "active"
    },
    "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 },
      "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"
    },
    "address": {
      "street": "Bahnhofstrasse 22",
      "city": "Zurich",
      "state": "ZH",
      "postcode": "8001"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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,
    "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
  }
}

๐Ÿ‡จ๐Ÿ‡ญ Switzerland - Credit Bureau (CH_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Date of birth via person.dateOfBirth

  • Street name via address.street

  • City via address.city

  • Postcode via address.postcode

  • Consent via consents array (type: general)

Optional

  • Last name via person.lastName

  • Gender via person.gender

  • House number via address.houseNumber

  • Unit via address.unit

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

Send the street name in address.street and the house number separately in address.houseNumber. The house number is strongly recommended: the registry uses it for matching.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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,
    "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 }
    },
    "error": null,
    "timestamp": 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

  • Postcode via address.postcode

Optional

  • Email via person.email

  • Street via address.street

  • City via address.city

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

The postcode is used to locate the record. Send address.street and address.city as well for address matching.

Sample response payload

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

{
  "GB_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 },
      "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

  • Email via person.email

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "Emma",
      "lastName": "Clark",
      "dateOfBirth": "1995-04-18",
      "email": "emma.clark@example.co.uk",
      "phoneNumber": "+447911123456"
    },
    "address": {
      "street": "25 Baker Street",
      "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 verification.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "GB_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 }
    },
    "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.postcode OR address.fullAddress

  • Consent via consents array (type: general)

Optional

  • Middle name via person.middleName

  • City via address.city

  • State via address.state

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, use either the parsed address fields 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 verification.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "GB_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_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

  • Street via address.street OR address.fullAddress

Optional

  • First name via person.firstName

  • Date of birth via person.dateOfBirth

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

  • Email via person.email

  • National ID number via person.idNumber

  • Document number via document.number

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

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

To send address info, use either the parsed address fields or the full address via address.fullAddress. Do not send both. Sending city and postcode improves matching.

Sample response payload

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

{
  "GB_FINANCIAL_SERVICES": {
    "status": "success",
    "data": {
      "activityHistory": "3",
      "amberhill": false,
      "deathRegistration": false,
      "identityFraud": "3",
      "identityStrength": "1",
      "identityValidity": "1",
      "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 },
      "phone_number_match": { "result": "success", "reason": null },
      "address_full_address_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

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

Optional

  • Phone number via person.phoneNumber

  • State via address.state

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

To send address info, use either the parsed address fields 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 verification.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "GB_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_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

  • Date of birth via person.dateOfBirth

  • Phone number via person.phoneNumber

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

Optional

  • City via address.city

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

To send address info, use either the parsed address fields 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 verification.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "GB_PHONE_2": {
    "status": "success",
    "data": {
      "statusMessage": "Success"
    },
    "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

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

  • Email via person.email

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

{
  "verification": {
    "person": {
      "firstName": "William",
      "lastName": "Davies",
      "dateOfBirth": "1982-01-30",
      "phoneNumber": "+447700900123",
      "landLinePhoneNumber": "+442071234567"
    },
    "address": {
      "street": "10 Downing Street",
      "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 verification.registryValidations object. Note that the payloads contain more parameters; to find info about them see the decision webhook and GET /decision endpoint's documentation.

{
  "GB_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 },
      "land_line_phone_number_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom - Sequence Search (GB_SEQUENCE_SEARCH)

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.postcode OR address.fullAddress

  • Consent via consents array (type: general)

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

  • Landline phone number via person.landLinePhoneNumber

  • Email via person.email

  • City via address.city

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "Charlotte",
      "lastName": "Pemberton",
      "dateOfBirth": "1977-06-19"
    },
    "address": {
      "street": "45 Threadneedle Street",
      "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
      }
    ]
  }
}

Sample response payload

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

{
  "GB_SEQUENCE_SEARCH": {
    "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 },
      "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 },
      "phone_number_match":   { "result": "success", "reason": null },
      "land_line_phone_number_match": { "result": "success", "reason": null },
      "email_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

Optional

  • Date of birth via person.dateOfBirth

  • 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"
    },
    "address": {
      "street": "123 Bay Street",
      "suburb": "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 verification.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 },
      "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

  • Street via address.street

  • City via address.city

  • Province via address.state

  • Postcode via address.postcode

  • Consent via consents array (type: ca-consent)

Optional

  • Middle name via person.middleName

{
  "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 verification.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 },
      "date_of_birth_match": { "result": "success", "reason": null },
      "middle_name_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

  • Street via address.street

  • City via address.city

  • Province via address.state

  • Postcode via address.postcode

  • Consent via consents array (type: general)

Optional

  • Middle name via person.middleName

  • Unit via address.unit

  • 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"
    },
    "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 verification.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 },
      "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 },
      "middle_name_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 - Phone (CA_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Street via address.street

  • City via address.city

  • Province via address.state

  • Postcode via address.postcode

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Anderson",
      "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 verification.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 },
      "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

  • Phone number via person.phoneNumber

  • Street via address.street

  • City via address.city

  • Province via address.state

  • Postcode via address.postcode

  • Consent via consents array (type: ca-consent)

Optional

  • Middle name via person.middleName

  • Date of birth via person.dateOfBirth

{
  "verification": {
    "person": {
      "firstName": "James",
      "lastName": "Anderson",
      "dateOfBirth": "1982-05-18",
      "phoneNumber": "+14165551234"
    },
    "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 verification.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": {
      "accountClass": "personal",
      "accountType": "postpaid",
      "activationDate": "2021-09-01",
      "brandName": "Fido",
      "carrierName": "Rogers",
      "phoneStatus": "active",
      "subscriberId": "d0ec3b250f47ed5d6fea9e347de56b3a35ced563"
    },
    "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 },
      "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 verification.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

Conditionally required in addition to mandatory data

  • At least two of: person.dateOfBirth, address.street, address.city, address.state, address.postcode, person.idNumber (SSN), person.phoneNumber, person.email

Optional

  • Middle name via person.middleName

{
  "verification": {
    "person": {
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1985-06-15",
      "idNumber": "123-45-6789"
    },
    "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 verification.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": {
      "altDobScore": "0.91"
    },
    "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_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

Optional

  • Middle name via person.middleName

  • Date of birth via person.dateOfBirth

  • SSN via person.idNumber

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

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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 Smith"
    },
    "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

  • SSN 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"
    },
    "document": {
      "number": "ABC123456"
    },
    "address": {
      "street": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "postcode": "94103"
    }
  }
}

*Send only the first name (first word) of person's name. Sending several words in the firstName field will fail the session.

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "altDobScore": "0.91",
      "dataSourceId": "DS-0000",
      "dataSourceScore": "0.93",
      "deceasedRecord": true,
      "hasBankruptcyRecords": true,
      "hasBusinessRecords": true,
      "hasEvictionsRecords": true,
      "hasForeclosuresRecords": true,
      "hasJudgmentRecords": true,
      "hasLienRecords": true,
      "hasUccRecords": true,
      "hasWorkplaceRecords": true
    },
    "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 },
      "middle_name_match": { "result": "success", "reason": null },
      "phone_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

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

Optional

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

{
  "verification": {
    "person": {
      "firstName": "John",
      "lastName": "Smith",
      "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 verification.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 },
      "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

  • Phone number via person.phoneNumber

  • Street via address.street

  • Postcode via address.postcode

Optional

  • SSN via person.idNumber

  • City via address.city

  • State via address.state

{
  "verification": {
    "person": {
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1985-06-15",
      "phoneNumber": "+14155551234"
    },
    "address": {
      "street": "123 Main Street",
      "postcode": "94103"
    }
  }
}

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verification.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": {
      "statusMessage": "Success"
    },
    "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 }
    },
    "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

  • Street via address.street

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

Optional

  • Middle name via person.middleName

  • SSN via person.idNumber

  • Phone number via person.phoneNumber

  • Email via person.email

{
  "verification": {
    "person": {
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirth": "1985-06-15",
      "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 verification.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": {
      "altDobScore": "0.91"
    },
    "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
  }
}

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:

  • verification.reason for the reason why the verification failed.

  • 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, data did not match, or the input was invalid (for example a mandatory field was missing). Check registryValidations for field-level failures.

declined

640

Consent not obtained

Consent was missing, not approved, or sent with a type the registry does not accept. See Consent types.

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

640

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. In that case, to find info about the codes you are seeing, refer to:


Additional data

Best practices

  • In API flow, ensure that initData is present, especially the mandatory fields of the configured registry.

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

  • Send consent with the exact type listed for the registry in Consent types.

  • Build for data object conditionality: they are optional on the registry side and Veriff strips null/empty fields, so presence is not guaranteed even where listed.

  • Send the person's national ID number (national ID, tax ID, SSN, CPF, etc.) in person.idNumber, and the number of a document (passport, licence, PAN, card, etc.) in document.number, as listed for each registry.

  • Do not send empty strings for fields you do not have; omit the field instead.

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

  • 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 registry_unavailable or technical_issues.

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

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

  • 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. An ignored field does not count towards that registry's mandatory fields.

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

See the per-registry documentation in the Databases by regions section. Mandatory and conditionally required fields are listed for each database; if any of them is missing, is_input_valid fails.

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

Nov 4, 2026

  • Hong Kong - Residential (HK_RESIDENTIAL) updated

  • Greece - Utility (GR_UTILITY) added

  • Germany - Consumer (DE_CONSUMER) added

Oct 30, 2026

Denmark - Utility (DK_UTILITY), France - Consumer 2 (FR_CONSUMER_2) and United Kingdom - Sequence Search (GB_SEQUENCE_SEARCH) added.

Registry requirements aligned with the current implementation:

  • Consent marked mandatory for multiple sources

  • AU_CREDIT_BUREAU and AU_DEATH_CHECK consent type corrected to general; AU_ELECTORAL_ROLL consent type changed to au-consent

  • Australian registries: address.suburb and address.state documented instead of address.city

  • Mandatory and optional parameters changed for multiple registries in all regions; fullName OR firstName + lastName rule documented

  • Parameters removed (e.g. address.neighbourhood, AU_IMMICARD validUntil, GB_RESIDENTIAL document.version)

  • address.unit and address.houseNumber added to initData

  • Sample payloads corrected (JSON syntax, DE_PHONE_2 registry key, realistic values)

  • dateOfDeath and dateOfRegistration format to YYYY-MM-DD

  • Best practice about person.idNumber / document.number corrected

Oct 5, 2026

AU_VEVO registry consent type updated to general

Sep 22, 2026

Australia - Electoral Roll (AU_ELECTORAL_ROLL) consent type updated to au-dvs

Sep 18, 2026

Several registries response payloads updated

Note added to US_FINANCIAL_SERVICES about sending only one word in firstName field

Sep 3, 2026

Initdata info updated:

  • address: buildingName and subDistrict added; neighbourhood and country removed

  • person: gender now accepts male and female; citizenship removed

  • document: type removed

AU_SUPERANNUATION_AND_PAYROLL name updated

Sep 2, 2026

Consent types of several New Zealand registries updated: NZ_CREDIT_BUREAU โ†’ nz-consent; NZ_DIA_BIRTH, NZ_DIA_CITIZENSHIP, NZ_DIA_PASSPORT โ†’ dia-consent

Aug 26, 2026

NZ_DRIVER_LICENCE list of mandatory parameters updated

Aug 17, 2026

Intro section updated

Jul 13, 2026

US_FINANCIAL_SERVICES response payload example updated

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