> ## Documentation Index > Fetch the complete documentation index at: https://devdocs.veriff.com/llms.txt > Use this file to discover all available pages before exploring further. # Decision data > ### 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 `verification` field in the response: - `null` = decision not yet available, try again later - object = decision is ready with final results ##### Decision status codes - `9001` - Approved: Verification successful - `9102` - Declined: Verification failed - `9103` - Resubmission requested: Additional attempt needed - `9104` - Expired: Session expired before completion - `9121` - Abandoned: Session started but not completed - See the complete [verification session status codes table](https://devdocs.veriff.com/docs/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 `null` values before processing. #### Implementation notes - This endpoint requires session-level [HMAC signature](https://devdocs.veriff.com/docs/hmac-authentication-and-endpoint-security#public-api-v1) authentication - Handle `null` values gracefully. - Use the `code` field for programmatic decision handling (9001=approved, etc.) - Always ensure that you use the correct API URL to send requests. See the [API URL section](https://devdocs.veriff.com/apidocs/veriff-public-api-guides#api-url) 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](https://devdocs.veriff.com/apidocs/veriff-public-api-guides#backwards-compatible-changes) requirements. ## OpenAPI ````json GET /v1/sessions/{id}/decision { "openapi": "3.0.0", "info": { "title": "Veriff Public API", "version": "1.0.0" }, "servers": [ { "url": "https://example-base-url" } ], "paths": { "/v1/sessions/{id}/decision": { "get": { "summary": "Decision data", "description": "### Returns verification session decision, extracted document data, database matching results, and risk assessment outcomes\n\n#### When to use this endpoint\n\n- To get the session decision (for both completed sessions and sessions\nthat expired/were abandoned)\n- For polling when webhook delivery fails or is not configured\n\n#### Decision availability\n\n##### Decision timing\n - Results are typically available within seconds to minutes after session completion, depending on:\n - Verification solution type (automated vs manual review)\n - Document complexity and quality\n - Additional checks enabled (e.g., AML screening, database validation)\n\n##### Session status vs decision\n- The session can be in \"submitted\" status while the decision is still being processed. Check the `verification` field in the response:\n - `null` = decision not yet available, try again later\n - object = decision is ready with final results\n\n##### Decision status codes\n\n- `9001` - Approved: Verification successful\n- `9102` - Declined: Verification failed\n- `9103` - Resubmission requested: Additional attempt needed\n- `9104` - Expired: Session expired before completion\n- `9121` - Abandoned: Session started but not completed\n- See the complete [verification session status codes table](https://devdocs.veriff.com/docs/verification-session-status-codes-table) for detailed descriptions.\n\n#### Response data\n\n- The full payload depends on your integration configuration. Click on the \"Show example\"\nbutton inside the \"Responses\" section to see examples of some solutions' response\npayloads.\n\n#### Null and missing fields\n\n- Fields may be `null`, empty, or omitted depending on integration configuration and data availability:\n - `null` = field is included in payload but has no value (data unavailable, feature disabled, or verification declined/expired)\n - Empty (`{}` or `[]`) = field is included but returned no data (feature enabled but no results)\n - Omitted = field not part of payload (integration configuration or no results returned)\n- Always check field existence and `null` values before processing.\n\n#### Implementation notes\n\n- This endpoint requires session-level [HMAC signature](https://devdocs.veriff.com/docs/hmac-authentication-and-endpoint-security#public-api-v1) authentication\n- Handle `null` values gracefully.\n- Use the `code` field for programmatic decision handling (9001=approved, etc.)\n- Always ensure that you use the correct API URL to send requests. See the [API URL section](https://devdocs.veriff.com/apidocs/veriff-public-api-guides#api-url) for more info.\n- The order of parameters in the real API response can differ from the order you see in this documentation. \n This is expected and part of the [Backwards compatible changes](https://devdocs.veriff.com/apidocs/veriff-public-api-guides#backwards-compatible-changes) requirements.\n", "operationId": "retrieveDecisionData", "tags": [ "Session results" ], "parameters": [ { "name": "id", "required": "true", "in": "path", "description": "Verification session ID.", "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-12d3-a456-426614174000" }, { "name": "X-AUTH-CLIENT", "required": "true", "in": "header", "description": "Your integration's API key (occasionally referred to as \nthe \"Token\", \"API public key\" or \"Publishable key\"). \nRequired for all API requests.\n\nYou can find your API key in the Veriff Customer Portal > Settings > API keys.\n", "schema": { "type": "string" }, "example": "your-api-key" }, { "name": "X-HMAC-SIGNATURE", "required": "true", "in": "header", "description": "Session ID signed with the shared secret key. \nRequired to authenticate the request sender.\n", "schema": { "type": "string" }, "example": "abc123def456ghi789jkl012mno345pqr678stu901vwx234yz" }, { "name": "Content-Type", "required": "true", "in": "header", "description": "Must be set to application/json", "schema": { "type": "string", "enum": [ "application/json" ] }, "example": "application/json" } ], "responses": { "200": { "description": "Response of a successful API call", "headers": { "Content-Type": { "description": "Response content type.", "schema": { "type": "string", "example": "application/json" } }, "X-AUTH-CLIENT": { "description": "API key echoed back in response.", "schema": { "type": "string", "example": "your-api-key" } }, "X-HMAC-SIGNATURE": { "description": "Response body signed with the shared secret key. \nRequired to authenticate the response sender.\n", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecisionResponse" }, "examples": { "age_estimation": { "description": "Approved verification with age and gender estimation", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } }, "bioauth": { "description": "Approved biometric authentication using Veriff's document + selfie IDV", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } }, "biometric_db_verification": { "description": "Approved biometric database check with facial and data matching results, currently only for Brazilian CPF biometric database", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } }, "biometric_liveness": { "description": "Approved biometric liveness check with baseline verification data", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } }, "br_cadastro_db_verification": { "description": "Approved Brazilian Cadastro Único social programs registry verification", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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": "05/12/2022", "dataInconsistency": "false", "firstBenefitDate": "05/12/2022", "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": "01/10/2022", "installmentValueReceived": "1212.00", "fishingRegistrationNumber": "123456", "bolsaFamiliaInsuranceSameDate": "false" }, "auxilioEmergencialBenefit": { "state": "PR", "value": "300,00", "observation": "NAO HA", "installments": "9", "municipality": "CAMBE", "classification": "CADUN NAO BOLSA", "isInRegistry": "true", "availableMonth": "12/2020", "municipalityCode": "1234567" } } } }, "comments": [] }, "technicalData": { "ip": "192.158.1.38" } } }, "br_cpf_validation": { "description": "Approved Brazilian CPF validation with registry data (non-biometric check)", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } }, "br_probet_db_verification": { "description": "Approved Brazilian ProBet gambling exclusion registry verification", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } }, "idv_doc+selfie_or_doc-only": { "description": "Standard identity verification with person and document data.\nThis example applies also for any IDV verification done with \nan AML Screening integration.\n", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } }, "mx_curp_db_verification": { "description": "Approved Mexican CURP population registry database verification with validation results", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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": "success" } }, "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" } } }, "mx_ine_biometric": { "description": "Approved Mexican INE biometric database check with facial matching results", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } }, "mx_ine_db_verification": { "description": "Approved Mexican INE voter registry database verification with data matching results", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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": "success" } }, "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" } } }, "poa_address_matching": { "description": "Approved address matching session showing document and reference data", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } }, "poa_address_validation_address_confirmed": { "description": "Approved address validation session with parsed address components and validation checks", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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": { "status": "CONFIRMED", "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" } } }, "poa_address_validation_address_not_found": { "description": "Failed address validation session where the address was not found (no parsed address components returned, only validation checks)", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "submissionTime": "2024-01-01T00:05:30Z", "decisionTime": "2024-01-01T00:07:45Z", "code": "9102", "vendorData": "1234567890", "endUserId": "c1de400b-1877-4284-8494-071d37916197", "status": "declined", "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": { "status": "NOT_FOUND", "components": null, "addressType": null, "validations": { "countryExists": { "result": "skipped" } } } } }, "comments": [] }, "technicalData": { "ip": "192.158.1.38" } } }, "poa_basic": { "description": "Approved proof of address verification with name matching results and document type info", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } }, "poa_with_fraud": { "description": "Approved proof of address with fraud detection, name matching results and document type info", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } }, "selfie2selfie_biometric": { "description": "Approved selfie-to-selfie biometric comparison with strong match result", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } }, "session_abandoned_generic": { "description": "Abandoned session started but not completed by end-user", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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 } } }, "session_declined_generic": { "description": "Declined verification due to expired document", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } }, "session_expired_generic": { "description": "Expired session with no end-user submission before timeout", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "submissionTime": null, "decisionTime": "2024-01-08T00:00:00Z", "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 } } }, "session_resubmission_generic": { "description": "Resubmission requested due to unclear document image", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } }, "session_with_tag_parameter": { "description": "Session result with the tag parameter", "value": { "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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, "tag": "your_custom_tag_max_64_characters", "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" } } }, "udocs_approved_bank_account_core_features_only": { "description": "Approved [Unstructured Docs](https://devdocs.veriff.com/docs/unstructured-docs)\nsession for bank account ownership\nverification. Shows core features only: document classification,\ndata extraction, and document metadata. No optional add-ons enabled.\n", "value": { "status": "success", "verification": { "id": "f3a8b7c2-d4e1-4f92-a8b3-c5d6e7f8a9b0", "attemptId": "b9c8d7e6-f5a4-4b32-9c8d-7e6f5a4b3c2d", "acceptanceTime": "2026-02-04T11:57:36.495752Z", "submissionTime": "2026-02-04T11:57:43.127728Z", "decisionTime": "2026-02-04T11:58:15.073712Z", "code": "9001", "vendorData": null, "endUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "status": "approved", "reason": null, "reasonCode": null, "person": { "firstName": null, "lastName": null, "fullName": "JUAN MARTINEZ", "citizenship": null, "idNumber": null, "gender": null, "dateOfBirth": null, "yearOfBirth": null, "placeOfBirth": null, "nationality": null, "addresses": [ { "fullAddress": "AV INSURGENTES SUR 2847 PISO 3 COL DEL VALLE BENITO JUAREZ CIUDAD DE MEXICO MEXICO CP 03100" } ], "pepSanctionMatch": null }, "document": { "number": null, "type": "BANK_STATEMENT", "country": "MX", "validFrom": null, "validUntil": null, "state": null }, "additionalVerifiedData": {}, "udocs": { "metadata": { "pageCount": "2" }, "extraction": { "fullName": "JUAN MARTINEZ", "fullAddress": "AV INSURGENTES SUR 2847 PISO 3 COL DEL VALLE BENITO JUAREZ CIUDAD DE MEXICO MEXICO CP 03100", "bankAccountNumber": "84532345", "issueDate": "2024-05-28", "issuer": "Skrill Limited", "currency": "USD" }, "classification": { "documentType": "financial", "documentSubType": "bank_statement", "countryCode": "mx", "language": "es", "issuer": "skrill_limited" } }, "comments": [] }, "technicalData": { "ip": null } } }, "udocs_approved_birth_certificate_verification": { "description": "Approved Unstructured Docs session for\n[Birth certificate verification](https://devdocs.veriff.com/docs/unstructured-docs#birth-certificate-verification)\nuse case.\n", "value": { "status": "success", "verification": { "id": "f3a8b7c2-d4e1-4f92-a8b3-c5d6e7f8a9b0", "attemptId": "b9c8d7e6-f5a4-4b32-9c8d-7e6f5a4b3c2d", "acceptanceTime": "2026-02-04T11:57:36.495752Z", "submissionTime": "2026-02-04T11:57:43.127728Z", "decisionTime": "2026-02-04T11:58:15.073712Z", "code": "9001", "vendorData": null, "endUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "status": "approved", "reason": null, "reasonCode": null, "person": { "firstName": null, "lastName": null, "fullName": "JUAN MARTINEZ", "citizenship": null, "idNumber": null, "gender": "M", "dateOfBirth": null, "yearOfBirth": null, "placeOfBirth": null, "nationality": null, "addresses": null, "pepSanctionMatch": null }, "document": { "number": null, "type": "BIRTH_CERTIFICATE", "country": "MX", "validFrom": null, "validUntil": null, "state": null }, "additionalVerifiedData": {}, "udocs": { "metadata": { "pageCount": "1" }, "extraction": { "fullName": "JUAN MARTINEZ", "documentNumber": "ACT-2024-001234", "countryOfBirth": "MX", "dateOfBirth": "1980-07-05", "fatherFullName": "CARLOS MARTINEZ LOPEZ", "motherFullName": "MARIA ELENA GARCIA RUIZ", "nationality": "MEXICANA", "birthFacility": "HOSPITAL GENERAL DE MEXICO", "placeOfBirthAddress": "CIUDAD DE MEXICO, MEXICO" }, "classification": { "documentType": "government", "documentSubType": "birth_certificate", "countryCode": "mx", "language": "es", "issuer": "registro_civil" } }, "comments": [] }, "technicalData": { "ip": null } } }, "udocs_declined_address_matching_address_validation_enabled": { "description": "Declined [Unstructured Docs](https://devdocs.veriff.com/docs/unstructured-docs)\nsession with Address Matching and\nAddress Validation add-ons enabled. Session declined because\nthe address from the document does not match the address sent\nas initData. Address Validation shows the address extracted from document was\nconfirmed as valid.\n", "value": { "status": "success", "verification": { "id": "f3a8b7c2-d4e1-4f92-a8b3-c5d6e7f8a9b0", "attemptId": "b9c8d7e6-f5a4-4b32-9c8d-7e6f5a4b3c2d", "acceptanceTime": "2026-02-18T13:39:54.401658Z", "submissionTime": "2026-02-18T13:40:22.784253Z", "decisionTime": "2026-02-18T13:41:47.173826Z", "code": "9102", "vendorData": null, "endUserId": null, "status": "declined", "reason": "Addresses do not match", "reasonCode": "573", "person": { "firstName": "JUAN MARTINEZ", "lastName": null, "fullName": "JUAN MARTINEZ", "citizenship": null, "idNumber": null, "gender": null, "dateOfBirth": null, "yearOfBirth": null, "placeOfBirth": null, "nationality": null, "addresses": [ { "fullAddress": "AV INSURGENTES SUR 2847 PISO 3 COL DEL VALLE BENITO JUAREZ CIUDAD DE MEXICO MEXICO CP 03100" } ], "pepSanctionMatch": null }, "document": { "number": null, "type": "BANK_STATEMENT", "country": "MX", "validFrom": "2025-12-09", "validUntil": null, "state": null }, "additionalVerifiedData": { "proofOfAddress": { "addressValidationResult": { "status": "CONFIRMED", "components": { "plausibleFullAddress": "CALLE MADERO 415 INT 5 COL CENTRO CUAUHTÉMOC CIUDAD DE MÉXICO MÉXICO CP 06000", "street": "CALLE MADERO", "city": "CUAUHTÉMOC", "state": "CIUDAD DE MÉXICO", "postcode": "06000", "country": "MÉXICO", "houseNumber": "415", "unit": "INT 5" }, "addressType": "residential", "validations": { "countryExists": { "result": "skipped" } } } }, "addressMatching": { "matchPercentage": "0", "matchThreshold": "80", "result": "false", "addresses": [ { "fullAddress": "AV INSURGENTES SUR 2847 PISO 3 COL DEL VALLE BENITO JUAREZ CIUDAD DE MEXICO MEXICO CP 03100", "parsedAddress": { "street": "AV INSURGENTES SUR", "city": "BENITO JUAREZ", "state": "CIUDAD DE MEXICO", "postcode": "03100", "country": "MEXICO", "houseNumber": "2847", "unit": "PISO 3" } }, { "fullAddress": "CALLE MADERO 415 INT 5 COL CENTRO CUAUHTÉMOC CIUDAD DE MÉXICO MÉXICO CP 06000", "parsedAddress": { "street": "CALLE MADERO", "city": "CUAUHTÉMOC", "state": "CIUDAD DE MÉXICO", "postcode": "06000", "country": "MÉXICO", "houseNumber": "415", "unit": "INT 5" } } ] } }, "udocs": { "metadata": { "pageCount": "1" }, "extraction": { "fullName": "JUAN MARTINEZ", "fullAddress": "CALLE MADERO 415 INT 5 COL CENTRO CUAUHTÉMOC CIUDAD DE MÉXICO MÉXICO CP 06000", "bankAccountNumber": "014180012345678902", "issueDate": "2025-12-09", "issuer": "Santander", "currency": "MXN" }, "classification": { "documentType": "financial", "documentSubType": "bank_statement", "countryCode": "MX", "language": "ES", "issuer": "Santander" }, "validations": { "matchingResults": [ { "type": "full_name", "match": "true", "originalValue": "JUAN MARTINEZ", "extractedValue": "JUAN MARTINEZ", "matchThreshold": "80", "matchPercentage": "100" }, { "type": "occupation", "match": "false", "originalValue": "Engineer", "extractedValue": "", "matchThreshold": "80", "matchPercentage": "0" } ], "documentExpiration": { "isIssueDateInRange": "true" } }, "fraud": { "riskLevel": "HIGH_RISK", "reason": "ILLEGIBILITY", "reasonDescription": "Unreadable document", "indicators": [ "This image appears to have been generated directly from a digital PDF. This is unusual and may suggest an attempt to conceal edits." ] } }, "comments": [] }, "technicalData": { "ip": null } } }, "udocs_declined_all_features_enabled": { "description": "Declined [Unstructured Docs](https://devdocs.veriff.com/docs/unstructured-docs)\nsession with all optional features\nenabled: Classification, Extraction, InitData Matching, Tampering\nCheck (fraud), and Document Expiration. Session declined because\nthe extracted name does not match the name sent as initData.\n", "value": { "status": "success", "verification": { "id": "f3a8b7c2-d4e1-4f92-a8b3-c5d6e7f8a9b0", "attemptId": "b9c8d7e6-f5a4-4b32-9c8d-7e6f5a4b3c2d", "acceptanceTime": "2026-02-04T11:57:36.495752Z", "submissionTime": "2026-02-04T11:57:43.127728Z", "decisionTime": "2026-02-04T11:58:15.073712Z", "code": "9102", "vendorData": null, "endUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "status": "declined", "reason": "Name in initData does not match the document name", "reasonCode": "541", "person": { "firstName": null, "lastName": null, "fullName": "JUAN MARTEENEZ", "citizenship": null, "idNumber": null, "gender": null, "dateOfBirth": null, "yearOfBirth": null, "placeOfBirth": null, "nationality": null, "addresses": [ { "fullAddress": "AV INSURGENTES SUR 2847 PISO 3 COL DEL VALLE BENITO JUAREZ CIUDAD DE MEXICO MEXICO CP 03100" } ], "pepSanctionMatch": null }, "document": { "number": null, "type": null, "country": null, "validFrom": null, "validUntil": null, "state": null }, "additionalVerifiedData": {}, "udocs": { "metadata": { "pageCount": "2" }, "extraction": { "fullName": "JUAN MARTINEZ", "fullAddress": "AV INSURGENTES SUR 2847 PISO 3 COL DEL VALLE BENITO JUAREZ CIUDAD DE MEXICO MEXICO CP 03100", "bankAccountNumber": "84532345", "issueDate": "2024-05-28", "expiryDate": "2025-05-28", "documentNumber": "847293651024738569", "vehicleIdentificationNumber": "1HGBH41JXMN109186", "vehicleRegistrationNumber": "ABC-1234", "occupation": "Driver", "income": "45000", "issuer": "Skrill Limited", "currency": "USD" }, "classification": { "documentType": "financial", "documentSubType": "bank_statement", "countryCode": "mx", "language": "es", "issuer": "skrill_limited" }, "validations": { "matchingResults": [ { "type": "full_name", "match": "true", "originalValue": "JUAN MARTEENEZ", "extractedValue": "JUAN MARTINEZ", "matchThreshold": "80", "matchPercentage": "100" }, { "type": "occupation", "match": "true", "originalValue": "Driver", "extractedValue": "Driver", "matchThreshold": "80", "matchPercentage": "100" }, { "type": "bank_account_number", "match": "true", "originalValue": "AB123456789012345", "extractedValue": "AB123456789012345", "matchThreshold": "100", "matchPercentage": "100" } ], "documentExpiration": { "isIssueDateInRange": "false", "isWithinValidityPeriod": "false" } }, "fraud": { "riskLevel": "HIGH_RISK", "reason": "DIGITAL_MODIFICATION_HIGH_CONFIDENCE", "reasonDescription": "Document contains traces of digital modification, likely with fraudulent intent", "indicators": [ "This document's metadata shows a creation time: 2023-03-31T12:04:01+00:00 and a modification time: 2024-05-29T11:30:26+00:00, suggesting the file was updated after it was first created." ] } }, "comments": [] }, "technicalData": { "ip": null } } }, "us_database": { "description": "Approved verification with US credit bureau and identity graph database validation results", "value": { "status": "success", "verification": { "id": "12df6045-3846-3e45-946a-14fa6136d78b", "attemptId": "00bca969-b53a-4fad-b065-874d41a7b2b8", "acceptanceTime": "2024-01-01T00:00:00Z", "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" } } } } } } }, "400": { "description": "Bad request", "headers": { "Content-Type": { "description": "Response content type.", "schema": { "type": "string", "example": "application/json" } }, "X-AUTH-CLIENT": { "description": "API key echoed back in response.", "schema": { "type": "string", "example": "your-api-key" } }, "X-HMAC-SIGNATURE": { "description": "Response body signed with the shared secret key. Required to authenticate the response sender.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestErrorResponse" } } } }, "401": { "description": "Unauthorized", "headers": { "Content-Type": { "description": "Response content type.", "schema": { "type": "string", "example": "application/json" } }, "X-AUTH-CLIENT": { "description": "API key echoed back in response.", "schema": { "type": "string", "example": "your-api-key" } }, "X-HMAC-SIGNATURE": { "description": "Response body signed with the shared secret key. Required to authenticate the response sender.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedErrorResponse" } } } }, "404": { "description": "Session not found", "headers": { "Content-Type": { "description": "Response content type.", "schema": { "type": "string", "example": "application/json" } }, "X-AUTH-CLIENT": { "description": "API key echoed back in response.", "schema": { "type": "string", "example": "your-api-key" } }, "X-HMAC-SIGNATURE": { "description": "Response body signed with the shared secret key. Required to authenticate the response sender.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundErrorResponse" } } } }, "500": { "description": "Internal server error", "headers": { "Content-Type": { "description": "Response content type.", "schema": { "type": "string", "example": "application/json" } }, "X-AUTH-CLIENT": { "description": "API key echoed back in response.", "schema": { "type": "string", "example": "your-api-key" } }, "X-HMAC-SIGNATURE": { "description": "Response body signed with the shared secret key. Required to authenticate the response sender.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } } } } }, "components": { "schemas": { "DecisionResponse": { "type": "object", "properties": { "status": { "type": "string", "description": "API request status", "example": "success" }, "verification": { "description": "Verification request decision object. `null` if decision is not available yet.\n", "nullable": "true", "allOf": [ { "$ref": "#/components/schemas/DecisionVerification" } ] }, "technicalData": { "description": "Technical data object", "allOf": [ { "$ref": "#/components/schemas/TechnicalData" } ] } }, "required": [ "status", "verification" ] }, "BadRequestErrorResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "fail" ], "example": "fail" }, "code": { "type": "string", "example": "1101" }, "message": { "type": "string", "example": "Validation failed" } }, "required": [ "status", "code", "message" ] }, "UnauthorizedErrorResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "fail" ], "example": "fail" }, "code": { "type": "string", "example": "1101" }, "message": { "type": "string", "example": "Mandatory X-AUTH-CLIENT header containing the API key is missing from the request." } }, "required": [ "status", "code", "message" ] }, "NotFoundErrorResponse": { "type": "object", "required": [ "status", "code", "message" ], "properties": { "status": { "type": "string", "enum": [ "fail" ], "example": "fail" }, "code": { "type": "string", "example": "1101" }, "message": { "type": "string", "example": "Resource not found" } } }, "InternalServerErrorResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "fail" ], "example": "fail" }, "code": { "type": "string", "example": "1101" }, "message": { "type": "string", "example": "Something went wrong" } }, "required": [ "status", "code", "message" ] }, "DecisionVerification": { "type": "object", "properties": { "id": { "type": "string", "description": "UUID v4 which identifies the verification session.", "example": "12df6045-3846-3e45-946a-14fa6136d78b", "format": "uuid" }, "attemptId": { "type": "string", "description": "UUID v4 of the attempt which received a status (as shown in `verification.status` field).", "example": "00bca969-b53a-4fad-b065-874d41a7b2b8", "format": "uuid" }, "acceptanceTime": { "type": "string", "description": "Timestamp of when the session was generated.\n\nAs combined ISO 8601 date and time in UTC. Format: YYYY-MM-DDTHH:MM:SS.sssZ.\n", "format": "date-time", "example": "2024-01-01T10:00:00.123Z" }, "submissionTime": { "type": "string", "description": "Timestamp of when the session was submitted.\n\nAs combined ISO 8601 date and time in UTC. Format: YYYY-MM-DDTHH:MM:SS.ssssssZ.\n", "example": "2024-01-01T00:05:30.123456Z", "nullable": "true" }, "decisionTime": { "type": "string", "description": "Timestamp of when the session received a decision.\n\nAs combined ISO 8601 date and time in UTC. Format: YYYY-MM-DDTHH:MM:SS.sssZ.\n", "format": "date-time", "example": "2024-01-01T00:07:45.456Z", "nullable": "true" }, "status": { "type": "string", "description": "Human readable description of the verification session status", "enum": [ "approved", "declined", "resubmission_requested", "expired", "abandoned" ], "example": "approved" }, "code": { "type": "integer", "description": "Verification session status code.\n\nSee [Verification session status codes (table)](https://devdocs.veriff.com/docs/verification-session-status-codes-table) for more info.\n", "enum": [ "9001", "9102", "9103", "9104", "9121" ], "example": "9001", "format": "integer" }, "vendorData": { "type": "string", "description": "The unique identifier that you created for your end-user. It can be \nmax 1,000 characters long and contain only non-semantic data that can \nnot be resolved or used outside your systems or environments. Veriff \nreturns it unmodified in webhooks and API response payloads, or as \n`null` if not provided.\n", "example": "1234567890", "nullable": "true" }, "endUserId": { "type": "string", "description": "The `UUID` that you created for your end-user, that can not be \nresolved or used outside your systems or environments. Veriff returns \nit unmodified in webhooks and API response payloads, or as `null` if \nnot provided.\n", "format": "uuid", "example": "c1de400b-1877-4284-8494-071d37916197", "nullable": "true" }, "reason": { "type": "string", "description": "Human readable description of a failed verification reason.", "example": "Document not recognized", "nullable": "true" }, "reasonCode": { "type": "integer", "description": "Reason code of a failed verification. See the [Granular reason \ncodes (table)](https://devdocs.veriff.com/docs/granular-reason-codes) for more info.\n", "example": "647", "format": "integer", "nullable": "true" }, "person": { "$ref": "#/components/schemas/DecisionPerson" }, "document": { "$ref": "#/components/schemas/DecisionDocument" }, "tag": { "description": "Custom marker for the session that you set up and passed upon session creation. \nReturned unmodified or as `null` if not provided. Max length 64 characters.\n\nPart of payload only if enabled for your integration.\n", "type": "string", "nullable": "true", "example": "your_custom_tag_max_64_characters" }, "additionalVerifiedData": { "description": "Additional optionally verified data. Empty `{}` when no additional data has been verified.\nWhen present, its contents depend on your integration configuration.\n", "allOf": [ { "$ref": "#/components/schemas/DecisionVerificationAdditionalVerifiedData" } ] }, "udocs": { "description": "Container for [Unstructured Docs](https://devdocs.veriff.com/docs/unstructured-docs)\n(uDocs) features and add-on results.\n\nOptional, present only when the solution has been enabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/UDocsObject" } ] }, "riskScore": { "$ref": "#/components/schemas/DecisionRiskScore" }, "riskLabels": { "description": "Array of risk labels related to the session. Optional, present only Fraud Intelligence\nPackage has been enabled for your integration.\n", "type": "array", "items": { "$ref": "#/components/schemas/DecisionRiskLabel" } }, "biometricAuthentication": { "description": "Object containing data about the biometric authentication. Optional, \npresent only when using the [Biometric Authentication](https://devdocs.veriff.com/docs/biometric-authentication) solution.\n", "allOf": [ { "$ref": "#/components/schemas/BioMetricAuthentication" } ] }, "comments": { "description": "Always returns empty array.", "example": [], "deprecated": "true", "type": "array", "items": { "type": "string" } } }, "required": [ "id", "attemptId", "acceptanceTime", "submissionTime", "decisionTime", "code", "vendorData", "endUserId", "status", "reason", "reasonCode", "person", "document", "additionalVerifiedData", "comments" ] }, "TechnicalData": { "type": "object", "properties": { "ip": { "type": "string", "description": "IP of the device from which the verification was made.\n\nThis field can always be set to `null` in payloads for accounts with data minimisation requirements. \nContact your Solutions Engineer or Veriff Customer Support for info and configuration.\n", "example": "192.158.1.38", "nullable": "true" } }, "required": [ "ip" ] }, "DecisionPerson": { "type": "object", "properties": { "firstName": { "type": "string", "description": "Person's first name.\n\n`null` if data not available.\n", "example": "SARAH", "nullable": "true" }, "lastName": { "type": "string", "description": "Person's last name. \n\n`null` if data not available, or when all the name data is \npopulated to the `person.firstName` or the optional `person.fullName` field.\n", "example": "MORGAN", "nullable": "true" }, "idNumber": { "type": "string", "description": "National identification number.\n\n`null` if data not available.\n", "example": "123456789", "nullable": "true" }, "gender": { "type": "string", "description": "Person's gender. \n\n`null` if data not available.\n", "enum": [ "M", "F" ], "example": "F", "nullable": "true" }, "dateOfBirth": { "type": "string", "description": "Person's date of birth. Format: YYYY-MM-DD.\n\n`null` if data not available.\n", "format": "date", "example": "2001-01-01", "nullable": "true" }, "yearOfBirth": { "type": "string", "description": "Person's year of birth in YYYY format.\n\n`null` if data not available.\n", "example": "2001", "nullable": "true" }, "placeOfBirth": { "type": "string", "description": "Person's place of birth. \n\nOptional, present only if this \ninformation appears on the document and this data\nextraction add-on has been enabled for your integration.\n\n`null` if data not available.\n", "example": "ANYTOWN", "nullable": "true" }, "nationality": { "type": "string", "description": "Person's nationality, in capital letters. \n\nOptional, present only if this \ninformation appears on the document and this data\nextraction add-on has been enabled for your integration.\n\n`null` if data not available..\n", "format": "ISO 3166-1 Alpha-2", "example": "US", "nullable": "true" }, "addresses": { "description": "Address data from the document as array of strings. \n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "nullable": "true", "type": "array", "items": { "$ref": "#/components/schemas/DecisionAddress" } }, "fullName": { "type": "string", "description": "Person's full name. \n\nOptional, present only when doing the Indian Aadhaar cards\nor Brazilian ID cards verification.\n", "example": "SARAH MORGAN", "nullable": "true" }, "nameComponents": { "description": "Object containing person's name components extracted from the document.\n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration. \n", "allOf": [ { "$ref": "#/components/schemas/DecisionNameComponents" } ] }, "pepSanctionMatch": { "type": "string", "description": "Legacy field, may return incorrect results, should be ignored.", "example": "possible match", "nullable": "true" }, "ineIdentifier": { "type": "string", "description": "MX citizen's identifier (Identificador del Ciudadano) aka INE identification number.\n\nOptional, present only if Mexican INE identity documents are processed. Part of the\n[legacy MX INE database verification](https://devdocs.veriff.com/docs/ine-institutio-nacional-electoral-database-verification-guide).\n", "example": "000000101", "nullable": "true" }, "ifeIdentifier": { "type": "string", "description": "MX voter's card identifier (OCR) aka IFE identification number. \n\nOptional, present only if Mexican IFE identity documents are processed. Part of the \n[legacy MX INE database verification](https://devdocs.veriff.com/docs/ine-institutio-nacional-electoral-database-verification-guide).\n", "example": "000000001", "nullable": "true" }, "occupation": { "type": "string", "description": "Occupation data from the document. \n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "example": "Sales Representative", "nullable": "true" }, "employer": { "type": "string", "description": "Employer's name from the document. \n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "example": "Any Company LLC", "nullable": "true" }, "foreignerStatus": { "type": "string", "description": "Foreigner status field from the document. \n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "example": "EXTRANJERO", "nullable": "true" }, "extraNames": { "type": "string", "description": "Additional name from the document. \n\nOptional, present only if this information appears on the document \nand this data extraction add-on has been enabled for your integration.\n", "example": "NOM D'USAGE", "nullable": "true" }, "title": { "type": "string", "description": "Person's title extracted from the document. \n\nOptional, present only if this information appears on the document \nand this data extraction add-on has been enabled for your integration.\n", "example": "DR", "nullable": "true" }, "electorNumber": { "type": "string", "description": "Person's electoral number extracted from the document. \n\nOptional, currently present only for Mexican registry checks.\n", "example": "GMVLMR80070501M100", "nullable": "true" }, "eyeColor": { "type": "string", "description": "Person's eye color data extracted from the document. \n\nOptional, present only if this information appears on the document \nand this data extraction add-on has been enabled for your integration.\n", "example": "BRN", "nullable": "true" }, "hairColor": { "type": "string", "description": "Person's hair color data extracted from the document. \n\nOptional, present only if this information appears on the document \nand this data extraction add-on has been enabled for your integration.\n", "example": "BRN", "nullable": "true" }, "height": { "type": "string", "description": "Person's height data extracted from the document.\n\nOptional, present only if this information appears on the document \nand this data extraction add-on has been enabled for your integration.\n", "example": "5'", "nullable": "true" }, "weight": { "type": "string", "description": "Person's weight data extracted from the document.\n\nOptional, present only if this information appears on the document \nand this data extraction add-on has been enabled for your integration.\n", "example": "093 lb", "nullable": "true" }, "citizenship": { "type": "string", "description": "Always returns `null`", "deprecated": "true", "example": null, "nullable": "true" }, "phoneNumber": { "type": "string", "description": "Person's phone number, allows + and digits.\n\nOptional, available only for digital identity verification solutions.\n\n`null` if data not available.\n", "example": "+1234567890", "nullable": "true" } }, "required": [ "firstName", "lastName", "idNumber", "gender", "citizenship", "dateOfBirth", "yearOfBirth", "placeOfBirth", "nationality", "pepSanctionMatch" ] }, "DecisionDocument": { "type": "object", "properties": { "number": { "type": "string", "description": "Document number, [a-zA-Z0-9] characters only.\n\n`null` if data not available.\n", "example": "MORGA753116SM9IJ", "nullable": "true" }, "type": { "type": "string", "description": "Document type.\n\n`null` if data not available.\n", "example": "DRIVERS_LICENSE", "enum": [ "PASSPORT", "ID_CARD", "RESIDENCE_PERMIT", "DRIVERS_LICENSE", "VISA", "OTHER", "BIRTH_CERTIFICATE", "BANK_STATEMENT", "CREDIT_CARD_BILL", "LOAN_STATEMENT", "MORTGAGE_STATEMENT", "PENSION_STATEMENT", "PROOF_OF_BANK_ACCOUNT", "EMPLOYER_PAYSLIP", "CERTIFICATE_OF_RESIDENCE", "ELECTORAL_REGISTER_ENTRY", "GOVERNMENT_ISSUED_LETTER", "I9_FORM", "RESIDENCE_REGISTRATION", "SOCIAL_INSURANCE", "VEHICLE_REGISTRATION", "CAR_OWNERSHIP_CERTIFICATE", "INHERITANCE_LETTER", "COUNCIL_OR_HOUSING_ASSOCIATION_DOCUMENTATION", "KSA_NATIONAL_ADDRESS_CERTIFICATE", "LANDLORD_LETTER", "LEASE_AGREEMENT", "LEASE_BILL", "RENT_BILL", "RENT_RECEIPT", "RENTAL_AGREEMENT", "RENTAL_CONTRACT", "VEHICLE_INSURANCE_POLICY", "HEALTH_INSURANCE_CARD", "HOME_INSURANCE_POLICY", "INSURANCE_BILL", "INSURANCE_LETTER", "SOLICITORS_LETTER", "NOTARY_LETTER", "CERTIFICATE_OF_NON_TAXATION", "P60_TAX_CERTIFICATE", "PROOF_OF_HOUSING_TAX", "TAX_ASSESSMENT", "TAX_BILL", "TAX_RETURN", "TAX_STATEMENT", "ELECTRICITY_BILL", "GAS_BILL", "INTERNET_BILL", "LAND_LINE_PHONE_BILL", "MOBILE_PHONE_BILL", "COMBINED_UTILITY_BILL", "WATER_BILL" ], "nullable": "true" }, "country": { "type": "string", "description": "Document issuing country, in capital letters.", "example": "ES", "format": "ISO 3166-1 Alpha-2", "nullable": "true" }, "remarks": { "type": "string", "description": "Data extracted from the document's remarks field.\n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "example": "WORK PERMITTED", "nullable": "true" }, "state": { "type": "string", "description": "Document issuing state, in capital letters. \n\n`null` when the state data is not present on the document.\n", "example": "NY", "format": "ISO 3166-1 Alpha-2 or Alpha-3", "nullable": "true" }, "validFrom": { "type": "string", "description": "Date from when the document is valid. \n\nFormat: YYYY-MM-DD.\n", "example": "2018-04-20", "format": "date", "nullable": "true" }, "validUntil": { "type": "string", "description": "Date until when the document is valid. \n\nFormat: YYYY-MM-DD.\n", "example": "2028-04-20", "format": "date", "nullable": "true" }, "specimen": { "description": "Contains additional data about the particular document type. \n\nOptional, present only if Document Insights solution has\nbeen enabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/Specimen" } ] }, "placeOfIssue": { "type": "string", "description": "Place where document was issued.\n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "example": "MADRID", "nullable": "true" }, "firstIssue": { "type": "string", "description": "Date of document first issue. \n\nFormat: YYYY-MM-DD.\n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "example": "2018-04-20", "format": "date", "nullable": "true" }, "issueNumber": { "type": "string", "description": "Document issue number.\n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "example": "01", "nullable": "true" }, "issuedBy": { "type": "string", "description": "Document issuing authority.\n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "example": "ISSUER", "nullable": "true" }, "nfcValidated": { "type": "boolean", "description": "Indicates that biometric document data has been successfully decoded. \n\nOptional, present only if NFC validation has been enabled for your integration.\n", "example": "true" }, "residencePermitType": { "type": "string", "description": "Type of the residence permit type from the document.\n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "example": "C", "nullable": "true" }, "portraitIsVisible": { "type": "boolean", "description": "Indicates that the portrait image is visible in the session and its \nquality is sufficient to perform verification.\n\nOptional, present only if checking for this feature\nhas been enabled for your integration.\n", "example": "true" }, "signatureIsVisible": { "type": "boolean", "description": "Indicates that the signature is present on the document and is readable \nto perform the verification.\n\nOptional, present only if checking for this feature\nhas been enabled for your integration.\n", "example": "true" }, "ineIdentifier": { "type": "string", "description": "Person's INE (Mexican voter's registry) identifier number.\n\nOptional, present only if Mexican registry checks have been enabled for your solution\nand if this information appears on the document.\n", "example": "116375842", "nullable": "true" } } }, "DecisionVerificationAdditionalVerifiedData": { "type": "object", "properties": { "driversLicenseNumber": { "type": "string", "description": "Driver's license number. \n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "example": "ABC123" }, "driversLicenseCategory": { "description": "Indicates the driver's license category/ies.\n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/DriversLicenseCategory" } ] }, "driversLicenseCategoryFrom": { "description": "Date when the driving license category was obtained (valid from).\n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/DriversLicenseCategoryFrom" } ] }, "driversLicenseCategoryUntil": { "description": "Driving license category expiry date (valid until).\n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/DriversLicenseCategoryUntil" } ] }, "estimatedAge": { "type": "integer", "description": "An integer representing the estimated age. \n\nOptional, present only if the\n[Age Estimation](https://devdocs.veriff.com/docs/age-estimation) \nfeature has been enabled for your integration.\n", "format": "integer", "example": "28" }, "estimatedGender": { "type": "number", "description": "A float representing the estimated gender. Values closer to 0.0 indicate \n'male', values closer to 1.0 indicate 'female'. \n\nOptional, present only if gender estimation feature has been enabled \nfor your integration.\n", "example": "0.9", "format": "float" }, "proofOfAddress": { "description": "Object containing data from the Proof of Address solution extractions and checks.\n\nOptional, present only if [Proof of Address](https://devdocs.veriff.com/docs/proof-of-address-verification)\nsolution has been enabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/ProofOfAddress" } ] }, "addressMatching": { "description": "Contains all address matching validation results. \n\nOptional, present only when [Address Matching](https://devdocs.veriff.com/docs/proof-of-address-verification#address-matching)\nfeature has been enabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/PoAAddressMatching" } ] }, "faceMatch": { "description": "Indicates the result of the reference image and selfie matching.\n\nOptional, present only if [Selfie2Selfie Biometric Verification](https://devdocs.veriff.com/docs/selfie2selfie-biometric-verification)\nhas been enabled for your integration.\n", "type": "string", "enum": [ "strong_match", "possible_match", "weak_match" ], "example": "strong_match" }, "processNumber": { "type": "string", "description": "Process number (e.g., \"Trámite №\") from the document.\n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration.\n", "example": "00005" }, "validationResults": { "type": "array", "description": "Data that has been optionally verified for the \n[US Database Verification](https://devdocs.veriff.com/v1/docs/us-database-verification) session or the \n[Match Database Verification](https://devdocs.veriff.com/v1/docs/match-database-verifications) session, depending on your integration. \n\nEmpty [] if no additional data was verified.\n", "items": { "$ref": "#/components/schemas/ValidationResults" } }, "registryValidation": { "description": "Registry validation check object, currently available for Colombian registries.\n\nOptional, present only when the registry validation check has been enabled\nfor your integration.\n", "allOf": [ { "$ref": "#/components/schemas/RegistryValidation" } ] }, "biometricRegistryValidationResults": { "description": "Biometric registry validation container. \n\nOptional, present only if the solution has been enabled for your integration.\n", "type": "object", "additionalProperties": { "type": "object", "description": "Results for a specific country. The key is an `ISO 3166-1 Alpha-2` country code (e.g., `BR`, `US`, `AR`).\n\nCurrently available only for [Brazilian CPF Biometric Database Check](https://devdocs.veriff.com/docs/cpf-biometric-database-check) \nand present only when this solution has been enabled for your integration.\n", "example": "BR", "properties": { "isFirstNameMatch": { "description": "First name match result.\n\n`null` if first name match validation was not enabled or the check could not be completed.\n", "type": "boolean", "example": "true" }, "isLastNameMatch": { "description": "Last name match result.\n\n`null` if last name match validation was not enabled or the check could not be completed.\n", "type": "boolean", "example": "true" }, "isDobMatch": { "description": "Date of birth match result.\n\n`null` if date of birth match validation was not enabled or the check could not be completed.\n", "type": "boolean", "example": "true" }, "isFaceMatch": { "description": "Facial biometric match result.\n\n`null` if selfie not sent or the check could not be completed.\n", "type": "boolean", "example": "true" } } } }, "cpfValidation": { "description": "Brazilian individual taxpayer registry (CPF) validation check object. This is the non-biometric\nCPF validation solution.\n\nOptional, present only if the non-biometric Brazilian CPF validation \nhas been enabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/CpfValidation" } ] }, "cadastroUnico": { "description": "Main container for Cadastro Único Database Verification results (checks if the person \nis registered in government social assistance programs).\n\nOptional, present only if [Brazilian Cadastro Único Verification](https://devdocs.veriff.com/v1/docs/brazilian-cadastro-unico-database-verification) \nhas been enabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/AdditionalVerifiedDataCadastroUnico" } ] }, "proBet": { "description": "Brazilian ProBet registry verification results (checks against databases of politically exposed persons (PEPs), \nartists, influencers, and betting administration registries).\n\nOptional, present only if [Brazilian ProBet Verification](https://devdocs.veriff.com/v1/docs/pro-bet-database-verification) \nhas been enabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/AdditionalVerifiedDataProBet" } ] }, "officialDatabaseVerification": { "description": "Contains database verification results.\n\nOptional, present only if [INE Database Verification](https://devdocs.veriff.com/v1/docs/ine-database-verification)\nand/or [CURP Database Verification](https://devdocs.veriff.com/v1/docs/curp-database-verification)\nhave been enabled for your integration,\n", "allOf": [ { "$ref": "#/components/schemas/AdditionalVerifiedDataOfficialDatabaseVerification" } ] }, "ineBiometricValidation": { "description": "INE Biometric Database Verification check object. \n\nOptional, present only if [INE Biometric Database Validation](https://devdocs.veriff.com/docs/ine-biometric-database-verification)\nhas been enabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/IneBiometricValidation" } ] } } }, "UDocsObject": { "type": "object", "description": "Contains all results from the Unstructured Docs verification.\nAll nested objects are optional — a key is only present when the\ncorresponding feature or add-on has been enabled for your integration\nand the system successfully processed the relevant data.\n", "properties": { "metadata": { "description": "Meta info about the document and the verification process.\nAlways present when `udocs` object is returned.\n", "allOf": [ { "$ref": "#/components/schemas/UDocsMetadata" } ] }, "extraction": { "description": "Data fields extracted from the end-user's document.\n\nOptional. Keys appearing here depend on the use case and\ndocument type configured for your integration. Any key may\nbe omitted or return an empty string if the data could not\nbe extracted.\n", "allOf": [ { "$ref": "#/components/schemas/UDocsExtraction" } ] }, "classification": { "description": "Document classification result: document type, country,\nlanguage, and issuer.\n\nOptional. Nested fields may be omitted if classification\nconfidence is too low.\n", "allOf": [ { "$ref": "#/components/schemas/UDocsClassification" } ] }, "validations": { "description": "Validation results for InitData Matching and Document Expiration checks.\n\nOptional, present only when at least one of these features has been\nenabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/UDocsValidations" } ] }, "fraud": { "description": "Document tampering and risk analysis.\n\nOptional, present only when the Tampering Check add-on has\nbeen enabled for your integration.\n\n`riskLevel`: `HIGH_RISK` results in a `declined` session status.\n", "allOf": [ { "$ref": "#/components/schemas/UDocsFraud" } ] } } }, "DecisionRiskScore": { "type": "object", "description": "Data about risk score. \n\nOptional, present only Fraud Intelligence Package has been enabled for your integration.\n", "properties": { "score": { "type": "number", "description": "A float in the range of 0.0-1.0. Numerical value representing the \noverall risk associated with the session. Lower score indicates more \nconfidence in that the session is genuine. \n\nNote: in the Veriff Customer Portal, the range is shown as 1-100.\n", "example": "0.01", "format": "float" } }, "required": [ "score" ] }, "DecisionRiskLabel": { "type": "object", "properties": { "label": { "type": "string", "description": "Name of the risk label. \n\nLog in to Customer Portal to see the [Risk Insights and Crosslinks](https://help.veriff.com/en/articles/3410712-risk-labels-and-crosslinks)\narticle in Veriff Knowledge Base for more info about labels.\n", "example": "session_face_crosslinked_with_multiple_sessions" }, "category": { "type": "string", "description": "Category of the risk label", "enum": [ "client_data_mismatch", "crosslinks", "device", "document", "images", "network", "session", "person" ], "example": "crosslinks" }, "sessionIds": { "description": "Array of verification session IDs that are referenced to the particular risk label.", "example": [ "123e4567-e89b-12d3-a456-426614174000" ], "type": "array", "items": { "type": "string", "format": "array of strings" } } }, "required": [ "label", "category", "sessionIds" ] }, "BioMetricAuthentication": { "type": "object", "properties": { "matchedSessionId": { "type": "string", "description": "Refers to the verification session ID which face matched.", "example": "d40edb60-6ae6-4475-be72-84b81669cce6", "format": "uuid", "nullable": "true" }, "matchedSessionVendorData": { "type": "string", "description": "Refers to the verification session `vendorData` which the face matched.", "example": "12345678", "nullable": "true" }, "matchedSessionEndUserId": { "type": "string", "description": "Refers to the verification session `endUserId` which the face matched.", "example": "a1b2c35d-3b46-6d5e-3cd2-a1b2c35db3d4", "nullable": "true" }, "details": { "type": "object", "description": "Lists the results of different checks that were made to verify the \nend-user.\n\nData is shown as key-value pairs. The key represents the \ncheck name and the value represents the check result. \n\nLog in to Veriff Customer Portal to see a comprehensive\n[webhook payload](https://help.veriff.com/en/articles/9638913-biometric-authentication-results-in-decision-webhook)\nwith possible values.\n", "example": {} } }, "required": [ "matchedSessionId", "matchedSessionVendorData", "matchedSessionEndUserId", "details" ] }, "DecisionAddress": { "type": "object", "properties": { "fullAddress": { "type": "string", "description": "Address as single string.", "example": "123, Main Street, My County, Anytown 12345", "nullable": "true" }, "parsedAddress": { "description": "Object with parsed `fullAddress`. \n\nOptional, present only if this information appears on the document and this data\nextraction add-on has been enabled for your integration (e.g., [UK DIATF solution](https://devdocs.veriff.com/docs/uk-diatf); \nor the Proof of Address [Address Matching](https://devdocs.veriff.com/docs/proof-of-address-verification#address-matching)\nsolution).\n", "allOf": [ { "$ref": "#/components/schemas/DecisionAddressParsedAddress" } ] } } }, "DecisionNameComponents": { "type": "object", "properties": { "title": { "type": "string", "description": "Person's title extracted from the document, \ne.g., \"MR\", \"MS\". \n\n`null` when no title data present on the document.\n", "example": null, "nullable": "true" }, "middleName": { "type": "string", "description": "Person's middle name extracted from the document, \nfrom a dedicated field on the document or document barcode results. \n\n`null` when the first name has no suffix according to barcode data. \nThe field is not sent when the document has no dedicated field or barcode.\n", "example": "EMILY", "nullable": "true" }, "firstNameOnly": { "type": "string", "description": "Person's first name extracted from the document and stripped \nfrom all components like `middleName` or `firstNameSuffix`.\n", "example": "SARAH", "nullable": "true" }, "firstNameSuffix": { "type": "string", "description": "Person's first name suffix. `null` when the first name has no suffix \naccording to barcode data. \n\nThe field is not sent when the document has no barcode.\n", "example": null, "nullable": "true" } } }, "Specimen": { "type": "object", "properties": { "containsContactlessChip": { "type": "boolean", "description": "Indicates if the document contains a contactless chip (NFC).", "example": "false" }, "firstIssuedDate": { "type": "string", "format": "date", "description": "Indicates the first issue date of the identity document template. \n\nFormat: YYYY-MM-DD.\n", "example": "2025-01-01" }, "lastIssuedDate": { "type": "string", "format": "date", "description": "Indicates the last issue date of the identity document template. \n\nFormat: YYYY-MM-DD.\n", "example": "2025-01-02" }, "nistVersion": { "type": "string", "description": "Indicates the version of the US National Institute of Standards and Technology guidelines.", "example": "1.2.3" }, "digitalDocument": { "type": "boolean", "description": "Indicates if the document is a digital template identity document.", "example": "false" }, "nonStandardDrivingLicense": { "type": "boolean", "description": "Indicates if the driving permit is different from the standard \ndriver's licence (e.g. it is a learner's license, temporary driver's license, \npermit to drive boats).\n", "example": "false" }, "militaryDocument": { "type": "boolean", "description": "Indicates if the document is issued to a military personnel/staff \nor personnel's family.\n", "example": "false" }, "temporaryEmergencyDocument": { "type": "boolean", "description": "Indicates if the document is a temporary identity document.", "example": "false" }, "asylumRefugeeDocument": { "type": "boolean", "description": "Indicates if it is a document that is issued exclusively to \nasylum seekers or refugees.\n", "example": "false" }, "ICAOStandardizedDocument": { "type": "boolean", "description": "Indicates if the document is under the standards of International \nCivil Aviation Organization.\n", "example": "false" }, "notNationalIdCard": { "type": "boolean", "description": "Indicates if the identity card is not a national ID card (e.g., it is \na social security card, tax ID, electoral ID).\n", "example": "true" }, "legalStatus": { "type": "string", "nullable": "true", "description": "Indicates the legal status of the identity document in the country of \nissuance. One of `primary`, `secondary`, `tertiary`, indicating to what extent \nthe document is accepted as legal proof of identity.\n", "enum": [ "primary", "secondary", "tertiary" ], "example": "primary" }, "hasSecurityRisk": { "type": "boolean", "description": "Indicates if the document has properties that can increase the chance of document tampering.", "example": "false" } } }, "DriversLicenseCategory": { "type": "object", "properties": { "B": { "type": "boolean", "example": "true" } }, "required": [ "B" ] }, "DriversLicenseCategoryFrom": { "type": "object", "properties": { "B": { "type": "string", "description": "Category B valid-from date. \n\nFormat: YYYY-MM-DD.\n", "format": "date", "example": "2015-10-06" } }, "required": [ "B" ] }, "DriversLicenseCategoryUntil": { "type": "object", "properties": { "B": { "type": "string", "description": "Category B valid-until date. \n\nFormat: YYYY-MM-DD.\n", "format": "date", "example": "2029-10-06" } }, "required": [ "B" ] }, "ProofOfAddress": { "type": "object", "properties": { "nameMatch": { "type": "boolean", "description": "Indicates if the name on the Proof of Address document matches the name from the initial request data.\n\n`null` if the check could not be completed.\n", "example": "true", "nullable": "true" }, "nameMatchPercentage": { "type": "number", "description": "Indicates the level of similarity the matched names have, in the range of 0.00-100.00.\n\n`null` if the check could not be completed.\n", "example": "89", "nullable": "true" }, "documentType": { "type": "string", "description": "Indicates the type of the proof of address document. \nSee Proof of Address -> [Acceptable document types](https://devdocs.veriff.com/docs/proof-of-address-verification#define-acceptable-document-types-optional)\nsection for more info.\n\n`null` if the check could not be completed.\n", "example": "UTILITY_BILL", "nullable": "true" }, "issueDate": { "description": "Proof of Address document issue date. \n\nFormat: YYYY-MM-DD.\n", "type": "string", "format": "date", "example": "2025-09-01" }, "fraud": { "description": "Object with data about document integrity.\n\nOptional, present only if [Fraud Validation](https://devdocs.veriff.com/docs/proof-of-address-verification#note-about-the-fraud-validation)\nhas been enabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/Fraud" } ] }, "addressValidationResult": { "description": "Contains data that has been found about the extracted address.\n\nOptional, present only when [Address Validation](https://devdocs.veriff.com/docs/proof-of-address-verification#address-validation)\nfeature has been enabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/PoAAddressValidationResult" } ] } }, "required": [ "nameMatch", "nameMatchPercentage", "documentType", "fraud" ] }, "PoAAddressMatching": { "type": "object", "properties": { "addresses": { "description": "Array of exactly 2 address objects - first from initData, second from PoA document. The example displays one array.\n", "type": "array", "items": { "$ref": "#/components/schemas/PoAAddressMatchingAddresses" } }, "result": { "description": "Indicates whether addresses match based on threshold.", "type": "boolean", "example": "true" }, "matchThreshold": { "description": "Configured matching percentage threshold.", "type": "number", "example": "80", "format": "integer" }, "matchPercentage": { "description": "Indicates matching percentage.", "type": "number", "example": "90", "format": "integer" } }, "required": [ "addresses", "result", "matchThreshold", "matchPercentage" ] }, "ValidationResults": { "type": "object", "properties": { "registryName": { "type": "string", "description": "Name of the registry.", "example": "USA - Credit + US Identity Graph (US15)" }, "firstName": { "type": "string", "description": "Indicates the match level of person's first name data.", "example": "MATCH", "enum": [ "MATCH", "NO_MATCH", "PARTIAL_MATCH", "INVALID", "NO_INPUT", "NO_DATA" ] }, "lastName": { "type": "string", "description": "Indicates the match level of person's last name data.", "example": "MATCH", "enum": [ "MATCH", "NO_MATCH", "PARTIAL_MATCH", "INVALID", "NO_INPUT", "NO_DATA" ] }, "dateOfBirth": { "type": "string", "description": "Indicates the match level of person's date of birth data.", "example": "NO_INPUT", "enum": [ "MATCH", "NO_MATCH", "PARTIAL_MATCH", "INVALID", "NO_INPUT", "NO_DATA" ] }, "address": { "type": "string", "description": "Indicates the match level of person's address data.", "example": "PARTIAL_MATCH", "enum": [ "MATCH", "NO_MATCH", "PARTIAL_MATCH", "INVALID", "NO_INPUT", "NO_DATA" ] }, "city": { "type": "string", "description": "Indicates the match level of person's address data, specifically the city.", "example": "MATCH", "enum": [ "MATCH", "NO_MATCH", "PARTIAL_MATCH", "INVALID", "NO_INPUT", "NO_DATA" ] }, "state": { "type": "string", "description": "Indicates the match level of person's address data, specifically the state.", "example": "MATCH", "enum": [ "MATCH", "NO_MATCH", "PARTIAL_MATCH", "INVALID", "NO_INPUT", "NO_DATA" ] }, "zip": { "type": "string", "description": "Indicates the match level of person's address data, specifically the zip code (post code).", "example": "MATCH", "enum": [ "MATCH", "NO_MATCH", "PARTIAL_MATCH", "INVALID", "NO_INPUT", "NO_DATA" ] }, "idNumber": { "type": "string", "description": "Indicates the match level of person's identity number or SNN number data.", "example": "NO_DATA", "enum": [ "MATCH", "NO_MATCH", "PARTIAL_MATCH", "INVALID", "NO_INPUT", "NO_DATA" ] }, "phoneNumber": { "type": "string", "description": "Indicates the match level of person's phone number data.", "example": "PARTIAL_MATCH", "enum": [ "MATCH", "NO_MATCH", "PARTIAL_MATCH", "INVALID", "NO_INPUT", "NO_DATA" ] } }, "required": [ "registryName", "firstName", "lastName", "dateOfBirth", "address", "city", "state", "zip", "idNumber" ] }, "RegistryValidation": { "type": "object", "properties": { "countryRegistry": { "type": "string", "description": "Country of the registry, in capital letters.", "format": "ISO 3166 Alpha-2", "example": "CO" }, "registryName": { "type": "string", "description": "Name of the registry", "example": "resigo" }, "fullNameSimilarity": { "type": "number", "description": "Similarity of the full name in the registry to the full name in the document.", "example": "80" }, "documentValid": { "type": "boolean", "description": "Indicates if the document is valid in the registry.", "example": "true" }, "personIsAlive": { "type": "boolean", "description": "Indicates if the person is alive according to the registry.", "example": "true" } } }, "CpfValidation": { "type": "object", "properties": { "status": { "type": "string", "description": "Status of the entry in the registry. \n\n`CPF is cancelled` indicates that the entry was a duplicate.\n\n`Cancelled craft` indicates that the entry was cancelled due to reasons other than being a duplicate.\n", "enum": [ "CPF is validated", "CPF is suspended", "CPF holder is deceased", "CPF is pending regularization", "CPF is cancelled", "Cancelled craft" ], "example": "CPF is validated", "nullable": "true" }, "cpfNumber": { "type": "string", "description": "Brazilian individual taxpayer registry (CPF) number of the person.", "example": "1234569", "nullable": "true" }, "name": { "type": "string", "description": "Person's name in the CPF.", "example": "SARAH MORGAN", "nullable": "true" }, "dateOfBirth": { "type": "string", "description": "Person's date of birth in the CPF. \n\nFormat: YYYY-MM-DD.\n", "example": "1967-03-30", "format": "date", "nullable": "true" }, "dateOfDeath": { "type": "string", "description": "Person's date of death in the CPF. \n\nFormat: YYYY-MM-DD.\n", "format": "date", "example": null, "nullable": "true" } }, "required": [ "status", "cpfNumber", "name", "dateOfBirth", "dateOfDeath" ] }, "AdditionalVerifiedDataCadastroUnico": { "type": "object", "properties": { "validations": { "description": "Contains validation rule results.", "allOf": [ { "$ref": "#/components/schemas/AdditionalVerifiedDataCadastroUnicoValidations" } ] }, "registryResponse": { "description": "Contains detailed benefit information from government registries.", "allOf": [ { "$ref": "#/components/schemas/AdditionalVerifiedDataCadastroUnicoRegistryResponse" } ] } }, "required": [ "validations", "registryResponse" ] }, "AdditionalVerifiedDataProBet": { "type": "object", "properties": { "validations": { "description": "ProBet validation results container.", "allOf": [ { "$ref": "#/components/schemas/ProBetValidations" } ] }, "registryResponse": { "description": "Detailed registry data.", "allOf": [ { "$ref": "#/components/schemas/ProBetRegistryResponse" } ] } }, "required": [ "validations", "registryResponse" ] }, "AdditionalVerifiedDataOfficialDatabaseVerification": { "type": "object", "properties": { "ine": { "description": "Contains INE verification results.\n\nRelated to [INE Database Verification](https://devdocs.veriff.com/v1/docs/ine-database-verification)\nsolution.\n", "allOf": [ { "$ref": "#/components/schemas/OfficialDatabaseVerificationIne" } ] }, "curp": { "description": "Contains CURP verification results. \n\nRelated to [CURP Database Verification](https://devdocs.veriff.com/v1/docs/curp-database-verification) solution.\n", "allOf": [ { "$ref": "#/components/schemas/OfficialDatabaseVerificationCurp" } ] } }, "required": [ "ine", "curp" ] }, "IneBiometricValidation": { "type": "object", "properties": { "faceMatch": { "type": "boolean", "description": "Indicates if the person's selfie image is a match with their image in the registry. \nThis decision is made based on the value returned in `faceMatchPercentage` (see below).\n\n`null` if the check could not be completed.\n", "example": "true", "nullable": "true" }, "faceMatchPercentage": { "type": "integer", "description": "Indicates the level of similarity the system thinks the matched images have, in the range of 0-100. \nValues >85 indicate a match; values <85 indicate that images do not match. \n\n`null` if the check could not be completed.\n", "example": "89", "format": "integer", "nullable": "true" }, "responseStatus": { "type": "string", "description": "Indicates the response received from the service provider.\n\n`null` if the check could not be completed.\n", "enum": [ "success", "failure" ], "example": "success", "nullable": "true" } }, "required": [ "faceMatch", "faceMatchPercentage", "responseStatus" ] }, "UDocsMetadata": { "type": "object", "properties": { "pageCount": { "type": "integer", "description": "Number of pages processed from the end-user's document.", "example": "2" } }, "required": [ "pageCount" ] }, "UDocsExtraction": { "type": "object", "description": "Extracted data fields. Which keys appear depends on your use case\nconfiguration and the document type used. All keys are optional.\n", "properties": { "fullName": { "type": "string", "description": "Person's full name as extracted from the document.", "example": "JUAN MARTINEZ" }, "fullAddress": { "type": "string", "description": "Person's full address as extracted from the document.", "example": "AV INSURGENTES SUR 2847 PISO 3 COL DEL VALLE BENITO JUAREZ CIUDAD DE MEXICO MEXICO CP 03100" }, "bankAccountNumber": { "type": "string", "description": "Person's bank account number as extracted from the document.\n\nOnly for Bank account ownership verification use case.\n", "example": "84532345" }, "issueDate": { "type": "string", "description": "Document issue date as extracted from the document.\nRepresented as `YYYY-MM-DD`.\n", "example": "2024-05-28" }, "expiryDate": { "type": "string", "description": "Document expiry date as extracted from the document.\nRepresented as `YYYY-MM-DD`.\n", "example": "2025-05-28" }, "documentNumber": { "type": "string", "description": "Document reference number as extracted from the document\n(e.g., policy number, certificate number).\n", "example": "847293651024738569" }, "vehicleIdentificationNumber": { "type": "string", "description": "The unique 17-character VIN (Vehicle Identification Number)\nas extracted from the document.\n\nOnly for Vehicle ownership verification and Vehicle insurance policy verification use cases.\n", "example": "1HGBH41JXMN109186" }, "vehicleRegistrationNumber": { "type": "string", "description": "Vehicle registration number as extracted from the document.\n\nOnly for Vehicle ownership verification and Vehicle insurance policy verification use cases.\n", "example": "ABC-1234" }, "occupation": { "type": "string", "description": "Person's occupation as extracted from the document.\n\nOnly for Source of income verification use case.\n", "example": "Driver" }, "income": { "type": "string", "description": "Income amount as extracted from the document.\n\nOnly for Source of income verification use case.\n", "example": "45000" }, "issuer": { "type": "string", "description": "Document issuer name as extracted from the document.", "example": "Skrill Limited" }, "currency": { "type": "string", "description": "Currency as extracted from the document.", "example": "USD" }, "countryOfBirth": { "type": "string", "description": "The country where the person was born, as recorded on the birth certificate.\n\nOnly for Birth certificate verification use case.\n", "example": "MX" }, "dateOfBirth": { "type": "string", "description": "The person's date of birth in ISO 8601 format (YYYY-MM-DD),\nas recorded on the birth certificate.\n\nOnly for Birth certificate verification use case.\n", "example": "1980-07-05" }, "fatherFullName": { "type": "string", "description": "The full name of the person's father, as recorded on the birth certificate.\n\nOnly for Birth certificate verification use case.\n", "example": "CARLOS MARTINEZ LOPEZ" }, "motherFullName": { "type": "string", "description": "The full name of the person's mother, as recorded on the birth certificate.\n\nOnly for Birth certificate verification use case.\n", "example": "MARIA ELENA GARCIA RUIZ" }, "nationality": { "type": "string", "description": "The nationality of the person as recorded on the birth certificate.\n\nOnly for Birth certificate verification use case.\n", "example": "MEXICANA" }, "birthFacility": { "type": "string", "description": "The name of the hospital or facility where the person was born, as recorded on the birth certificate.\n\nOnly for Birth certificate verification use case.\n", "example": "HOSPITAL GENERAL DE MEXICO" }, "placeOfBirthAddress": { "type": "string", "description": "The city or address of the place of birth, as recorded on the birth certificate.\n\nOnly for Birth certificate verification use case.\n", "example": "CIUDAD DE MEXICO, MEXICO" } } }, "UDocsClassification": { "type": "object", "properties": { "documentType": { "type": "string", "description": "High-level document category grouping.\n", "enum": [ "financial", "government", "housing", "insurance", "legal", "tax", "utility", "other" ], "example": "financial" }, "documentSubType": { "type": "string", "description": "Specific document type within the category. See\n[Supported document types](https://devdocs.veriff.com/docs/supported-document-types#unstructured-documents)\nfor possible values.\n", "example": "bank_statement" }, "countryCode": { "type": "string", "description": "Document's country of origin, represented as\nISO 3166 `alpha-2` code.\n", "example": "mx" }, "language": { "type": "string", "description": "Document's language, represented as ISO 369-1 code.\n", "example": "es" }, "issuer": { "type": "string", "description": "Document issuing entity as identified during classification.", "example": "skrill_limited" } } }, "UDocsValidations": { "type": "object", "description": "Groups all validation check results within the uDocs object.\n", "properties": { "matchingResults": { "description": "Comparison results between initData fields and data extracted\nfrom the document.\n\nOptional, present only when InitData Matching has been enabled\nfor your integration and initData was provided in the session\ncreation request.\n", "type": "array", "items": { "$ref": "#/components/schemas/UDocsMatchingResult" } }, "documentExpiration": { "description": "Document validity period check results.\n\nOptional, present only when the Document Expiration check has\nbeen enabled for your integration.\n", "allOf": [ { "$ref": "#/components/schemas/UDocsDocumentExpiration" } ] } } }, "UDocsFraud": { "type": "object", "description": "Document tampering and risk analysis results from the Tampering Check\nadd-on. All fields return `null` if the check was not executed or failed.\n", "properties": { "riskLevel": { "type": "string", "description": "Risk level of the document.\n\nNote: `HIGH_RISK` results in a `declined` session status.\n`null` if the check was not executed or failed.\n", "enum": [ "LOW_RISK", "MEDIUM_RISK", "HIGH_RISK" ], "example": "HIGH_RISK", "nullable": "true" }, "reason": { "type": "string", "description": "Short identifier for the reason behind the risk level.\n`null` if the check was not executed or failed.\n", "example": "DIGITAL_MODIFICATION_HIGH_CONFIDENCE", "nullable": "true" }, "reasonDescription": { "type": "string", "description": "Human-readable explanation of the `reason` value.\n`null` if the check was not executed or failed.\n", "example": "Document contains traces of digital modification, likely with fraudulent intent", "nullable": "true" }, "indicators": { "type": "array", "description": "Array of strings describing the factors that influenced the\nrisk assessment. Empty array if no specific markers were detected\nor if the check was not executed.\n\nWarning: do not build application logic on specific indicator values — the\npossible values may change without notice. The array structure\nwill remain backwards compatible.\n", "items": { "type": "string" }, "example": [ "This document's metadata shows a creation time and a modification time, suggesting the file was updated after it was first created." ] } } }, "DecisionAddressParsedAddress": { "type": "object", "properties": { "city": { "type": "string", "description": "Any human settlement, including cities, towns, villages, hamlets, \nlocalities, etc.\n", "example": "MUMBAI", "nullable": "true" }, "cityDistrict": { "type": "string", "description": "Boroughs or districts within a city that serve some official purpose \ne.g. \"Brooklyn\" or \"Hackney\" or \"Bratislava IV\".\n", "example": "Any District", "nullable": "true" }, "country": { "type": "string", "description": "Sovereign nations and their dependent territories, as ISO country code.", "format": "ISO 3166-1 Alpha-2", "example": "IN", "nullable": "true" }, "countryRegion": { "type": "string", "description": "Informal subdivision of a country without any political status.", "example": "Sample Region", "nullable": "true" }, "entrance": { "type": "string", "description": "Numbered/lettered entrance.", "example": "B", "nullable": "true" }, "house": { "type": "string", "description": "Name of the venue or the building.", "example": "EXPRESS BUILDING", "nullable": "true" }, "houseNumber": { "type": "string", "description": "External (street-facing) building number.", "example": "9-10", "nullable": "true" }, "island": { "type": "string", "description": "Named islands e.g., \"Maui\".", "example": "Small Island", "nullable": "true" }, "level": { "type": "string", "description": "Expressions indicating a floor number e.g., \"3rd Floor\", \"Ground Floor\", etc.", "example": "1st floor", "nullable": "true" }, "near": { "type": "string", "description": "Phrases like \"in\", \"near\", etc. used after a category phrase to help with parsing\nqueries like \"restaurants in Brooklyn\".\n", "example": null, "nullable": "true" }, "road": { "type": "string", "description": "Name of the street(s).", "example": "Sample Avenue", "nullable": "true" }, "poBox": { "type": "string", "description": "Post office box, typically found in non-physical (mail-only) addresses.", "example": "123452", "nullable": "true" }, "postcode": { "type": "string", "description": "Postal codes used for mail sorting.", "example": "123456", "nullable": "true" }, "staircase": { "type": "string", "description": "Numbered/lettered staircase.", "example": "B", "nullable": "true" }, "state": { "type": "string", "description": "A first-level administrative division. For example, Scotland, Northern Ireland, Wales, and \nEngland in the UK are mapped to \"state\" as well (convention used in OSM, GeoPlanet, etc.)\n", "example": null, "nullable": "true" }, "stateDistrict": { "type": "string", "description": "Usually a second-level administrative division or county.", "example": null, "nullable": "true" }, "suburb": { "type": "string", "description": "Usually an unofficial neighbourhood name like \"Harlem\", \"South Bronx\", or \"Crown Heights\".", "example": null, "nullable": "true" }, "unit": { "type": "string", "description": "An apartment, unit, office, lot, or other secondary unit designator.", "example": "Building A", "nullable": "true" }, "worldRegion": { "type": "string", "description": "Currently only used for appending \"West Indies\" after the country name,\na pattern frequently used in the English-speaking Caribbean e.g. \"Jamaica, West Indies\".\n", "example": null, "nullable": "true" }, "subDivision": { "type": "string", "description": "A first-level administrative division. It may differ from state in jurisdictions\nwhere subdivisions and states are distinct administrative concepts.\n\nOptional, available only for digital identity verification solutions.\n\n`null` if data not available.\n", "example": "Maharashtra", "nullable": "true" } } }, "Fraud": { "type": "object", "properties": { "riskLevel": { "type": "string", "description": "Indicates the risk level. \n\n`null` if the check was not executed or failed.\n", "example": "HIGH_RISK", "nullable": "true", "enum": [ "HIGH_RISK", "MEDIUM_RISK", "LOW_RISK" ] }, "reason": { "type": "string", "description": "Short description indicating the reason behind the risk level.\n\n`null` if the check was not executed or failed.\n", "example": "PDF_PROCESSED_BY_EDITOR", "nullable": "true" }, "reasonDescription": { "type": "string", "description": "Human readable explanation of the data in the `reason` field.\n\n`null` if the check was not executed or failed.\n", "example": "Document was processed using editing software.", "nullable": "true" }, "indicators": { "type": "array", "description": "Array of strings listing the factors that influenced the risk assessment.\n\nEmpty if the check was not executed or failed.\n", "example": [], "items": { "type": "string" } } }, "required": [ "riskLevel", "reason", "reasonDescription", "indicators" ] }, "PoAAddressValidationResult": { "type": "object", "properties": { "status": { "description": "Shows the level of address validity confirmation.", "type": "string", "enum": [ "CONFIRMED", "CONFIRMED_PARTIAL", "NOT_CONFIRMED", "NOT_FOUND" ] }, "components": { "description": "Contains address components. Returns `null` if address could not be found.", "nullable": "true", "allOf": [ { "$ref": "#/components/schemas/AddressValidationResultComponents" } ] }, "addressType": { "description": "Indicates if the address is of a residential or business premise, or it is a PO box.\n\n`null` if the address validation feature was has not been enabled, or if no data was sent.\n", "type": "string", "enum": [ "residential", "business", "poBox" ], "example": "residential", "nullable": "true" }, "validations": { "description": "Contains country validation result data.", "allOf": [ { "$ref": "#/components/schemas/AddressValidationResultValidations" } ] } }, "required": [ "status", "components", "addressType", "validations" ] }, "PoAAddressMatchingAddresses": { "type": "object", "properties": { "fullAddress": { "description": "Original full address string as provided/extracted.", "type": "string", "example": "23 Willowbrook Lane, Ashford, Kent CT19 8NP, UK" }, "parsedAddress": { "description": "Google Maps API parsed address components", "allOf": [ { "$ref": "#/components/schemas/PoAAddressMatchingAddressesParsedAddress" } ] } }, "required": [ "fullAddress", "parsedAddress" ] }, "AdditionalVerifiedDataCadastroUnicoValidations": { "type": "object", "properties": { "processing": { "description": "Indicates if registry processing was successful.", "allOf": [ { "$ref": "#/components/schemas/CadastroUnicoValidationsProcessing" } ] }, "isUserDataValid": { "description": "Validates input data format (CPF number and date of birth).", "allOf": [ { "$ref": "#/components/schemas/CadastroUnicoValidationsIsUserDataValid" } ] }, "isNotBcpBeneficiary": { "description": "Checks if the end-user is NOT receiving BCP benefit (`failure` means IS receiving).", "allOf": [ { "$ref": "#/components/schemas/CadastroUnicoValidationsIsNotBcpBeneficiary" } ] }, "isNotBolsaFamiliaBeneficiary": { "description": "Checks if the end-user is NOT receiving Bolsa Familia (`failure` means IS receiving).", "allOf": [ { "$ref": "#/components/schemas/CadastroUnicoValidationsIsNotBolsaFamiliaBeneficiary" } ] }, "isNotSeguroDefesoBeneficiary": { "description": "Checks if the end-user is NOT receiving fishermen insurance (`failure` means IS receiving).", "allOf": [ { "$ref": "#/components/schemas/CadastroUnicoValidationsIsNotSeguroDefesoBeneficiary" } ] }, "isNotCadastroUnicoBeneficiary": { "description": "Checks if the end-user is NOT in general registry (`failure` means IS registered).", "allOf": [ { "$ref": "#/components/schemas/CadastroUnicoValidationsIsNotCadastroUnicoBeneficiary" } ] }, "isNotAuxilioEmergencialBeneficiary": { "description": "Checks if the end-user is NOT receiving emergency aid (`failure` means IS receiving).", "allOf": [ { "$ref": "#/components/schemas/CadastroUnicoValidationsIsNotAuxilioEmergencialBeneficiary" } ] } }, "required": [ "processing", "isUserDataValid", "isNotBcpBeneficiary", "isNotBolsaFamiliaBeneficiary", "isNotSeguroDefesoBeneficiary", "isNotCadastroUnicoBeneficiary", "isNotAuxilioEmergencialBeneficiary" ] }, "AdditionalVerifiedDataCadastroUnicoRegistryResponse": { "type": "object", "properties": { "bcpBenefit": { "description": "Continuous Cash Benefit details.", "allOf": [ { "$ref": "#/components/schemas/CadastroUnicoRegistryResponseBcpBenefit" } ] }, "bolsaFamiliaBenefit": { "description": "Bolsa Fami­lia program details.", "allOf": [ { "$ref": "#/components/schemas/CadastroUnicoRegistryResponseBolsaFamiliaBenefit" } ] }, "seguroDefesoBenefit": { "description": "Artisanal fishermen insurance details.", "allOf": [ { "$ref": "#/components/schemas/CadastroUnicoRegistryResponseSeguroDefesoBenefit" } ] }, "auxilioEmergencialBenefit": { "description": "Emergency aid details.", "allOf": [ { "$ref": "#/components/schemas/CadastroUnicoRegistryResponseAuxilioEmergencialBenefit" } ] } }, "required": [ "bcpBenefit", "bolsaFamiliaBenefit", "seguroDefesoBenefit", "auxilioEmergencialBenefit" ] }, "ProBetValidations": { "type": "object", "properties": { "processing": { "description": "Validation rule results.", "allOf": [ { "$ref": "#/components/schemas/ValidationsProcessing" } ] }, "isUserDataValid": { "description": "User data format validation.", "allOf": [ { "$ref": "#/components/schemas/ValidationsIsUserDataValid" } ] }, "isNotOnPia": { "description": "Checks that the end-user is NOT on the Betting Administration database.\n\n`failure` means that IS on the database.\n", "allOf": [ { "$ref": "#/components/schemas/ValidationsIsNotOnPia" } ] }, "isNotOnProBet": { "description": "Checks that the end-user is NOT on the ProBet database.\n\n`failure` means that IS on the database.\n", "allOf": [ { "$ref": "#/components/schemas/ValidationsIsNotOnProBet" } ] } }, "required": [ "processing", "isUserDataValid", "isNotOnPia", "isNotOnProBet" ] }, "ProBetRegistryResponse": { "type": "object", "properties": { "pepData": { "description": "Politically exposed person (PEP) information.", "allOf": [ { "$ref": "#/components/schemas/RegistryResponsePepData" } ] }, "artistData": { "description": "Artist/public figure information.", "allOf": [ { "$ref": "#/components/schemas/RegistryResponseArtistData" } ] }, "piaData": { "description": "Betting administration registry information.", "allOf": [ { "$ref": "#/components/schemas/RegistryResponsePiaData" } ] }, "influencerData": { "description": "Digital influencer information.", "allOf": [ { "$ref": "#/components/schemas/RegistryResponseInfluencerData" } ] }, "scoreData": { "description": "The final computed result based on all the data above.", "allOf": [ { "$ref": "#/components/schemas/RegistryResponseScoreData" } ] } }, "required": [ "pepData", "artistData", "piaData", "influencerData", "scoreData" ] }, "OfficialDatabaseVerificationIne": { "type": "object", "properties": { "matchData": { "description": "Shows how different end-user data types that were sent as initData or extracted\nfrom the document match the data in the registry. \n\nOptional, present only when end-user data matching validation is enabled for your integration.\n\n\n- `MATCH` means that the input data matches registry data\n\n- `NO_MATCH` means the input data does not match registry data\n\n- `NO_INPUT` means no data was provided for the field\n\n- `NO_DATA` means the registry did not contain any info for this field\n", "allOf": [ { "$ref": "#/components/schemas/OfficialDatabaseVerificationMatchData" } ] }, "validations": { "description": "Contains validation check results.", "allOf": [ { "$ref": "#/components/schemas/OfficialDatabaseVerificationIneValidations" } ] }, "registryResponse": { "description": "Detailed information from the Mexican electoral registry.\n\nFields below are optional and might not be present if the data is `null` from the provider.\n", "allOf": [ { "$ref": "#/components/schemas/OfficialDatabaseVerificationIneRegistryResponse" } ] } }, "required": [ "matchData", "validations", "registryResponse" ] }, "OfficialDatabaseVerificationCurp": { "type": "object", "properties": { "matchData": { "description": "Shows how different end-user data types that were sent as initData or extracted\nfrom the document match the data in the registry. \n\nOptional, present only when\nend-user data matching validation is enabled for your integration. \n\n\n- `MATCH` means that the input data matches registry data\n\n- `NO_MATCH` means the input data does not match registry data\n\n- `NO_INPUT` means no data was provided for the field\n\n- `NO_DATA` means the registry did not contain any info for this field\n", "allOf": [ { "$ref": "#/components/schemas/OfficialDatabaseVerificationMatchData" } ] }, "validations": { "description": "Contains validation check results.", "allOf": [ { "$ref": "#/components/schemas/OfficialDatabaseVerificationCurpValidations" } ] }, "registryResponse": { "description": "Object containing detailed information retrieved from the Mexican government registry. \n\nFields below are optional and might not be present if the data is `null` from the provider.\n", "allOf": [ { "$ref": "#/components/schemas/CurpValidationsRegistryResponse" } ] } }, "required": [ "matchData", "validations", "registryResponse" ] }, "UDocsMatchingResult": { "type": "object", "properties": { "type": { "type": "string", "description": "The initData field that was matched against extracted data.\n", "example": "full_name" }, "match": { "type": "boolean", "description": "Indicates if match was `true` or `false`\n`true` if the match percentage meets or exceeds the match\nthreshold. `false` if the match percentage is below the\nthreshold or the extracted value is empty.\n", "example": "true" }, "originalValue": { "type": "string", "description": "Echoes the initData value that was sent in the session creation request.", "example": "JUAN MARTINEZ" }, "extractedValue": { "type": "string", "description": "The value extracted from the end-user's document.", "example": "JUAN MARTINEZ" }, "matchThreshold": { "type": "integer", "description": "The minimum match percentage configured for this field.", "example": "80" }, "matchPercentage": { "type": "integer", "description": "The actual match percentage calculated between the two values.", "example": "100" } } }, "UDocsDocumentExpiration": { "type": "object", "properties": { "isIssueDateInRange": { "type": "boolean", "description": "Checks if document’s issue date clears the allowed range threshold (days since issue date).\n\nSkipped if the document has an expiry date\nand expiry date-based validation is enabled.\n", "example": "false" }, "isWithinValidityPeriod": { "type": "boolean", "description": "Checks if document’s expiration date clears the range threshold (days before expiration date).\n", "example": "false" } } }, "AddressValidationResultComponents": { "type": "object", "properties": { "plausibleFullAddress": { "description": "Full address as a string, containing extracted and found data.", "type": "string", "example": "23 Willowbrook Lane, Ashford, Kent CT19 8NP, UK", "nullable": "true" }, "city": { "description": "Any human settlement, including cities, towns, villages, hamlets, localities, etc.", "type": "string", "example": "Ashford", "nullable": "true" }, "unit": { "description": "An apartment, unit, office, lot, or other secondary unit designator.", "type": "string", "example": null, "nullable": "true" }, "state": { "description": "A first-level administrative division.", "type": "string", "example": null, "nullable": "true" }, "street": { "description": "Street name", "type": "string", "example": "Willobrook Lane", "nullable": "true" }, "country": { "description": "Sovereign nations and their dependent territories (ISO 3166).", "type": "string", "example": "UK", "nullable": "true" }, "postcode": { "description": "Postal codes used for mail sorting.", "type": "string", "example": "Kent CT19 8NP", "nullable": "true" }, "houseNumber": { "description": "External (street-facing) building number.", "type": "string", "example": "23", "nullable": "true" } }, "required": [ "plausibleFullAddress", "city", "unit", "state", "street", "country", "postCode", "houseNumber" ] }, "AddressValidationResultValidations": { "type": "object", "properties": { "countryExists": { "description": "Indicates if the validation was able to verify the country.", "allOf": [ { "$ref": "#/components/schemas/AddressValidationResultValidationsCountryExists" } ] } }, "required": [ "countryExists" ] }, "PoAAddressMatchingAddressesParsedAddress": { "type": "object", "properties": { "city": { "description": "Parsed city name.", "type": "string", "example": "Ashford", "nullable": "true" }, "unit": { "description": "Parsed apartment/unit number.", "type": "string", "example": null, "nullable": "true" }, "state": { "description": "Parsed state/province.", "type": "string", "example": null, "nullable": "true" }, "street": { "description": "Parsed street name (premise).", "type": "string", "example": "Willowbrook Lane", "nullable": "true" }, "country": { "description": "Parsed country name.", "type": "string", "example": "UK", "nullable": "true" }, "postcode": { "description": "Parsed postal/ZIP code.", "type": "string", "example": "Kent CT19 8NP", "nullable": "true" }, "houseNumber": { "description": "Parsed house/building number.", "type": "string", "example": "23", "nullable": "true" } }, "required": [ "city", "unit", "state", "street", "country", "postcode", "houseNumber" ] }, "CadastroUnicoValidationsProcessing": { "type": "object", "properties": { "result": { "description": "Validation outcome.", "type": "string", "enum": [ "success", "failure" ], "example": "success" }, "reasons": { "description": "Explanations for when the validation failed.\n\n`null` or empty if `result` value is `success`.\n", "type": "array", "example": [], "nullable": "true", "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "CadastroUnicoValidationsIsUserDataValid": { "type": "object", "properties": { "result": { "description": "Validation outcome.", "type": "string", "enum": [ "success", "failure" ], "example": "success" }, "reasons": { "description": "Explanations for when the validation failed.\n\n`null` or empty if `result` value is `success`.\n", "type": "array", "example": [], "nullable": "true", "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "CadastroUnicoValidationsIsNotBcpBeneficiary": { "type": "object", "properties": { "result": { "description": "Validation outcome.", "type": "string", "enum": [ "success", "failure" ], "example": "failure" }, "reasons": { "description": "Explanations for when the validation failed.\n\n`null` or empty if `result` value is `success`.\n", "type": "array", "example": [ "User is bcp beneficiary" ], "nullable": "true", "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "CadastroUnicoValidationsIsNotBolsaFamiliaBeneficiary": { "type": "object", "properties": { "result": { "description": "Validation outcome", "type": "string", "enum": [ "success", "failure" ], "example": "success" }, "reasons": { "description": "Explanations for when the validation failed.\n\n`null` or empty if `result` value is `success`.\n", "type": "array", "example": [], "nullable": "true", "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "CadastroUnicoValidationsIsNotSeguroDefesoBeneficiary": { "type": "object", "properties": { "result": { "description": "Validation outcome.", "type": "string", "enum": [ "success", "failure" ], "example": "failure" }, "reasons": { "description": "Explanations for when the validation failed.\n\n`null` or empty if `result` value is `success`.\n", "type": "array", "example": [ "User is seguro defeso beneficiary" ], "nullable": "true", "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "CadastroUnicoValidationsIsNotCadastroUnicoBeneficiary": { "type": "object", "properties": { "result": { "description": "Validation outcome.", "type": "string", "enum": [ "success", "failure" ], "example": "success" }, "reasons": { "description": "Explanations for when the validation failed.\n\n`null` or empty if `result` value is `success`.\n", "type": "array", "example": [], "nullable": "true", "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "CadastroUnicoValidationsIsNotAuxilioEmergencialBeneficiary": { "type": "object", "properties": { "result": { "description": "Validation outcome.", "type": "string", "enum": [ "success", "failure" ], "example": "failure" }, "reasons": { "description": "Explanations for when the validation failed.\n\n`null` or empty if `result` value is `success`.\n", "type": "array", "example": [ "User is auxilio emergencial beneficiary" ], "nullable": "true", "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "CadastroUnicoRegistryResponseBcpBenefit": { "type": "object", "properties": { "state": { "description": "Brazilian state code where the benefit is registered.", "type": "string", "example": "SP" }, "benefitNumber": { "description": "Unique benefit identification number.", "type": "string", "example": "" }, "isInRegistry": { "description": "Indicates whether the end-user was found in BCP registry.", "type": "boolean", "example": "true" }, "beneficiaryNis": { "description": "Social Identification Number of beneficiary.", "type": "string", "example": "" }, "referenceMonth": { "description": "Reference period for data.", "type": "string", "example": "202210", "format": "YYYYMM" }, "competenceMonth": { "description": "Competence month for payment.", "type": "string", "example": "202210", "format": "YYYYMM" }, "installmentValue": { "description": "Monetary value of benefit installment.", "type": "string", "example": "1.212,00" }, "municipalityName": { "description": "City where the beneficiary resides.", "type": "string", "example": "OSASCO" }, "judiciallyGrantedBenefit": { "description": "Indicates if the benefit was court-ordered.", "type": "string", "example": "" } }, "required": [ "state", "benefitNumber", "isInRegistry", "beneficiaryNis", "referenceMonth", "competenceMonth", "installmentValue", "municipalityName", "judiciallyGrantedBenefit" ] }, "CadastroUnicoRegistryResponseBolsaFamiliaBenefit": { "type": "object", "properties": { "qsa": { "description": "Quadro Social e Administrativo indicator, indicating if the beneficiary \nis registered as a partner or administrator of a business.\n", "type": "boolean", "example": "true" }, "currentlyActive": { "description": "Indicates whether benefit is currently active.", "type": "boolean", "example": "false" }, "lastBenefitDate": { "description": "Date of last benefit payment.", "type": "string", "example": "05/12/2022", "format": "DD/MM/YYYY" }, "dataInconsistency": { "description": "Flags data inconsistencies in record.", "type": "boolean", "example": "false" }, "firstBenefitDate": { "description": "Date user first received benefit.", "type": "string", "example": "05/12/2022", "format": "DD/MM/YYYY" }, "lastBenefitValue": { "description": "Value of last installment paid.", "type": "string", "example": "" }, "last12MonthsData": { "description": "Payment history summary for last year.", "type": "string", "example": "dez/25 - NAO, nov/25 - NAO, out/25 - NAO, set/25 - NAO, ago/25 - NAO, jul/25 - NAO, jun/25 - NAO, mai/25 - NAO, abr/25 - NAO, mar/25 - NAO, fev/25 - NAO, jan/25 - NAO" }, "lastBenefitPayment": { "description": "Details of last payment method.", "type": "string", "example": "" }, "wasBenefitRecipient": { "description": "Indicates whether the end-user ever received this benefit.", "type": "boolean", "example": "true" }, "currentlyInBolsaFamilia": { "description": "Current enrollment status.", "type": "boolean", "example": "false" }, "employmentLinkLast5Years": { "description": "Had formal employment in last 5 years.", "type": "boolean", "example": "true" } }, "required": [ "qsa", "currentlyActive", "lastBenefitDate", "dataInconsistency", "firstBenefitDate", "lastBenefitValue", "last12MonthsData", "lastBenefitPayment", "wasBenefitRecipient", "currentlyInBolsaFamilia", "employmentLinkLast5Years" ] }, "CadastroUnicoRegistryResponseSeguroDefesoBenefit": { "type": "object", "properties": { "isInRegistry": { "description": "Shows whether the end-user was found in Seguro Defeso registry.", "type": "boolean", "example": "true" }, "beneficiaryCpf": { "description": "CPF number of the beneficiary.", "type": "string", "example": "12345678901" }, "beneficiaryNis": { "description": "NIS number of the beneficiary.", "type": "string", "example": "12345678901" }, "beneficiaryName": { "description": "Full name of the beneficiary.", "type": "string", "example": "MARIA SILVA SANTOS" }, "beneficiaryState": { "description": "State of the beneficiary.", "type": "string", "example": "AL" }, "municipalityCode": { "description": "IBGE municipality code.", "type": "string", "example": "2745" }, "municipalityName": { "description": "Municipality name.", "type": "string", "example": "CORURIPE" }, "benefitReferenceMonth": { "description": "Reference month for benefit.", "type": "string", "example": "01/10/2022", "format": "DD/MM/YYYY" }, "installmentValueReceived": { "description": "Amount received for installment.", "type": "string", "example": "1212.00" }, "fishingRegistrationNumber": { "description": "RGP fishing registration number.", "type": "string", "example": "123456" }, "bolsaFamiliaInsuranceSameDate": { "description": "Indicates if the person received both benefits in same period.", "type": "boolean", "example": "false" } }, "required": [ "isInRegistry", "beneficiaryCpf", "beneficiaryNis", "beneficiaryName", "beneficiaryState", "municipalityCode", "municipalityName", "benefitReferenceMonth", "installmentValueReceived", "fishingRegistrationNumber", "bolsaFamiliaInsuranceSameDate" ] }, "CadastroUnicoRegistryResponseAuxilioEmergencialBenefit": { "type": "object", "properties": { "state": { "description": "State where aid was registered.", "type": "string", "example": "PR" }, "value": { "description": "Monetary value of aid installment.", "type": "string", "example": "300,00" }, "observation": { "description": "Remarks about benefit status.", "type": "string", "example": "NAO HA" }, "installments": { "description": "Specific installment number.", "type": "string", "example": "9" }, "municipality": { "description": "City where the beneficiary resides.", "type": "string", "example": "CAMBE" }, "classification": { "description": "Category of the beneficiary.", "type": "string", "example": "CADUN NAO BOLSA" }, "isInRegistry": { "description": "Whether the end-user was found in the Emergency Aid registry.", "type": "boolean", "example": "true" }, "availableMonth": { "description": "Month when the funds became available.", "type": "string", "example": "12/2020", "format": "MM/YYYY" }, "municipalityCode": { "description": "Municipality code.", "type": "string", "example": "1234567" } }, "required": [ "state", "value", "observation", "installments", "municipality", "classification", "isInRegistry", "availableMonth", "municipalityCode" ] }, "ValidationsProcessing": { "type": "object", "properties": { "result": { "description": "Validation outcome", "type": "string", "enum": [ "success", "failure" ], "example": "success" }, "reasons": { "description": "Explanations for when the validation failed.\n\n`null` or empty if `result` value is `success`.\n", "type": "array", "example": null, "nullable": "true", "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "ValidationsIsUserDataValid": { "type": "object", "properties": { "result": { "description": "Validation outcome.", "type": "string", "enum": [ "success", "failure" ], "example": "success" }, "reasons": { "description": "Explanations for when validation failed.\n\n`null` or empty if `result` was `success`.\n", "type": "array", "example": null, "nullable": "true", "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "ValidationsIsNotOnPia": { "type": "object", "properties": { "result": { "description": "Validation outcome.", "type": "string", "enum": [ "success", "failure" ], "example": "failure" }, "reasons": { "description": "Explanations for when validation failed.\n\n`null` or empty if `result` was `success`.\n", "type": "array", "example": [ "User is on PIA registry" ], "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "ValidationsIsNotOnProBet": { "type": "object", "properties": { "result": { "description": "Validation outcome.", "type": "string", "enum": [ "success", "failure" ], "example": "failure" }, "reasons": { "description": "Explanations for when validation failed.\n\n`null` or empty if `result` was `success`.\n", "type": "array", "example": [ "User is on Pro Bet registry" ], "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "RegistryResponsePepData": { "type": "object", "properties": { "name": { "description": "Full name of the PEP.", "type": "string", "example": "MARIA SILVA SANTOS" }, "role": { "description": "Public office or role held.", "type": "string", "example": "SECRETARIO GERAL" }, "organization": { "description": "Government body or organization.", "type": "string", "example": "SECRETARIA NACIONAL DE DESENVOLVIMENTO REGIONAL" }, "exerciseStartDate": { "description": "Role start date.", "type": "string", "format": "DD/MM/YYYY", "example": "25/07/2023" }, "exerciseEndDate": { "description": "Role end date.", "type": "string", "format": "DD/MM/YYYY", "example": "" }, "pepValidityDate": { "description": "PEP validity date.", "type": "string", "example": "" } }, "required": [ "name", "role", "organization", "exerciseStartDate", "exerciseEndDate", "pepValidityDate" ] }, "RegistryResponseArtistData": { "type": "object", "properties": { "cpf": { "description": "Brazilian Tax ID.", "type": "string", "example": "12345678901" }, "name": { "description": "Legal name.", "type": "string", "example": "MARIA SILVA SANTOS" }, "artisticName": { "description": "Stage or public name.", "type": "string", "example": "MARIA SILVA SANTOS" }, "occupation": { "description": "Profession or role.", "type": "string", "example": "CANTORA" } }, "required": [ "cpf", "name", "artisticName", "occupation" ] }, "RegistryResponsePiaData": { "type": "object", "properties": { "isInRegistry": { "description": "Indicates whether found in PIA registry.", "type": "boolean", "example": "true" }, "cnpj": { "description": "Company tax identification number.", "type": "string", "example": "12345678901234" }, "companyName": { "description": "Legal company name.", "type": "string", "example": "LOTERICA BOM DESTINO LTDA" }, "type": { "description": "Business category.", "type": "string", "example": "CASAS LOTERICAS" } }, "required": [ "isInRegistry", "cnpj", "companyName", "type" ] }, "RegistryResponseInfluencerData": { "type": "object", "properties": { "artisticName": { "description": "Social media name.", "type": "string", "example": "MARIA SILVA SANTOS" }, "socialMediaUrl": { "description": "Primary social media URL.", "type": "string", "example": "" }, "areaOfActivity": { "description": "Influence category.", "type": "string", "example": "INFLUENCER" } }, "required": [ "artisticName", "socialMediaUrl", "areaOfActivity" ] }, "RegistryResponseScoreData": { "type": "object", "properties": { "isAllowedToBet": { "description": "Indicates whether the end-user is allowed to bet.", "type": "boolean", "example": "false" } }, "required": [ "isAllowedToBet" ] }, "OfficialDatabaseVerificationMatchData": { "type": "object", "properties": { "gender": { "description": "Indicates the match level of person's gender data from initData or the document against the registry data.\n", "type": "string", "enum": [ "MATCH", "NO_MATCH", "NO_INPUT", "NO_DATA" ], "example": "MATCH" }, "dateOfBirth": { "description": "Indicates the match level of person's date of birth data from initData or the document against the registry data.\n", "type": "string", "enum": [ "MATCH", "NO_MATCH", "NO_INPUT", "NO_DATA" ], "example": "NO_INPUT" }, "fullName": { "description": "Indicates the match level of person's full name data from initData or the document against the registry data.\n", "type": "string", "enum": [ "MATCH", "NO_MATCH", "NO_INPUT", "NO_DATA" ], "example": "MATCH" } }, "required": [ "gender", "dateOfBirth", "fullName" ] }, "OfficialDatabaseVerificationIneValidations": { "type": "object", "properties": { "ineCardIsValid": { "description": "Confirms that the INE credential exists and data matches.", "allOf": [ { "$ref": "#/components/schemas/IneValidationsIneCardIsValid" } ] }, "ineIsValidForVoting": { "description": "Verifies active voting rights.", "allOf": [ { "$ref": "#/components/schemas/IneValidationsIneIsValidForVoting" } ] }, "processing": { "description": "Processing validation result.", "allOf": [ { "$ref": "#/components/schemas/IneValidationsProcessing" } ] }, "matching": { "description": "Optional, present only when the input data matching validation has\nbeen enabled for your integration (`matchData` object is part of payload).\n", "allOf": [ { "$ref": "#/components/schemas/OfficialDatabaseValidationsMatching" } ] } }, "required": [ "ineCardIsValid", "ineIsValidForVoting", "processing", "matching" ] }, "OfficialDatabaseVerificationIneRegistryResponse": { "type": "object", "properties": { "cic": { "description": "CIC (Código de Identificación de la Credencial) aka credential identification code.", "type": "string", "example": "IDMEX2023456789012" }, "electorKey": { "description": "Voter key (Clave de Elector) assigned to the credential holder.", "type": "string", "example": "GOMZJN89041509H300" }, "federalDistrict": { "description": "Federal electoral district number.", "type": "string", "example": "4" }, "issueNumber": { "description": "The issue/emission number of the credential (1-9 indicating how many times the credential has been reissued).\n", "type": "string", "example": "3" }, "issueyear": { "description": "Year the current credential was issued.", "type": "string", "example": "2018" }, "validity": { "description": "Expiration date of the credential.", "format": "DD de MMMM de YYYY in Spanish", "type": "string", "example": "31 de diciembre de 2028" }, "ocr": { "description": "OCR (Optical Character Recognition) code from the credential.", "type": "string", "example": "0876543210987" }, "registrationYear": { "description": "Year the person was registered in the electoral system.", "type": "string", "example": "2010" } }, "required": [ "cic", "electorKey", "federalDistrict", "issueNumber", "issueyear", "validity", "ocr", "registrationYear" ] }, "OfficialDatabaseVerificationCurpValidations": { "type": "object", "properties": { "processing": { "description": "Indicates processing validation result.", "allOf": [ { "$ref": "#/components/schemas/CurpValidationsProcessing" } ] }, "curpIsValid": { "description": "CURP validity validation result.", "allOf": [ { "$ref": "#/components/schemas/CurpValidationsCurpIsValid" } ] }, "curpHasNoRiskFactors": { "description": "Risk factors validation result.", "allOf": [ { "$ref": "#/components/schemas/CurpValidationsCurpHasNoRiskFactors" } ] }, "matching": { "description": "Indicates if the end-user's data from initData or\ndocument extraction could be matched against the data in registry.\n", "allOf": [ { "$ref": "#/components/schemas/OfficialDatabaseValidationsMatching" } ] } }, "required": [ "processing", "curpIsValid", "curpHasNoRiskFactors", "matching" ] }, "CurpValidationsRegistryResponse": { "type": "object", "properties": { "curp": { "description": "The validated CURP number.", "type": "string", "example": "VISH560427MSRLNL06" }, "paternalSurname": { "description": "Person's paternal surname from the registry.", "type": "string", "example": "VILLA" }, "maternalSurname": { "description": "Person's maternal surname from the registry.", "type": "string", "example": "SANCHES" }, "names": { "description": "Person's given name(s) from the registry.", "type": "string", "example": "GLORIA" }, "gender": { "description": "Person's gender from the registry.", "type": "string", "example": "MUJER" }, "dob": { "description": "Date of birth from the registry.", "type": "string", "example": "27/04/1956", "format": "DD/MM/YYYY" }, "nationality": { "description": "Person's nationality.", "type": "string", "example": "MEXICO" }, "supportingDocument": { "description": "Type of supporting document used for CURP registration.", "type": "string", "example": "1" }, "registrationEntity": { "description": "Entity where the person was registered.", "type": "string", "example": "SONORA" }, "registrationStateNumber": { "description": "State indicator where the person was registered.", "type": "string", "example": "" }, "registrationMunicipalityKey": { "description": "Municipality indicator where the person was registered.", "type": "string", "example": "" }, "page": { "description": "Page number from birth certificate (if applicable).", "type": "string", "example": "" }, "tome": { "description": "Tome number from birth certificate (if applicable).", "type": "string", "example": "" }, "book": { "description": "Book number from birth certificate (if applicable).", "type": "string", "example": "" }, "minutesNumber": { "description": "Minutes number from civil registry.", "type": "string", "example": "02203" }, "crip": { "description": "CRIP identifier (if applicable).", "type": "string", "example": "" }, "registrationEntity2": { "description": "Secondary registration entity.", "type": "string", "example": "HERMOSILLO" }, "registrationYear": { "description": "Year of registration.", "type": "string", "example": "" }, "foreignRegistrationNumber": { "description": "Foreign registration number.", "type": "string", "example": "1956" }, "letterFolio": { "description": "Letter folio from registration.", "type": "string", "example": "" }, "birthStateKey": { "description": "State of birth code.", "type": "string", "example": "SONORA" }, "issueEntityKey": { "description": "Entity that issued the CURP.", "type": "string", "example": "SONORA" }, "curpStatus": { "description": "Current status of the CURP.", "type": "string", "example": "RNC" }, "certificateFolio": { "description": "Certificate information.", "type": "string", "example": "" } }, "required": [ "curp", "paternalSurname", "maternalSurname", "names", "gender", "dob", "nationality", "supportingDocument", "registrationEntity", "registrationStateNumber", "registrationMuniciplaityKey", "page", "tome", "book", "minutesNumber", "crip", "registrationEntity2", "registrationYear", "foreignRegistrationNumber", "letterFolio", "birthStateKey", "issueEntityKey", "curpStatus", "certificateFolio" ] }, "AddressValidationResultValidationsCountryExists": { "type": "object", "properties": { "result": { "description": "Indicates the result of country validation or if it was skipped.\n", "type": "string", "enum": [ "success", "failure", "skipped" ], "example": "skipped", "nullable": "true" } }, "required": [ "result" ] }, "IneValidationsIneCardIsValid": { "type": "object", "properties": { "result": { "description": "Indicates if the request was properly processed.\n\nOne of `success`, `failure` (there was an error when processing the request),\n`not_applicable` (processing check was not configured) or `skipped`.\n", "type": "string", "example": "success", "enum": [ "success", "failure", "not_applicable", "skipped" ] }, "reasons": { "description": "Additional information about the validation result. \n\nNot sent if `result`: `success`.\n", "type": "array", "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "IneValidationsIneIsValidForVoting": { "type": "object", "properties": { "result": { "description": "Indicates if the request was properly processed.\n\nOne of `success`, `failure` (there was an error when processing the request),\n`not_applicable` (processing check was not configured) or `skipped`.\n", "type": "string", "enum": [ "success", "failure", "not_applicable", "skipped" ], "example": "success" }, "reasons": { "description": "Additional information about the validation result. \n\nNot sent if `result`: `success`.\n", "type": "array", "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "IneValidationsProcessing": { "type": "object", "properties": { "result": { "description": "Indicates if the request was properly processed.\n\nOne of `success`, `failure` (there was an error when processing the request),\n`not_applicable` (processing check was not configured) or `skipped`.\n", "type": "string", "example": "success" }, "reasons": { "description": "Additional information about the validation result. \n\nNot sent if `result`: `success`.\n", "type": "array", "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "OfficialDatabaseValidationsMatching": { "type": "object", "properties": { "result": { "description": "Always `success`, irrespective of `matchData` results.", "type": "string", "enum": [ "success" ], "example": "success" } }, "required": [ "result" ] }, "CurpValidationsProcessing": { "type": "object", "properties": { "result": { "description": "Indicates if the request was properly processed.\n\nOne of `success`, `failure` (there was an error when processing the request),\n`not_applicable` (processing check was not configured) or `skipped`.\n", "type": "string", "enum": [ "success", "failure", "not_applicable", "skipped" ], "example": "success" }, "reasons": { "description": "Additional information about the validation result. \n\nNot sent if `result`: `success`.\n", "type": "array", "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "CurpValidationsCurpIsValid": { "type": "object", "properties": { "result": { "description": "Indicates if the request was properly processed.\n\nOne of `success`, `failure` (there was an error when processing the request),\n`not_applicable` (processing check was not configured) or `skipped`.\n", "type": "string", "enum": [ "success", "failure", "not_applicable", "skipped" ], "example": "success" }, "reasons": { "description": "Additional information about the validation result. \n\nNot sent if `result`: `success`.\n", "type": "array", "items": { "type": "string" } } }, "required": [ "result", "reasons" ] }, "CurpValidationsCurpHasNoRiskFactors": { "type": "object", "properties": { "result": { "description": "Indicates if the request was properly processed.\n\nOne of `success`, `failure` (there was an error when processing the request),\n`not_applicable` (processing check was not configured) or `skipped`.\n", "type": "string", "enum": [ "success", "failure", "not_applicable", "skipped" ], "example": "not_applicable" }, "reasons": { "description": "Additional information about the validation result. \n\nNot sent if `result`: `success`.\n", "type": "array", "example": [], "items": { "type": "string" } } }, "required": [ "result", "reasons" ] } } } } ````