Create an onboarding requirement
Opportunities module
POST/onboarding-requirementsonboardingRequirements.create
A requirement of the onboarding packet, by role type and jurisdiction. Creates an onboarding requirement. 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 org.gateway.write.
- OAuth scopes: org.
- 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: OnboardingRequirementCreate
| Field | Type | Required | Description |
|---|---|---|---|
| role_type | ExternalRoleType | null | No | |
| jurisdiction_id | JurisdictionId | No | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$ |
| verification_method | string | Yes | Verification method. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| name | string | Yes | Requirement name, for example Certificate of Insurance.Constraints: length 1 to 300 |
| item_kind | "Document Upload" | "Electronic Signature" | "Form" | "Certification" | "Training" | "Acknowledgment" | "Background Check" | "Tax Form" | "Payout Details" | Yes | Kind of onboarding item. |
| is_blocking | boolean | No | True when the engagement cannot become Active until the item passes. |
| valid_for_days | integer | null | No | Days a verification stays valid; null when it does not expire.Constraints: range 1 to any |
| remind_days_before | integer | null | No | Days before expiry the party is reminded.Constraints: range 1 to any |
{
"verification_method": "Reviewer",
"name": "Certificate of Insurance",
"item_kind": "Document Upload",
"is_blocking": true,
"valid_for_days": 365,
"remind_days_before": 30
}Response 201: OnboardingRequirement
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the onboarding requirement. |
| 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. |
| role_type | ExternalRoleType | null | Yes | |
| jurisdiction_id | JurisdictionId | Yes | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$ |
| verification_method | string | Yes | Verification method. A Title Case value from the lifecycle's database enum.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| name | string | Yes | Requirement name, for example Certificate of Insurance.Constraints: length 1 to 300 |
| item_kind | "Document Upload" | "Electronic Signature" | "Form" | "Certification" | "Training" | "Acknowledgment" | "Background Check" | "Tax Form" | "Payout Details" | Yes | Kind of onboarding item. |
| is_blocking | boolean | Yes | True when the engagement cannot become Active until the item passes. |
| valid_for_days | integer | null | Yes | Days a verification stays valid; null when it does not expire.Constraints: range 1 to any |
| remind_days_before | integer | null | Yes | Days before expiry the party is reminded.Constraints: 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
}Code samples
curl -X POST "$XOS_BASE_URL/onboarding-requirements" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"verification_method":"Reviewer","name":"Certificate of Insurance","item_kind":"Document Upload","is_blocking":true,"valid_for_days":365,"remind_days_before":30}'const { data } = await xos.onboardingRequirements.create({
"verification_method": "Reviewer",
"name": "Certificate of Insurance",
"item_kind": "Document Upload",
"is_blocking": true,
"valid_for_days": 365,
"remind_days_before": 30
});response = xos.onboarding_requirements.create({"verification_method": "Reviewer", "name": "Certificate of Insurance", "item_kind": "Document Upload", "is_blocking": True, "valid_for_days": 365, "remind_days_before": 30})xos onboarding-requirements create --data '{"verification_method":"Reviewer","name":"Certificate of Insurance","item_kind":"Document Upload","is_blocking":true,"valid_for_days":365,"remind_days_before":30}'