Saltar al contenido

onboardingRequirements

Módulo Opportunities · 5 operaciones

List onboarding requirement rows

GET/onboarding-requirements

A requirement of the onboarding packet, by role type and jurisdiction. Returns a cursor page of onboarding requirement rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create an onboarding requirement

POST/onboarding-requirements

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.

Get an onboarding requirement

GET/onboarding-requirements/{id}

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.

Update an onboarding requirement

PATCH/onboarding-requirements/{id}

A requirement of the onboarding packet, by role type and jurisdiction. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete an onboarding requirement

DELETE/onboarding-requirements/{id}

A requirement of the onboarding packet, by role type and jurisdiction. Soft-deletes the onboarding requirement: it moves to Trash and can be restored for its table's retention period.