Overview
Use this method to add a consent on processing personal applicant data to the specified applicant profile.
A standard use of this method is when you are practising exclusively the API integration, so you can submit a consent the applicant has agreed to via the API.
The method can also be beneficial, for example, if your applicant has already given all the necessary consents, and you no longer need the consent text to be displayed in the SDKs for this applicant.
Request example
curl --request POST \
--url https://api.sumsub.com/resources/applicants/656a2722ea802f0f724e00e7/agreement \
--header 'content-type: application/json'
--data '{
"records": [
{
"content": "some_consent_content"
},
{
"content": "some_agreement_content"
}
],
"acceptedAt": "2022-01-01 01:01:01",
"residenceCountry": "USA"
}'
Response explained
Upon successful execution, the response will have a status code of 200 and include the applicant information in the JSON format, as described in Get applicant data.
Refer to the agreement object for detailed information about consent acceptance.
Attention
A new data format for the
agreementobject has been introduced (see the response examples below for details). The old format will be deprecated and no longer be supported starting June 10, 2025.Update your integration accordingly to ensure continued compatibility.
Response examples
The following difference exists between the new and old agreement objects.
The new agreement object includes an items array of objects, where each object represents an individual consent. Since an applicant can agree to the same consent multiple times (e.g., for onboarding and reusable KYC), all these instances are grouped within the same item.
{
"id": "654a2724ea803f0f724e00e7",
"createdAt": "2023-11-07 12:01:40",
"clientId": "my_key_name",
"inspectionId": "654a2734ea802f0f724e00e8",
"externalUserId": "myapp",
"fixedInfo": {
"firstName": "John",
"firstNameEn": "John",
"middleName": "Timothy",
"middleNameEn": "Timothy",
"lastName": "Doe",
"lastNameEn": "Doe",
"residenceCountry": "USA"
},
"applicantPlatform": "API",
"agreement": {
"items": [
{
"id": "aea6411c-4a34-4d16-9e2c-62bd2c850011",
"acceptedAt": "2024-03-25 06:56:47",
"source": "API",
"type": "onboarding",
"recordIds": [
"6401202f39c56ebefd4497b9",
"67f0c31bf26d8087f14d133d"
],
}
],
},
"requiredIdDocs": {
"videoIdent": true,
"videoIdentUploadTypes": [
"ID_CARD",
"PASSPORT"
],
"docSets": [
{
"idDocSetType": "IDENTITY",
"types": [
"ID_CARD",
"PASSPORT",
"RESIDENCE_PERMIT",
"DRIVERS"
],
"subTypes": [
"FRONT_SIDE",
"BACK_SIDE"
],
"videoRequired": "disabled",
"captureMode": "manualAndAuto",
"uploaderMode": "always"
},
{
"idDocSetType": "IDENTITY2",
"types": [
"VISA"
]
}
]
},
"review": {
"reviewId": "zUUXB",
"attemptId": "OpBfU",
"attemptCnt": 0,
"levelName": "basic-kyc-level",
"createDate": "2023-11-07 12:01:40+0000",
"reviewStatus": "init",
"priority": 0
},
"type": "individual"
}
{
"id": "654a2724ea803f0f724e00e7",
"createdAt": "2023-11-07 12:01:40",
"clientId": "my_key_name",
"inspectionId": "654a2734ea802f0f724e00e8",
"externalUserId": "myapp",
"fixedInfo": {
"firstName": "John",
"firstNameEn": "John",
"middleName": "Timothy",
"middleNameEn": "Timothy",
"lastName": "Doe",
"lastNameEn": "Doe",
"residenceCountry": "USA"
},
"applicantPlatform": "API",
"agreement": {
"createdAt": "2024-03-25 06:56:47",
"acceptedAt": "2024-03-25 06:56:47",
"source": "API",
"recordIds": [
"6401202f39c56ebefd4497b9",
"67f0c31bf26d8087f14d133d"
]
},
"requiredIdDocs": {
"videoIdent": true,
"videoIdentUploadTypes": [
"ID_CARD",
"PASSPORT"
],
"docSets": [
{
"idDocSetType": "IDENTITY",
"types": [
"ID_CARD",
"PASSPORT",
"RESIDENCE_PERMIT",
"DRIVERS"
],
"subTypes": [
"FRONT_SIDE",
"BACK_SIDE"
],
"videoRequired": "disabled",
"captureMode": "manualAndAuto",
"uploaderMode": "always"
},
{
"idDocSetType": "IDENTITY2",
"types": [
"VISA"
]
}
]
},
"review": {
"reviewId": "zUUXB",
"attemptId": "OpBfU",
"attemptCnt": 0,
"levelName": "basic-kyc-level",
"createDate": "2023-11-07 12:01:40+0000",
"reviewStatus": "init",
"priority": 0
},
"type": "individual"
}