Callbacks and Retrieval API - Netverify to the Jumio Platform
Callbacks in the Jumio Platform do not return any PII data for the transaction. Jumio Platform callbacks only provide the transaction status and metadata. To access transaction details you must call the retrieval APIs.
Learn more about callback here.
Netverify Callbacks
Netverify callbacks included complete transaction details as URL parameters appended to your callback URL.
Example Callback Parameters
idExpiry=2022-12-31&idType=PASSPORT&idDob=....
Jumio Platform Callbacks
Jumio Platform callbacks do not contain any PII data. Transaction status and metadata are provided as the body of the POST request sent to your Callback URL.
Example Callback Request Body
{
"callbackSentAt":"2021-01-21T14:55:01.917Z",
"workflowExecution":{
"id":"22222222-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"href":"https://retrieval.apac-1.jumio.ai/api/v1/accounts/11111111-xxxx-xxxx-xxxx-xxxxxxxxxxxx/workflow-executions/22222222-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"definitionKey":"3",
"status":"PROCESSED"
},
"account":{
"id":"11111111-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"href":"https://retrieval.apac-1.jumio.ai/api/v1/accounts/11111111-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}
Retrieval API
The APIs and data model for retrieving transactions have changed.
For more information checkout,
Netverify Retrieval APIs
Netverify retrieval APIs used different endpoints for different Jumio products, such as ID Verification, Document Verification, and Authorization.
Examples Details Response
Details
{
"timestamp": "2019-03-20T16:25:38.663Z",
"scanReference": "xxxxxxxx-xxxx-xxxx-...",
"document": {
"type": "DRIVING_LICENSE",
"dob": "1990-01-01",
"expiry": "2022-12-31",
"firstName": "FIRST NAME",
"issuingCountry": "AUT",
"issuingDate": "2013-01-01",
"lastName": "LAST NAME",
"number": "123456789",
"status": "APPROVED_VERIFIED"
},
"transaction": {
"clientIp": "XX.XX.X.XX",
"customerId": "CUSTOMERID",
"date": "2019-01-01T11:01:10.227Z",
"merchantReportingCriteria": "...",
"merchantScanReference": "...",
"source": "WEB_UPLOAD",
"status": "DONE"
},
"verification": {
"identityVerification": {
"similarity": "MATCH",
"validity": "true"
},
"mrzCheck": "NOT_AVAILABLE"
},
"facemap": {
"classifier": "facemap",
"href": "https://netverify.com/api/netverify/v2/scans/xxx..."
}
}
Jumio Platform Retrieval APIs
The structure of Jumio Platform detail responses provide separate objects for credentialsClosed and capabilitiesClosed.
Example Details Response
Details
{
"workflow": {
"id": "9541ae91-834e-4914-a30d-6534fed4eb6d",
"status": "PROCESSED",
"definitionKey": "10549",
"userReference": "FBC02D3F-C3B5-4B19-A663-00AE0886A704_1660925181283",
"customerInternalReference": "test ref"
},
"account": {
"id": "310ede34-41ab-4f2b-ac47-b5c3553edf03"
},
"createdAt": "2022-11-07T22:56:00.112Z",
"startedAt": "2022-11-07T22:57:34.012Z",
"completedAt": "2022-11-07T22:57:47.892Z",
"credentials": [
{
"id": "7e5ad90a-9277-44d4-a5cb-7797420220fc",
"category": "SELFIE",
"parts": [
{
"classifier": "FACE",
"href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/310ede34-41ab-4f2b-ac47-b5c3553edf03/credentials/7e5ad90a-9277-44d4-a5cb-7797420220fc/parts/FACE"
}
]
},
{
"id": "b420829c-abe6-4df8-93cb-93f85cd9d5ac",
"category": "ID",
"parts": [
{
"classifier": "FRONT",
"href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/310ede34-41ab-4f2b-ac47-b5c3553edf03/credentials/b420829c-abe6-4df8-93cb-93f85cd9d5ac/parts/FRONT"
},
{
"classifier": "BACK",
"href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/310ede34-41ab-4f2b-ac47-b5c3553edf03/credentials/b420829c-abe6-4df8-93cb-93f85cd9d5ac/parts/BACK"
}
]
},
{
"id": "78974167-956f-4087-b4f1-04782c929e05",
"category": "FACEMAP",
"parts": [
{
"classifier": "FACEMAP"
},
{
"classifier": "LIVENESS_1",
"href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/310ede34-41ab-4f2b-ac47-b5c3553edf03/credentials/78974167-956f-4087-b4f1-04782c929e05/parts/LIVENESS_1"
},
{
"classifier": "LIVENESS_3",
"href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/310ede34-41ab-4f2b-ac47-b5c3553edf03/credentials/78974167-956f-4087-b4f1-04782c929e05/parts/LIVENESS_3"
},
{
"classifier": "LIVENESS_2",
"href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/310ede34-41ab-4f2b-ac47-b5c3553edf03/credentials/78974167-956f-4087-b4f1-04782c929e05/parts/LIVENESS_2"
},
{
"classifier": "LIVENESS_5",
"href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/310ede34-41ab-4f2b-ac47-b5c3553edf03/credentials/78974167-956f-4087-b4f1-04782c929e05/parts/LIVENESS_5"
},
{
"classifier": "LIVENESS_4",
"href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/310ede34-41ab-4f2b-ac47-b5c3553edf03/credentials/78974167-956f-4087-b4f1-04782c929e05/parts/LIVENESS_4"
},
{
"classifier": "LIVENESS_6",
"href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/310ede34-41ab-4f2b-ac47-b5c3553edf03/credentials/78974167-956f-4087-b4f1-04782c929e05/parts/LIVENESS_6"
}
]
}
],
"decision": {
"type": "WARNING",
"details": {
"label": "WARNING"
},
"risk": {
"score": 50.0
}
},
"steps": {
"href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/310ede34-41ab-4f2b-ac47-b5c3553edf03/workflow-executions/9541ae91-834e-4914-a30d-6534fed4eb6d/steps"
},
"capabilities": {
"extraction": [
{
"id": "29ddc912-d5dd-4750-85ba-10d969556d32",
"credentials": [
{
"id": "b420829c-abe6-4df8-93cb-93f85cd9d5ac",
"category": "ID"
}
],
"decision": {
"type": "PASSED",
"details": {
"label": "OK"
}
},
"data": {
"type": "DRIVING_LICENSE",
"subType": "REGULAR_DRIVING_LICENSE",
"issuingCountry": "USA",
"firstName": "THOMAS JACOB",
"lastName": "GOERING",
"dateOfBirth": "1957-01-18",
"expiryDate": "2025-01-18",
"issuingDate": "2019-12-26",
"documentNumber": "N7624107",
"state": "CA",
"gender": "M",
"currentAge": "65"
}
}
],
"similarity": [
{
"id": "76a58e7b-b9db-493d-9a8b-a1756e499085",
"credentials": [
{
"id": "7e5ad90a-9277-44d4-a5cb-7797420220fc",
"category": "SELFIE"
},
{
"id": "b420829c-abe6-4df8-93cb-93f85cd9d5ac",
"category": "ID"
}
],
"decision": {
"type": "PASSED",
"details": {
"label": "MATCH"
}
},
"data": {
"similarity": "MATCH"
}
}
],
"liveness": [
{
"id": "bfa003f6-c400-4696-973c-7dbdf890006b",
"credentials": [
{
"id": "7e5ad90a-9277-44d4-a5cb-7797420220fc",
"category": "SELFIE"
},
{
"id": "78974167-956f-4087-b4f1-04782c929e05",
"category": "FACEMAP"
}
],
"decision": {
"type": "PASSED",
"details": {
"label": "OK"
}
},
"data": {
"predictedAge": 46,
"ageConfidenceRange": "34-58"
}
}
],
"dataChecks": [
{
"id": "1d0587eb-aca3-41a7-be70-fbcd08de420c",
"credentials": [
{
"id": "b420829c-abe6-4df8-93cb-93f85cd9d5ac",
"category": "ID"
}
],
"decision": {
"type": "PASSED",
"details": {
"label": "OK"
}
}
}
],
"imageChecks": [
{
"id": "1110bc6c-708c-444d-b41a-6164d71e3c6f",
"credentials": [
{
"id": "7e5ad90a-9277-44d4-a5cb-7797420220fc",
"category": "SELFIE"
},
{
"id": "b420829c-abe6-4df8-93cb-93f85cd9d5ac",
"category": "ID"
}
],
"decision": {
"type": "WARNING",
"details": {
"label": "REPEATED_FACE"
}
},
"data": {
"faceSearchFindings": {
"status": "DONE",
"findings": [
"22771260-8cb0-42a2-a38a-d8f853063cc2",
"27232651-4b18-4cf1-8d4a-df0451abc717"
]
}
}
}
],
"usability": [
{
"id": "70ee4aad-fde7-44f9-92f9-97ca77c28f09",
"credentials": [
{
"id": "b420829c-abe6-4df8-93cb-93f85cd9d5ac",
"category": "ID"
}
],
"decision": {
"type": "PASSED",
"details": {
"label": "OK"
}
}
},
{
"id": "9fb1876e-6078-4ea5-aba6-d68c200634fb",
"credentials": [
{
"id": "7e5ad90a-9277-44d4-a5cb-7797420220fc",
"category": "SELFIE"
}
],
"decision": {
"type": "PASSED",
"details": {
"label": "OK"
}
}
},
{
"id": "810cb95c-a7d0-46fc-bd2a-45b241a669f8",
"credentials": [
{
"id": "78974167-956f-4087-b4f1-04782c929e05",
"category": "FACEMAP"
}
],
"decision": {
"type": "PASSED",
"details": {
"label": "OK"
}
}
}
]
}
}