v1

latestOpenAPI 3.1.02026-07-1276185442.2 KB

Background Checks

Results

Update Background Check Result

patch/unified/ats/background_checks/orders/{id}/result

Path parameters

idstring required

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

start_datestring date-time nullable

The start date of the candidate test

submission_datestring date-time nullable

The submission date of the candidate test

summarystring nullable

The summary about the result of the test

result_urlstring nullable

The test`s result url

passthroughobject nullable

Value to pass through to the provider

Example request

{
  "score": {
    "label": "Percentage",
    "value": "80",
    "min": "0",
    "max": "100"
  },
  "start_date": "2021-01-01T01:01:01.000Z",
  "submission_date": "2021-01-01T01:01:01.000Z",
  "summary": "Test is passed",
  "result": {
    "value": "passed"
  },
  "result_url": "https://exmaple.com/result?id=xyz",
  "attachments": [
    {
      "url": "http://example.com/resume.pdf",
      "content_type": {
        "value": "text"
      }
    }
  ],
  "candidate": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "profile_url": "https://exmaple.com/candidate?id=xyz"
  },
  "passthrough": {
    "other_known_names": "John Doe"
  }
}

Response

The result update of the background check for candidate.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 200,
  "message": "Record updated successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z"
}