Skip to main content
POST
Create an ultimate payor

Authorizations

Authorization
string
header
required

The data.access_token value from Get access token.

Headers

X-Api-Version
string

Version applied to this request. It wins over your account's pinned version — see Versioning.

Example:

"2026-06-01"

Body

application/json

Any other field is ignored.

The payor's legal name, as the screening should check it. Spaces around it are trimmed.

Minimum string length: 1
Example:

"Acme Holdings LLC"

city
string
required

The city the payor is based in. Spaces around it are trimmed.

Minimum string length: 1
Example:

"New York"

country
string
required

The payor's country, as an ISO 3166-1 alpha-3 code. Any case is accepted, and it is stored upper-cased.

Pattern: ^[A-Za-z]{3}$
Example:

"USA"

sub_client_id
string<uuid>
required

The user_id of the sub-client that pays on this payor's behalf.

The sub-client has to hold the pobo capability — see Request a capability.

Example:

"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

Response

The payor is registered. Read status to know whether its screening started.

id
string<uuid>

The payor's identifier. Send it as ultimate_payor_id on a payout made on its behalf.

status
string

How far the screening got before this call returned. Available options: verifying, failed — see Values.