Overview

Use this method to add a consent to an applicant profile.

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.

Response example:

{
  "id": "654a2724ea803f0f724e00e7",
  "createdAt": "2023-11-07 12:01:40",
  "key": "EJBDYWTFWAQXSH",
  "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"
    ]
  },
  "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"
}