Overview
Use this method to update the data in the Profile information section of an applicant profile, providing more flexibility than the Dashboard. For example, you can change the applicant identifier as registered on your side, modify the applicant registration date in your system, and so on.
In the Dashboard, you can only edit some of the Profile information 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": "[email protected]",
"phone": "+49 123456789",
"sourceKey": "newSourceKey",
"metadata": [
{
"key": "keyFromClient",
"value": "valueFromClient"
}
],
"lang": "en"
}'
Note
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": "[email protected]",
"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"
}