Update Background Check Result

curl --request PATCH \
  --url https://api.stackone.com/unified/ats/background_checks/orders/{id}/result \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "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",
    "source_value": "Passed"
  },
  "result_url": "https://exmaple.com/result?id=xyz",
  "attachments": [
    {
      "url": "http://example.com/resume.pdf",
      "content_type": {
        "value": "text",
        "source_value": "Text"
      }
    }
  ],
  "candidate": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "profile_url": "https://exmaple.com/candidate?id=xyz"
  },
  "passthrough": {
    "other_known_names": "John Doe"
  }
}
'

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

PATCH

unified

ats

background_checks

orders

{id}

result

Update Background Check Result

curl --request PATCH \
  --url https://api.stackone.com/unified/ats/background_checks/orders/{id}/result \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "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",
    "source_value": "Passed"
  },
  "result_url": "https://exmaple.com/result?id=xyz",
  "attachments": [
    {
      "url": "http://example.com/resume.pdf",
      "content_type": {
        "value": "text",
        "source_value": "Text"
      }
    }
  ],
  "candidate": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "profile_url": "https://exmaple.com/candidate?id=xyz"
  },
  "passthrough": {
    "other_known_names": "John Doe"
  }
}
'

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

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

Body

application/json

score

object

Show child attributes

score.label

string | null

The label of the score

Example:

"Percentage"

score.value

string | null

The value is the actual score

Example:

"80"

score.min

string | null

The minimum value of the score

Example:

"0"

score.max

string | null

The maximum value of the score

Example:

"100"

start_date

string<date-time> | null

The start date of the candidate test

Example:

"2021-01-01T01:01:01.000Z"

submission_date

string<date-time> | null

The submission date of the candidate test

Example:

"2021-01-01T01:01:01.000Z"

summary

string | null

The summary about the result of the test

Example:

"Test is passed"

result

object

Show child attributes

result.value

enum<string> | null

The result of the test.

Available options:

initiated,

in_progress,

cancelled,

completed,

expired,

failed,

passed,

unmapped_value,

Example:

"passed"

result.source_value

The source value of the test result.

Example:

"Passed"

result_url

string | null

The test`s result url

Example:

"https://exmaple.com/result?id=xyz"

attachments

object[] | null

Show child attributes

attachments.url

string | null

The URL of the attachment.

Example:

"http://example.com/resume.pdf"

attachments.content_type

object

Show child attributes

attachments.content_type.value

enum<string> | null

The content type of the attachment.

Available options:

text,

pdf,

video,

other,

unmapped_value,

Example:

"text"

attachments.content_type.source_value

The source value of the content type.

Example:

"Text"

candidate

object

Show child attributes

candidate.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

candidate.profile_url

string | null

Candidate profile url

Example:

"https://exmaple.com/candidate?id=xyz"

passthrough

object

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

Response

The result update of the background check for candidate.

statusCode

number

required

Example:

200

message

string

required

Example:

"Record updated successfully."

timestamp

string<date-time>

required

Example:

"2021-01-01T01:01:01.000Z"

Order Background Check Request List Application Document Categories

⌘I

Getting Started

Use Cases

API Reference

Update Background Check Result

Authorizations

Headers

Path Parameters

Body

Response