Skip to main content
GET
Get bank requirements
This feature is in Beta and not ready for production integration.

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Headers

X-Organization-ID
string<uuid>

ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400.

Response

Requirements retrieved successfully.

Everything a bank asks of a bank account application in one version of its requirements: the sections to ask in, and every question with its type, checks and wording.

bank
object
required

The bank whose requirements these are.

questions
object[]
required

Every question the bank asks, in the order to ask them within each section.

sections
object[]
required

The sections the questions are grouped into, in the order to ask them.

supersededBy
null | object
required

The version that replaces this one, once it is published. Null until then.

supersedes
null | object
required

The version this one replaced. Null for the bank's first version.

version
object
required

The version of the bank's requirements described here.