Skip to main content
GET
List disclosures

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

userId
string<uuid>

The invitee. Only meaningful on an application token, and only alongside invitationToken: the id is client-supplied, and the token is what makes it trustworthy. Ignored when a user token identifies the caller. Omit both to be answered for the organization the application token is acting as.

invitationToken
string

The invitation token issued to userId. Required alongside it, and omitted when naming nobody.

Response

The version in force, the requirement, whether this caller has accepted it, the documents, and the same for every capacity with a version in force. Acceptance is false when nobody was named.

The disclosures in force for a caller, and whether they have accepted them.

accepted
boolean
required

Whether this caller has accepted the version above. False for an invitee by definition, and false again for an existing user after a new version is published. Without it a client cannot tell a cleared user from one owing re-acceptance, and has to prompt everyone or nobody.

documents
object[]
required

The documents making up the version, in the order to present them.

requirement
enum<string>
required

Whether this caller's organization requires disclosures at all.

Available options:
NOT_REQUIRED,
REQUIRED
version
null | string<uuid>
required

The version in force, or null if the caller's bank has published none. Submit this back when accepting, so an acceptance cannot be recorded against documents that were superseded while the caller was reading them.

capacities
object[]

Every capacity with a version in force, whether or not it falls on this caller, so a client can list what governs the organization. The fields above describe the person capacity alone. Whether an entry is this caller's to act on is carried by its standing and canAccept, never by being absent.