Create a background check

Módulo Gateway

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.

Requiere la capacidad opportunities.onboarding.write.
Alcances de OAuth: opportunities.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: BackgroundCheckCreate

backgroundChecks.create: BackgroundCheckCreate
Campo	Tipo	Obligatorio	Descripción
engagement_id	string (uuid)	Sí	Identifier of the engagement.
provider	string	No	Background check provider.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
provider_reference	string	Sí	Provider reference.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "provider": "checkr",
  "provider_reference": "chk_7c1a2b"
}

Respuesta 201: BackgroundCheck

backgroundChecks.create: BackgroundCheck
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the background check.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
engagement_id	string (uuid)	Sí	Identifier of the engagement.
provider	string	Sí	Background check provider.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
provider_reference	string	Sí	Provider reference.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
completed_at	string (date-time) \| null	Sí	When the provider completed it.
result	"Pending" \| "Clear" \| "Consider" \| "Suspended" \| "Canceled"	Sí	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"
}

Ejemplos de código

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