Skip Navigation
Log In Sign Up

Retrieve an Entity

·

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

Request

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

Authentication

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

Path Parameters

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

Notes

  • This endpoint returns all details for a specific entity.
  • The entity must belong to your organization to be accessible.
  • The response includes important identification details like registration number, tax number, and jurisdiction.
  • You can use the retrieved entity UID in other API calls that require an entity reference, such as creating loans, recipients, or payment methods.

Example Request

curl -X GET https://tupel.com/api/entities/7Ba9c2E4f/ \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>

Response

A successful request returns a 200 OK status code and a complete Entity 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 entity.
404 Not Found - The specified entity could not be found.

Example Error Response

{
  "detail": [
    {
      "type": "not_found",
      "loc": ["path", "uid"],
      "msg": "Entity with id 7Ba9c2E4f not found."
    }
  ]
}