Add Check to Person

Overview

Initiates a background check on a specific person. On success, returns a unique orderCheckId for the created check.

---

Endpoint: {{baseURL}}/person/check
Method: POST
Content-Type: application/json Authentication: Bearer {{token}}.

Request Body

The request body must be sent as JSON.

Field	Type	Required	Description
checkName	string	Yes	The name/type of the check to be performed.
personId	string	Yes	The unique identifier of the person on whom the check is being initiated.
checkInfos	object	Yes	An object containing additional information required for the check.
checkInfos.pan	string	Yes	The PAN (Permanent Account Number) of the person, e.g. AAAAR4534T.

Example Request Body:

{
  "checkName": "panCheck",
  "personId": "12345",
  "checkInfos": {
    "pan": "AAAAR4534T"
  }
}

---

Response

201 Created

Returned when the check is successfully created.

Field	Type	Description
checkId	string	The unique identifier of the newly created check.

Example Response Body:

{
  "orderCheckId": "chk_abc123xyz"
}