List Recipients

Retrieves a list of recipients for your customer account

Response

List Recipients
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