Getting Started

Integration Overview

1. Partner Setup            Obtain credentials, configure webhooks
        ↓
2. Partner Token            POST /api/v1/token
        ↓
3. Wallet Deployment        Deploy the corporation AA wallet
        ↓
4. On-Chain Registration    Register in the CorporateAccounts contract
        ↓
5. Corporation Registration POST /api/v1/corporations/register
        ↓
6. Corporation Token        POST /api/v1/corporations/login
        ↓
7. KYB Verification         POST /api/v1/corporations/level-token
        ↓
8. Operations               Employees, cards, transfers, activities

---

Retail or Corporate

Wirex BaaS exposes two separate APIs. The credentials you hold determine which one you call — a
corporate client_id is rejected by the retail API and vice versa.

---

Prerequisites

---

Step 1: Environments

The Corporate API is served on its own hosts. api-baas.wirexapp.* serves the retail API and does not
route corporate endpoints.

See Environments for chain IDs and sandbox credentials.

---

Step 2: Partner Token

Exchange client credentials for a partner token:

POST /api/v1/token

The partner token reaches four endpoints only. Everything else needs a corporation token.

See Authentication.

---

Step 3: Wallet Deployment and On-Chain Registration

The corporation is identified on-chain by its own Account Abstraction wallet. Deploy the wallet, install
the executor, the corporate policy and CorporateValidator, then call
createCorporationForCorporateWallet(partnerId, wallet) on the CorporateAccounts contract. The
address recorded as the wallet's creator becomes the corporation owner.

CorporateValidator is what lets employees sign for the corporation. The older createCorporation
path produces a single-key corporation and is obsolete — see
Wallet Deployment.

See Wallet Deployment.

---

Step 4: Register the Corporation

POST /api/v1/corporations/register

Only the on-chain owner can register the corporation. Registration links the on-chain corporation to a
Wirex corporation record and completes the owner's employee record.

See Registering a Corporation.

---

Step 5: Corporation Token

POST /api/v1/corporations/login

Returns a corporation token carrying the corporation address, the employee id, the role and the resolved
permission set. Every corporation-scoped endpoint requires it.

---

Step 6: KYB Verification

Capabilities stay locked until the corporation passes the verification level each capability requires.
Verification runs in the SumSub SDK, initialised with a token from the API.

See Verification (KYB).

---

Step 7: Operations

---

Next Steps