Request action check

Requests an applicant action check.

Overview

Use this method to set an applicant action state to pending.

Response explained

To get the results, use the Get applicant action method.

The following is an example of the response. See review.reviewResult.reviewAnswer:

{
  "id" : "5dc2d80ce3cc9b1c1e389c4c",
  "createdAt" : "2019-11-06 14:26:20",
  "applicantId" : "5dc158b109494c3cbf431e28",
  "type" : "paymentMethod",
  // main result
  "review" : {
    "createDate" : "2019-11-06 14:35:06",
    "reviewResult" : {
      "moderationComment" : "",
      "reviewAnswer" : "GREEN"
    },
    "reviewStatus" : "completed"
  },

  // checks performed for the applicant actions
  "checks" : [ {
    "answer" : "GREEN",
    "checkType" : "FACE_LIVELINESS",
    "createdAt" : "2019-11-06 14:34:27",
    "id" : "a1f096a8-a9c0-419a-a117-51312506931f",
    "livenessInfo" : {
      "livenessData" : {
        "sessionId" : "d5ff4c12-4616-44fe-86ab-ad4fd73174fc",
        "images" : [ {
          "imageId" : 866303241
        },
          //...
        ]
      },
      "livenessResult" : {
        "answer" : "GREEN"
      },
    }
  }, {
    "answer" : "GREEN",
    "checkType" : "FACE_MATCH",
    "createdAt" : "2019-11-07 09:07:02",
    "id" : "79983099-b0cf-4b5d-882a-67f25a174041",
    "faceMatchInfo" : {
      "answer" : "GREEN"
    },
    "imageIds" : [ 935595818, 1567323303 ]
  }],
  "requiredIdDocs" : {
    "docSets" : [ {
      "idDocSetType" : "PAYMENT_METHODS",
      "types" : [ "PAYMENT_METHOD" ]
    }, {
      "idDocSetType" : "SELFIE",
      "types" : [ "SELFIE" ]
    } ]
  },
  "paymentMethod" : {
    "type" : "bankCard",
    "subType" : "VISA",
    "data" : {
      "firstName" : "JOHN SMITH",
      "validUntil" : "2021-01-01",
      "number" : "411111****1111"
    },
    // check for the risk score
    "checks" : [ {
      "answer" : "GREEN",
      "checkType" : "bankCardRiskScore",
      "inputData" : {
        "firstName" : "JOHN SMITH",
        "validUntil" : "2021-01-01",
        "number" : "4111111111"
      },
      "bankCardRiskScoreInfo" : {
        "riskScore" : 0.01
      }
    } ]
  },
  // images uploaded for the action
  "images" : [ {
    "addedDate" : "2019-11-06 14:26:37",
    "imageFileName" : "creditCard.png",
    "resizedImageId" : 1545333812,
    "mimeType" : "png",
    "imageId" : 66881456
  }, {
    /// ...
  } ]
}

Language
Authorization
Header
Click Try It! to start a request and see the response here!