Skip to main content
POST
Create a requirements session

Authorizations

Authorization
string
header
default:BASIC <Meld API Key>
required

Headers

Meld-Version
string

Dated API version to use for this request, e.g. 2026-02-03.

Example:

"2026-02-03"

Body

application/json

Who the session is for, and what for

customerId
string
required

The Meld customer the session is for

Example:

"W9kL817BBS7bNEwxAZaX4z"

serviceProviders
string[]
required

The providers you might create the order with: 1 to 5, each once. Steps they share, such as Unified KYC or an email, run once for all of them

Required array length: 1 - 5 elements
order
object

The order you mean to create, whole or absent. With it, each provider that checks the order itself answers for this order, as the requirements do with the order parameters. Without it, such a provider never answers READY

readyWhen
enum<string>

ALL, the default: the session is READY when every provider is. ANY: when one is

Available options:
ALL,
ANY

Response

The session. Pass it to the SDK unchanged

The session. Pass it to Meld.ensureReady unchanged, and never log it: it carries the token

customerId
string
required
expiresAt
string<date-time>
required

When the token expires, 30 minutes after the session was created (ISO-8601 UTC)

Example:

"2026-11-04T15:28:30Z"

id
string
required

The session id, 1 to 64 base58 characters

readyWhen
enum<string>
required
Available options:
ALL,
ANY
requirementsActions
object
required

Where the SDK sends the session's actions, and with what. Read by the SDK

serviceProviders
string[]
required
token
string
required

The session bearer. Never log or store it