Sign in
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

externalIdstring

Caller-supplied opaque identifier for cross-system reference. Do not place personal data in this indexed field.

entityType'individual' | 'business' required

Counterparty entity type.

displayNamestring required

Human-readable, searchable display name. Keep it minimal because this indexed field is not application-encrypted.

Example request

{
  "externalId": "customer_42",
  "entityType": "individual",
  "displayName": "Jane Doe"
}

Response

Counterparty created

Example response

{
  "data": {
    "counterparty": {
      "id": "cpty_example",
      "organizationId": "org_example",
      "projectId": "prj_example",
      "externalId": "customer_42",
      "entityType": "individual",
      "displayName": "Jane Doe",
      "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"
  }
}

Changes