Skip to main content
POST
/
unified
/
screening
/
orders
Create Screening Order
curl --request POST \
  --url https://api.stackone.com/unified/screening/orders \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "package_id": "54321",
  "candidate": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]"
  },
  "passthrough": {
    "other_known_names": "John Doe"
  },
  "unified_custom_fields": {
    "my_project_custom_field_1": "REF-1236",
    "my_project_custom_field_2": "some other value"
  }
}
'
{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}

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

Body

application/json
​
package_id
string
required

Package ID

Example:

"54321"

​
candidate
object
required

Candidate information

​
passthrough
object

Value to pass through to the provider

Example:
{ "other_known_names": "John Doe" }
​
unified_custom_fields
object

Custom Unified Fields configured in your StackOne project

Example:
{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

Response

The screening order was created.

​
statusCode
number
required
Example:

201

​
message
string
required
Example:

"Record created successfully."

​
timestamp
string<date-time>
required
Example:

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

​
data
object
required