Get an onboarding verification
Módulo Opportunities
GET/onboarding-verifications/{id}onboardingVerifications.get
A verification decision on an onboarding item. Returns one onboarding verification with its `ETag`. A onboarding verification the caller may not see returns 404.
- Requiere la capacidad opportunities.engagement.read.
- Alcances de OAuth: opportunities.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the onboarding verification. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: 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 GET "$XOS_BASE_URL/onboarding-verifications/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.onboardingVerifications.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.onboarding_verifications.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos onboarding-verifications get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f