Overview

Use this method to update the info object that contains the personal applicant data recognized from the documents. This information is to be cross-checked with the provided applicant data (fixedInfo).

The method could be helpful if you believe the applicant documents have been recognized incorrectly and there are mistakes or typos in the extracted data.

📘

Note

If you request another check once you have updated the extracted information, there is always a chance this data will be overwritten when we run OCR for the same uploaded documents.

Request example

curl -X PATCH \
  'https://api.sumsub.com/resources/applicants/609d68bf460647000aa2d87e/info' \
  -H 'Content-Type: application/json' \
  -d '{
        "firstName": "John",
        "lastName": "Doe",
        "dob": "1997-03-01",
        "placeOfBirth": "Denver",
        "countryOfBirth": "USA",
        "stateOfBirth": "Colorado"
      }'

The body must contain only the fields that you want to change; null fields are ignored.

Response explained

If the request is successfully sent and processed, in the response, you will get a JSON file with the object containing the updated data. There could also be additional fields with automatic transliteration of the provided information into Latin characters.

For example:

{
  "firstName": "John",
  "firstNameEn": "John",
  "lastName": "Doe",
  "lastNameEn": "Doe",
  "dob": "1997-03-01",
  "placeOfBirth": "Denver",
  "placeOfBirthEn": "Denver",
  "countryOfBirth": "USA",
  "stateOfBirth": "Colorado"
}

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

For example:

{
  "description": "Invalid id '000000000'",
  "code": 400,
  "correlationId": "3773cd5e8ad50ea28fe40553717ffe3a"
}