Skip Navigation
Log In Sign Up

Entities

·

The Entities API allows you to manage business profiles within the Tupel platform. Entities form the foundation of your Tupel integration, representing the businesses your organization works with and serving as references for loans, payment methods, and recipients.

What is an Entity?

In Tupel, an entity represents a business entity with which you interact. Each entity includes:

  • Basic company information (name, jurisdiction)
  • Registration details (incorporation date, registration number, tax ID)
  • Status information (active/inactive)
  • Entity type (limited company, partnership, etc.)

Entity Types

Tupel supports various entity types across multiple jurisdictions:

  • PLC - Public Limited Company
  • LTD - Limited Company
  • PAR - Partnership
  • STR - Sole Trader
  • LLP - Limited Liability Partnership

Supported Jurisdictions

Entities can be registered in any of the supported jurisdictions. A small subset of the supported countries is provided below:

Code Country
BE Belgium
FR France
GB United Kingdom
CH Switzerland
NL Netherlands
US United States
ES Spain
DE Germany
IT Italy
PT Portugal
IE Ireland
PL Poland
RO Romania
CY Cyprus

Entity Relationships

Entities are central to Tupel's data model and are referenced by multiple other resource types:

  • Loans: Each loan is associated with an entity as the borrower
  • Recipients: Banking details for receiving funds are linked to entities
  • Payment Methods: Methods used for repayments are tied to entities
  • Credit Limits: Entities may have credit limits that determine lending capacity

Available Endpoints

Endpoint Description
Retrieve an Entity Get details about a specific entity
List All Entities Get a paginated list of entities with filtering options

Best Practices

  • Keep entity information up-to-date, especially contact details and registration information
  • Use the entity UID as a reference in your internal systems
  • Verify entity details before creating loans or other financial products
  • Use appropriate filtering when listing entities to improve performance
  • Consider implementing a sync mechanism to keep your systems aligned with Tupel's entity data

Common Use Cases

Listing All Active Entities

curl -X GET "https://tupel.com/api/entities/?status=ACTIVE" \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>

Getting Entity Details Before Creating a Loan

# First retrieve the entity to confirm details
curl -X GET "https://tupel.com/api/entities/7aB9c/" \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>

# Then use the entity UID when creating a loan
curl -X POST "https://tupel.com/api/loans/" \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY> \
  -H "Content-Type: application/json" \
  -d '{
    "entity": "7aB9c",
    "currency": "USD",
    "principal": "50000.00",
    "pay_at": "2023-04-01T12:00:00Z",
    "due_at": "2023-10-01T23:59:59Z",
    "recipient": "3xY4zW",
    "payment_method": "2qP3oN"
  }'

Filtering Entities by Type and Jurisdiction

# Find all Limited Companies in the United States
curl -X GET "https://tupel.com/api/entities/?jurisdiction=US&type=LTD" \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>