Returns verification session decision, extracted document data, database matching results, and risk assessment outcomes
When to use this endpoint
- To get the session decision (for both completed sessions and sessions that expired/were abandoned)
- For polling when webhook delivery fails or is not configured
Decision availability
Decision timing
- Results are typically available within seconds to minutes after session completion, depending on:
- Verification solution type (automated vs manual review)
- Document complexity and quality
- Additional checks enabled (e.g., AML screening, database validation)
Session status vs decision
- The session can be in "submitted" status while the decision is still being processed. Check the
verificationfield in the response:null= decision not yet available, try again later- object = decision is ready with final results
Decision status codes
9001- Approved: Verification successful9102- Declined: Verification failed9103- Resubmission requested: Additional attempt needed9104- Expired: Session expired before completion9121- Abandoned: Session started but not completed- See the complete verification session status codes table for detailed descriptions.
Response data
- The full payload depends on your integration configuration. Click on the "Show example" button inside the "Responses" section to see examples of some solutions' response payloads.
Null and missing fields
- Fields may be
null, empty, or omitted depending on integration configuration and data availability:null= field is included in payload but has no value (data unavailable, feature disabled, or verification declined/expired)- Empty (
{}or[]) = field is included but returned no data (feature enabled but no results) - Omitted = field not part of payload (integration configuration or no results returned)
- Always check field existence and
nullvalues before processing.
Implementation notes
- This endpoint requires session-level HMAC signature authentication
- Handle
nullvalues gracefully. - Use the
codefield for programmatic decision handling (9001=approved, etc.) - Always ensure that you use the correct API URL to send requests. See the API URL section for more info.
- The order of parameters in the real API response can differ from the order you see in this documentation. This is expected and part of the Backwards compatible changes requirements.
Your integration's API key (occasionally referred to as the "Token", "API public key" or "Publishable key"). Required for all API requests.
You can find your API key in the Veriff Customer Portal > Settings > API keys.
Session id signed with the shared secret key. Required to authenticate the request sender.
Must be set to application/json
Verification session ID.
Response of a successful API call
Approved verification with age and gender estimation
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": null,
"lastName": null,
"citizenship": null,
"idNumber": null,
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"pepSanctionMatch": null
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": null,
"validUntil": null,
"state": null
},
"additionalVerifiedData": [
{
"estimatedAge": 28,
"estimatedGender": 0.9
}
],
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved biometric authentication using Veriff's document + selfie IDV
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": "SARAH",
"lastName": "MORGAN",
"citizenship": null,
"idNumber": "123456789",
"gender": "F",
"dateOfBirth": "1967-03-30",
"yearOfBirth": "1967",
"placeOfBirth": "ANYTOWN",
"nationality": "US",
"pepSanctionMatch": null
},
"document": {
"number": "MORGA753116SM9IJ",
"type": "DRIVERS_LICENSE",
"country": "US",
"validFrom": "2018-04-20",
"validUntil": "2028-04-20",
"state": "NY"
},
"additionalVerifiedData": {},
"biometricAuthentication": {
"matchedSessionId": "d40edb60-6ae6-4475-be72-84b81669cce6",
"matchedSessionVendorData": "12345678",
"matchedSessionEndUserId": "a1b2c35d-e8f7-6d5e-3cd2-a1b2c35db3d4",
"details": {}
},
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved biometric database check with facial and data matching results, currently only for Brazilian CPF biometric database
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": "JOÃO",
"lastName": "SILVA",
"citizenship": null,
"idNumber": "123456789",
"gender": null,
"dateOfBirth": "1990-01-15",
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"pepSanctionMatch": null
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": null,
"validUntil": null,
"state": null
},
"additionalVerifiedData": {
"biometricRegistryValidationResults": {
"BR": {
"isFirstNameMatch": true,
"isLastNameMatch": true,
"isDobMatch": true,
"isFaceMatch": true
}
}
},
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved biometric liveness check with baseline verification data
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": null,
"lastName": null,
"citizenship": null,
"idNumber": null,
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"pepSanctionMatch": null
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": null,
"validUntil": null,
"state": null
},
"additionalVerifiedData": {},
"comments": [],
"riskLabels": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved Brazilian Cadastro Único social programs registry verification
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": "MARIA",
"lastName": "SILVA SANTOS",
"dateOfBirth": "1990-01-15",
"gender": "F",
"nationality": "BR",
"idNumber": "12345678901",
"yearOfBirth": "1990",
"placeOfBirth": "BRAZIL"
},
"document": {
"number": "AB123456",
"type": "ID_CARD",
"country": "BR",
"state": "DF"
},
"additionalVerifiedData": {
"cadastroUnico": {
"validations": {
"processing": {
"result": "success",
"reasons": null
},
"isUserDataValid": {
"result": "success",
"reasons": null
},
"isNotBcpBeneficiary": {
"result": "failure",
"reasons": [
"User is bcp beneficiary"
]
},
"isNotBolsaFamiliaBeneficiary": {
"result": "success",
"reasons": []
},
"isNotSeguroDefesoBeneficiary": {
"result": "failure",
"reasons": [
"User is seguro defeso beneficiary"
]
},
"isNotCadastroUnicoBeneficiary": {
"result": "success",
"reasons": []
},
"isNotAuxilioEmergencialBeneficiary": {
"result": "failure",
"reasons": [
"User is auxilio emergencial beneficiary"
]
}
},
"registryResponse": {
"bcpBenefit": {
"state": "SP",
"benefitNumber": "",
"isInRegistry": true,
"beneficiaryNis": "",
"referenceMonth": "202210",
"competenceMonth": "202210",
"installmentValue": "1.212,00",
"municipalityName": "OSASCO",
"judiciallyGrantedBenefit": ""
},
"bolsaFamiliaBenefit": {
"qsa": true,
"currentlyActive": false,
"lastBenefitDate": "2022-05-12T00:00:00Z",
"dataInconsistency": false,
"firstBenefitDate": "2022-05-12T00:00:00Z",
"lastBenefitValue": "",
"last12MonthsData": "dez/25 - NAO, nov/25 - NAO, out/25 - NAO",
"lastBenefitPayment": "",
"wasBenefitRecipient": true,
"currentlyInBolsaFamilia": false,
"employmentLinkLast5Years": true
},
"seguroDefesoBenefit": {
"isInRegistry": true,
"beneficiaryCpf": "12345678901",
"beneficiaryNis": "12345678901",
"beneficiaryName": "MARIA SILVA SANTOS",
"beneficiaryState": "AL",
"municipalityCode": "1234",
"municipalityName": "CORURIPE",
"benefitReferenceMonth": "2022-01-10T00:00:00Z",
"installmentValueReceived": "1212.00",
"fishingRegistrationNumber": "123456",
"bolsaFamiliaInsuranceSameDate": false
},
"auxilioEmergencialBenefit": {
"state": "PR",
"value": 30000.0,
"observation": "NAO HA",
"installments": "9",
"municipality": "CAMBE",
"classification": "CADUN NAO BOLSA",
"isInRegistry": true,
"availableMonth": "2020-12-01T00:00:00Z",
"municipalityCode": "1234567"
}
}
}
},
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved Brazilian CPF validation with registry data (non-biometric check)
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": "JOÃO",
"lastName": "SILVA",
"citizenship": null,
"idNumber": "123456789",
"gender": null,
"dateOfBirth": "1990-01-15",
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"pepSanctionMatch": null
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": null,
"validUntil": null,
"state": null
},
"additionalVerifiedData": {
"cpfValidation": {
"status": "CPF is validated",
"cpfNumber": "12345678901",
"name": "JOÃO SILVA",
"dateOfBirth": "1990-01-15",
"dateOfDeath": null
}
},
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved Brazilian ProBet gambling exclusion registry verification
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": "MARIA",
"lastName": "SILVA SANTOS",
"dateOfBirth": "1990-01-15",
"gender": "F",
"nationality": "BR",
"idNumber": "12345678901",
"yearOfBirth": "1990",
"placeOfBirth": "SAO PAULO"
},
"document": {
"number": "AB123456",
"type": "ID_CARD",
"country": "BR",
"state": "SP"
},
"additionalVerifiedData": {
"proBet": {
"validations": {
"processing": {
"result": "success",
"reasons": null
},
"isUserDataValid": {
"result": "success",
"reasons": null
},
"isNotOnPia": {
"result": "failure",
"reasons": [
"User is on PIA registry"
]
},
"isNotOnProBet": {
"result": "failure",
"reasons": [
"User is on Pro Bet registry"
]
}
},
"registryResponse": {
"pepData": {
"name": "MARIA SILVA SANTOS",
"role": "SECRETARIO GERAL",
"organization": "SECRETARIA NACIONAL DE DESENVOLVIMENTO REGIONAL",
"exerciseStartDate": "25/07/2023",
"exerciseEndDate": "",
"pepValidityDate": ""
},
"artistData": {
"cpf": "12345678901",
"name": "MARIA SILVA SANTOS",
"artisticName": "MARIA SILVA SANTOS",
"occupation": "CANTORA"
},
"piaData": {
"isInRegistry": true,
"cnpj": "29872262000128",
"companyName": "LOTERICA BOM DESTINO LTDA",
"type": "CASAS LOTERICAS"
},
"influencerData": {
"artisticName": "MARIA SILVA SANTOS",
"socialMediaUrl": "",
"areaOfActivity": "INFLUENCER"
},
"scoreData": {
"isAllowedToBet": false
}
}
}
},
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Standard identity verification with person and document data. This example applies also for any IDV verificatoion done with an AML Screening integration.
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": "SARAH",
"lastName": "MORGAN",
"citizenship": null,
"idNumber": "123456789",
"gender": "F",
"dateOfBirth": "1967-03-30",
"yearOfBirth": "1967",
"placeOfBirth": "ANYTOWN",
"nationality": "US",
"pepSanctionMatch": null
},
"document": {
"number": "MORGA753116SM9IJ",
"type": "DRIVERS_LICENSE",
"country": "US",
"validFrom": "2018-04-20",
"validUntil": "2028-04-20",
"state": "NY"
},
"additionalVerifiedData": {},
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved Mexican CURP population registry database verification with validation results
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": null,
"lastName": null,
"citizenship": null,
"idNumber": null,
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"pepSanctionMatch": null
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": null,
"validUntil": null,
"state": null
},
"additionalVerifiedData": {
"officialDatabaseVerification": {
"curp": {
"matchData": {
"dateOfBirth": "MATCH",
"fullName": "MATCH",
"gender": "NO_INPUT"
},
"validations": {
"processing": {
"result": "success"
},
"curpIsValid": {
"result": "success"
},
"curpHasRiskFactors": {
"result": "not_applicable"
},
"matching": {
"result": "sucess"
}
},
"registryResponse": {
"curp": "VISH560427MSRLNL06",
"paternalSurname": "VILLA",
"maternalSurname": "SANCHES",
"names": "GLORIA",
"gender": "MUJER",
"dob": "27/04/1956",
"nationality": "MEXICO",
"supportingDocument": "1",
"registrationEntity": "SONORA",
"registrationStateNumber": null,
"registrationMunicipalityKey": null,
"page": null,
"tome": null,
"book": null,
"minutesNumber": "02203",
"crip": "string",
"registrationEntity2": "HERMOSILLO",
"registrationYear": "1956",
"foreignRegistrationNumber": "string",
"letterFolio": "string",
"birthStateKey": "SONORA",
"issueEntityKey": "SONORA",
"curpStatus": "RNC",
"certificateFolio": "string"
}
}
}
},
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved Mexican INE biometric database check with facial matching results
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": "SARAH",
"lastName": "MORGAN",
"citizenship": null,
"idNumber": "123456789",
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"pepSanctionMatch": null
},
"document": {
"number": "MORGA753116SM9IJ",
"type": "DRIVERS_LICENSE",
"country": "US",
"validFrom": null,
"validUntil": null,
"state": null
},
"additionalVerifiedData": [
{
"ineBiometricValidation": {
"faceMatch": true,
"faceMatchPercentage": 89,
"responseStatus": "success"
}
}
],
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved Mexican INE voter registry database verification with data matching results
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": null,
"lastName": null,
"citizenship": null,
"idNumber": null,
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"pepSanctionMatch": null
},
"document": {
"number": "123456789M00000000",
"type": null,
"country": null,
"validFrom": null,
"validUntil": null,
"state": null
},
"additionalVerifiedData": {
"officialDatabaseVerification": {
"ine": {
"matchData": {
"dateOfBirth": "MATCH",
"fullName": "MATCH",
"gender": "NO_INPUT"
},
"validations": {
"processing": {
"result": "success",
"reasons": null
},
"ineCardIsValid": {
"result": "success",
"reasons": null
},
"ineIsValidForVoting": {
"result": "success",
"reasons": null
},
"matching": {
"result": "sucess"
}
},
"registryResponse": {
"electorKey": "GOMZJN89041509H300",
"issueNumber": "3",
"registrationYear": "2010",
"issueYear": "2018",
"validity": "31 de diciembre de 2028",
"ocr": "0876543210987",
"cic": "IDMEX2023456789012",
"federalDistrict": "4"
}
}
}
},
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved proof of address with address matching results between document and reference data
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": "SARAH MORGAN",
"lastName": null,
"citizenship": null,
"idNumber": null,
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"addresses": [
{
"fullAddress": "23 Willowbrook Lane, Ashford, Kent CT19 8NP, UK"
}
],
"pepSanctionMatch": null
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": "2023-11-25",
"validUntil": null,
"state": null
},
"additionalVerifiedData": {
"proofOfAddress": {
"documentType": "UTILITY_BILL",
"fullName": "John Smith",
"fullAddress": "23 Willowbrook Lane, Ashford, Kent CT19 8NP, UK",
"issueDate": "2025-09-01",
"nameMatch": null,
"nameMatchPercentage": null
},
"addressMatching": {
"addresses": [
{
"fullAddress": "23 Willowbrook Lane, Ashford, Kent CT19 8NP, UK",
"parsedAddress": {
"city": "New York",
"unit": null,
"state": "NY",
"street": "Main Street",
"country": "USA",
"postcode": "10001",
"houseNumber": "123"
}
},
{
"fullAddress": "23 Willowbrook Lane, Ashford, Kent CT19 8NP, United Kingdom",
"parsedAddress": {
"city": "New York",
"unit": null,
"state": "New York",
"street": "Main St",
"country": "United States",
"postcode": "10001",
"houseNumber": "123"
}
}
],
"result": true,
"matchThreshold": 80,
"matchPercentage": 90
}
},
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved proof of address with parsed address components and validation checks
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": "SARAH MORGAN",
"lastName": null,
"citizenship": null,
"idNumber": null,
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"addresses": [
{
"fullAddress": "23 Willowbrook Lane, Ashford, Kent CT19 8NP, UK"
}
],
"pepSanctionMatch": null
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": "2023-11-25",
"validUntil": null,
"state": null
},
"additionalVerifiedData": {
"proofOfAddress": {
"documentType": "ELECTRICITY_BILL",
"nameMatch": null,
"nameMatchPercentage": null,
"addressValidationResult": {
"components": {
"plausibleFullAddress": "23 Willowbrook Lane, Ashford, Kent CT19 8NP, UK",
"city": "Ashford",
"unit": null,
"state": null,
"street": "Willowbrook Lane",
"country": "UK",
"postcode": "CT19 8NP",
"houseNumber": "23"
},
"addressType": "residential",
"validations": {
"countryExists": {
"result": "skipped"
}
}
}
}
},
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved proof of address verification with name matching results and document type info
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": "SARAH MORGAN",
"lastName": null,
"citizenship": null,
"idNumber": null,
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"pepSanctionMatch": null,
"addresses": [
{
"fullAddress": "23 Willowbrook Lane, Ashford, Kent CT19 8NP, UK"
}
]
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": "2023-11-25",
"validUntil": null,
"state": null
},
"additionalVerifiedData": [
{
"proofOfAddress": {
"nameMatch": true,
"nameMatchPercentage": 89,
"documentType": "UTILITY_BILL"
}
}
],
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved proof of address with fraud detection, name matching results and document type info
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": "SARAH MORGAN",
"lastName": null,
"citizenship": null,
"idNumber": null,
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"pepSanctionMatch": null,
"addresses": [
{
"fullAddress": "23 Willowbrook Lane, Ashford, Kent CT19 8NP, UK"
}
]
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": "2023-11-25",
"validUntil": null,
"state": null
},
"additionalVerifiedData": [
{
"proofOfAddress": {
"nameMatch": true,
"nameMatchPercentage": 89,
"documentType": "UTILITY_BILL",
"fraud": {
"riskLevel": "HIGH_RISK",
"reason": "PDF_PROCESSED_BY_EDITOR",
"reasonDescription": "Document was processed using editing software.",
"indicators": []
}
}
}
],
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved selfie-to-selfie biometric comparison with strong match result
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": "SARAH",
"lastName": "MORGAN",
"citizenship": null,
"idNumber": null,
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"pepSanctionMatch": null
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": null,
"validUntil": null,
"state": null
},
"additionalVerifiedData": {
"faceMatch": "strong_match"
},
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Abandoned session started but not completed by end-user
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": null,
"decisionTime": null,
"code": 9121,
"vendorData": null,
"endUserId": null,
"status": "abandoned",
"reason": null,
"reasonCode": null,
"person": {
"firstName": null,
"lastName": null,
"citizenship": null,
"idNumber": null,
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"pepSanctionMatch": null
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": null,
"validUntil": null,
"state": null
},
"additionalVerifiedData": [],
"comments": []
},
"technicalData": {
"ip": null
}
}Declined verification due to expired document
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:06:15Z",
"code": 9102,
"vendorData": null,
"endUserId": null,
"status": "declined",
"reason": "Document expired",
"reasonCode": 102,
"person": {
"firstName": null,
"lastName": null,
"citizenship": null,
"idNumber": null,
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"pepSanctionMatch": null
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": null,
"validUntil": null,
"state": null
},
"additionalVerifiedData": [],
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Expired session with no end-user submission before timeout
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": null,
"decisionTime": "2024-01-08",
"code": 9104,
"vendorData": null,
"endUserId": null,
"status": "expired",
"reason": null,
"reasonCode": null,
"person": {
"firstName": null,
"lastName": null,
"citizenship": null,
"idNumber": null,
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"pepSanctionMatch": null
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": null,
"validUntil": null,
"state": null
},
"additionalVerifiedData": [],
"comments": []
},
"technicalData": {
"ip": null
}
}Resubmission requested due to unclear document image
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:06:15Z",
"code": 9103,
"vendorData": null,
"endUserId": null,
"status": "resubmission_requested",
"reason": "Document image unclear",
"reasonCode": 201,
"person": {
"firstName": null,
"lastName": null,
"citizenship": null,
"idNumber": null,
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"pepSanctionMatch": null
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": null,
"validUntil": null,
"state": null
},
"additionalVerifiedData": [],
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}Approved verification with US credit bureau and identity graph database validation results
{
"status": "success",
"verification": {
"id": "12df6045-3846-3e45-946a-14fa6136d78b",
"attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8",
"acceptanceTime": "2024-01-01",
"submissionTime": "2024-01-01T00:05:30Z",
"decisionTime": "2024-01-01T00:07:45Z",
"code": 9001,
"vendorData": "1234567890",
"endUserId": "c1de400b-1877-4284-8494-071d37916197",
"status": "approved",
"reason": null,
"reasonCode": null,
"person": {
"firstName": "SARAH",
"lastName": "MORGAN",
"citizenship": null,
"idNumber": "123456789",
"gender": null,
"dateOfBirth": null,
"yearOfBirth": null,
"placeOfBirth": null,
"nationality": null,
"address": [
{
"fullAddress": "123 Main St, New York, New York 10001, United States"
}
],
"pepSanctionMatch": null
},
"document": {
"number": null,
"type": null,
"country": null,
"validFrom": null,
"validUntil": null,
"state": "NY"
},
"additionalVerifiedData": [
{
"validationResults": [
{
"registryName": "USA - Credit + US Identity Graph (US15)",
"firstName": "MATCH",
"lastName": "MATCH",
"dateOfBirth": "NO_INPUT",
"address": "PARTIAL_MATCH",
"city": "MATCH",
"state": "MATCH",
"zip": "MATCH",
"idNumber": "NO_DATA"
}
]
}
],
"comments": []
},
"technicalData": {
"ip": "192.158.1.38"
}
}API request status
Verification request decision object. null if decision is not available yet.
UUID v4 which identifies the verification session.
UUID v4 of the attempt which received a status (as shown in verification.status field).
Timestamp of when the session was generated.
As combined ISO 8601 date and time in UTC, YYYY-MM-DDTHH:MM:SSS+Timezone Offset.
Timestamp of when the session was submitted.
As combined ISO 8601 date and time in UTC, YYYY-MM-DDTHH:MM:SSSSSS+Timezone Offset.
Timestamp of when the session received a decision.
As combined ISO 8601 date and time in UTC, YYYY-MM-DDTHH:MM:SSS+Timezone Offset.
Human readable description of the verification session status
Verification session status code.
See Verification session status codes (table) for more info.
The unique identifier that you created for your end-user. It can be
max 1,000 characters long and contain only non-semantic data that can
not be resolved or used outside your systems or environments. Veriff
returns it unmodified in webhooks and API response payloads, or as
null if not provided.
The UUID that you created for your end-user, that can not be
resolved or used outside your systems or environments. Veriff returns
it unmodified in webhooks and API response payloads, or as null if
not provided.
Human readable description of a failed verification reason.
Reason code of a failed verification. See the Granular reason codes (table) for more info.
Person's first name.
null if data not available.
Person's last name.
null if data not available, or when all the name data is
populated to the person.firstName or the optional person.fullName field.
National identification number.
null if data not available.
Person's gender.
null if data not available.
Person's date of birth.
null if data not available.
Person's year of birth.
null if data not available.
Person's place of birth.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
null if data not available.
Person's nationality, in capital letters.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
null if data not available..
Address data from the document as array of strings.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Address as single string.
Object with parsed fullAddress.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration (e.g., UK DIATF solution; or the Proof of Address Address Matching solution).
Any human settlement, including cities, towns, villages, hamlets, localities, etc.
Boroughs or districts within a city that serve some official purpose e.g. "Brooklyn" or "Hackney" or "Bratislava IV".
Sovereign nations and their dependent territories, as ISO country code.
Informal subdivision of a country without any political status.
Numbered/lettered entrance.
Name of the venue or the building.
External (street-facing) building number.
Named islands e.g., "Maui".
Expressions indicating a floor number e.g., "3rd Floor", "Ground Floor", etc.
Phrases like "in", "near", etc. used after a category phrase to help with parsing queries like "restaurants in Brooklyn".
Name of the street(s).
Post office box, typically found in non-physical (mail-only) addresses.
Postal codes used for mail sorting.
Numbered/lettered staircase.
A first-level administrative division. For example, Scotland, Northern Ireland, Wales, and England in the UK are mapped to "state" as well (convention used in OSM, GeoPlanet, etc.)
Usually a second-level administrative division or county.
Usually an unofficial neighbourhood name like "Harlem", "South Bronx", or "Crown Heights".
An apartment, unit, office, lot, or other secondary unit designator.
Currently only used for appending "West Indies" after the country name, a pattern frequently used in the English-speaking Caribbean e.g. "Jamaica, West Indies".
Person's full name.
Optional, present only when doing the Indian Aadhaar cards or Brazilian ID cards verification.
Object containing person's name components extracted from the document.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Person's title extracted from the document, e.g., "MR", "MS".
null when no title data present on the document.
Person's middle name extracted from the document, from a dedicated field on the document or document barcode results.
null when the first name has no suffix according to barcode data.
The field is not sent when the document has no dedicated field or barcode.
Person's first name extracted from the document and stripped
from all components like middleName or firstNameSuffix.
Person's first name suffix. null when the first name has no suffix
according to barcode data.
The field is not sent when the document has no barcode.
Legacy field, may return incorrect results, should be ignored.
MX citizen's identifier (Identificador del Ciudadano) aka INE identification number.
Optional, present only if Mexican INE identity documents are processed. Part of the legacy MX INE database verification.
MX voter's card identifier (OCR) aka IFE identification number.
Optional, present only if Mexican IFE identity documents are processed. Part of the legacy MX INE database verification.
Occupation data from the document.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Employer's name from the document.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Foreigner status field from the document.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Additional name from the document.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Person's title extracted from the document.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Person's electoral number extracted from the document.
Optional, currently present only for Mexican registry checks.
Person's eye color data extracted from the document.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Person's hair color data extracted from the document.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Person's height data extracted from the document.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Person's weight data extracted from the document.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Always returns null
Document number, [a-zA-Z0-9] characters only.
null if data not available.
Document type.
null if data not available.
Document issuing country, in capital letters.
Data extracted from the document's remarks field.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Document issuing state, in capital letters.
null when the state data is not present on the document.
Date from when the document is valid
Date until when the document is valid.
Contains additional data about the particular document type.
Optional, present only if Document Insights solution has been enabled for your integration.
Indicates if the document contains a contactless chip (NFC).
Indicates the first issue date of the identity document template.
Indicates the last issue date of the identity document template.
Indicates the version of the US National Institute of Standards and Technology guidelines.
Indicates if the document is a digital template identity document.
Indicates if the driving permit is different from the standard driver's licence (e.g. it is a learner's license, temporary driver's license, permit to drive boats).
Indicates if the document is issued to a military personnel/staff or personnel's family.
Indicates if the document is a temporary identity document.
Indicates if it is a document that is issued exclusively to asylum seekers or refugees.
Indicates if the document is under the standards of International Civil Aviation Organization.
Indicates if the identity card is not a national ID card (e.g., it is a social security card, tax ID, electoral ID).
Indicates the legal status of the identity document in the country of
issuance. One of primary, secondary, tertiary, indicating to what extent
the document is accepted as legal proof of identity.
Indicates if the document has properties that can increase the chance of document tampering.
Place where document was issued.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Date of document first issue.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Document issue number.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Document issuing authority.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Indicates that biometric document data has been successfully decoded.
Optional, present only if NFC validation has been enabled for your integration.
Type of the residence permit type from the document.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Indicates that the portrait image is visible in the session and its quality is sufficient to perform verification.
Optional, present only if checking for this feature has been enabled for your integration.
Indicates that the signature is present on the document and is readable to perform the verification.
Optional, present only if checking for this feature has been enabled for your integration.
Person's INE (Mexican voter's registry) identifier number.
Optional, present only if Mexican registry checks have been enabled for your solution and if this information appears on the document.
Additional optionally verified data. Empty {} when no additional data has been verified.
When present, its contents depend on your integration configuration.
Driver's license number.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Indicates the driver's license category/ies.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Date when the driving license category was obtained (valid from).
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Driving license category expiry date (valid until).
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
An integer representing the estimated age.
Optional, present only if the Age Estimation feature has been enabled for your integration.
A float representing the estimated gender. Values closer to 0.0 indicate 'male', values closer to 1.0 indicate 'female'.
Optional, present only if gender estimation feature has been enabled for your integration.
Object containing data from the Proof of Address solution extractions and checks.
Optional, present only if Proof of Address solution has been enabled for your integration.
Indicates if the name on the Proof of Address document matches the name from the initial request data.
null if the check could not be completed.
Indicates the level of similarity the matched names have, in the range of 0.00-100.00.
null if the check could not be completed.
Indicates the type of the proof of address document. See Proof of Address -> Acceptable document types section for more info.
null if the check could not be completed.
Proof of Address document issue date
Object with data about document integrity.
Optional, present only if Proof of Address Fraud Validation has been enabled for your PoA integration.
Indicates the risk level.
null if the check was not executed or failed.
Short description indicating the reason behind the risk level.
null if the check was not executed or failed.
Human readable explanation of the data in the reason field.
null if the check was not executed or failed.
Array of strings listing the factors that influenced the risk assessment.
Empty if the check was not executed or failed.
Contains data that has been found about the extracted address.
Optional, present only only when PoA Address Validation feature has been enabled for your PoA integration.
Contains extracted address components
Full address as a string, containing extracted and found data.
Any human settlement, including cities, towns, villages, hamlets, localities, etc.
An apartment, unit, office, lot, or other secondary unit designator.
A first-level administrative division.
Street name
Sovereign nations and their dependent territories (ISO 3166).
Postal codes used for mail sorting.
External (street-facing) building number.
Indicates if the address is of a residential or business premise, or it is a PO box.
null if the address validation feature was has not been enabled, or if no data was sent.
Contains country validation result data.
Indicates if the validation was able to verify the country.
Indicates the result of country validation or if it was skipped.
Contains all address matching validation results.
Optional, present only when PoA Address Matching feature has been enabled for your PoA integration.
Array of exactly 2 address objects - first from initData, second from PoA document. The example displays one array.
Original full address string as provided/extracted.
Google Maps API parsed address components
Parsed city name.
Parsed partment/unit number.
Parsed state/province.
Parsed street name (premise).
Parsed country name.
Parsed postal/ZIP code.
Parsed house/building number.
Indicates whether addresses match based on threshold.
Configured matching percentage threshold.
Indicates matching percentage.
Indicates the result of the reference image and selfie matching.
Optional, present only if Selfie2Selfie Biometric Verification has been enabled for your integration.
Process number (e.g., "Trámite №") from the document.
Optional, present only if this information appears on the document and this data extraction add-on has been enabled for your integration.
Data that has been optionally verified for the US Database Verification session or some other Match Database Verification session, depending on your integration.
Empty if no additional data was verified.
Name of the registry.
Indicates the match level of person's first name data.
Indicates the match level of person's last name data.
Indicates the match level of person's date of birth data.
Indicates the match level of person's address data.
Indicates the match level of person's address data, specifically the city.
Indicates the match level of person's address data, specifically the state.
Indicates the match level of person's address data, specifically the zip code (post code).
Indicates the match level of person's identity number or SNN number data.
Indicates the match level of person's phone number data.
Registry validation check object, currently available for Colombian registries.
Optional, present only when the registry validation check has been enabled for your integration.
Country of the registry, in capital letters.
Name of the registry
Similarity of the full name in the registry to the full name in the document.
Indicates if the document is valid in the registry.
Indicates if the person is alive according to the registry.
Biometric registry validation container.
Optional, present only if the solution has been enabled for your integration.
Results for a specific country. The key is an ISO 3166-1 Alpha-2 country code (e.g., BR, US, AR).
Currently available only for Brazilian CPF Biometric Database Check and present only when this solution has been enabled for your integration.
First name match result.
null if first name match validation was not enabled or the check could not be completed.
Last name match result.
null if last name match validation was not enabled or the check could not be completed.
Date of birth match result.
null if date of birth match validation was not enabled or the check could not be completed.
Facial biometric match result.
null if selfie not sent or the check could not be completed.
Brazilian individual taxpayer registry (CPF) validation check object. This is the non-biometric CPF validation solution.
Optional, present only if the non-biometric Brazilian CPF validation has been enabled for your integration.
Status of the entry in the registry.
CPF is cancelled indicates that the entry was a duplicate.
Cancelled craft indicates that the entry was cancelled due to reasons other than being a duplicate.
Brazilian individual taxpayer registry (CPF) number of the person.
Person's name in the CPF.
Person's date of birth in the CPF.
Person's date of death in the CPF.
Main container for Cadastro Único Database Verification results (checks if the person is registered in government social assistance programs).
Optional, present only if Brazilian Cadastro Único Verification has been enabled for your integration.
Contains validation rule results.
Indicates if registry processing was successful.
Validation outcome.
Explanations for when the validation failed.
null or empty if result value is success.
Validates input data format (CPF number and date of birth).
Validation outcome.
Explanations for when the validation failed.
null or empty if result value is success.
Checks if the end-user is NOT receiving BCP benefit (failure means IS receiving).
Validation outcome.
Explanations for when the validation failed.
null or empty if result value is success.
Checks if the end-user is NOT receiving Bolsa Familia (failure means IS receiving).
Validation outcome
Explanations for when the validation failed.
null or empty if result value is success.
Checks if the end-user is NOT receiving fishermen insurance (failure means IS receiving).
Validation outcome.
Explanations for when the validation failed.
null or empty if result value is success.
Checks if the end-user is NOT in general registry (failure means IS registered).
Validation outcome.
Explanations for when the validation failed.
null or empty if result value is success.
Checks if the end-user is NOT receiving emergency aid (failure means IS receiving).
Validation outcome.
Explanations for when the validation failed.
null or empty if result value is success.
Contains detailed benefit information from government registries.
Continuous Cash Benefit details.
Brazilian state code where the benefit is registered.
Unique benefit identification number.
Indicates whether the end-user was found in BCP registry.
Social Identification Number of beneficiary.
Reference period for data.
Competence month for payment.
Monetary value of benefit installment.
City where the beneficiary resides.
Indicates if the benefit was court-ordered.
Bolsa Familia program details.
Quadro Social e Administrativo indicator, indicating if the beneficiary is registered as a partner or administrator of a business.
Indicates whether benefit is currently active.
Date of last benefit payment.
Flags data inconsistencies in record.
Date user first received benefit.
Value of last installment paid.
Payment history summary for last year.
Details of last payment method.
Indicates whether the end-user ever received this benefit.
Current enrollment status.
Had formal employment in last 5 years.
Artisanal fishermen insurance details.
Shows whether the end-user was found in Seguro Defeso registry.
CPF number of the beneficiary.
NIS number of the beneficiary.
Full name of the beneficiary.
State of the beneficiary.
IBGE municipality code.
Municipality name.
Reference month for benefit.
Amount received for installment.
RGP fishing registration number.
Indicates if the person received both benefits in same period.
Emergency aid details.
State where aid was registered.
Monetary value of aid installment.
Remarks about benefit status.
Specific installment number.
City where the beneficiary resides.
Category of the beneficiary.
Whether the end-user was found in the Emergency Aid registry.
Month when the funds became available.
Municipality code.
Brazilian ProBet registry verification results (checks against databases of politically exposed persons (PEPs), artists, influencers, and betting administration registries).
Optional, present only if Brazilian ProBet Verification has been enabled for your integration.
ProBet validation results container.
Validation rule results.
Validation outcome
Explanations for when the validation failed.
null or empty if result value is success.
User data format validation.
Validation outcome.
Explanations for when validation failed.
null or empty if result was success.
Checks that the end-user is NOT on the Betting Administration database.
failure means that IS on the database.
Validation outcome.
Explanations for when validation failed.
null or empty if result was success.
Checks that the end-user is NOT on the ProBet database.
failure means that IS on the database.
Validation outcome.
Explanations for when validation failed.
null or empty if result was success.
Detailed registry data.
Politically exposed person (PEP) information.
Full name of the PEP.
Public office or role held.
Government body or organization.
Role start date.
Role end date.
PEP validity date.
Artist/public figure information.
Brazilian Tax ID.
Legal name.
Stage or public name.
Profession or role.
Betting administration registry information.
Indicates whether found in PIA registry.
Company tax identification number.
Legal company name.
Business category.
Digital influencer information.
Social media name.
Primary social media URL.
Influence category.
The final computed result based on all the data above.
Indicates whether the end-user is allowed to bet.
Contains database verification results.
Optional, present only if INE Database Verification and/or CURP Database Verification have been enabled for your integration,
Shows how different end-user data types that were sent as initData or extracted from the document match the data in the registry.
Optional, present only when end-user data matching validation is enabled for your integration.
MATCHmeans that the input data matches registry dataNO_MATCHmeans the input data does not match registry dataNO_INPUTmeans no data was provided for the fieldNO_DATAmeans the registry did not contain any info for this field
Indicates the match level of person's gender data from initData or the document against the registry data.
Indicates the match level of person's date of birth data from initData or the document against the registry data.
Indicates the match level of person's full name data from initData or the document against the registry data.
Contains validation check results.
Confirms that the INE credential exists and data matches.
Indicates if the request was properly processed.
One of success, failure (there was an error when processing the request),
not_applicable (processing check was not configured) or skipped.
Additional information about the validation result.
Not sent if result: success.
Verifies active voting rights.
Indicates if the request was properly processed.
One of success, failure (there was an error when processing the request),
not_applicable (processing check was not configured) or skipped.
Additional information about the validation result.
Not sent if result: success.
Processing validation result.
Indicates if the request was properly processed.
One of success, failure (there was an error when processing the request),
not_applicable (processing check was not configured) or skipped.
Additional information about the validation result.
Not sent if result: success.
Optional, present only when the input data matching validation has
been enabled for your integration (matchData object is part of payload).
Always success, irrespective of matchData results.
Detailed information from the Mexican electoral registry.
Fields below are optional and might not be present if the data is null from the provider.
CIC (Código de Identificación de la Credencial) aka credential identification code.
Voter key (Clave de Elector) assigned to the credential holder.
Federal electoral district number.
The issue/emission number of the credential (1-9 indicating how many times the credential has been reissued).
Year the current credential was issued.
Expiration date of the credential.
OCR (Optical Character Recognition) code from the credential.
Year the person was registered in the electoral system.
Shows how different end-user data types that were sent as initData or extracted from the document match the data in the registry.
Optional, present only when end-user data matching validation is enabled for your integration.
MATCHmeans that the input data matches registry dataNO_MATCHmeans the input data does not match registry dataNO_INPUTmeans no data was provided for the fieldNO_DATAmeans the registry did not contain any info for this field
Indicates the match level of person's gender data from initData or the document against the registry data.
Indicates the match level of person's date of birth data from initData or the document against the registry data.
Indicates the match level of person's full name data from initData or the document against the registry data.
Contains validation check results
Indicates processing validation result.
Indicates if the request was properly processed.
One of success, failure (there was an error when processing the request),
not_applicable (processing check was not configured) or skipped.
Additional information about the validation result.
Not sent if result: success.
CURP validity validation result.
Indicates if the request was properly processed.
One of success, failure (there was an error when processing the request),
not_applicable (processing check was not configured) or skipped.
Additional information about the validation result.
Not sent if result: success.
Risk factors validation result.
Indicates if the request was properly processed.
One of success, failure (there was an error when processing the request),
not_applicable (processing check was not configured) or skipped.
Additional information about the validation result.
Not sent if result: success.
Indicates if the end-user's data from initData or document extraction could be matched against the data in registry.
Always success, irrespective of matchData results.
Object containing detailed information retrieved from the Mexican government registry.
Fields below are optional and might not be present if the data is null from the provider.
The validated CURP number.
Person's paternal surname from the registry.
Person's maternal surname from the registry.
Person's given name(s) from the registry.
Person's gender from the registry.
Date of birth from the registry.
Person's nationality.
Type of supporting document used for CURP registration.
Entity where the person was registered.
State indicator where the person was registered.
Municipality indicator where the person was registered.
Page number from birth certificate (if applicable).
Tome number from birth certificate (if applicable).
Book number from birth certificate (if applicable).
Minutes number from civil registry.
CRIP identifier (if applicable).
Secondary registration entity.
Year of registration.
Foreign registration number.
Letter folio from registration.
State of birth code.
Entity that issued the CURP.
Current status of the CURP.
Certificate information.
INE Biometric Database Verification check object.
Optional, present only if INE Biometric Database Validation has been enabled for your integration.
Indicates if the person's selfie image is a match with their image in the registry.
This decision is made based on the value returned in faceMatchPercentage (see below).
null if the check could not be completed.
Indicates the level of similarity the system thinks the matched images have, in the range of 0-100. Values >85 indicate a match; values <85 indicate that images do not match.
null if the check could not be completed.
Indicates the response received from the service provider.
null if the check could not be completed.
Data about risk score.
Optional, present only Fraud Intelligence Package has been enabled for your integration.
A float in the range of 0.0-1.0. Numerical value representing the overall risk associated with the session. Lower score indicates more confidence in that the session is genuine.
Note: in the Veriff Customer Portal, the range is shown as 1-100.
Array of risk labels related to the session. Optional, present only Fraud Intelligence Package has been enabled for your integration.
Name of the risk label.
Log in to Customer Portal to see the Risk Insights and Crosslinks article in Veriff Knowledge Base for more info about labels.
Category of the risk label
Array of verification session IDs that are referenced to the particular risk label.
Object containing data about the biometric authentication. Optional, present only when using the Biometric Authentication solution.
Refers to the verification session ID which face matched.
Refers to the verification session vendorData which the face matched.
Refers to the verification session endUserId which the face matched.
Lists the results of different checks that were made to verify the end-user.
Data is shown as key-value pairs. The key represents the check name and the value represents the check result.
Log in to Veriff Customer Portal to see a comprehensive webhook payload with possible values.
Always returns empty array.
Technical data object
IP of the device from which the verification was made.
Bad request
Unauthorized
Session not found
Internal server error
Changelog
Date | Description |
|---|---|
Mar 9, 2026 | Documentation updated: parent categories rearranged, intro section expanded, request and response examples added |
Feb 16, 2025 |
|
Feb 10, 2025 | - - - |
Dec 16, 2025 | New objects added to - - - Data type of |
Nov 27, 2025 |
|
Nov 19, 2025 | INE Database Verification and CURP Database verification info added to |
Nov 14, 2025 | Proof of Address info updated: |
Oct 3, 2025 | The ISO 8601 format and example of |
Oct 2, 2025 | New prarameters
|
Sep 11, 2025 | New optional object added: |
Aug 19, 2025 | Typo fixed in parameter name: |
Aug 6, 2025 | Response headers added |
Jul 23, 2025 | New category name added to |
Jul 22, 2025 | New fields added to: - - |
May 21, 2025 | Updated the note about response payload when there is no decision yet |
May 19, 2025 |
|
May 2, 2025 |
|
Aprl 7, 2025 |
Description of |
Mar 12, 2025 | Documentation publishedSelfie2Selfie Biometric Verification |