4. Add Check

2026-04-28

Call the add check api to which you need to pass the personId and checkShortName of the check you want to add. Most checks require supporting information before they can be performed. You can pass this information either through this api or later through HR ui. This will create an order for person containing this check, if an not started order already exists then this check will be added to that order. It will return orderCheckId which was created on your behalf. You will use this `orderCheckId` to optionally add supporting documents for this check.

Written by: Tarun

Overview

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

To find out checkShortName for all checks go to https://hr.bgv.millowapp.com/company after login.

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
`checkShortName`	`string`	Yes	The checkShortName 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:

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

Response

201 Created

Returned when the check is successfully created.

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

Example Response Body:

{
  "orderCheckId": "chk_abc123xyz"
}