Metadata Database Verification

  • Updated on Apr 20, 2026
  • Published on Apr 8, 2026
Prev Next

Available via API

Available via SDK

Needs configuration on Veriff's side

Needs a separate integration

Needs a separate webhook

✅

❌

✅

✅

❌

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

*This solution can be:

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

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

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

Contact your solutions engineer for info and configuration.

Prerequisites

  • You have an integration set up with Veriff

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

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

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

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

Key terminology

Term

Description

DataZoo

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

Registry

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

Registry Key

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

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

initData

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

End-user data sources

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

InitData

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

General overview of the parameters sent via initData:

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

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

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

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

  • person.middleName: string Middle name

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

  • person.email: string Email address

  • person.phoneNumber: string Mobile phone number

  • person.landLinePhoneNumber: string Landline phone number

  • person.idNumber: string National ID number

  • person.partnerFirstName: string Partner’s first name

  • person.partnerLastName: string Partner’s last name

  • person.marriageDateOfEvent: string Marriage date

  • person.secondLastName: string Second last name

  • document.number: string Document number

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

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

  • document.validUntil: string Document expiry date

  • document.cardNumber: string Physical card number

  • document.cardType: string Card type

  • document.stateOfIssue: string State of issue

  • document.referenceNumber: string Reference number

  • document.registrationNumber: string Registration number

  • document.version: string Document version

  • address.fullAddress: string Full address string

  • address.street: string Street name

  • address.neighbourhood: string Usually an unofficial neighbourhood name

  • address.city: string City name

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

  • address.postcode: string Postcode number

  • consents: array List of consent objects

    • type: string Consent type (general or dvs)

    • approved: boolean Whether consent was obtained

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

Flow overview

Database flow

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

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

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

Step 4: validation decision

Step 5: webhook is sent, containing:

  • Validation conclusion per field sent and supported by registry

  • Info about decision influence based on selected compared fields

Session flow

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

Use via API

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

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

Sample request payload

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

  1. Database checks are run.

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

Find decision and/or session related info

You can get the data from three sources:

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

Note about object and field visibility

Some objects and fields within the registryValidations are optional.

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

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

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

Note on session outcomes

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

  • All configured validations returned success or not_applicable

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

Webhook/API response general structure

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

