v1
latestOpenAPI 3.1.02026-07-242735131.1 MBPre-Onboarding Requirements
Acknowledge a pre-onboarding acknowledgement requirement
Records an acknowledgement for an acknowledgement requirement. Rejected if the requirement is blocked by an unmet dependency or has already been acknowledged.
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employment documents (employment_documents) | - | Manage documents (document:write) |
post/v1/onboarding/employments/{employment_id}/pre-onboarding-requirements/{requirement_slug}/acknowledge
Path parameters
employment_idstring required
Employment ID
requirement_slugstring required
Pre-onboarding requirement slug
Response
Success
Example response
{
"data": {
"pre_onboarding_acknowledgement": {
"id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
}
}
}