Reference data

Lookup tables and per-bank configuration data. These appear as branchOffice, riskGroup, associationType etc. on other entities — you query them when you need to populate a dropdown, validate an ID before creating an invitation, or browse what your bank supports.

BranchOffice

A physical or organizational unit of your bank. You assign a branch office to an organization (or invitation) so reporting and access can be scoped to it.

• Bank-scoped: each branch office belongs to exactly one bank.
• Lifecycle: created via addBranchOffice, updated via updateBranchOffice, deleted via removeBranchOffice.
• Soft-deleted branch offices are filtered out automatically.

RiskGroup

A risk classification you apply to organizations and invitations — think "low risk", "medium", "high", or whatever scheme your bank uses. Configured per-bank.

• Bank-scoped.
• Read-only on the External API; risk groups are configured in the bank portal.
• The riskGroupId is required when creating an invitation, so query riskGroups first to find a valid ID.

AssociationType

The legal form of an organization — ApS, A/S, foundation, etc. Unlike branch offices and risk groups, association types are global reference data shared across all banks, not per-bank.

• Not bank-scoped.
• Read-only.
• The type itself only carries id and associationTypeLocalizations: [AssociationTypeLocalization]. To get a human-readable name, project the localization for the languageCode you want.
• You'll see it as Organization.type: AssociationType.

BusinessVolume

A questionnaire about the customer's business activity. Each business volume can have multiple revisions — you query the catalog with businessVolumes and a specific revision with businessVolumeRevision.

The revision body is returned as a Base64-encoded JSON string (in the base64 field) and must be decoded client-side. The decoded JSON contains sections, questions, examples, and option lists — the structure you'd render as a form.

Country

A country reference, used on addresses, tax residencies, and similar. Standard ISO codes; not bank-scoped. The External API exposes countries as a typed field on consuming entities — there's no top-level countries query in this surface.

Lead

A potential future customer — typically a name and contact captured from a marketing channel, before any invitation is sent. Bank-scoped.

• Read-only on the External API via leads.
• Lead lifecycle (creation, fulfilment) happens elsewhere; from this API you observe state transitions via state, createdDate, and fulfillDate.

Where to query

• Read: Querying reference data.
• Write (where applicable): Managing branch offices.