Modules

Modules are the per-bank feature packages of the platform, and they decide what your integration can do: several parts of the API are module-gated and return an authorization error without the matching module — for example legalDocuments requires the legal-documents module and dynamicAttorneyCards the dynamic-attorneys one. Your JWT carries your bank's module claims, so entitlements are evaluated on every request.

Query bank.modules to see the full catalog and your bank's entitlements in one call. It always lists every module the API exposes — each entry carries the type, a human-readable description, and an isEnabled flag telling you whether your bank has it. Check isEnabled, not list membership.

query bankModules {
bank {
  id
  name
  modules {
    type
    description
    isEnabled
  }
}
}

The module catalog

Module	Description
LEADS	Receiving and processing leads for prospective customer organizations
BANK_REPORT_REVIEW	Employee review and approval flow for submitted bank reports
RISK_DATA	Risk data captured during the administrators electronic identity verification
SIGNED_ATTORNEYS	Attorney documents signed by the organizations administrators
SELF_DECLARATION	Self-declaration documents collected from organizations
SELF_MANAGED_BUSINESS_VOLUMES	The organizations business volumes are maintained by the banks own employees instead of being delivered through bank reports
BANK_REQUESTS	Ad-hoc requests from the bank to its customer organizations
DYNAMIC_ATTORNEYS	Attorney cards and procuras granted from the banks configurable dynamic attorney settings
LEGAL_DOCUMENTS	Bank-supplied legal documents signed by organizations as part of bank reports
ADMINISTRATION_COMPANIES	Administration companies administrating organizations on their behalf
PRESCREENING	Prescreening of prospective customer organizations before onboarding
ORGANIZATION_MESSAGING	Direct messaging between the bank and its customer organizations

Modules are managed by Unioo per agreement with your bank — they're read-only on the External API. If a module-gated field returns an authorization error and bank.modules shows the module as disabled, reach out to your Unioo contact to have it enabled. Remember to fetch a fresh JWT after a module changes: entitlement claims are minted when you authenticate.

Module-gated areas of the API

• RISK_DATA — the risk data on identity verifications.
• LEGAL_DOCUMENTS — the legal documents on bank reports and bank relations.
• DYNAMIC_ATTORNEYS — the dynamic attorney cards and procuras on administrators and bank accounts, and the dynamic attorney changes on bank reports.
• LEADS — the leads queries.