👩🏫 The data providers review and confirm the accuracy of the provided data.
Data Provider result depends on the configured Data provider per client. If the Data provider is not present, then the data_provider field is not included in the Fetch a Transaction - JSON - Response. It will be defined in a JSON object with the following structure:
IDMartrix Example
{
"DATA_CONNECT": "DataConnectResult",
"ID_MATRIX": "IdMatrixResult"
}
Pep and Sanctions Example
{
"DATA_CONNECT": "DataConnectResult",
"OCRLABS_PEP_SANCTIONS": "OCRLabsPepSanctionsResult"
}
Serpro Example
{
"DATA_CONNECT": "DataConnectResult",
"OCRLABS_SERPRO": "OcrLabsSerproResult"
}
The following table explains the details of each field:
Note:
There will be various responses depending on user activity. There are two categories:
- Mandatory: means the field and its value will always be returned, even with
nullvalues.- Optional: means the field would not exist in some cases when either:
- The transaction is not completed yet.
- The client has not configured a data provider in Settings.
| Fields | Data Type | Mandatory/Optional | Description | Possible Response |
|---|---|---|---|---|
DATA_CONNECT | object | Optional | DataConnect will respond if the Data provider check's result is DataConnect. | - The field will not exist if the Data provider check was not DataConnect- If the data has been redacted, the result will be invalid with null.- Otherwise, it will always be present. |
ID_MATRIX | object | Optional | IdMatrix will respond if the Data provider check's result is IdMatrix. | - The field will not exist if the Data provider check was not IDMatrix- If the data has been redacted, the result will be invalid with null.- Otherwise, it will always be present. |
OCRLABS_PEP_SANCTIONS | object | Optional | OCR Labs PEP and Sanctions will respond if the data provider has been configured in client settings. - Validate individual results against - Politically Exposed Persons: current, former and linked - Sanctions: current and former - Regulatory Enforcement Lists - Reputational Risk Exposure dataset | - The field "OCRLABS_PEP_SANCTIONS" will not exist if the Data Provider check was not OCRLABS_PEP_SANCTIONSIf the transaction is redacted, the "OCRLABS_PEP_SANCTIONS" will show the "overall" result, but the data node will be NULL.- Otherwise, it will always be present. |
OCRLABS_SERPRO | object | Optional | OCRLABS_SERPRO will respond if the data provider has been configured in client settings. | - The field "OCRLABS_SERPRO" will not exist if the Data Provider check was not Serpro- If the transaction is redacted, the "OCRLABS_SERPRO" will show the "overall" result, but the data node will be NULL.- If the CPF Consultation call returns an invalid CPF, the Datavalid API check is not invoked. - The "Document Only" flow, i.e., the Normal V2 flow for which the Liveness Check is turned off, will only invoke the Serpro Consulta CPF API and not the Serpro Datavalid API. - Otherwise, it will always be present. |
Below is the data_provider sample response:
Info:
All contents under the
data{...}field are returned by the Data provider and are not under IDVerse' control.
"data_provider": {
"DATA_CONNECT": {
"overall": "FAILED",
"data": {
"rapidID": "<check-id>",
"VerifyDocumentResult": {
"attributes": {
"i:type": "DriverLicenceResponse"
},
"VerificationResultCode": "N",
"OriginatingAgencyCode": "XXXX",
"ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
},
"fieldDetails": {
"BirthYear": "No Match",
"BirthMonth": "No Match",
"FamilyName": "No Match",
"LicenceNumber": "No Match",
"GivenName": "No Match",
"BirthDay": "No Match",
"StateOfIssue": "No Match",
"ImmiCardNumber": "No Match",
"MiddleName": "No Match",
"ExpiryDay": "No Match",
"RegistrationState": "No Match",
"CardType": "No Match",
"CountryOfIssue": "No Match",
"BirthDate": "No Match"
}
},
"message": "OK",
"version": "1.0.0",
"xml": false
},
"ID_MATRIX": {
"data": {
"fraudAssessment": {
"dataSource": [
{
"name": "Politically Exposed Person (PEP) Verification",
"result": "PASS",
"score": "100.0",
"threshold": "50.0",
"weight": "0.25"
},
{
"name": "Velocity Verification",
"result": "PASS",
"score": "100.0",
"threshold": "50.0",
"weight": "0.25"
},
{
"name": "FraudCheck Shared Fraud Database",
"result": "PASS",
"score": "100.0",
"threshold": "50.0",
"weight": "0.25"
},
{
"name": "Sanctions Check",
"result": "PASS",
"score": "100.0",
"threshold": "50.0",
"weight": "0.25"
}
],
"overall": [
{
"name": "Overall Result",
"value": "PASS"
},
{
"name": "Overall Fraud Score",
"value": "100/100"
},
{
"name": "Overall Threshold",
"value": "50.0"
}
]
},
"overall": "ACCEPT",
"searchResults": {
"overall": "ACCEPT",
"rulesResults": [
{
"name": "Overall Decision",
"value": "ACCEPT"
},
{
"name": "Overall Points",
"value": "119.0"
},
{
"name": "IDMatrix Minimum Requirements Verification",
"value": "MATCH"
},
{
"name": "IDMatrix Safe Harbour Verification",
"value": "MATCH"
}
],
"searchResults": {
"fraudassessment": [
{
"components": {
"address": "NO MATCH",
"dob": "NO MATCH",
"fraud": "NO MATCH",
"full_name": "NO MATCH",
"id": "NO MATCH",
"name": "NO MATCH"
},
"name": "Velocity (v1.0)",
"points": "0",
"results": 0,
"searchName": "VEDA-EVVELOCITY-0026",
"value": "NO MATCH"
},
{
"components": {
"address": "NO MATCH",
"dob": "NO MATCH",
"fraud": "NO MATCH",
"full_name": "NO MATCH",
"id": "NO MATCH",
"name": "NO MATCH"
},
"name": "GlobalScreening - PEPs (Domestic) (v1.0)",
"points": "0",
"results": 0,
"searchName": "ACC-PEPS-0048",
"value": "NO MATCH"
},
{
"components": {
"address": "NO MATCH",
"dob": "NO MATCH",
"fraud": "NO MATCH",
"full_name": "NO MATCH",
"id": "NO MATCH",
"name": "NO MATCH"
},
"name": "GlobalScreening - Sanctions (International) (v2.0)",
"points": "0",
"results": 0,
"searchName": "ACC-COMPLINK-0021",
"value": "NO MATCH"
},
{
"components": {
"address": "NO MATCH",
"dob": "NO MATCH",
"fraud": "NO MATCH",
"full_name": "NO MATCH",
"id": "NO MATCH",
"name": "NO MATCH"
},
"name": "Fraud Lookup - Address (v1.0)",
"points": "0",
"results": "0",
"searchName": "VEDA-SFDADDR-0023",
"value": "NO MATCH"
}
],
"verification": [
{
"components": {
"address": "PASS",
"dob": "PASS",
"fraud": "PASS",
"full_name": "PASS",
"id": "PASS",
"name": "PASS"
},
"name": "Credit Bureau Consumer (v3.0)",
"points": "59",
"results": "98",
"searchName": "VEDA-CBCONS-0050",
"value": "PASS"
},
{
"components": {
"address": "PASS",
"dob": "PASS",
"fraud": "PASS",
"full_name": "PASS",
"id": "PASS",
"name": "PASS"
},
"name": "Credit Bureau Consumer (v3.2)",
"points": "0",
"results": "100",
"searchName": "VEDA-CBCONS-0066",
"value": "PASS"
},
{
"components": {
"address": "PASS",
"dob": "PASS",
"fraud": "PASS",
"full_name": "PASS",
"id": "PASS",
"name": "PASS"
},
"name": "Australian Electoral Roll (v3.0)",
"points": "60",
"results": "100",
"searchName": "AEC-ER-0049",
"value": "PASS"
}
]
},
"verificationOutcome": {
"indicator": "ACCEPT",
"totalPoints": "119"
}
},
"summary": [
{
"name": "Reference",
"value": "200822-98BE2-ADFA9"
},
{
"name": "Profile Name",
"value": "KYC-TEST_PROFILE_GEE-Service1"
},
{
"name": "Profile Version",
"value": "1"
}
]
},
"encrypted_xml": "example/transaction_id/encrypted-id-matrix-response.xml.enc",
"message": "OK",
"version": "1.0.0"
}
}
Data Provider - DataConnectResult
DATA_CONNECT will be defined in a JSON object with the following structure:
Info:
All contents under the
data{...}field are returned by the Data provider and are not under IDVerse' control.
"data_provider": {
"DATA_CONNECT": {
"overall": "FAILED",
"data": {
"rapidID": "<check-id>",
"VerifyDocumentResult": {
"attributes": {
"i:type": "DriverLicenceResponse"
},
"VerificationResultCode": "N",
"OriginatingAgencyCode": "XXXX",
"ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
},
"fieldDetails": {
"BirthYear": "No Match",
"BirthMonth": "No Match",
"FamilyName": "No Match",
"LicenceNumber": "No Match",
"GivenName": "No Match",
"BirthDay": "No Match",
"StateOfIssue": "No Match",
"ImmiCardNumber": "No Match",
"MiddleName": "No Match",
"ExpiryDay": "No Match",
"RegistrationState": "No Match",
"CardType": "No Match",
"CountryOfIssue": "No Match",
"BirthDate": "No Match"
}
},
"message": "OK",
"version": "1.0.0",
"xml": false
}
}
However, if the data_provider data is redacted, you will see the following response:
"data_provider": {
"DATA_CONNECT": null
}
Data Provider - IdMatrixResult
ID_MATRIX will be defined in a JSON object with the following structure:
Info:
All contents under the
data{...}field are returned by the Data provider and are not under IDVerse' control.
"data_provider": {
"ID_MATRIX": {
"data": {
"fraudAssessment": {
"dataSource": [
{
"name": "Politically Exposed Person (PEP) Verification",
"result": "PASS",
"score": "100.0",
"threshold": "50.0",
"weight": "0.25"
},
{
"name": "Velocity Verification",
"result": "PASS",
"score": "100.0",
"threshold": "50.0",
"weight": "0.25"
},
{
"name": "FraudCheck Shared Fraud Database",
"result": "PASS",
"score": "100.0",
"threshold": "50.0",
"weight": "0.25"
},
{
"name": "Sanctions Check",
"result": "PASS",
"score": "100.0",
"threshold": "50.0",
"weight": "0.25"
}
],
"overall": [
{
"name": "Overall Result",
"value": "PASS"
},
{
"name": "Overall Fraud Score",
"value": "100/100"
},
{
"name": "Overall Threshold",
"value": "50.0"
}
]
},
"overall": "ACCEPT",
"searchResults": {
"overall": "ACCEPT",
"rulesResults": [
{
"name": "Overall Decision",
"value": "ACCEPT"
},
{
"name": "Overall Points",
"value": "119.0"
},
{
"name": "IDMatrix Minimum Requirements Verification",
"value": "MATCH"
},
{
"name": "IDMatrix Safe Harbour Verification",
"value": "MATCH"
}
],
"searchResults": {
"fraudassessment": [
{
"components": {
"address": "NO MATCH",
"dob": "NO MATCH",
"fraud": "NO MATCH",
"full_name": "NO MATCH",
"id": "NO MATCH",
"name": "NO MATCH"
},
"name": "Velocity (v1.0)",
"points": "0",
"results": 0,
"searchName": "VEDA-EVVELOCITY-0026",
"value": "NO MATCH"
},
{
"components": {
"address": "NO MATCH",
"dob": "NO MATCH",
"fraud": "NO MATCH",
"full_name": "NO MATCH",
"id": "NO MATCH",
"name": "NO MATCH"
},
"name": "GlobalScreening - PEPs (Domestic) (v1.0)",
"points": "0",
"results": 0,
"searchName": "ACC-PEPS-0048",
"value": "NO MATCH"
},
{
"components": {
"address": "NO MATCH",
"dob": "NO MATCH",
"fraud": "NO MATCH",
"full_name": "NO MATCH",
"id": "NO MATCH",
"name": "NO MATCH"
},
"name": "GlobalScreening - Sanctions (International) (v2.0)",
"points": "0",
"results": 0,
"searchName": "ACC-COMPLINK-0021",
"value": "NO MATCH"
},
{
"components": {
"address": "NO MATCH",
"dob": "NO MATCH",
"fraud": "NO MATCH",
"full_name": "NO MATCH",
"id": "NO MATCH",
"name": "NO MATCH"
},
"name": "Fraud Lookup - Address (v1.0)",
"points": "0",
"results": "0",
"searchName": "VEDA-SFDADDR-0023",
"value": "NO MATCH"
}
],
"verification": [
{
"components": {
"address": "PASS",
"dob": "PASS",
"fraud": "PASS",
"full_name": "PASS",
"id": "PASS",
"name": "PASS"
},
"name": "Credit Bureau Consumer (v3.0)",
"points": "59",
"results": "98",
"searchName": "VEDA-CBCONS-0050",
"value": "PASS"
},
{
"components": {
"address": "PASS",
"dob": "PASS",
"fraud": "PASS",
"full_name": "PASS",
"id": "PASS",
"name": "PASS"
},
"name": "Credit Bureau Consumer (v3.2)",
"points": "0",
"results": "100",
"searchName": "VEDA-CBCONS-0066",
"value": "PASS"
},
{
"components": {
"address": "PASS",
"dob": "PASS",
"fraud": "PASS",
"full_name": "PASS",
"id": "PASS",
"name": "PASS"
},
"name": "Australian Electoral Roll (v3.0)",
"points": "60",
"results": "100",
"searchName": "AEC-ER-0049",
"value": "PASS"
}
]
},
"verificationOutcome": {
"indicator": "ACCEPT",
"totalPoints": "119"
}
},
"summary": [
{
"name": "Reference",
"value": "200822-98BE2-ADFA9"
},
{
"name": "Profile Name",
"value": "KYC-TEST_PROFILE_GEE-Service1"
},
{
"name": "Profile Version",
"value": "1"
}
]
},
"encrypted_xml": "example/transaction_id/encrypted-id-matrix-response.xml.enc",
"message": "OK",
"version": "1.0.0"
}
}
However, if the data_provider data is redacted, you will see the following response:
"data_provider": {
"DATA_CONNECT": null
}
Data Provider - OCR Labs PEP and Sanctions (Powered By Acuris/ION)
OCRLABS_PEP_SANCTIONS will be defined in a JSON object with the following structure if passed:
"data_provider": {
"OCRLABS_PEP_SANCTIONS": {
"overall": "PASSED",
"data": {
"checkId": "client_5f541775-3a4a-4d27-8f01-ac7b142f8eb6",
"matches": [],
"raw_response": "{\"check_id\":\"client_5f541775-3a4a-4d27-8f01-ac7b142f8eb6\",\"provider_response\":{\"results\":{\"matchCount\":0,\"matches\":[]}}}"
},
"message": "OK",
"version": "1.0.0",
"xml": false
}
},
OCRLABS_PEP_SANCTIONS will be defined in a JSON object with the following structure if flagged:
"data_provider": {
"OCRLABS_PEP_SANCTIONS": {
"overall": "FLAGGED",
"data": {
"checkId": "client_850e6190-8674-464e-a178-b9cfa7db7457",
"matches": [
{
"countries": [
"NZ"
],
"datasets": [
"PEP-CURRENT",
"SAN-CURRENT"
],
"datesOfBirth": [
"1980-07-26"
],
"gender": "Female",
"match": "Ardern Jacinda",
"name": "Jacinda Kate Laurell Ardern",
"pepTier": "PEP Tier 1",
"profileImage": "https://www.acurisriskintelligence.com/cdn/content/ari0202227/RpHfDuRHnEa2x7iGYxkBW.png",
"qrCode": "1691834",
"resourceId": "68f9a8df0282b6fe5d38663af1f92d35db8b1f5788cd7a12f470bbf9fff6da18",
"resourceUri": "/individuals/68f9a8df0282b6fe5d38663af1f92d35db8b1f5788cd7a12f470bbf9fff6da18",
"score": 96,
"version": 1691480889011
}
],
"raw_response": "{\"check_id\":\"client_850e6190-8674-464e-a178-b9cfa7db7457\",\"provider_response\":{\"results\":{\"matchCount\":1,\"matches\":[{\"countries\":[\"NZ\"],\"datasets\":[\"PEP-CURRENT\",\"SAN-CURRENT\"],\"datesOfBirth\":[\"1980-07-26\"],\"gender\":\"Female\",\"match\":\"Ardern Jacinda\",\"name\":\"Jacinda Kate Laurell Ardern\",\"pepTier\":\"PEP Tier 1\",\"profileImage\":\"https://www.acurisriskintelligence.com/cdn/content/ari0202227/RpHfDuRHnEa2x7iGYxkBW.png\",\"qrCode\":\"1691834\",\"resourceId\":\"68f9a8df0282b6fe5d38663af1f92d35db8b1f5788cd7a12f470bbf9fff6da18\",\"resourceUri\":\"/individuals/68f9a8df0282b6fe5d38663af1f92d35db8b1f5788cd7a12f470bbf9fff6da18\",\"score\":96,\"version\":1691480889011}]}}}"
},
"message": "OK",
"version": "1.0.0",
"xml": false
}
}
Note:
All transactions before February 2024 might or can include Datazoo reference URLs.
OCRLABS_PEP_SANCTIONS will be defined in a JSON object with the following structure if redacted:
"data_provider": {
"OCRLABS_PEP_SANCTIONS": {
"overall": "PASSED",
"data": {
"checkId": null,
"matches": null,
"raw_response": null
},
"message": null,
"version": null,
"xml": null
}
},
Data Provider - Serpro
OCRLABS_SERPRO will be defined in a JSON object with the following structure if passed:
Note:
Please note that the following is an example of only CPF Consulta results in the response.
"data_provider": {
"OCRLABS_SERPRO": {
"overall": "FLAGGED",
"data": {
"cpf": {
"birth_date": "21101940",
"checkId": "client_56ab0acb-23e6-4812-82cf-084cde6fb052",
"cpf": "03658252804",
"death_date": "2022",
"name": "EDSON ARANTES DO NASCIMENTO",
"result": false,
"situation_code": 3,
"situation_description": "Titular falecido",
"status": 200
}
},
"message": "OK",
"version": "1.0.0",
"xml": false
}
},
OCRLABS_SERPRO will be defined in a JSON object with the following structure if flagged:
Note:
Please note that the following is an example of CPF Consulta and Datavalid API results in the response.
"OCRLABS_SERPRO": {
"data": {
"cpf": {
"birth_date": "23101998",
"checkId": "client_c977ce3d-e15c-4cc4-8e1a-d9ab3e8a5fef",
"cpf": "40913607851",
"death_date": null,
"name": "BEATRIZ DE SOUZA BATISTA",
"result": true,
"situation_code": 0,
"situation_description": "Regular",
"status": 200
},
"data_valid": {
"checkId": "client_f93d4fdd-f752-418c-8973-507c455ea777",
"cnh_available": true,
"cpf_available": true,
"face_available": false,
"face_probability": "Baixíssima probabilidade",
"face_similarity": 0.19243275,
"result": false,
"status": 200
},
"overall": "FLAGGED"
},
💬 We Are Here to Help!
If you encounter an issue, a bug, or require assistance, please contact our support page here to find the solution. Don't forget to provide any important information on the issue.