Get an onboarding requirement
Módulo Opportunities
GET/onboarding-requirements/{id}onboardingRequirements.get
A requirement of the onboarding packet, by role type and jurisdiction. Returns one onboarding requirement with its `ETag`. A onboarding requirement 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 requirement. |
| 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: OnboardingRequirement
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the onboarding requirement. |
| 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. |
| role_type | ExternalRoleType | null | Sí | |
| jurisdiction_id | JurisdictionId | Sí | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$ |
| verification_method | string | Sí | Verification method. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| name | string | Sí | Requirement name, for example Certificate of Insurance.Restricciones: length 1 to 300 |
| item_kind | "Document Upload" | "Electronic Signature" | "Form" | "Certification" | "Training" | "Acknowledgment" | "Background Check" | "Tax Form" | "Payout Details" | Sí | Kind of onboarding item. |
| is_blocking | boolean | Sí | True when the engagement cannot become Active until the item passes. |
| valid_for_days | integer | null | Sí | Days a verification stays valid; null when it does not expire.Restricciones: range 1 to any |
| remind_days_before | integer | null | Sí | Days before expiry the party is reminded.Restricciones: range 1 to any |
{
"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",
"role_type": "Crew",
"jurisdiction_id": "US-FL",
"verification_method": "Reviewer",
"name": "Certificate of Insurance",
"item_kind": "Document Upload",
"is_blocking": true,
"valid_for_days": 365,
"remind_days_before": 30
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/onboarding-requirements/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.onboardingRequirements.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.onboarding_requirements.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos onboarding-requirements get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f