Update a Recipient

Updates a recipient

Path parameters

idstringRequired

Request

This endpoint expects an object.
given_namestringOptional
The recipient's given name
family_namestringOptional
The recipient's family name
addressobjectOptional
Address information for the recipient
emailstringOptional
The recipient's email address
phonestringOptional
The recipient's phone number
documentobjectOptional
Document information for identity verification

Response

Update a Recipient
idstring
Unique public identifier for the recipient
addressobject
Address information for the recipient
documentobject
Document information for identity verification
financial_accountobject
Associated financial account details
emailstring
Recipient's email address
phonestring
Recipient's phone number
given_namestring
Recipient's given name
family_namestring
Recipient's family name
legal_namestring
Legal name for business recipients
statusenum
Current status of the recipient
Allowed values:
typeenum

The type of recipient (‘individual’ or ‘business’)

Allowed values:
created_atstring
ISO 8601 timestamp when the recipient was created
updated_atstring
ISO 8601 timestamp when the recipient was last updated