Overview

Use this method to deactivate a specific applicant profile.

Once the method is applied, the applicant profile becomes as if it never existed and none of your or Sumsub operators will be able to perform any actions (change, remove, add information, and so on) with the profile data.

Though the deactivated profile record remains in the database, its data will be ignored when checking for duplicates during registration of new applicants.

You can always reactivate the profile when necessary by specifying activated in the status field.

📘

Info

The system does not allow to deactivate profiles currently being checked with the pending, queued, or prechecked review status.

Request example

curl -X PATCH \
  'https://api.sumsub.com/resources/applicants/63e096c51b6b400000000000/presence/deactivated'

Response explained

The response is a JSON file that includes an array of objects containing the applicant data. The set of data depends on the permissions you have in the system.

You can overview the response structure and possible content with descriptions on the following page.

Mind the deleted parameter which indicates the request result:

• true — the applicant profile is deactivated.
• false — the applicant profile is activated.

Response example

{
  "id" : "652dsf45fg563798cee64d3e",
  "createdAt" : "2023-10-16 13:34:54",
  "key" : "WBFHTKYHGUTOLX",
  "clientId" : "john.doe",
  "inspectionId" : "652deh58gk68df29cee64d3f",
  "externalUserId" : "dash-315bcbed-eadd-4f50-a5f4-csge467fht269",
  "applicantPlatform" : "API",
  "requiredIdDocs" : {
    "videoIdent" : true,
    "videoIdentUploadTypes" : [ "UTILITY_BILL" ],
    "docSets" : [ {
      "idDocSetType" : "IDENTITY",
      "types" : [ "ID_CARD", "PASSPORT" ]
    }, {
      "idDocSetType" : "PROOF_OF_RESIDENCE",
      "types" : [ "UTILITY_BILL" ],
      "poaStepSettingsId" : "64ad4c234568fghj28f496ad"
    } ]
  },
  "deleted" : true,
  "review" : {
    "levelName" : "vi_old",
    "createDate" : "2023-10-16 13:39:34+0000",
    "startDate" : "2023-10-16 13:39:47+0000",
    "reviewStatus" : "init",
    "priority" : 0,
  },
  "lang" : "en",
  "type" : "individual"
}