Create a beneficiary

Create a new beneficiary for receiving payments.

Beneficiary Types:

  • Fiat beneficiaries require bank account details (account number, IBAN, bank code, etc.)
  • Crypto beneficiaries require a wallet address and blockchain specification

Compliance Screening: All new beneficiaries undergo automatic compliance screening. The beneficiary will be created with status new and will transition to approved or rejected after screening completes.

You will receive a BeneficiaryScreened webhook event when screening is complete. Alternatively, poll GET /beneficiaries/{id} until the status changes from new.

Body Params
accountDetails
object
required
address
object
required

Beneficiary's physical address

ownerIdentification

Required for crypto beneficiaries. Identifies the wallet owner for compliance purposes.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json