Background Check Integration

Integration by third party Background Check service to update Candidates using the REST API.

Scenario

A 3rd party wants to integrate their background check service by making a call and receiving candidates that are ready for checking then updating the candidate with the relevant value once complete.

This example will involve using the REST API

Retrieving candidates ready for background check

Endpoint - GET /{appType}

layout - 358. The layout determines what data will be returned with each candidate and is configured in the ATS.
config_search - 208. This will return all applications that are ready for a background check that have not yet been collected and this search is configured in the ATS.

The response will return the candidate’s application ID which is required in the subsequent POST calls. Using an API client like postman, the request URL is https://example.tal.net/vx/api/v1/applications?layout=358&config_search=208

https://example.tal.net/vx/api/v1/applications?layout=358&config_search=208

Updating a candidate’s background check flag

Endpoint - POST /{appType}/{appId}/form_values

{
   "transaction": [
    {
      "item_id": 138182,
      "values": [
        {
          "instance": 1,
          "value": "XXXXXX",
          "log_history": true
        }
      ]
    }
  ]
}