Profile and Capabilities

Read the corporation record and the capability list that gates every other endpoint.

Before You Start

Read the following guides before proceeding:

GuideWhy
Getting StartedPlatform overview and setup
Api BasicsRequired headers and request configuration
AuthenticationHow to obtain the corporation token

The corporation record is the state of the tenant: who owns it, what legal entity it is, how far KYB has
progressed, and which products it may use. One endpoint returns all of it, recomputed per call.

Capabilities are the operative part. Every product endpoint checks a capability before doing anything,
and a capability that is not Active produces the same 400 Capability is not active regardless of
why. Reading the capability list first is how an integration turns that into an actionable message.

Capability Lifecycle (Simplified)

Detailed documentation available in Corporation Profile and
Capabilities.

sequenceDiagram
    participant App as Your App
    participant Corp as Wirex Corporate API

    App->>Corp: 1. GET /api/v1/corporations
    Corp-->>App: capabilities[] with status NotFulfilled

    Note over App,Corp: Verification unlocks
    App->>Corp: 2. POST /api/v1/corporations/level-token
    Corp-->>App: SumSub SDK token
    Corp->>App: POST /v2/webhooks/corporations

    App->>Corp: 3. GET /api/v1/corporations
    Corp-->>App: capabilities[] with status ActivationNotStarted

    Note over App,Corp: Activation completes
    App->>Corp: 4. POST /api/v1/bank/accounts
    Corp-->>App: details_id

    App->>Corp: 5. GET /api/v1/corporations
    Corp-->>App: capabilities[] with status Active
StepActionDescription
1GET /api/v1/corporationsRead the capability list and its status_reason values
2POST /api/v1/corporations/level-tokenStart the verification level the capability requires
3GET /api/v1/corporationsVerification passed — the capability moves off NotFulfilled
4POST /api/v1/bank/accountsActivate the capability where activation is required
5GET /api/v1/corporationsThe capability reads Active and the endpoint it gates is callable

Card capabilities skip step 4 — they become Active as soon as verification passes and the profile is
Active.


Guides

GuideDescription
Corporation ProfileThe corporation record, its statuses, and the allowed-actions list
CapabilitiesEvery capability, its prerequisites, and how to diagnose a blocked one

Did this page help you?