Validate a beneficiary
Call Validate a beneficiary API to check for errors before creating a beneficiary:
- If validation errors are found, a list of all errors will be returned as a 400 response.
- If all parameters provided for the payout are valid, the endpoint will return a 200 (
OK
) response.
To learn more about error response structures and detailed descriptions of error codes, please see Error codes.
Example request
Shell
If you are registered as a platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of
header.