Overview
Use this method to record that an applicant has already accepted certain legally significant language outside of the SDK. This may include, for example, the acknowledgment of a privacy notice or consenting to data processing.
The method is typically used in API-only integrations or cases where consent has been obtained externally and does not need to be presented again in the SDK.
Recorded consents become part of the applicant's consent history and can be retrieved via the Get applicant-facing consents method.
Notes
- If the applicant gave a single consent that covers multiple agreements, add multiple objects to the
recordsarray.- If the applicant gave separate consents, you can include multiple objects in the
applicantAgreementsarray. These will be grouped within a single item in the response, using the most recentacceptedAttimestamp.
Request example
curl -X POST \
'https://api.sumsub.com/resources/applicants/6824bc5e93dc802528e9df79/agreements' \
-H 'content-type: application/json' \
-d '{
"applicantAgreements": [
{
"records": [
{
"content": "agreement_text_1"
},
{
"content": "agreement_text_2"
}
],
"acceptedAt": "2025-04-01 01:01:04",
"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.
Response example
The agreement object includes an items array, where each object represents an individual consent event and may contain multiple agreements.
{
"id": "68275b92cfe61383cb7b81d2",
"createdAt": "2025-05-16 15:36:50",
"clientId": "your_cool_id",
"externalUserId": "SomeExternalUserId",
"applicantPlatform": "Web",
"agreement": {
"items": [
{
"id": "0d9ae56b-1ab7-4486-851f-39f52630f2e0",
"acceptedAt": "2025-05-16 15:42:30",
"source": "API",
"type": "onboarding",
"recordIds": [
"68275b37070f404802ba0cff",
"68275b37070f404802ba0d12"
]
},
{
"id": "b651bc62-2cdd-4cb5-85ae-9922f395be7f",
"acceptedAt": "2025-05-18 15:47:08",
"source": "API",
"type": "onboarding",
"recordIds": [
"68275dfc070f404802c85f81"
]
}
]
},
"requiredIdDocs": {
"docSets": [
{
"idDocSetType": "PHONE_VERIFICATION"
}
]
},
"review": {
"reviewId": "QRZtn",
"attemptId": "FCBXT",
"attemptCnt": 0,
"levelName": "basic_phone_check",
"createDate": "2025-05-16 15:36:50+0000",
"reviewStatus": "init",
"priority": 0
},
"lang": "en",
"type": "individual"
}