Create an onboarding item
Opportunities module
POST/onboarding-itemsonboardingItems.create
One onboarding requirement instantiated for an engagement. Creates an onboarding item. 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: OnboardingItemCreate
| Field | Type | Required | Description |
|---|---|---|---|
| engagement_id | string (uuid) | Yes | Identifier of the engagement. |
| onboarding_requirement_id | string (uuid) | Yes | Identifier of the onboarding requirement. |
{
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"onboarding_requirement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 201: OnboardingItem
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the onboarding item. |
| 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. |
| onboarding_requirement_id | string (uuid) | Yes | Identifier of the onboarding requirement. |
| document_id | string (uuid) | null | Yes | Identifier of the submitted document. |
| onboarding_item_state | string | Yes | Item state. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| expires_on | string (date) | null | Yes | Expiry. |
| carried_over | boolean | Yes | Whether a verified item carried over from an earlier engagement. |
| submitted_at | string (date-time) | null | Yes | When the engaged party submitted the item. |
{
"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",
"onboarding_requirement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"onboarding_item_state": "In Review",
"expires_on": "2026-10-08",
"carried_over": false,
"submitted_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X POST "$XOS_BASE_URL/onboarding-items" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","onboarding_requirement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data } = await xos.onboardingItems.create({
"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"onboarding_requirement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
});response = xos.onboarding_items.create({"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "onboarding_requirement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})xos onboarding-items create --data '{"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","onboarding_requirement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'