View a recipient by recipientRef

Searches for recipients with the specified recipientRef.

<!-- theme: info -->

📘 Notes

• You can only use recipientRef as the path parameter for this endpoint.
• When searching for a recipient by recipientId use the View a recipient by recipientId endpoint.
• To view a recipient using other IDs or parameters, use the View recipients endpoint.

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.<br/><br/>Include the recipientRef in the path parameter of the request.

<div style="display:none;">

Request parameters

• recipientRef

Response parameters

• recipientRef
• recipientId
• payoutAccountId
• providerId
• providerType
• providerRecipientRef
• userType
• firstName
• lastName
• gender
• birthDate
• countryOfBirth
• countryOfNationality
• addressLine1
• addressLine2
• city
• region
• postalCode
• country
• email
• phoneNumber
• mobileNumber
• governmentIdType
• recipientIdNumbers
• recipientIdNumbers.governmentId
• recipientIdNumbers.passportId
• recipientIdNumbers.employerId
• recipientIdNumbers.driversLicenseId
• createdAt
• updatedAt

</div>