Retrieval Response Examples

The following retrieval response examples show typical fields and values that are captured for a transaction. They are provided to assist with understanding the differences in the data models.

Netverify /v2/scans/<scanReference>/data Response

A GET request to the /v2/scans/<scanReference>/data API returns a JSON object containing nested objects for document, transaction, and verification.

info

the <scanReference> value is obtained from the response to the call to the Netverify Acquisitions API

https://acquisition.netverify.com/api/netverify/v2/acquisitions API:

Response

{
"timestamp": "2017-10-17T06:37:51.969Z",
"scanReference": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

For additional information see: ID Verification Retrieval API Implementation Guide

Example

{
    "timestamp": "2019-03-20T16:25:38.663Z",
    "scanReference": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "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": "YOURREPORTINGCRITERIA",
        "merchantScanReference": "YOURSCANREFERENCE",
        "source": "WEB_UPLOAD",
        "status": "DONE"
    },
    "verification": {
        "identityVerification": {
            "similarity": "MATCH",
            "validity": "true"
        }
    }, "facemap": {
        "classifier": "facemap",
        "href": "https://netverify.com/api/netverify/v2/scans/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/data/facemap"
    }
}

Jumio Platform API Responses

Following are examples of the API response bodies, in JSON format.

Account Creation Response

The <accountId> value, <workflowExcecutionId> value, authorization tokens, and URLs are obtained from the response to the call to the Accounts API. (https://account.<region>.jumio.ai/api/v1/accounts API):

Response

{
  "timestamp": "2022-11-22T23:51:19.152Z",
  "account": {
    "id": "310ede34-41ab-4f2b-ac47-b5c3553edf03"
  },
  "web": {
    "href": "https://greenunion.web.amer-1.jumio.ai/web/v4/app?authorizationToken=eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XMMQ7CMAyF4btkxlJibNdhY2TlBq6TsLQUiUogIe5O2huwvvfp_4T6Pq_hFJJITpJkyCnmcAjmfil9V7PI7AieKwKV6JCTITCqobbIqejGd3xshDq4gOQmQC4CI1eCXmCLpQ5ax45frf7D_Vpb14_luc52h3WZb-A2Tbh9ewilUYyskCgyEEqBUajA0ck051adNXx_y3qZiOwAAAA.Hv4xo7lzBstXZLYu6XVFp2TK3quWANfecnftOGXIuX2C5vvLN00PRkS31x5jiI6wfr2o5A65tEl67Ps7WhDE4w&locale=en-US"
  },
  "sdk": {
    "token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XMMQ7CMAyF4btkxlJibNdhY2TlBq6TsLQUiUogIe5O2huwvvfp_4T6Pq_hFJJITpJkyCnmcAjmfil9V7PI7AieKwKV6JCTITCqobbIqejGd3xshDq4gOQmQC4CI1eCXmCLpQ5ax45frf7D_Vpb14_luc52h3WZb-A2Tbh9ewilUYyskCgyEEqBUajA0ck051adNXx_y3qZiOwAAAA.Hv4xo7lzBstXZLYu6XVFp2TK3quWANfecnftOGXIuX2C5vvLN00PRkS31x5jiI6wfr2o5A65tEl67Ps7WhDE4w"
  },
  "workflowExecution": {
    "id": "9541ae91-834e-4914-a30d-6534fed4eb6d",
    "credentials": [
      {
        "id": "f769b899-2752-45d1-83b2-f5e13631d052",
        "category": "ID",
        "allowedChannels": ["WEB", "API", "SDK"],
        "api": {
          "token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XMMQ7CMAyF4btkxlJibNdhY2TlBq6TsLQUiUogIe5O2huwvvfp_4T6Pq_hFJJITpJkyCnmcAjmfil9V7PI7AieKwKV6JCTITCqobbIqejGd3xshDq4gOQmQC4CI1eCXmCLpQ5ax45frf7D_Vpb14_luc52h3WZb-A2Tbh9ewilUYyskCgyEEqBUajA0ck051adNXx_y3qZiOwAAAA.Hv4xo7lzBstXZLYu6XVFp2TK3quWANfecnftOGXIuX2C5vvLN00PRkS31x5jiI6wfr2o5A65tEl67Ps7WhDE4w",
          "parts": {
            "front": "https://api.amer-1.jumio.ai/api/v1/accounts/8aa055c2-c9e2-4d0c-91a2-528a28f051d8/workflow-executions/3f4287c6-69f6-4c66-b5e4-0555a0de78eb/credentials/f769b899-2752-45d1-83b2-f5e13631d052/parts/FRONT",
            "back": "https://api.amer-1.jumio.ai/api/v1/accounts/8aa055c2-c9e2-4d0c-91a2-528a28f051d8/workflow-executions/3f4287c6-69f6-4c66-b5e4-0555a0de78eb/credentials/f769b899-2752-45d1-83b2-f5e13631d052/parts/BACK"
          },
          "workflowExecution": "https://api.amer-1.jumio.ai/api/v1/accounts/8aa055c2-c9e2-4d0c-91a2-528a28f051d8/workflow-executions/3f4287c6-69f6-4c66-b5e4-0555a0de78eb"
        }
      },
      {
        "id": "02065ddb-d87d-45b3-9972-967d2c0837f1",
        "category": "FACEMAP",
        "allowedChannels": ["WEB", "SDK"]
      },
      {
        "id": "68179e08-ba1c-4794-a35a-32ea9c16f264",
        "category": "SELFIE",
        "allowedChannels": ["WEB", "API", "SDK"],
        "api": {
          "token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XMMQ7CMAyF4btkxlJibNdhY2TlBq6TsLQUiUogIe5O2huwvvfp_4T6Pq_hFJJITpJkyCnmcAjmfil9V7PI7AieKwKV6JCTITCqobbIqejGd3xshDq4gOQmQC4CI1eCXmCLpQ5ax45frf7D_Vpb14_luc52h3WZb-A2Tbh9ewilUYyskCgyEEqBUajA0ck051adNXx_y3qZiOwAAAA.Hv4xo7lzBstXZLYu6XVFp2TK3quWANfecnftOGXIuX2C5vvLN00PRkS31x5jiI6wfr2o5A65tEl67Ps7WhDE4w",
          "parts": {
            "face": "https://api.amer-1.jumio.ai/api/v1/accounts/8aa055c2-c9e2-4d0c-91a2-528a28f051d8/workflow-executions/3f4287c6-69f6-4c66-b5e4-0555a0de78eb/credentials/68179e08-ba1c-4794-a35a-32ea9c16f264/parts/FACE"
          },
          "workflowExecution": "https://api.amer-1.jumio.ai/api/v1/accounts/8aa055c2-c9e2-4d0c-91a2-528a28f051d8/workflow-executions/3f4287c6-69f6-4c66-b5e4-0555a0de78eb"
        }
      }
    ]
  }
}

Workflow Details Response

A GET request to the /api/v1/accounts/<accountId>/workflow-executions/<workflowExecutionId> API returns a JSON object containing arrays of nested objects for the credentials and the capabilities in the workflow.

Response

{
  "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",
        "validFaceMapForAuthentication": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/310ede34-41ab-4f2b-ac47-b5c3553edf03/credentials/78974167-956f-4087-b4f1-04782c929e05/parts/FACEMAP",
        "credentials": [
          { "id": "7e5ad90a-9277-44d4-a5cb-7797420220fc", "category": "SELFIE" },
          { "id": "78974167-956f-4087-b4f1-04782c929e05", "category": "FACEMAP" }
        ],
        "decision": { "type": "PASSED", "details": { "label": "OK" } },
        "data": {
          "type": "JUMIO_STANDARD",
          "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" } }
      }
    ]
  }
}

Response​

Example​

Jumio Platform API Responses​

Account Creation Response​

Workflow Details Response​

Table of Contents

Response

Example

Jumio Platform API Responses

Account Creation Response

Workflow Details Response