Overview

Use this method to retrieve information extracted from the applicant’s documents, provided the applicant is approved. The method aggregates data from all documents and ignores verification levels.

To retrieve information recognized only from approved documents, set the forApprovedImages parameter to true. In this mode, the method works exclusively for approved applicants and approved documents.

🚧

Important

If the applicant is in the Rejected or Resubmission requested status, the method returns an error.

Request examples

// This request returns data only from approved applicant documents.

curl -X GET \ 
    'https://api.sumsub.com/resources/applicants/67b3659550a9ed51c777daa9/info/idDocs?forApprovedImages=true'

// This request returns data from all applicant documents, independent of their approval status.

curl -X GET \ 
    'https://api.sumsub.com/resources/applicants/67b3659550a9ed51c777daa9/info/idDocs'

Response explained

The response is a JSON object containing information extracted from the applicant's documents. Its structure and content match the format of the idDocs array returned by the Get applicant data method.

idDocs element fields

The table below describes the fields that represent data extracted from the applicant’s documents.

address attributes

The following table explains the address attributes that represent the applicant address details.

nfcInfo attributes

The following table explains the nfcInfo attributes representing the data extracted from the NFC chip of an identity document.

Response examples

If the request is successfully sent and processed, you will get a response like the one below.

{
  "idDocs": [
    {
      "idDocType": "ID_CARD",
      "country": "DEU",
      "firstName": "CHRISTIAN",
      "firstNameEn": "CHRISTIAN",
      "lastName": "SMITH",
      "lastNameEn": "SMITH",
      "aliasName": "BROOKS",
      "validUntil": "2028-09-04",
      "number": "LGXX359T8",
      "dob": "1989-07-16",
      "mrzLine1": "IDD<<LGXX359T88<<<<<<<<<<<<<<<",
      "mrzLine2": "8907167<2809045D<<<<<<<<<<<<<8",
      "mrzLine3": "SMITH<<CHRISTIAN<<<<<<<<<<<<<<",
      "nfcInfo": {
        "fullMrz": "MRZ IS HERE",
        "imageId": "IMAGE ID IS HERE"
      }
    }
  ]
}

If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:

{
   "code": 400,
   "description": "Applicant should be not in rejected state",
   "correlationId": "955bce80ffb06f470d4bd7665f02f2df"
}