Tesser API

Counterparties (v1)

Endpointhttps://sandbox.tesserx.co

Download schema

List all counterparties

GET

https://sandbox.tesserx.co

/v1/entities/counterparties

Retrieve all counterparties for your workspace or a specific tenant.

List all counterparties › query Parameters

classification

string · enum

Filter by classification

Enum values:

individual

business

search

string

Search by name

include_secure

boolean

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

Default: false

page

number · min: 1 · max: 9007199254740991

Page number for pagination (1-based)

limit

number · min: 1 · max: 100

Number of items per page (max 100)

List all counterparties › Responses

Counterparties retrieved successfully

object[] · required

object

GET/v1/entities/counterparties

curl --request GET \
  --url https://sandbox.tesserx.co/v1/entities/counterparties

shell

Example Responses

{
  "data": [
    {
      "id": "6f1c4a8e-2d7b-4930-b5e2-9a3f0c7d1b6e",
      "workspace_id": "b53f6690-3242-4942-9907-885779632832",
      "classification": "business",
      "tenant_id": null,
      "individual_first_name": null,
      "individual_last_name": null,
      "individual_address_country": null,
      "individual_date_of_birth": null,
      "individual_national_identification_number": null,
      "individual_street_address1": null,
      "individual_street_address2": null,
      "individual_city": null,
      "individual_state": null,
      "individual_postal_code": null,
      "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_at": "2024-02-01T14:00:00.000Z",
      "updated_at": "2024-02-01T14:00:00.000Z"
    },
    {
      "id": "3e9a7c2f-1b8d-4e56-a0f3-5c2d8b1e9a7f",
      "workspace_id": "b53f6690-3242-4942-9907-885779632832",
      "classification": "individual",
      "tenant_id": null,
      "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": null,
      "business_dba": null,
      "business_address_country": null,
      "business_street_address1": null,
      "business_street_address2": null,
      "business_city": null,
      "business_state": null,
      "business_legal_entity_identifier": null,
      "created_at": "2024-01-15T10:30:00.000Z",
      "updated_at": "2024-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 2,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  }
}

json

application/json

Create a new counterparty

POST

https://sandbox.tesserx.co

/v1/entities/counterparties

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

Create a new counterparty › Request Body

classification

string · enum · required

Classification: 'individual' or 'business'.

Enum values:

individual

business

tenant_id

string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

ID of the tenant entity (optional).

individual_first_name

string · maxLength: 255

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

individual_last_name

string · maxLength: 255

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

individual_address_country

string · minLength: 2 · maxLength: 3 · pattern: ^[A-Za-z]{2,3}$

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

individual_date_of_birth

string · maxLength: 255

Date of birth (for individuals).

individual_national_identification_number

string · maxLength: 255

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

individual_street_address1

string · maxLength: 255

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

individual_street_address2

string · maxLength: 255

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

individual_city

string · maxLength: 255

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

individual_state

string · maxLength: 255

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

individual_postal_code

string · maxLength: 255

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

business_legal_name

string · maxLength: 255

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

business_dba

string · maxLength: 255

Doing Business As name (optional).

business_address_country

string · minLength: 2 · maxLength: 3 · pattern: ^[A-Za-z]{2,3}$

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

business_street_address1

string · maxLength: 255

Street address line 1 (for businesses).

business_street_address2

string · maxLength: 255

Street address line 2 (for businesses).

business_city

string · maxLength: 255

City (for businesses).

business_state

string · maxLength: 255

State/region (for businesses).

business_legal_entity_identifier

string · maxLength: 255

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

Create a new counterparty › Responses

Counterparty created successfully

object · required

POST/v1/entities/counterparties

curl --request POST \
  --url https://sandbox.tesserx.co/v1/entities/counterparties \
  --header 'Content-Type: application/json' \
  --data '
{
  "classification": "individual",
  "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"
}
'

shell

Example Request Body

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

json

application/json

Example Responses

{
  "data": {
    "id": "c7d8e9f0-1a2b-3c4d-5e6f-789012345678",
    "workspace_id": "b53f6690-3242-4942-9907-885779632832",
    "classification": "individual",
    "tenant_id": null,
    "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": null,
    "business_dba": null,
    "business_address_country": null,
    "business_street_address1": null,
    "business_street_address2": null,
    "business_city": null,
    "business_state": null,
    "business_legal_entity_identifier": null,
    "created_at": "2024-03-01T10:00:00.000Z",
    "updated_at": "2024-03-01T10:00:00.000Z"
  }
}

json

application/json

Get a counterparty by ID

GET

https://sandbox.tesserx.co

/v1/entities/counterparties/{id}

Retrieve a specific counterparty by its unique identifier.

Get a counterparty by ID › path Parameters

id

string · required

Counterparty ID (UUID)

Get a counterparty by ID › query Parameters

include_secure

boolean

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

Get a counterparty by ID › Responses

Counterparty retrieved successfully

object · required

GET/v1/entities/counterparties/{id}

curl --request GET \
  --url https://sandbox.tesserx.co/v1/entities/counterparties/:id

shell

Example Responses

{
  "data": {
    "id": "d8e9f0a1-2b3c-4d5e-6f78-901234567890",
    "workspace_id": "b53f6690-3242-4942-9907-885779632832",
    "classification": "business",
    "tenant_id": null,
    "individual_first_name": null,
    "individual_last_name": null,
    "individual_address_country": null,
    "individual_date_of_birth": null,
    "individual_national_identification_number": null,
    "individual_street_address1": null,
    "individual_street_address2": null,
    "individual_city": null,
    "individual_state": null,
    "individual_postal_code": null,
    "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_at": "2024-02-01T14:00:00.000Z",
    "updated_at": "2024-02-01T14:00:00.000Z"
  }
}

json

application/json

Currencies Tenants

List all counterparties

GET

https://sandbox.tesserx.co

/v1/entities/counterparties

Retrieve all counterparties for your workspace or a specific tenant.

List all counterparties › query Parameters

classification

string · enum

Filter by classification

Enum values:

individual

business

search

string

Search by name

include_secure

boolean

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

Default: false

page

number · min: 1 · max: 9007199254740991

Page number for pagination (1-based)

limit

number · min: 1 · max: 100

Number of items per page (max 100)

List all counterparties › Responses

Counterparties retrieved successfully

object[] · required

object

{ "data": [ { "id": "6f1c4a8e-2d7b-4930-b5e2-9a3f0c7d1b6e", "workspace_id": "b53f6690-3242-4942-9907-885779632832", "classification": "business", "tenant_id": null, "individual_first_name": null, "individual_last_name": null, "individual_address_country": null, "individual_date_of_birth": null, "individual_national_identification_number": null, "individual_street_address1": null, "individual_street_address2": null, "individual_city": null, "individual_state": null, "individual_postal_code": null, "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_at": "2024-02-01T14:00:00.000Z", "updated_at": "2024-02-01T14:00:00.000Z" }, { "id": "3e9a7c2f-1b8d-4e56-a0f3-5c2d8b1e9a7f", "workspace_id": "b53f6690-3242-4942-9907-885779632832", "classification": "individual", "tenant_id": null, "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": null, "business_dba": null, "business_address_country": null, "business_street_address1": null, "business_street_address2": null, "business_city": null, "business_state": null, "business_legal_entity_identifier": null, "created_at": "2024-01-15T10:30:00.000Z", "updated_at": "2024-01-15T10:30:00.000Z" } ], "pagination": { "page": 1, "limit": 10, "total": 2, "total_pages": 1, "has_next": false, "has_prev": false } }

Create a new counterparty

POST

https://sandbox.tesserx.co

/v1/entities/counterparties

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

Create a new counterparty › Request Body

classification

string · enum · required

Classification: 'individual' or 'business'.

Enum values:

individual

business

tenant_id

string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

ID of the tenant entity (optional).

individual_first_name

string · maxLength: 255

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

individual_last_name

string · maxLength: 255

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

individual_address_country

string · minLength: 2 · maxLength: 3 · pattern: ^[A-Za-z]{2,3}$

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

individual_date_of_birth

string · maxLength: 255

Date of birth (for individuals).

individual_national_identification_number

string · maxLength: 255

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

individual_street_address1

string · maxLength: 255

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

individual_street_address2

string · maxLength: 255

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

individual_city

string · maxLength: 255

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

individual_state

string · maxLength: 255

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

individual_postal_code

string · maxLength: 255

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

business_legal_name

string · maxLength: 255

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

business_dba

string · maxLength: 255

Doing Business As name (optional).

business_address_country

string · minLength: 2 · maxLength: 3 · pattern: ^[A-Za-z]{2,3}$

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

business_street_address1

string · maxLength: 255

Street address line 1 (for businesses).

business_street_address2

string · maxLength: 255

Street address line 2 (for businesses).

business_city

string · maxLength: 255

City (for businesses).

business_state

string · maxLength: 255

State/region (for businesses).

business_legal_entity_identifier

string · maxLength: 255

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

Create a new counterparty › Responses

Counterparty created successfully

object · required

curl --request POST \ --url https://sandbox.tesserx.co/v1/entities/counterparties \ --header 'Content-Type: application/json' \ --data ' { "classification": "individual", "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" } '

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

{ "data": { "id": "c7d8e9f0-1a2b-3c4d-5e6f-789012345678", "workspace_id": "b53f6690-3242-4942-9907-885779632832", "classification": "individual", "tenant_id": null, "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": null, "business_dba": null, "business_address_country": null, "business_street_address1": null, "business_street_address2": null, "business_city": null, "business_state": null, "business_legal_entity_identifier": null, "created_at": "2024-03-01T10:00:00.000Z", "updated_at": "2024-03-01T10:00:00.000Z" } }

Get a counterparty by ID

GET

https://sandbox.tesserx.co

/v1/entities/counterparties/{id}

Retrieve a specific counterparty by its unique identifier.

Get a counterparty by ID › path Parameters

id

string · required

Counterparty ID (UUID)

Get a counterparty by ID › query Parameters

include_secure

boolean

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

Get a counterparty by ID › Responses

Counterparty retrieved successfully

object · required

{ "data": { "id": "d8e9f0a1-2b3c-4d5e-6f78-901234567890", "workspace_id": "b53f6690-3242-4942-9907-885779632832", "classification": "business", "tenant_id": null, "individual_first_name": null, "individual_last_name": null, "individual_address_country": null, "individual_date_of_birth": null, "individual_national_identification_number": null, "individual_street_address1": null, "individual_street_address2": null, "individual_city": null, "individual_state": null, "individual_postal_code": null, "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_at": "2024-02-01T14:00:00.000Z", "updated_at": "2024-02-01T14:00:00.000Z" } }