📄 Guide
The concepts below decide how you model accounts, funds and controls for your customers. This page gives you the object landscape and the ID conventions; each concept page then follows one thread in depth.The three-tier identity model
Your business is organized as partner → company → employee: the partner is you (one API integration); a company is your business customer (KYB onboarding, funding pool); an employee is the end cardholder (issued cards after KYC). Cards can be issued to a company (a custodian is required) or to an employee.
Core objects and ID conventions
Every ID in the contract is a JSON string, shaped as follows:
The meaning of a polymorphic ID (
subjectId / subjectId / subjectId) is determined by the type field in the same structure, never inferred from its shape.
Two orthogonal axes
“Who holds the card” (the holder) and “which account pays” (the funding owner) are independent axes, mapped to each other by the card profilecardProfileId — the key to understanding card types and the fund endpoints. See Holders and the funding model.
Reading path
Next steps
- Start with the first thread of the object model: Holders and the funding model
- Or go hands-on and issue your first card: Quickstart