legal.status
What the signed-in person has accepted: for each document that is accepted here, the current version, the versions accepted and when, and whether the current version still needs accepting.
When to use it
What the signed-in person has accepted: for each document that is accepted here, the current version, the versions accepted and when, and whether the current version still needs accepting.
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
Example
GET https://doingwork.work/v1/legal/status?
Output
| Field | Type | Always there |
|---|
documents | array | yes |
documents[].document | string | yes |
documents[].current_version | string | yes |
documents[].placeholder | boolean | yes |
documents[].accepted | array | yes |
documents[].accepted[].version | string | yes |
documents[].accepted[].accepted_at | string | yes |
documents[].needs_acceptance | boolean | yes |
{
"documents": [
{
"document": "...",
"current_version": "...",
"placeholder": true,
"accepted": [
{
"version": "...",
"accepted_at": "..."
}
],
"needs_acceptance": true
}
]
}
Errors
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |