Change Profile Data details

Log in to see full request history

Overview

Use this method to update the information in the Profile Data section of an applicant profile. For example, you can change the applicant identifier as it is registered on your side, assign another source key to the applicant, and so on.

In the Dashboard, you can only edit some of the Profile Data fields, provided you have proper permissions.

Request example

curl -X PATCH \ 'https://api.sumsub.com/resources/applicants' \ -H 'Content-Type: application/json' \ -d '{ "id": "5e9ad53d0a975a656d67e4d0", "externalUserId": "userIdOnYourSide", "email": "new@email.com", "phone": "+49 123456789", "sourceKey": "newSourceKey", "metadata": [ { "key": "keyFromClient", "value": "valueFromClient" } ], "lang": "en" }'

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

Response explained

The response is a JSON file representing the applicant profile with augmented and structured information. You can find the response structure, possible content with descriptions, and response examples on this page.

Response example

{ "id": "5e9ad53d0a975a656d67e4d0", "createdAt": "2020-04-18 10:23:57", "inspectionId": "5e9ad53d0a975a656d67e4d1", "externalUserId": "1983114", "email": "new@email.nz", "requiredIdDocs": { "docSets": [ { "idDocSetType": "IDENTITY", "types": [ "ID_CARD", "PASSPORT", "DRIVERS" ] }, { "idDocSetType": "SELFIE", "types": [ "SELFIE" ], "videoRequired": "liveness" } ] }, "review": { "createDate": "2020-04-18 10:25:53+0000", "expireDate": "2020-04-18 10:40:53+0000", "reviewStatus": "init" }, "lang": "en", "type": "individual" }

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

For example:

{ "description": "Malformed data provided in the request", "code": 400, "correlationId": "b0e8cacbb0024fa37129118767d0f871" }
Body Params
string
required

Unique applicant identifier in the Sumsub system. It correlates to applicantId.

This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant is created on the Sumsub side, and can be found in the Dashboard.

If the applicantId is unknown to you, use the Get applicant data (externalUserId) method to fetch it.

string

New unique applicant identifier as registered on your side.

  • This identifier can be used to get the applicant data in case the applicantId in the Sumsub system is unknown to you.
  • When creating an applicant, you can generate and add the externalUserId manually, or it will be automatically generated and added by Sumsub.

string

New applicant email address.

It is mandatory if the email verification is required. If not provided, the applicant cannot receive verification status emails.

string

New applicant phone number.

It is mandatory if the phone verification is required.

string

New source key that you want to assign to the applicant.

Mind that you must specify one of the previously created and existing source keys. Otherwise, nothing will be changed.

string

Specify a new language in the two-letter code (ISO 639-1 format, for example, en, fr, de) for the SDK and emails sent to the applicant.

The verification results should be displayed to the applicant in this language as well. As a rule, it is detected by the applicant IP address. You can set the language when creating an applicant or initializing the SDK (MSDK).

array

Additional information in custom fields that is not displayed to the applicant and not checked by Sumsub.

You can specify any information related to the applicant you want. For example: [{"key": "keyFromClient", "value": "valueFromClient"}].

metadata
Language
Credentials
Click Try It! to start a request and see the response here!