| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Overview
Use this method to update the fixedInfo object, which contains the personal data provided either by the applicant via the Web and Mobile SDKs or by you directly when creating the applicant profile. Sumsub cross-checks this data with the data it extracts from the applicant's documents.
The method saves you from creating another profile when you receive new information about the applicant. Send a PATCH request instead.
If you need to re-check the applicant after the information has changed, revert the applicant status to pending by initiating another review.
Attention
- Do not use this endpoint to change information for a company applicant. To modify provided company data, use Change provided company data instead.
- Custom field values from the Applicant data step are stored in the applicant's
metadata. The field definitions are inrequiredIdDocs→docSets→customFieldsand are configured in the level settings in the Dashboard. To change these values via API, use Change profile data details with themetadataarray. UsefixedInfoonly for standard fields, such as country or date of birth, because it does not acceptmetadata.
NoteMake sure that the applicant's verification level includes the Applicant data step. Without it, the applicant cannot correct the data in the SDK. For API integrations, Sumsub checks whether the step is in the level settings and refers to it when verifying the applicant.
Required permissions
To use this method, your app token must have the Change applicant's personal data permission.
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
pendingby initiating another review.
NoteMake 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.
AttentionDo not use this endpoint to change information for a company applicant. To modify provided company data, use the following method instead.
Required permissions
To use this method, your app token must have the Change applicant's personal data permission.
Request example
curl -X PATCH \
'https://api.sumsub.com/resources/applicants/609d68bf4606470000000000/fixedInfo' \
-H 'Content-Type: application/json' \
-H 'X-App-Token: <your-app-token>' \
-H 'X-App-Access-Sig: <your-signature>' \
-H 'X-App-Access-Ts: <unix-timestamp>' \
-d '{
"firstName": "Stanley",
"dob": "1997-03-01",
"placeOfBirth": "Denver",
"countryOfBirth": "USA",
"stateOfBirth": "Colorado"
}'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"
}