Skip to main content
GET
The authenticated caller's terms-acceptance state

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Response

Status returned

The caller's acceptance state across every configured document.

reacceptance_required
boolean
required

True when any document requires re-acceptance. The client gates the app shell on this.

documents
DocumentAcceptanceStatus · object[]

Empty while no document version is configured, in which case nothing is required.

notice_sent_at
string
default:""

ISO date the amendment email was sent, for display in the re-acceptance dialog so the user can see the notice period they were given. Empty when unset.

organization_tier
string | null

The caller's organisation tier, or null when it could not be resolved.

self_service_terms_required
boolean
default:true

False when the caller's organisation contracts separately, in which case documents is empty. Branch on this rather than on an empty documents, which also means 'nothing configured'.