v1

latestOpenAPI 3.1.02026-07-1242526.8 KB

Orders

Create Screening Order

post/unified/screening/orders

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

passthroughobject nullable

Value to pass through to the provider

unified_custom_fieldsobject nullable

Custom Unified Fields configured in your StackOne project

package_idstring required

Package ID

Example request

{
  "passthrough": {
    "other_known_names": "John Doe"
  },
  "unified_custom_fields": {
    "my_project_custom_field_1": "REF-1236",
    "my_project_custom_field_2": "some other value"
  },
  "package_id": "54321",
  "candidate": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com"
  }
}

Response

The screening order was created.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "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"
  }
}