Change profile data details

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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 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).

date-time

Date and time when the applicant was initially registered in your system. Format: YYYY-MM-DD hh:mm:ss (for example, 2025-01-15 10:20:35).

metadata
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
structuredMetadata
object

Container for structured applicant metadata and configuration settings.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!