RHrhinestonewtf
Compliance

Create or resume a compliance customer and mint a scoped session

Changed on

Called by the integrator backend. Creates or resumes the provider-neutral compliance customer for the given opaque external customer id, optionally binds a registered smart account, and returns a short-lived browser session bearer. The project API key must never be forwarded to the browser — hand the returned token to the modal instead.

post/compliance/sessions

Request

Headers

x-api-keystring

API key for authentication

Example:your-api-key

Request body

externalCustomerIdstring required

The integrator's stable, opaque end-user identifier. Must reveal no identity data (no email/name/wallet). Stored verbatim within the authenticated project.

smartAccountstring

Ethereum address (0x followed by 40 hex characters)

resumeOnlyboolean

Read-only session: never creates a customer or binds an account. 404 CUSTOMER_NOT_FOUND unless the customer exists and is bound to smartAccount (or no account is given). Needs deposits:read. The bearer is read-only whatever the key may do: it reads status, options, accounts and orders, while POST /compliance/verification, POST /onramp/accounts and POST /offramp/orders answer 403 READ_ONLY_SESSION.

Example request

{
  "externalCustomerId": "usr_01J7H8Q4K67Y8E",
  "smartAccount": "0x742d35Cc6634C0532925a3b844Bc9e7595f5bE91"
}

Response

Scoped session token

externalCustomerIdstring required

The opaque external customer reference, returned only to the authenticated integrator backend.

tokenstring required

Short-lived scoped session bearer for the browser.

expiresAtstring required

ISO-8601 absolute expiry of the session token.

Example response

{
  "expiresAt": "2026-08-13T12:15:00.000Z"
}

Changes

  • aa1767d704faRevision changes
    • info

      the endpoint scheme security internalProjectBearer was added to the API

    • info

      the endpoint scheme security tenantApiKey was added to the API

    • info

      the header request parameter x-api-key became optional

  • 992508911684Revision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status