Sign in
latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

Counterparties

Create counterparty

Creates a counterparty. If externalId is provided, it must be unique within the organization.

post/v1/counterparties

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Request body

OR

Example request

{
  "externalId": "customer_42",
  "displayName": "Jane Doe",
  "email": "jane@example.com",
  "entityType": "individual",
  "identity": {
    "firstName": "Jane",
    "middleName": "Q",
    "lastName": "Doe",
    "secondLastName": "Garcia",
    "dateOfBirth": "1990-01-15",
    "phone": "+14155551234",
    "address": {
      "line1": "123 Main St",
      "line2": "Apt 4B",
      "city": "San Francisco",
      "postalCode": "94105",
      "countryCode": "US",
      "subdivisionCode": "CA"
    }
  }
}

Response

Counterparty created

Example response

{
  "data": {
    "counterparty": {
      "id": "cp_example",
      "organizationId": "org_example",
      "projectId": "prj_example",
      "externalId": "customer_42",
      "entityType": "individual",
      "displayName": "Jane Doe",
      "email": "jane@example.com",
      "identity": {
        "firstName": "Jane",
        "middleName": "Q",
        "lastName": "Doe",
        "secondLastName": "Garcia",
        "dateOfBirth": "1990-01-15",
        "phone": "+14155551234",
        "address": {
          "line1": "123 Main St",
          "line2": "Apt 4B",
          "city": "San Francisco",
          "postalCode": "94105",
          "countryCode": "US",
          "subdivisionCode": "CA"
        }
      },
      "status": "active",
      "createdBy": "usr_example",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-02T00:00:00.000Z"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}