TEtesser
Counterparties

Create a new counterparty

Create a new counterparty for your workspace or a specific tenant.

post/v1/entities/counterparties

Request

Request body

classification'individual' | 'business' required

Classification: 'individual' or 'business'.

tenant_idstring uuid nullable

ID of the tenant entity (optional).

individual_first_namestring nullable

First name (required if classification is 'individual'). Secure field, returned based on include_secure.

individual_last_namestring nullable

Last name (required if classification is 'individual'). Secure field, returned based on include_secure.

individual_address_countrystring nullable

ISO 3166-1 alpha-2 or alpha-3 country code.

individual_date_of_birthstring nullable

Date of birth (for individuals).

individual_national_identification_numberstring nullable

National identification number (for individuals). Secure field, returned based on include_secure.

individual_street_address1string nullable

Street address line 1 (for individuals). Secure field, returned based on include_secure.

individual_street_address2string nullable

Street address line 2 (for individuals). Secure field, returned based on include_secure.

individual_citystring nullable

City (for individuals). Secure field, returned based on include_secure.

individual_statestring nullable

State/region (for individuals). Secure field, returned based on include_secure.

individual_postal_codestring nullable

Postal code (for individuals). Secure field, returned based on include_secure.

business_legal_namestring nullable

Legal business name (required if classification is 'business').

business_dbastring nullable

Doing Business As name (optional).

business_address_countrystring nullable

ISO 3166-1 alpha-2 or alpha-3 country code.

business_street_address1string nullable

Street address line 1 (for businesses).

business_street_address2string nullable

Street address line 2 (for businesses).

business_citystring nullable

City (for businesses).

business_statestring nullable

State/region (for businesses).

business_legal_entity_identifierstring nullable

Legal Entity Identifier (for businesses). Secure field, returned based on include_secure.

Example request

{
  "classification": "individual",
  "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"
}

Response

Counterparty created 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.