Skip to main content

Service details for ReadID

This section goes more into detail about some useful endpoints when integrating with ReadID:

Start capture flow​

More information will follow later.

Get process​

This section describes the final result status that you receive in the Get process response for ReadID.

Final result status​

ReadID's response returns the data extracted from the document as well as the information about the results of the chip verification and chip clone detection.

Assure API uses the information in the chipVerification and chipCloneDetection fields to map the process' final status:

  • accepted:
    • chipVerification was successful.
    • chipCloneDetection was either successful or not available. This can happen with some older documents that do not support clone detection.
  • inconclusive: chipVerification was successful but chipCloneDetection failed. This means that it was not possible to check if the chip is real. Since this validation may fail for other reasons, we recommend that you allow the end-user to retry one or two more times.
  • rejected: chipVerification failed.

accepted​

This is a response example of a ReadID process that was accepted:

{
  "provider": "readid",
  "status": "accepted",
  "processId": "4e6aed00-f72a-4363-9d4a-418d66f5e49c",
  "providerSpecific": {
    "consolidatedIdentityData": {
      "chipVerification": "SUCCEEDED",
      "chipCloneDetection": "SUCCEEDED",
      "dateOfBirth": "2002-04-29",
      "dateOfExpiry": "2030-07-08",
      "documentCode": "P",
      "documentNumber": "P123456",
      "documentType": "passport",
      "gender": "F",
      "issuingCountry": "PRT",
      "nationality": "PRT",
      "personalIdentificationNumber": "123456789",
      "firstName": "MARIA PAULA",
      "lastName": "SANTOS MENDES"
    }
  },
  "finalResult": {
    "documentType": "passport",
    "firstName": "MARIA PAULA",
    "lastName": "SANTOS MENDES",
    "gender": "F",
    "nationality": "PRT",
    "dateOfBirth": "2002-04-29",
    "documentNumber": "P123456",
    "dateOfExpiry": "2030-07-08",
    "issuingCountry": "PRT",
    "personalIdentificationNumber": "123456789"
  },
  "processType": "ready",
  "createdAt": "2021-08-04T08:19:22Z",
  "updatedAt": "2021-08-04T08:21:56Z"
}

For field descriptions, see the Open API documentation > Get process.

inconclusive​

This is a response example of a ReadID process that was inconclusive:

{
  "provider": "readid",
  "status": "inconclusive",
  "processId": "36c9e4cb-9fe2-4326-a57b-ec1e7f6d2bbf",
  "providerSpecific": {
    "consolidatedIdentityData": {
      "chipVerification": "SUCCEEDED",
      "chipCloneDetection": "FAILED",
      "dateOfBirth": "2002-04-29",
      "dateOfExpiry": "2025-10-13",
      "documentCode": "P",
      "documentNumber": "P123456",
      "documentType": "passport",
      "gender": "F",
      "issuingCountry": "PRT",
      "nationality": "PRT",
      "personalIdentificationNumber": "123456789",
      "firstName": "MARIA PAULA",
      "lastName": "SANTOS MENDES"
    }
  },
  "processType": "ready",
  "createdAt": "2021-08-04T09:18:09Z",
  "updatedAt": "2021-08-04T09:24:01Z"
}

rejected​

This is a response example of a ReadID process that was rejected:

{
  "provider": "readid",
  "status": "rejected",
  "processId": "36c9e4cb-9fe2-4326-a57b-ec1e7f6d2bbf",
  "providerSpecific": {
    "consolidatedIdentityData": {
      "chipVerification": "FAILED",
      "chipCloneDetection": "SUCCEEDED",
      "dateOfBirth": "2002-04-29",
      "dateOfExpiry": "2025-10-13",
      "documentCode": "P",
      "documentNumber": "M123456",
      "documentType": "passport",
      "gender": "F",
      "issuingCountry": "PRT",
      "nationality": "PRT",
      "personalIdentificationNumber": "123456789",
      "firstName": "MARIA PAULA",
      "lastName": "SANTOS MENDES"
    }
  },
  "processType": "ready",
  "createdAt": "2021-08-04T09:18:09Z",
  "updatedAt": "2021-08-04T09:24:01Z"
}

For field descriptions, see the Open API documentation > Get process.

Final result status with iProov​

If you have added iProov to ReadID, the response will have an additional providerSpecific field, iProovSession, with information about the liveness and facial similarity checks.

accepted (iProov)​

Here is an accepted ReadID process with iProov liveness assurance:

