Verification data retrieval
Webhooks are the recommended method for receiving verification results. They provide information efficiently as events happen.
Use the additional data retrieval endpoints only in these specific fallback scenarios:
- If you suspect a webhook notification failed or missed some data.
- To fetch details for a verification after it has already finished.
These endpoints are meant for troubleshooting individual cases, not for routine integration. Relying on webhooks ensures the best performance. If you face issues, please contact technical support.
Do not use the /api/v2/status endpoint as part of your main integration flow to check verification status.
This endpoint is strictly a supplement for webhooks, intended only for isolated cases where a webhook isn't working correctly or data is missing.
Regularly polling /api/v2/status is not supported. It can lead to system inefficiencies, and your account access may be restricted. Always use webhooks for status updates. For assistance, contact technical support.
You might find that some data fields in the response are empty or null. This typically occurs for one of two reasons:
- The information was not present on the specific document provided.
- The data was unreadable due to the quality of the submitted image.
Verification status
status retrieval endpointAuthorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/api/v2/status
Status
For more details on status, see vocabulary
Request example
{
"scanRef": "scan-ref"
}
Response example
{
"fraudTags": [],
"mismatchTags": [],
"autoDocument": "DOC_VALIDATED",
"autoFace": "FACE_MATCH",
"manualDocument": "DOC_VALIDATED",
"manualFace": "FACE_MATCH",
"scanRef": "328c6766-934e-11ed-bb9b-025ad99a18e7",
"clientId": "W2GL2K333Y",
"status": "APPROVED"
}
Verification data
data retrieval endpointAuthorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/api/v2/data
data
Any of the specified fields below can be null. Also, some fields in original language may have symbols
encoded in UTF-16.
Response example
{
"docFirstName": "JOHN",
"docLastName": "SAMPLE PETER",
"docNumber": "DE4878783",
"docPersonalCode": null,
"docExpiry": "2024-03-09",
"docDob": "1965-03-10",
"docDateOfIssue": "2014-03-09",
"docType": "PASSPORT",
"docSex": "MALE",
"docNationality": "NL",
"docIssuingCountry": "NL",
"docTemporaryAddress": null,
"docBirthName": null,
"birthPlace": "LONDON",
"authority": "BURG",
"address": null,
"mothersMaidenName": null,
"driverLicenseCategory": null,
"manuallyDataChanged": false,
"fullName": "JOHN SAMPLE PETER",
"orgFirstName": "JOHN",
"orgLastName": "SAMPLE PETER",
"orgNationality": "NEDERLANDSE",
"orgBirthPlace": "LONDON",
"orgAuthority": "BURG",
"orgAddress": null,
"orgTemporaryAddress": null,
"orgMothersMaidenName": null,
"orgBirthName": null,
"selectedCountry": "NL",
"ageEstimate": null,
"clientIpProxyRiskLevel": null,
"duplicateFaces": null,
"duplicateDocFaces": null,
"addressVerification": null,
"additionalData": {},
"scanRef": "328c6766-934e-11ed-bb9b-025ad99a18e7",
"clientId": "W2GL2K333Y"
}
Verification files
Authorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/api/v2/files
Response example
{
"FACE": "https:...",
"FRONT": "https://...",
"fileUrls": {
"FACE": "https://...",
"FRONT": "https://..."
},
"videoUrls": {},
"additionalStepPdfUrls": {}
}
Please use photo URLs in fileUrls. File URLs not in fileUrls or videoUrls could be removed in future.