Skip Navigation

Retrieve a Recipient

·

Retrieve detailed information about a specific recipient by its unique identifier.

Request

GET https://tupel.com/api/recipients/{uid}/

Authentication

This endpoint requires basic authentication with your Organization ID and API Key.

Path Parameters

  • uid string Required
    The unique identifier of the recipient to retrieve.

Notes

  • This endpoint returns all details for a specific recipient, including the associated entity information.
  • The recipient must belong to your organization to be accessible.
  • The response includes banking information that can be used for disbursing funds.
  • When retrieving a recipient before creating a loan, verify that the recipient's currency matches the loan currency.
  • For security purposes, the account number might be partially masked depending on your permissions.
  • You can use the retrieved recipient UID in other API calls, such as when creating a loan.

Example Request

curl -X GET https://tupel.com/api/recipients/rcpt_3xY4zW5vU6tS7rQ/ \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>

Response

A successful request returns a 200 OK status code and a complete Recipient in the response body.

Error Responses

Code Description
401 Unauthorized - Authentication failed. Check your Organization ID and API Key.
403 Forbidden - Insufficient permissions to access the specified recipient.
404 Not Found - The specified recipient could not be found.

Example Error Response

{
  "detail": [
    {
      "type": "not_found",
      "loc": ["path", "uid"],
      "msg": "Recipient with id rcpt_3xY4zW5vU6tS7rQ not found."
    }
  ]
}