Get started with Non-Doc Address Verification
To start using Non-Doc Address Verification, you can opt for:
- Code-free integration involving our SDKs.
- API integration.
Note
- Non-Doc Address Verification comes at an additional cost regardless of the integration method. Make sure to contact us before starting the integration.
- To view and manage your available and active Non-Doc Address Verification products, refer to this article
Verify address via SDK
Use our Web and Mobile SDKs to conduct Non-Doc Address Verification code-free:
- Set up the integration, as described in the WebSDK integration article and MobileSDK integration article.
- Create a verification level, add an Applicant data verification step, and submit the data as per table references.
- Conduct verification and handle verification results.
Verify address via API
You can utilize our public API endpoints to conduct Address Verification using the Non-Doc solution:
- Create a verification level with an Applicant data step.
- Include the Required fields as specified in the table and add Recommended/Optional fields to increase the positive impact on pass rates.
- Create an applicant and pass the level name created at step 1 as the
levelNamequery parameter.
curl -X POST \
'https://api.sumsub.com/resources/applicants?levelName=non-doc-address-2x2' \
-H 'Content-Type: application/json' \
-d '{
"externalUserId": "someUniqueUserId",
"metadata": [
{
"key": "documentNumber",
"value": "12345678"
}
],
"fixedInfo": {
"firstName": "Franco Manuel",
"lastName": "Martinez",
"dob": "1990-02-13",
"country": "ARG",
"phone": "+54 1234 5678",
"addresses": [
{
"street": "Corrientes",
"buildingNumber": "1538",
"town": "Villa Carlos Paz",
"state": "Córdoba",
"postCode": "X5152",
"country": "ARG"
}
]
}
}'{
"id": "668b827860f280647fa07091",
"createdAt": "2024-07-08 06:08:56",
"key": "DGATQKRNEXWUCD",
"clientId": "ClientName",
"inspectionId": "668b827860f280647fa07092",
"externalUserId": "htr23wq435trujasdgdgdf",
"info": { },
"fixedInfo": {
"firstName": "Franco Manuel",
"lastName": "Martinez",
"dob": "1990-02-13",
"country": "ARG",
"phone": "+54 1234 5678",
"addresses": [ {
"street": "Corrientes",
"state": "Córdoba",
"buildingNumber": "1538",
"town": "Villa Carlos Paz",
"postCode": "X5152",
"country": "ARG",
"formattedAddress": "Corrientes, 1538, Villa Carlos Paz, Córdoba, Argentina, X5152"
} ]
},
"applicantPlatform": "API",
"requiredIdDocs": {
"videoIdent": false,
"docSets": [ {
"idDocSetType": "APPLICANT_DATA",
"fields": [ {
"name": "firstName",
"required": true,
"prefill": null
}, {
"name": "middleName",
"required": false,
"prefill": null
}, {
"name": "lastName",
"required": true,
"prefill": null
}, {
"name": "dob",
"required": false,
"prefill": null
}, {
"name": "country",
"required": true,
"prefill": null
}, {
"name": "street",
"required": false,
"prefill": null
}, {
"name": "subStreet",
"required": false,
"prefill": null
}, {
"name": "town",
"required": false,
"prefill": null
}, {
"name": "postCode",
"required": false,
"prefill": null
}, {
"name": "phone",
"required": false,
"prefill": null
}, {
"name": "tin",
"required": false,
"prefill": null
} ],
"customFields": [ {
"name": "documentNumber",
"displayName": "National ID Number",
"required": false
} ]
} ]
},
"review": {
"reviewId": "AYMIW",
"attemptId": "HehBH",
"attemptCnt": 0,
"levelName": "non-doc-address-2x2",
"levelAutoCheckMode": null,
"createDate": "2024-07-08 06:08:56+0000",
"reviewStatus": "init",
"priority": 0
},
"type": "individual",
"metadata": [ {
"key": "documentNumber",
"value": "12345678"
} ]
}
ImportantPay attention to the following fields from the table reference:
- The National ID number must be provided in the metadata as the
documentNumberfield."metadata": [ { "key": "documentNumber", "value": "12345678" } ]- The Tax Identification number must be provided as
TINin the.fixedInfoobject.
curl -X POST \
'https://api.sumsub.com/resources/applicants/5b73b82f0a975a3b46429758/status/pending'{
"ok": 1
}Fallback to standard verification
In case something goes wrong during Non-Doc Address Verification or you just want to verify applicants using the standard document verification approach:
- For SDKs, use the Workflow Builder to configure the verification flow as necessary.
- For the API, If you already have a complex logic on your side, move the applicants to a desired level by using this API method.
Updated 2 days ago