{
  "processId": "093b6c3b-f1ec-49c2-b349-58c3176f7aa8",
  "provider": "readid",
  "processType": "ready",
  "status": "accepted",
  "finalResult": {
    "firstName": "MARIA PAULA",
    "lastName": "SANTOS MENDES",
    "dateOfExpiry": "2030-07-08",
    "dateOfBirth": "2002-04-29",
    "gender": "F",
    "nationality": "PRT",
    "documentType": "passport",
    "documentNumber": "P123456",
    "issuingCountry": "PRT",
    "personalIdentificationNumber": "123456789"
  },
  "providerSpecific": {
    "consolidatedIdentityData": {
      "chipVerification": "SUCCEEDED",
      "chipCloneDetection": "SUCCEEDED",
      "documentType": "passport",
      "firstName": "MARIA PAULA",
      "lastName": "SANTOS MENDES",
      "gender": "F",
      "nationality": "PRT",
      "dateOfBirth": "2002-04-29",
      "documentNumber": "P123456",
      "dateOfExpiry": "2030-07-08",
      "issuingCountry": "PRT",
      "documentCode": "P",
      "personalIdentificationNumber": "123456789"
    },
    "documentContent": {
      "dateOfBirth": "2002-04-29",
      "dateOfExpiry": "2030-07-08",
      "documentNumber": "P123456",
      "issuingCountry": "PRT",
      "personalIdentificationNumber": "123456789",
      "firstName": "MARIA PAULA",
      "lastName": "SANTOS MENDES",
      "gender": "F",
      "mrzFirstName": "MARIA PAULA",
      "mrzLastName": "SANTOS MENDES",
      "nationality": "PRT",
      "placeOfBirth": ""
    },
    "iproovSession": {
      "attempts": 1,
      "enrollmentImageSource": "Chip",
      "finished": true,
      "hasError": false,
      "passed": true,
      "iProovAssuranceType": "GENUINE_PRESENCE"
    }
  },
  "createdAt": "2023-12-07T22:32:50Z",
  "updatedAt": "2023-12-07T22:34:37Z"
}

inconclusive (iProov)​

In this response example, the status result is inconclusive since the iProov session was unsuccessful ("passed": false):

{
  "processId": "7e28b214-572d-41cc-ae57-ded4d766bef9",
  "provider": "readid",
  "processType": "ready",
  "status": "inconclusive",
  "providerSpecific": {
    "consolidatedIdentityData": {
      "chipVerification": "SUCCEEDED",
      "chipCloneDetection": "SUCCEEDED",
      "documentType": "passport",
      "firstName": "MARIA PAULA",
      "lastName": "SANTOS MENDES",
      "gender": "F",
      "nationality": "PRT",
      "dateOfBirth": "2002-04-29",
      "documentNumber": "P123456",
      "dateOfExpiry": "2030-07-08",
      "issuingCountry": "PRT",
      "documentCode": "P",
      "personalIdentificationNumber": "123456789"
    },
    "documentContent": {
      "dateOfBirth": "2002-04-29",
      "dateOfExpiry": "2030-07-08",
      "documentNumber": "P123456",
      "issuingCountry": "PRT",
      "personalIdentificationNumber": "123456789",
      "firstName": "MARIA PAULA",
      "lastName": "SANTOS MENDES",
      "gender": "F",
      "mrzFirstName": "MARIA PAULA",
      "mrzLastName": "SANTOS MENDES",
      "nationality": "PRT",
      "placeOfBirth": ""
    },
    "iproovSession": {
      "attempts": 3,
      "enrollmentImageSource": "Chip",
      "finished": true,
      "hasError": false,
      "passed": false,
      "iProovAssuranceType": "GENUINE_PRESENCE"
    }
  },
  "createdAt": "2023-12-07T22:39:27Z",
  "updatedAt": "2023-12-07T22:42:22Z"
}

rejected (iProov)​

iProov will never cause a rejected status. The rejected status will only happen if the document is invalid (see the general rejected example response above).

Download full result​

In the Get process response, you get the results for ReadID in the provider-specific area (for example chipVerification). For full information as obtained from the provider, use the Download full result service. This service returns a zip file containing data and media files about the verification.

You can always get a zip file for ReadID processes that have been completed with success.

Data file​

session.json​

This file contains ReadID’s interpretation of the data read from the chip of the identity document.

Media files​

Download full result with iProov​

If you have added iProov to ReadID, you will in addition to the above information, receive:

  • A selfie image (selfie.jpg) of the end-user captured by iProov to be compared with the ID document portrait.
  • An extra iProov field in the session.json file, for example:
Extra field in json file

Extra field in json file

On this page