Create an ultimate payor
Register the business one of your sub-clients pays on behalf of, and start its anti-money-laundering screening.
The screening finishes after this call returns. How a payor clears says how to follow it.
This call takes no idempotency key, and every call registers a new payor. If you never got the answer to one, look for the payor with List ultimate payors before you send it again.
Authorizations
The data.access_token value from Get access token.
Headers
Version applied to this request. It wins over your account's pinned version — see Versioning.
"2026-06-01"
Body
Any other field is ignored.
The payor's legal name, as the screening should check it. Spaces around it are trimmed.
1"Acme Holdings LLC"
The city the payor is based in. Spaces around it are trimmed.
1"New York"
The payor's country, as an ISO 3166-1 alpha-3 code. Any case is accepted, and it is stored upper-cased.
^[A-Za-z]{3}$"USA"
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.
"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"