Blocklist applicants

Adds an applicant profile to the blocklist.


Use this method to blocklist the applicant profile.



Before adding applicants to the blocklist, make sure they are not yet in it by checking for BLACKLIST and BLOCKLIST labels in the rejectLabels array. In case you are trying to add an already listed applicant to blocklist, we will throw the 400 HTTP status with the 5000 error code.


Did you know?

You can also blocklist applicants from the Dashboard.

Request example

curl -X POST \

Response explained

The response is a JSON file representing the profile data of the blocklisted applicant with augmented and structured information. You can overview the response structure and possible content with descriptions on the following page.

Mind the review section of the response to make sure the applicant is blocklisted.

Response example

  "id": "63e099da46199a0000000000",
  "createdAt": "2023-02-06 06:10:34",
  "clientId": "yourCoolId",
  "inspectionId": "63e099da46199a0000000000",
  "externalUserId": "someExternalUserId",
  "info": {
    "firstName": "John",
    "firstNameEn": "John",
    "middleName": "",
    "middleNameEn": "",
    "lastName": "Doe",
    "lastNameEn": "Doe"
  "email": "[email protected]",
  "requiredIdDocs": {
    "docSets": [
        "idDocSetType": "IDENTITY",
        "types": [
        "subTypes": [
  "review": {
    "reviewId": "wTgDO",
    "attemptId": "hiiOC",
    "attemptCnt": 0,
    "elapsedSincePendingMs": 3,
    "levelName": "basic-kyc-level",
    "createDate": "2024-06-17 10:51:01+0000",
    "reviewDate": "2024-06-17 10:51:01+0000",
    "reviewResult": {
      "reviewAnswer": "RED",
      "rejectLabels": [
      "reviewRejectType": "FINAL"
    "reviewStatus": "completed"
  "type": "individual"
Click Try It! to start a request and see the response here!