Change provided information

Updates the personal data provided by the applicant.

Overview

Use this method to update the fixedInfo object that contains the personal data provided either by the applicant via the Web and Mobile SDKs or directly by you while creating the applicant profile. This information is to be cross-checked with the data Sumsub extracts from the applicant documents.

The method is rather beneficial because you do not need to create another profile when obtaining new information about the applicant, you just make this PATCH request instead.

Mind that if you need to re-check the applicant once the information has been changed, you need to revert the applicant status to pending by initiating another review.

📘

Note

Make sure that a verification level associated with the applicant for which the data is being updated, includes the Applicant data step.

If this step is excluded, then the applicant will not be able to correct the data by themselves when initiating the SDK. In case the integration is via API, Sumsub can see if the Applicant data step is in the settings, and refer to it when verifying the applicant.

Request example

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

The request 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": "Stanley",
  "firstNameEn": "Stanley",
  "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"
}
Language
Authorization
Header
Click Try It! to start a request and see the response here!