Legal
Get Legal Status
Check whether the authenticated customer must accept general or contract-specific terms and conditions before using the portal.
GET
Get Legal Status
Get Legal Status
Returns the legal terms acceptance status for the current customer. The portal checks this on every authenticated session bootstrap. IfMustAgreeToTerms is true, a modal is shown with the full terms text. It blocks the portal unless CanPostponeTerms is true: then the location’s grace period (setting Legal.TermsGracePeriodDays) is still running, the modal says how long is left, and Remind me later closes it for the rest of the browser tab.
Authentication
Requires a valid customer bearer token.Response
boolean
true when the customer has one or more outstanding terms to accept. Show the acceptance modal when this is true.string | null
ISO 8601 UTC end of the grace period for the outstanding terms: the earliest one when several documents are pending.
null when nothing is pending or the location has no grace period, in which case the terms must be accepted now.boolean
true while the grace period is running, so the customer may keep using the portal and accept later. Once it is false with MustAgreeToTerms still true, the modal blocks the portal until the terms are accepted.boolean
Whether the customer has already accepted the space’s general terms and conditions.
string
HTML or plain-text content of the general terms and conditions to display to the customer.
array | undefined
Array of contract-specific terms the customer must accept. Present only when there are pending contract terms. Each entry contains:
number
Unique identifier of the contract.
string
ISO 8601 date when the contract starts.
string
Display name of the plan associated with this contract.
string
HTML or plain-text content of the contract-specific terms to display.
Example Response
TypeScript Integration
Usage in Portal
Error Responses
error
The bearer token is missing, expired, or invalid. The customer must sign in.