{
  "verification": {
    "registryValidations": {
      "<REGISTRY_KEY>": {
        "status": "success | failure | error",
        "data": { ... } | null,
        "error": null | {
          "code": "enum string",
          "message": "string"
        },
        "timestamp": null,
        "validations": {
          "<validation_code>": {
            "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_code> to the validations matching outcome as shown in result. null when <REGISTRY_KEY>.status is error

          • <validation_code> : 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

Person

  • firstName

  • lastName

  • middleName

  • fullName (AU_MEDICARE_CARD only)

  • firstPartnerName (AU_MARRIAGE_CERTIFICATE only)

  • lastPartnerName (AU_MARRIAGE_CERTIFICATE only)

Address

  • addressElement1

  • addressElement2 (GB_RESIDENTIAL only)

  • addressElement3

  • addressElement4

  • addressElement5

  • matchedAddress (GB_RESIDENTIAL only)

Contact

  • emailAddress

  • phoneNo

  • landlineNumber (GB_RESIDENTIAL only)

Document / Verification

  • documentNo

  • verificationRequestNumber (DVS registries)

  • passportNumber (AU_VEVO only)

Identity / Registry Score

  • dataSourceScore (AU_RESIDENTIAL, AU_CITIZENS)

  • nationalIdNo (CL_NATIONAL_ID)

  • nationalIdNoStatus (CL_NATIONAL_ID)

AU_VEVO-specific

  • visaClass

  • visaGrantDate

  • visaExpiryDate

  • visaStream

  • workEntitlementStatus

  • workEntitlementStatusText

  • location

GB_FINANCIAL_SERVICES-specific

  • identityStrength

  • identityValidity

  • identityFraud

  • activityHistory

  • deathRegistration

  • amberhill

  • siraFraud

  • siraImpersonation

  • synthIdNoMatch

GB_PHONE_2-specific

  • statusMessage

Available validation_code values

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

  • processing System-level execution status

  • is_input_valid Whether end-user data passed format validation

    • (Note: has details array on failure)

  • consent_obtained Whether required consent was provided

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

  • first_name_match First name comparison result

  • middle_name_match Middle name comparison result

  • last_name_match Last name comparison result

  • full_name_match Full name comparison result

  • first_partner_name_match Partner’s first name comparison result

  • last_partner_name_match Partner’s last name comparison result

  • date_of_birth_match Date of birth comparison result

  • gender_match Gender comparison result

  • email_match Email comparison result

  • phone_number_match Phone number comparison result

  • land_line_phone_number_match Landline phone comparison result

  • id_number_match National ID number comparison result

  • marriage_date_of_event_matchMarriage date comparison result

  • address_full_address_match Full address comparison result

  • address_street_match Street comparison result

  • address_city_match City comparison result

  • address_state_match State comparison result

  • address_postcode_match Postcode comparison result

  • address_neighbourhood_match Neighbourhood comparison result

  • document_number_match Document number comparison result

  • document_card_number_match Card number comparison result

  • document_version_match Document version comparison result

  • document_reference_number_match Reference number comparison result

  • document_valid_from_match Document valid-from date comparison result

validation_code.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_code.reason values

  • null On success

  • value_mismatch Provided value does not match registry

  • input_not_provided Input value was not provided

  • output_not_received Registry didn't return the data point

  • person_not_found Person not found in registry

  • consent_not_obtained Required consent was not given

  • input_invalid Input data was provided but in incorrect format

  • registry_unavailable Registry could not be reached

  • technical_issues Internal error occurred

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

Databases by regions

APAC

LATAM

EMEA

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": "Jane",
      "lastName": "Thompson",
      "middleName": "Sarah",
      "dateOfBirth": "1985-07-14"
    }
  }
}

Sample response payload

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

{
  "status": "success",
  "verification": {
    "registryValidations": {
      "AU_ASIC_PERSONAL_NAME_REGISTER": {
        "status": "success",
        "data": {
          "firstName": "Sarah",
          "lastName": "Thompson",
          "middleName": "Jane"
        },
        "validations": {
          "processing": { "result": "success", "reason": null },
          "consent_obtained": { "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": "not_applicable", "reason": "input_not_provided" }
        },
        "error": null,
        "timestamp": null
      }
    }
  }
}

🇦🇺 Australia Citizens (AU_CITIZENS)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Conditionally required in addition to mandatory data

  • Group A

  • Date of birth via person.dateOfBirth

  • Group B

  • Street via address.street

  • Postcode via address.postcode

Optional

  • Email via person.email

  • Gender via person.gender

  • Middle name via person.middleName

  • Phone number via person.phoneNumber

Group A

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

Group B with parsed address fields

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

Group B with fullAddress parameter

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

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

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

Sample response payload

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

{
  "AU_CITIZENS": {
    "status": "success",
    "data": {
      "addressElement1": "15 Queen Street",
      "addressElement3": "Brisbane",
      "addressElement4": "QLD",
      "addressElement5": "4000",
      "dataSourceScore": 0.92,
      "documentNo": true,
      "firstName": "Sarah",
      "lastName": "Thompson",
      "middleName": "Jane"
    },
    "validations": {
      "processing": {"result": "success", "reason": null},
      "is_input_valid": {"result": "success", "reason": null},
      "identity_is_valid": {"result": "success", "reason": null},
      "first_name_match": {"result": "success", "reason": null},
      "last_name_match": {"result": "success", "reason": null},
      "date_of_birth_match": {"result": "success", "reason": null},
      "address_full_address_match": {"result": "success", "reason": null}
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺Australia Consumer (AU_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • Neighbourhood via address.neighbourhood

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

  • Email via person.email

  • Phone number via person.phoneNumber

With parsed address elements

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

With fullAddress parameter

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

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

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

Sample response payload

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


  "AU_CONSUMER": {
    "status": "success",
    "data": {
      "addressElement1": "8 Pitt Street",
      "addressElement3": "Sydney",
      "addressElement4": "NSW",
      "emailAddress": "m.brown@example.com",
      "firstName": "Michael",
      "lastName": "Brown"
    },
    "validations": {
      "processing": {"result": "success", "reason": null},
      "is_input_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 Credit Bureau (AU_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

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

  • Consent via consents array

Optional

  • Phone number via person.phoneNumber

  • Email via person.email

With parsed address fields

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

With fullAddress parameter

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

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

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. 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": {
      "addressElement1": "18 Bourke Street",
      "addressElement3": "Melbourne",
      "addressElement4": "VIC",
      "addressElement5": "3000",
      "emailAddress": "p.henderson@example.com",
      "firstName": "Patricia",
      "lastName": "Henderson"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null },
      "email_match": { "result": "not_applicable", "reason": "output_not_received" },
      "phone_number_match": { "result": "not_applicable", "reason": "output_not_received" }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia Death Check (AU_DEATH_CHECK)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Consent via consents array

Optional

  • Middle name via person.middleName

With mandatory fields

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

Sample response payload

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

{
  "AU_DEATH_CHECK": {
    "status": "success",
    "data": {
      "firstName": "Margaret",
      "lastName": "Collins"
    },
    "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
  }
}

🇦🇺 Australia DVS - Australia Driver Licence (AU_DRIVER_LICENCE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Licence number via document.number

  • Consent via consents array

Optional

  • Card number via document.cardNumber

  • State of issue via document.stateOfIssue

  • Middle name via person.middleName

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

Sample response payload

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

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

🇦🇺 Australia DVS - Australia Medicare Card (AU_MEDICARE_CARD)

Input parameters

POST /sessions example

Mandatory

  • Date of birth via person.dateOfBirth

  • Consent via consents array

Optional

  • First name via person.firstName

  • Last name via person.lastName

  • Medicare card number via document.cardNumber

  • Medicare card type via document.cardType

  • Medicare card expiry via document.validUntil

  • Medicare individual reference number via document.referenceNumber

  • Middle name via person.middleName

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

Sample response payload

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

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

🇦🇺 Australia DVS - Australia Passport (AU_PASSPORT)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Passport number via document.number

  • Consent via consents array

Optional

  • Middle name via person.middleName

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

Sample response payload

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

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

🇦🇺 Australia DVS - Australia Visa (AU_VISA)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Passport number via document.number

  • Document issuing country via document.country

  • Consent via consents array

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

Sample response payload

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

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

🇦🇺 Australia DVS - Birth Certificate (AU_BIRTH_CERTIFICATE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Consent via consents array

Optional

  • Birth certificate number via document.number

  • Birth registration date via document.validFrom

  • Birth registration number via document.registrationNumber

  • Birth registration state via document.stateOfIssue

  • Middle name via person.middleName

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

Sample response payload

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

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

🇦🇺 Australia DVS - Centrelink Card (AU_CENTRELINK_CARD)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Card type via document.cardType

  • Card expiry via document.validUntil

  • Customer reference number via document.referenceNumber

  • Consent via consents array

Optional

  • Middle name via person.middleName

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

Sample response payload

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

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

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

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Certificate number via document.number

  • Registration date via document.validFrom

  • Registration number via document.registrationNumber

  • Registration state via document.stateOfIssue

  • Consent via consents array

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

Sample response payload

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

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

🇦🇺 Australia DVS - Citizenship Certificate (AU_CITIZENSHIP_CERTIFICATE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Citizenship certificate number via document.number

  • Citizenship certificate date via document.validFrom

  • Consent via consents array

Optional

  • Middle name via person.middleName

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

Sample response payload

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

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

🇦🇺 Australia DVS - ImmiCard (AU_IMMICARD)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Card number via document.number

  • Card expiry via document.validUntil

  • Consent via consents array

Optional

  • Middle name via person.middleName

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

Sample response payload

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

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

🇦🇺 Australia DVS - Marriage Certificate (AU_MARRIAGE_CERTIFICATE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Partner's first name via person.partnerFirstName

  • Partner's last name via person.partnerLastName

  • Marriage date via person.marriageDateOfEvent

  • Registration state via document.stateOfIssue

  • Consent via consents array

Optional

  • Certificate number via document.number

  • Registration date via document.validFrom

  • Registration number via document.registrationNumber

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

Sample response payload

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

{
  "AU_MARRIAGE_CERTIFICATE": {
    "status": "success",
    "data": {
      "documentNo": "MC-2012-00891",
      "firstName": "Claire",
      "lastName": "Sutton",
      "firstPartnerName": "Daniel",
      "lastPartnerName": "Sutton",
      "verificationRequestNumber": "VRN-20260415-00367"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "first_partner_name_match": { "result": "success", "reason": null },
      "last_partner_name_match": { "result": "success", "reason": null },
      "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

  • Consent via consents array

Optional

  • Travel document number via document.number

  • Document issuing country via document.country

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

Sample response payload

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

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

🇦🇺 Australia Electoral Roll (AU_ELECTORAL_ROLL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

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

  • Consent via consents array

With parsed address fields

{
  "verification": {
    "person": {
      "firstName": "Robert",
      "lastName": "Mitchell",
      "dateOfBirth": "1979-08-22"
    },
    "address": {
      "street": "27 Flinders Street",
      "city": "Melbourne",
      "postcode": "3000"
    },
    "consents": [
      {
        "type": "general",
        "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": "general",
        "approved": true
      }
    ]
  }
}

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

Sample response payload

The following info can be found in decision webhook payload and GET /decision endpoint's payload, in verifications.registryValidations object. 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": {
      "addressElement1": "27 Flinders Street",
      "addressElement3": "Melbourne",
      "addressElement4": "VIC",
      "addressElement5": "3000",
      "firstName": "Robert",
      "lastName": "Mitchell"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "consent_obtained": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "date_of_birth_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia Phone (AU_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

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

With parsed address fields

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

With fullAddress parameter

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

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

Sample response payload

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

{
  "AU_PHONE": {
    "status": "success",
    "data": {
      "addressElement1": "14 Park Road",
      "addressElement3": "Brisbane",
      "addressElement4": "QLD",
      "addressElement5": "4000",
      "firstName": "Gregory",
      "lastName": "Walsh",
      "middleName": "Alan",
      "phoneNo": "+61731234567"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia Residential (AU_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Date of birth via person.dateOfBirth OR

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

  • Email via person.email

  • Gender via person.gender

  • Middle name via person.middleName

  • Landline number via person.landLinePhoneNumber

  • Phone number via person.phoneNumber

With date of birth and other optional data

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

With parsed address fields and other optional data

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

With fullAddress parameter and other optional data

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

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

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

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

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

Sample response payload

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

{
  "AU_RESIDENTIAL": {
    "status": "success",
    "data": {
      "addressElement1": "42 George Street",
      "addressElement3": "Sydney",
      "addressElement4": "NSW",
      "addressElement5": "2000",
      "dataSourceScore": 0.95,
      "emailAddress": "james.wilson@example.com",
      "firstName": "James",
      "lastName": "Wilson",
      "middleName": "Robert"
    },
    "validations": {
      "processing": {"result": "success", "reason": null},
      "is_input_valid": {"result": "success", "reason": null},
      "identity_is_valid": {"result": "success", "reason": null},
      "first_name_match": {"result": "success", "reason": null},
      "last_name_match": {"result": "success", "reason": null},
      "middle_name_match": {"result": "success", "reason": null},
      "date_of_birth_match": {"result": "success", "reason": null},
      "address_full_address_match": {"result": "success", "reason": null},
      "email_match": {"result": "not_applicable", "reason": "output_not_received"},
      "phone_number_match": {"result": "not_applicable", "reason": "output_not_received"}
    },
    "error": null,
    "timestamp": null
  }
}

🇦🇺 Australia Residential Lookup (AU_RESIDENTIAL_LOOKUP)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Landline number via person.landLinePhoneNumber

  • Phone number via person.phoneNumber

Optional

  • Middle name via person.middleName

  • Gender via person.gender

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

Mandatory fields only

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

With all optional fields

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

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

Sample response payload

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

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

🇦🇺 Australia Superannuation & Payroll (AU_SUPERANNUATION_PAYROLL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Consent via consents array

Optional

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

Mandatory fields only

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

With optional address

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

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

Sample response payload

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

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

🇦🇺 Australia TICA Tenancy Register (AU_TICA_TENANCY_REGISTER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Middle name via person.middleName

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

Sample response payload

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

{
  "status": "success",
  "verification": {
    "registryValidations": {
      "AU_TICA_TENANCY_REGISTER": {
        "status": "success",
        "data": {
          "firstName": "Tom",
          "lastName": "Evans",
          "middleName": "Michael"
        },
        "validations": {
          "processing": { "result": "success", "reason": null },
          "consent_obtained": { "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": "not_applicable", "reason": "input_not_provided" }
        },
        "error": null,
        "timestamp": null
      }
    }
  }
}

🇦🇺 Australia VEVO (AU_VEVO)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

  • Passport number via document.number

  • Passport issuing country via document.country

  • Consent via consents array

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

Sample response payload

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

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

LATAM

🇨🇱 Chile National ID (CL_NATIONAL_ID)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

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

Optional

  • Middle name via person.middleName

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

Sample response payload

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


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

🇨🇱 Chile Residential (CL_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Street via address.street

  • City via address.city

  • Middle name via person.middleName

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

Sample response payload

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

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

EMEA

🇬🇧 United Kingdom Citizens (GB_CITIZENS)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

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

With parsed address fields

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

With fullAddress parameter

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

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

Sample response payload

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

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

🇬🇧 United Kingdom Consumer (GB_CONSUMER)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

Optional

  • Street via address.street

  • Neighbourhood via address.neighbourhood

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

  • Email via person.email

  • Phone number via person.phoneNumber

With all optional data

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

Sample response payload

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

{
  "GB_CONSUMER": {
    "status": "success",
    "data": {
      "addressElement1": "25 Baker Street",
      "addressElement3": "London",
      "addressElement4": "Greater London",
      "addressElement5": "W1U 8EW",
      "emailAddress": "emma.clark@example.co.uk",
      "firstName": "Emma",
      "lastName": "Clark"
    },
    "validations": {
      "processing": {"result": "success", "reason": null},
      "is_input_valid": {"result": "success", "reason": null},
      "first_name_match": {"result": "success", "reason": null},
      "last_name_match": {"result": "success", "reason": null},
      "date_of_birth_match": {"result": "success", "reason": null}
    },
    "error": null,
    "timestamp": null
  }
}

🇬🇧 United Kingdom Credit Bureau (GB_CREDIT_BUREAU)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Date of birth via person.dateOfBirth

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

  • Consent via consents array

With parsed address fields

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

With fullAddress parameter

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

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

Sample response payload

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

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

🇬🇧 United Kingdom Financial Services (GB_FINANCIAL_SERVICES)

Input parameters

POST /sessions example

Mandatory

  • Last name via person.lastName

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

Optional

  • First name via person.firstName

  • Date of birth via person.dateOfBirth

  • Phone number via person.phoneNumber

With parsed address fields

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

With fullAddress parameter

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

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

Sample response payload

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

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

🇬🇧 United Kingdom Phone (GB_PHONE)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Phone number via person.phoneNumber

Optional

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

Mandatory fields only

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

With optional address

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

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

Sample response payload

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

{
  "GB_PHONE": {
    "status": "success",
    "data": {
      "addressElement1": "37 Victoria Street",
      "addressElement3": "Manchester",
      "addressElement4": "Greater Manchester",
      "addressElement5": "M2 3BQ",
      "firstName": "Thomas",
      "lastName": "Hargreaves",
      "phoneNo": "+447700900456"
    },
    "validations": {
      "processing": { "result": "success", "reason": null },
      "is_input_valid": { "result": "success", "reason": null },
      "identity_is_valid": { "result": "success", "reason": null },
      "first_name_match": { "result": "success", "reason": null },
      "last_name_match": { "result": "success", "reason": null },
      "phone_number_match": { "result": "success", "reason": null },
      "address_full_address_match": { "result": "success", "reason": null }
    },
    "error": null,
    "timestamp": null
  }
}

🇬🇧 United Kingdom Phone 2 (GB_PHONE_2)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

  • Phone number via person.phoneNumber

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

Optional

  • Date of birth via person.dateOfBirth

With parsed address and optional DOB

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

With fullAddress parameter

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

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

Sample response payload

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

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

🇬🇧 United Kingdom Residential (GB_RESIDENTIAL)

Input parameters

POST /sessions example

Mandatory

  • First name via person.firstName

  • Last name via person.lastName

Optional

  • Date of birth via person.dateOfBirth

  • Street via address.street

  • Neighbourhood via address.neighbourhood

  • City via address.city

  • State via address.state

  • Postcode via address.postcode

  • Drivers licence version via document.version

  • Landline number via person.landLinePhoneNumber

  • Phone number via person.phoneNumber

With all optional data

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

Sample response payload

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

{
  "GB_RESIDENTIAL": {
    "status": "success",
    "data": {
      "addressElement1": "10 Downing Street",
      "addressElement2": "Westminster",
      "addressElement3": "London",
      "addressElement4": "England",
      "addressElement5": "SW1A 2AA",
      "emailAddress": null,
      "firstName": "William",
      "landlineNumber": "+442071234567",
      "lastName": "Davies",
      "matchedAddress": "10 Downing Street"
    },
    "validations": {
      "processing": {"result": "success", "reason": null},
      "is_input_valid": {"result": "success", "reason": null},
      "identity_is_valid": {"result": "success", "reason": null},
      "first_name_match": {"result": "success", "reason": null},
      "last_name_match": {"result": "success", "reason": null},
      "date_of_birth_match": {"result": "success", "reason": null},
      "address_full_address_match": {"result": "success", "reason": null},
      "phone_number_match": {"result": "success", "reason": null},
      "land_line_phone_number_match": {"result": "success", "reason": null}
    },
    "error": null,
    "timestamp": null
  }
}

Status and reason codes

For info about the session, see:

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

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

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

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

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

verification.status

verification.reasonCode

verification.reason

What does it mean?

declined

529

Unable to validate National Id data

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

declined

9102

Declined

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

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

Additional data

Best practices

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

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

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

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

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

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

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

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

  9. Ensure backwards compatibility for webhooks and API connections.

FAQ

Can I query multiple registries in a single session?

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

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

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

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

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

What if the registry returns data about the person?

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

Changelog

Date

Description

Apr 20, 2026

Documentation updated

Apr 16, 2026

Documentation updated

Apr 8, 2026

Documentation published