Overview

Use this method to deactivate the specified applicant profile so no action could be performed with the profile data. You can also reactivate it back when necessary by specifying activated in the status field.

📘
Info
The applicant data from the deactivated profile will be ignored when checking for duplicates during registration of new applicants.

Response explained

The response would include an array of objects containing the applicant data. The set of data depends on the permissions you have in the system.

Consider the following 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"
}

Mind the deleted parameter which indicates the request result:

true — profile deactivated.
false — profile activated.