Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Path Parameters

customerId
string
required
beneficiaryId
string
required

Body

application/json
version
integer
required
Required range: x >= 1
input
object
required

Full replacement of non-sensitive beneficiary facts. Omitted non-sensitive values are cleared. Sensitive identifiers are write-only; omission preserves their values and an empty string clears them. Enum values use camelCase.

Response

Success

id
string
required
object
enum<string>
required
Available options:
businessBeneficiary
customerId
string
required
roles
enum<string>[]
required
Available options:
beneficialOwner,
controller,
director,
signatory,
representative
version
integer
required
Required range: x >= 1
firstName
string
middleName
string
lastName
string
fullNameAsOnDocument
string
nationality
string
address
object
email
string
emailType
enum<string>
Available options:
personal,
work,
other
phone
string
phoneType
enum<string>
Available options:
home,
mobile,
work,
fax
title
string
ownershipPercentage
string
hasControl
boolean
politicallyExposedPerson
boolean
regO
boolean
riskRating
enum<string>
Available options:
low,
medium,
high
taxIdType
enum<string>
Available options:
ein,
vat,
foreign,
ssn,
itin,
foreignTin
identificationType
enum<string>
Available options:
driversLicense,
passport,
idCard,
socialSecurityCard,
other
issuingAuthority
string
issuingCountry
string
issuingState
string
issuedDate
string
expirationDate
string
verifiedDate
string
hasBirthDate
boolean
hasTaxId
boolean
hasIdentificationNumber
boolean
createdAt
string<date-time>
updatedAt
string<date-time>