Skip to main content
POST
/
v2
/
account
/
beneficiaries
/
bank-accounts
/
cop
Create COP bank-account beneficiary
curl --request POST \
  --url https://api.example.com/v2/account/beneficiaries/bank-accounts/cop/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias": "<string>",
  "beneficiaryName": "<string>",
  "description": "<string>",
  "beneficiaryType": "<string>",
  "beneficiaryEmail": "jsmith@example.com",
  "beneficiaryAddress": {
    "streetLine1": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zipCode": "<string>"
  },
  "phoneNumber": "<string>",
  "accountType": "<string>",
  "bankAccountNumber": "<string>",
  "documentNumber": "<string>",
  "documentType": "<string>",
  "bankId": "<string>",
  "bankName": "<string>",
  "breBKey": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

subAccountId
string<uuid>

Operate against a sub-account of the authenticated main account.

Body

application/json

Passthrough body. BreBKey-only registration or bank fields or both accepted.

alias
string
required
beneficiaryName
string
required
description
string
beneficiaryType
string
beneficiaryEmail
string<email>
beneficiaryAddress
object

COP beneficiary address

phoneNumber
string
accountType
string
bankAccountNumber
string
documentNumber
string
documentType
string
bankId
string
bankName
string
breBKey
string

Response

OK

id
string<uuid>