TEtesser
Counterparties

Get a counterparty by ID

Retrieve a specific counterparty by its unique identifier.

get/v1/entities/counterparties/{id}

Request

Path parameters

idstring required
Example:d8e9f0a1-2b3c-4d5e-6f78-901234567890

Counterparty ID (UUID)

Query parameters

include_secureboolean

Include masked vault data (address, DOB, national ID, legal entity identifier)

Response

Counterparty retrieved successfully

Example response

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "workspace_id": "550e8400-e29b-41d4-a716-446655440001",
    "classification": "business",
    "name": "Acme Corporation",
    "tenant_id": "550e8400-e29b-41d4-a716-446655440002",
    "individual_first_name": "John",
    "individual_last_name": "Doe",
    "individual_address_country": "US",
    "individual_date_of_birth": "1980-01-01",
    "individual_national_identification_number": "123456789",
    "individual_street_address1": "123 Main St",
    "individual_street_address2": "Apt 4B",
    "individual_city": "New York",
    "individual_state": "NY",
    "individual_postal_code": "10001",
    "business_legal_name": "Acme Corporation",
    "business_dba": "Acme Co",
    "business_address_country": "US",
    "business_street_address1": "456 Corp Blvd",
    "business_street_address2": "Suite 200",
    "business_city": "San Francisco",
    "business_state": "CA",
    "business_legal_entity_identifier": "1234567890",
    "created_by": "CUSTOMER",
    "created_at": "2024-01-15T10:30:00.000Z",
    "updated_at": "2024-01-15T10:30:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.