Querying basics
Most list queries in the External API are exposed as Relay-style connections with cursor-based pagination, projection, filtering, and sorting. Once you understand the shape on one query, the others all follow the same pattern.
Organizations
organizations returns onboarded customers of your bank. Soft-deleted and surrendered organizations are excluded by default unless you explicitly filter for them.
Organization invitations
organizationInvitations returns invitations sent by your bank that haven't yet been accepted. Once accepted, the resulting customer appears under Organizations instead.
Bank packages
A bank package (bankReport in the schema) is the bundle of documents an organization submits to satisfy ajour requirements. Use these queries to list packages submitted to your bank or to fetch a specific one.
People
The API distinguishes two kinds of people:
Reviews
A review (BankReportReview) is the bank-side process of going through a published bank report — pending, provisionally approved, fully approved, or rejected. Each review breaks down into sections (basic information, documents, business volume, board members, …) that are tracked individually.
Reference data and other lookups
Lookup tables and assorted catalog data: branch offices, risk groups, association types, leads, and business volume questionnaires.