Skip to main content
POST
Add a party to an account
Requires scope: manage:accounts — see Required scopes. Associates a party with the account in a role. A party can hold only one role per account.

Authorizations

Path Parameters

accountId
string<uuid>
required

Unique account identifier

Body

application/json
partyId
string<uuid>
required

ID of the party to add to the account

roleType
enum<string>
required

Role type for the party-account relationship.

  • ACCOUNT_HOLDER — the party holds the account
  • PAYOUT_RECIPIENT — the party is an allowed pay-out destination for the account. Required (with cleared KYC/KYB) before a payout route can be created for its bank account. A party may hold this alongside ACCOUNT_HOLDER on the same account, which is the self-payout case.
Available options:
ACCOUNT_HOLDER,
PAYOUT_RECIPIENT

Response

Party role added

success
boolean

Indicates whether the request was successful

result
object

Represents the relationship between a Party and an Account