Create an onboarding verification

Módulo Opportunities

POST/onboarding-verificationsonboardingVerifications.create

A verification decision on an onboarding item. Creates an onboarding verification. 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: OnboardingVerificationCreate

onboardingVerifications.create: OnboardingVerificationCreate
Campo	Tipo	Obligatorio	Descripción
onboarding_item_id	string (uuid)	Sí	Identifier of the onboarding item.
passed	boolean	Sí	Whether the item passed.
notes	string \| null	No	Reviewer notes.Restricciones: length 1 to 20000

{
  "onboarding_item_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "passed": true,
  "notes": "Name matches the tax form."
}

Respuesta 201: OnboardingVerification

onboardingVerifications.create: OnboardingVerification
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the onboarding verification.
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.
onboarding_item_id	string (uuid)	Sí	Identifier of the onboarding item.
passed	boolean	Sí	Whether the item passed.
verified_by	string (uuid) \| null	Sí	Identifier of the verifier.
verified_at	string (date-time)	Sí	When it was verified.
notes	string \| null	Sí	Reviewer notes.Restricciones: length 1 to 20000

{
  "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",
  "onboarding_item_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "passed": true,
  "verified_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "verified_at": "2026-10-08T14:30:00Z",
  "notes": "Name matches the tax form."
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/onboarding-verifications" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"onboarding_item_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","passed":true,"notes":"Name matches the tax form."}'

const { data } = await xos.onboardingVerifications.create({
    "onboarding_item_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "passed": true,
    "notes": "Name matches the tax form."
  });

response = xos.onboarding_verifications.create({"onboarding_item_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "passed": True, "notes": "Name matches the tax form."})

xos onboarding-verifications create --data '{"onboarding_item_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","passed":true,"notes":"Name matches the tax form."}'