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_validfails 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 |
initData | The data object sent by the customer in the |
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:stringEnd-user's first nameperson.lastName:stringEnd-user's last nameperson.fullName:stringEnd-user's first and last nameperson.dateOfBirth:stringDate of birth inYYYY-MM-DDformatperson.middleName:stringMiddle nameperson.gender:stringGender (Mormale/Forfemale)person.email:stringEmail addressperson.phoneNumber:stringMobile phone numberperson.landLinePhoneNumber:stringLandline phone numberperson.idNumber:stringNational ID number (also tax ID, SSN, CPF, etc., depending on the registry)person.partnerFirstName:stringPartner's first nameperson.partnerLastName:stringPartner's last nameperson.marriageDateOfEvent:stringMarriage date inYYYY-MM-DDformatperson.secondLastName:stringSecond last namedocument.number:stringDocument numberdocument.country:stringDocument issuing country (ISO 3166-1 alpha-2)document.validFrom:stringDocument issue/valid-from date inYYYY-MM-DDformatdocument.validUntil:stringDocument expiry date inYYYY-MM-DDformatdocument.cardNumber:stringPhysical card numberdocument.cardType:stringCard typedocument.stateOfIssue:stringState of issuedocument.referenceNumber:stringReference numberdocument.registrationNumber:stringRegistration numberdocument.version:stringDocument versionaddress.fullAddress:stringFull address string. When sent, it is parsed into the individual address fields; parsed values only fill fields you did not sendaddress.street:stringStreet name and numberaddress.houseNumber:stringHouse number (used by registries that take it separately, e.g. CH, TH, ID)address.unit:stringUnit, flat or floor (used e.g. by HK, CA, SK)address.buildingName:stringA name given to a building or a propertyaddress.suburb:stringA specific named area within a city or a town. For AU and NZ registries this is the locality (suburb/town) of the postal addressaddress.subDistrict:stringAn entity at a lower level than districtaddress.city:stringCity nameaddress.state:stringA first-level administrative division (for AU:NSW,VIC,QLD,WA,SA,TAS,ACT,NT)address.postcode:stringPostcode numberconsents:arrayList of consent objectstype:stringConsent type, see Consent types for the valid value per registryapproved:booleanWhether 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 onlyaddress.cityleaves 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
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).
Check each database's documentation to see which initData parameters are required and allowed to be sent.
Patch session status to
submittedstatus using PATCH /sessions/{sessionId} call.This endpoint requires endpoint level authentication via
x-hmac-signatureheader. 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"
}
}'
Database checks are run.
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:
Receive the decision webhook (check each database's documentation to see an example).
Query the results via GET /sessions/{sessionId}/decision (payload is identical to webhook's, check each database's documentation to see an example).
View the session in Veriff Customer Portal > All Verifications > Webhooks tab.
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
successornot_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:objectParent container for verification resultsregistryValidations:objectMetadata Database Verification results container<REGISTRY_KEY>:objectCombination of country code and registry name. Parent container for the specific registry resultsstatus:stringOverall result. Enum:success,failure, orerrordata:object|nullData returned from the registry (e.g., visa details, person status).nullif registry only performs matching without returning dataerror:object|nullStructured error when<REGISTRY_KEY>.statusiserror.nullotherwisetimestamp: Always returnsnullvalidations:object|nullMap of<validation_check>to the validations matching outcome as shown inresult.nullwhen<REGISTRY_KEY>.statusiserror
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
firstNameFirst namemiddleNameMiddle namelastNameLast namefullNameFull nameotherNamesOther / alternative names (array)genderGenderyearOfBirthYear of birth indicatorpersonStatusRegistry-recorded person status
Address
addressAddress as a single stringaddress1First address line (street + number)matchedAddressStatus of the returned address (current,previous)cityCity / townsuburbSuburb or neighbourhoodpostCodePostal / ZIP codelocationFree-form working-rights values string, such asonshore
Contact
homePhoneNoHome / landline phone numberphoneDataStructured phone records (array of objects)phoneStatusPhone status (active,disconnected)carrierNameTelephone carrier name
Identification
nationalIdNoNational ID number returned by the registrynationalIdNoStatusNational ID status (active/inactive)verificationRequestNumberDVS verification request referencescanIdScan / search identifier
Visa and work entitlement (AU_VEVO and similar)
visaClassVisa class codevisaStreamVisa stream / category descriptionvisaGrantDateVisa grant datevisaExpiryDateVisa expiry dateworkEntitlementStatusWork-entitlement status as integerworkEntitlementStatusTextWork-entitlement status description
Identity quality and match scores
identityFraudIdentity-fraud indicator, stringidentityStrengthIdentity-strength score / band, stringidentityValidityIdentity-validity indicator, stringaltAddressMatchScoreAlternative address-match score (object)altDobScoreAlternative date-of-birth match score, stringaltNameMatchScoreAlternative name-match score (object)dataSourceIdSource registry identifierdataSourceScoreSource-data confidence score (float)
Death and deceased-records signals
dateOfDeathRecorded date of death, present only when the registry returns it. Passed through unchanged inYYYY-MM-DDformat.dateOfRegistrationDeath-record registration date, passed through unchanged inYYYY-MM-DDformatdeathIndexDeath-index identifierdeathRegistrationDeath registration found (boolean)deceasedRecordDeceased-record found (boolean)possibleDeceasedRecordPossible deceased-record match (boolean)possibleDeceasedRecordNameName on the possible deceased recordpossibleDeceasedRecordAddressAddress on the possible deceased recordpossibleDeceasedRecordPartialMatchingPartial-match indicator (boolean)
Fraud and risk signals
amberhillAmberhill fraud-list match (boolean)fraudVictimAlertFraud-victim alert on file (boolean)fraudulentActivityAddressAddress linked to fraudulent activity (boolean)overallFraudRiskOverall fraud-risk flag (boolean)siraFraudSIRA fraud indicator (boolean)siraImpersonationSIRA impersonation indicator (boolean)synthIdNoMatchSynthetic-identity number-match flag (boolean)whitelistWhitelist match (boolean)
Credit-file and records signals (US, CA, GB credit registries)
newCreditFileNewly created credit file (boolean)thinFileThin credit file (boolean)hasBankruptcyRecordsBankruptcy records present (boolean)hasBusinessRecordsBusiness records present (boolean)hasEvictionsRecordsEviction records present (boolean)hasForeclosuresRecordsForeclosure records present (boolean)hasJudgmentRecordsJudgment records present (boolean)hasLienRecordsLien records present (boolean)hasUccRecordsUCC records present (boolean)hasWorkplaceRecordsWorkplace records present (boolean)
Account and registry-specific
accountClassAccount classification, values:business,personal,corporate,unknownaccountTypeAccount type, values:postpaid,prepaid,unknownactivationDateAccount / record activation dateactivityHistoryActivity history summary, stringadditionalInfoUrlURL pointing to additional registry informationbrandNameBrand or product namecategoryRegistry-defined categorydpIdData-provider identifiersourceRegistry source labelsubscriberIdSubscriber identifierstatusMessageFree-form status message from the registryregistrationNumberRegistration-number presence indicatorregistrationStateRegistration-state presence indicatorregistrationStatusRegistration 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.
processingSystem-level execution statusis_input_validWhether end-user data passed format validation (note: hasdetailsarray onfailure)consent_obtainedWhether required consent was providedidentity_is_validWhether the person was found/verified in the registryfirst_name_matchFirst name comparison resultmiddle_name_matchMiddle name comparison resultlast_name_matchLast name comparison resultfull_name_matchFull name comparison resultfirst_partner_name_matchPartner's first name comparison resultlast_partner_name_matchPartner's last name comparison resultdate_of_birth_matchDate of birth comparison resultgender_matchGender comparison resultemail_matchEmail comparison resultphone_number_matchPhone number comparison resultland_line_phone_number_matchLandline phone comparison resultid_number_matchNational ID number comparison resultmarriage_date_of_event_matchMarriage date comparison resultaddress_full_address_matchFull address comparison resultaddress_street_matchStreet comparison resultaddress_city_matchCity comparison resultaddress_state_matchState comparison resultaddress_postcode_matchPostcode comparison resultaddress_neighbourhood_matchSuburb (address.suburb) comparison resultdocument_number_matchDocument number comparison resultdocument_card_number_matchCard number comparison resultdocument_version_matchDocument version comparison resultdocument_reference_number_matchReference number comparison resultdocument_valid_from_matchDocument valid-from date comparison result
validation_check.result statuses and meanings
successThe submitted value matches the registry recordfailurewith:reason:value_mismatchThe submitted value does not match the registry recordnot_applicablewith:reason:input_not_providedThe input value was not provided for this validationreason:output_not_receivedThe registry did not return data for this field
validation_check.reason values
nullOn successvalue_mismatchProvided value does not match registryinput_not_providedInput value was not providedoutput_not_receivedRegistry didn't return the data pointperson_not_foundPerson not found in registryconsent_not_obtainedRequired consent was not given, or was sent with a differenttypethan the registry requiresinput_invalidInput data was provided but in incorrect format, or a mandatory field is missingregistry_unavailableRegistry could not be reachedtechnical_issuesInternal error occurred
Special case:
is_input_validhas adetailsarray onfailureWhen the
is_input_validvalidation fails, the response includes adetailsarray (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
statusiserrorerrorisnullwhen registrystatusissuccessorfailure
|
|
|---|---|
| Two possible values: |
|
|
Consent types
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 | Used by |
|---|---|
| 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 Electoral Roll, AU Superannuation & Payroll |
| Canada Residential, Canada Credit Bureau (FINTRAC) |
| New Zealand Credit Bureau |
| New Zealand DIA Births, DIA Citizenship, DIA Passport |
| 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 |
Sample consent object
"consents": [
{
"type": "au-dvs",
"approved": true
}
]
Databases by regions
Australia - ASIC Personal Name Register (AU_ASIC_PERSONAL_NAME_REGISTER)
Australia - DVS Australia Driver Licence (AU_DRIVER_LICENCE)
Australia - DVS Change of Name Certificate (AU_CHANGE_OF_NAME_CERTIFICATE)
Australia - DVS Citizenship Certificate (AU_CITIZENSHIP_CERTIFICATE)
Australia - DVS Marriage Certificate (AU_MARRIAGE_CERTIFICATE)
Australia - Superannuation & Payroll (AU_SUPERANNUATION_AND_PAYROLL)
Australia - TICA Tenancy Register (AU_TICA_TENANCY_REGISTER)
Indonesia - Residential Identity Card (ID_RESIDENT_IDENTITY_CARD)
APAC
๐ฆ๐บ Australia - ASIC Personal Name Register (AU_ASIC_PERSONAL_NAME_REGISTER)
Input parameters | POST /sessions example |
|---|---|
Mandatory
Optional
| |
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
Conditionally required in addition to mandatory data
Optional
| Group A Group B with parsed address fields Group B with fullAddress parameter |
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.suburband the state code inaddress.state.address.cityis 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
Optional
| |
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.suburband the state code inaddress.state.address.cityis 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
Optional
| With parsed address fields With fullAddress parameter |
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.suburband the state code inaddress.state.address.cityis 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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Conditionally required in addition to mandatory data
Optional
| |
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
}
}๐ฆ๐บ Australia - DVS Centrelink Card (AU_CENTRELINK_CARD)
Input parameters | POST /sessions example |
|---|---|
Mandatory
Optional
| |
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
Conditionally required in addition to mandatory data
| |
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
Optional
| |
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
Optional
| |
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
Conditionally required in addition to mandatory data
| |
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
Optional
| |
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
Optional
| With parsed address fields With fullAddress parameter |
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.suburband the state code inaddress.state.address.cityis 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
Optional
| With parsed address fields With fullAddress parameter |
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.suburband the state code inaddress.state.address.cityis 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
Conditionally required in addition to mandatory data
Optional
| With date of birth With parsed address fields With fullAddress parameter |
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.suburband the state code inaddress.state.address.cityis 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
Optional
| |
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.suburband the state code inaddress.state.address.cityis 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
Optional
| |
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.suburband the state code inaddress.state.address.cityis 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
Optional
| |
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
Optional
| |
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
Optional
| |
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
| |
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
| |
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
Optional
| |
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
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
| |
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
Optional
| |
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
Optional
| |
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
| |
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
Optional
| |
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
Optional
| |
Send either
person.fullNameor bothperson.firstNameandperson.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
Optional
| |
Send either
person.fullNameor bothperson.firstNameandperson.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
Conditionally required in addition to mandatory data
Optional
| |
Send
address.streetplus at least one ofaddress.suburb,address.stateoraddress.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
Optional
| |
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
Conditionally required in addition to mandatory data
Optional
| |
Send
address.streetplus at least one ofaddress.suburb,address.stateoraddress.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
Conditionally required in addition to mandatory data
| |
Send
address.streetplus at least one ofaddress.suburb,address.stateoraddress.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
| |
Send all given names exactly as registered: first given name in
person.firstName, the remaining given names inperson.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
| |
Send all given names exactly as registered: first given name in
person.firstName, the remaining given names inperson.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
Optional
| |
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
| |
*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
Conditionally required in addition to mandatory data
Optional
| |
Send
address.streetplus at least one ofaddress.suburb,address.stateoraddress.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
Conditionally required in addition to mandatory data
Optional
| |
Send
address.streetplus at least one ofaddress.suburb,address.stateoraddress.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
Conditionally required in addition to mandatory data
Optional
| |
Send
address.streetplus at least one ofaddress.suburb,address.stateoraddress.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
Optional
| |
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
Optional
| |
Send either
person.fullNameor bothperson.firstNameandperson.lastName. You can send all three.
document.cardTypemust identify the ID sent inperson.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
Optional
| |
Send either
person.fullNameor bothperson.firstNameandperson.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
Optional
| |
Send either
person.fullNameor bothperson.firstNameandperson.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
Optional
| |
Send either
person.fullNameor bothperson.firstNameandperson.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
Optional
| |
Send either
person.fullNameor bothperson.firstNameandperson.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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
Send either
person.fullNameor bothperson.firstNameandperson.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
Optional
| |
Send either
person.fullNameor bothperson.firstNameandperson.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
Optional
| |
Send either
person.fullNameor bothperson.firstNameandperson.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
Optional
| |
Send either
person.fullNameor bothperson.firstNameandperson.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
Optional
| |
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
Optional
| |
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
Optional
| |
Send either
person.fullNameor bothperson.firstNameandperson.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
Optional
| |
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
Conditionally required in addition to mandatory data
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
Send either
person.fullNameor bothperson.firstNameandperson.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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
Send either
person.fullNameor bothperson.firstNameandperson.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
Optional
| |
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
Optional
| |
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
| |
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
Optional
| |
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
Optional
| |
For the best results send
address.streetandaddress.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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
Send the street name in
address.streetand the house number separately inaddress.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
Optional
| |
The postcode is used to locate the record. Send
address.streetandaddress.cityas 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
Optional
| |
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
Optional
| With parsed address fields With fullAddress parameter |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| With fullAddress parameter |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Optional
| |
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
Conditionally required in addition to mandatory data
Optional
| |
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
Optional
| |
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
Optional
| |
*Send only the first name (first word) of person's name. Sending several words in the
firstNamefield 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
Optional
| |
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
Optional
| |
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
Optional
| |
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.codeabout verification session decision code, one of9001,9102,9103,9104,9121.verification.statusabout verification status, one ofapproved,declined,resubmission_requested,expired,abandoned.
If the Metadata Database Verification session was declined or resubmission_requested, you can find additional information by checking:
verification.reasonfor the reason why the verification failed.verification.reasonCodefor reason code of the failed verification and cross-reference it with Granular reason codes (table).
|
|
| What does it mean? |
|---|---|---|---|
|
| 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 |
|
| Consent not obtained | Consent was missing, not approved, or sent with a |
|
| Declined | Generic decline. Check |
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 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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
typelisted for the registry in Consent types.Build for
dataobject 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.) indocument.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_unavailableortechnical_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 |
|
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:
|
Oct 5, 2026 | AU_VEVO registry consent type updated to |
Sep 22, 2026 | Australia - Electoral Roll (AU_ELECTORAL_ROLL) consent type updated to |
Sep 18, 2026 | Several registries response payloads updated Note added to US_FINANCIAL_SERVICES about sending only one word in |
Sep 3, 2026 | Initdata info updated:
AU_SUPERANNUATION_AND_PAYROLL name updated |
Sep 2, 2026 | Consent types of several New Zealand registries updated: NZ_CREDIT_BUREAU โ |
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 |