Create a background check
Gateway module
POST/background-checksbackgroundChecks.create
A background check result from the provider. The report itself is never stored. Creates a background check. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability opportunities.onboarding.write.
- OAuth scopes: opportunities.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: BackgroundCheckCreate
| Field | Type | Required | Description |
|---|---|---|---|
| engagement_id | string (uuid) | Yes | Identifier of the engagement. |
| provider | string | No | Background check provider.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| provider_reference | string | Yes | Provider reference.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"provider": "checkr",
"provider_reference": "chk_7c1a2b"
}Response 201: BackgroundCheck
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the background check. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| engagement_id | string (uuid) | Yes | Identifier of the engagement. |
| provider | string | Yes | Background check provider.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| provider_reference | string | Yes | Provider reference.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| completed_at | string (date-time) | null | Yes | When the provider completed it. |
| result | "Pending" | "Clear" | "Consider" | "Suspended" | "Canceled" | Yes | Result as the provider reports it. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"provider": "checkr",
"provider_reference": "chk_7c1a2b",
"completed_at": "2026-10-08T14:30:00Z",
"result": "Pending"
}Code samples
curl -X POST "$XOS_BASE_URL/background-checks" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","provider":"checkr","provider_reference":"chk_7c1a2b"}'const { data } = await xos.backgroundChecks.create({
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"provider": "checkr",
"provider_reference": "chk_7c1a2b"
});response = xos.background_checks.create({"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "provider": "checkr", "provider_reference": "chk_7c1a2b"})xos background-checks create --data '{"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","provider":"checkr","provider_reference":"chk_7c1a2b"}'