Overview
Use this method to obtain a list of all accepted applicant consents. Thus, you retrieve the evidence of an applicant having acknowledged or accepted certain legally significant language (typically in the form of a consent or a notification) previously embedded in the user journey. This allows to ensure that your applicants are presented with the right set of legal documentation (e.g., your or Sumsub's privacy notice) before onboarding.
Note
Sumsub reserves the right to make any consents or notifications mandatory due to its own legal obligations.
Request example
curl -X GET \
'https://api.sumsub.com/resources/applicants/6819f8ef6de534aa22770f1a/acceptedAgreements' \
-H 'accept: application/json'
Response explained
The response is a JSON object representing the fact of the applicant granting consent or acknowledging a notification. It contains an applicantAgreements array, where each object corresponds to an individual text string (e.g., consent or notification).
If no relevant text string is present in the applicant profile, the method returns no data.
| Field | Type | Description |
|---|---|---|
createdAt | Date | Date and time (GMT) when the applicant granted a specific consent or acknowledged a specific notification via the SDK, or when the record of such was added via the API. |
acceptedAt | Date | Date and time (GMT) when the applicant granted a specific consent or acknowledged a specific notification. |
type | String | Indicates the way the consent was granted or the notification acknowledged (e.g., during onboarding or via reusable KYC). |
source | String | Specifies the source from which the applicant granted the consent or acknowledged the notification (WebSDK, MSDK, API). |
records | Array of objects | Each object includes a content attribute that contains the text of the individually granted consent or acknowledged notification. |
Response examples
If the request is successfully sent and processed, you will get a response like one of those below.
{
"applicantAgreements": [
{
"createdAt": "2025-05-06 11:56:43",
"acceptedAt": "2025-05-06 11:56:43",
"type": "onboarding",
"source": "WebSDK",
"records": [
{
"content": "agreement_text_1"
}
]
}
]
}
{
"applicantAgreements": [
{
"createdAt": "2025-05-14 14:46:31",
"acceptedAt": "2025-05-14 14:46:31",
"type": "onboarding",
"source": "WebSDK",
"records": [
{
"content": "agreement_text_1"
}
]
},
{
"createdAt": "2025-05-14 14:46:31",
"acceptedAt": "2025-05-14 14:34:57",
"type": "onboarding",
"source": "API",
"records": [
{
"content": "agreement_text_2"
},
{
"content": "agreement_text_3"
}
]
}
]
}
If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:
{
"code": 400,
"correlationId": "bed53eb413f5d51518683d3b947e53a5",
"errorCode": 0,
"description": "Invalid id 'applicantId'"
}