Settlement parties

Retrieving your own entity, your beneficiaries and your senders, with their bank accounts and wallets.

Three endpoints return the same Participant record, differing only in which party they describe:

POST /api/3/originator     # you, as onboarded — always a single record
POST /api/3/beneficiaries  # parties that may receive from you
POST /api/3/senders        # parties that may deliver on your behalf

beneficiaries and senders are paged lists. originator describes you, so it returns exactly one record and ignores offset and limit.

A party carries both settlement rails — bank accounts and wallets — together with the identity and verification state behind them.

enabled, verified and whitelisted appear on the party and again on each individual account or address. Check the destination you intend to use, not only the party.

Request

Field	Type	Required	Notes
`nonce`	string	Optional	A counter that must increase with each request. An alternative to `tonce`; send one or the other
`tonce`	string	Optional	The current Unix time in microseconds. Send this or `nonce` — a request with neither is rejected, and each value must be higher than the last one used by the key
`userUuid`	string	Optional
`accountGroupUuid`	string	Optional	Restricts the result to one account group. Omitting it returns every party your credentials can see
`offset`	integer	Optional	Index to start from, for paging
`limit`	integer	Optional	How many records to return — min 0, max 50

Response

Every endpoint answers with data, an array of Participant, and total, the number of records available. originator returns a single-element array.

Participant

Field	Type	Notes
`uuid`	string	Identifier for the party. This is what a withdrawal request refers to
`clientShortcode`	string	Your shortcode for the relationship
`clientAccountGroupName`	string	Name of that account group
`clientAccountGroupUuid`	string	The account group the party belongs to
`type`	ParticipantType	Whether the party is an entity or an individual, which decides the identity fields below
`kind`	ParticipantKind	Whether the party is the originator, a beneficiary or a sender
`phoneNumber`	string
`website`	string
`email`	string
`vasp`	boolean	Whether the party is a Virtual Asset Service Provider
`enabled`	boolean	Whether the party is currently usable
`verified`	boolean	Whether the party has completed verification
`ownershipPercentage`	string	For an associated person, their holding in the entity
`address`	Address
`kycDetails`	KycDetails
`associatedPersons`	Participant[]	Individuals connected to an entity, such as directors or beneficial owners
`identifications`	Identification[]	Identity documents recorded against the party
`bankAccounts`	BankAccount[]	Fiat destinations held for this party
`wallets`	Wallet[]	Digital-asset destinations held for this party
`createdAt`	timestamp
`updatedAt`	timestamp

Identity fields

A party is one or the other, never both. type says which, and the fields below sit alongside the common ones above.

Present when type is an entity.

Field	Type	Notes
`companyName`	string	Registered name
`companyName2`	string	Second line of the registered name, where one is held
`dateOfFormation`	date
`countryOfFormation`	string	Where the entity was formed
`countryOfRegistration`	string	Where the entity is registered

BankAccount

A fiat destination. uuid is what a fiat withdrawal request names as its bankAccountUuid.

Field	Type	Notes
`uuid`	string	Identifier for this account
`bankName`	string	Name of the bank
`bankBranchName`	string	Branch, where recorded
`accountNumber`	string	Local account number
`accountAlias`	string
`accountName`	string	Name the account is held in
`currency`	string	Currency the account is held in
`iban`	string	IBAN, where the account has one
`swiftBic`	string	SWIFT/BIC of the account's bank
`country`	string
`city`	string
`street`	string
`postalCode`	string
`memo`	string	Reference to be carried with the payment
`intermediaryBankCountry`	string	Country of that intermediary bank
`intermediaryBankSwiftBic`	string	SWIFT/BIC of the intermediary bank, where one is required
`enabled`	boolean	Whether this account may currently be used
`verified`	boolean	Whether this account has been verified
`networkIds`	string[]
`createdAt`	timestamp
`updatedAt`	timestamp

Wallet

A digital-asset destination. uuid is what a crypto withdrawal request names as its walletParticipantUuid.

Field	Type	Notes
`uuid`	string	Identifier for this wallet
`blockchain`	string	Network the address is on
`asset`	string	Asset the address is for
`walletAddress`	string	The address itself
`alias`	string	Label given to the wallet
`type`	string
`memo`	string	Destination tag or memo, where the network requires one
`vasp`	string	The Virtual Asset Service Provider holding the address, where known
`executionProvider`	string
`default`	boolean	Whether this is the default wallet for its asset
`enabled`	boolean	Whether this wallet may currently be used
`whitelisted`	boolean	Whether the address is whitelisted for settlement
`createdAt`	timestamp
`updatedAt`	timestamp

Address

Field	Type	Notes
`country`	string	Country
`city`	string	City
`street`	string	Street
`postalCode`	string	Postal code
`stateProvince`	string	State or province
`createdAt`	timestamp
`updatedAt`	timestamp

Identification

Field	Type	Notes
`type`	IdentificationType	Which kind of document this is
`number`	string	Document number
`typeOther`	string	The document kind in words, used when `type` is `OTHER`
`createdAt`	timestamp
`updatedAt`	timestamp

ParticipantType

Value	Meaning
`INDIVIDUAL`	A natural person
`ENTITY`	A company or other legal entity

ParticipantKind

The role a party plays. originator, beneficiaries and senders each return one of the first three; the remaining values appear on associated persons.

Value	Meaning
`ORIGINATOR`	You, as onboarded
`BENEFICIARY`	A party that may receive from you
`AUTHORIZED_SIGNATORY`	A person authorised to act for an entity
`BENEFICIARY_OWNER`	A beneficial owner of an entity
`INTERMEDIARY_BENEFICIARY_OWNER`	A beneficial owner holding through an intermediary
`SENDER`	A party that may deliver on your behalf

IdentificationType

Value	Meaning
`PASSPORT`	Passport
`NATIONAL_ID`	National identity document
`DRIVERS_LICENSE`	Driving licence
`SSN`	Social security number
`TAX_ID`	Tax identification number
`LEI`	Legal Entity Identifier
`EIN`	Employer Identification Number
`VAT_NUMBER`	VAT registration number
`BUSINESS_REGISTRATION`	Company registration number
`OTHER`	Any other document, with the kind named in `typeOther`