Create a counterparty

POST

/counterparties

Creates a new counterparty under the authenticated entity. A counterparty represents an individual or business that your entity transacts with — for example, a customer, vendor, or recipient.

The email field must be unique per entity: you cannot create two counterparties with the same email under the same entity. If you supply a client_reference, that value must also be unique per entity and is useful for correlating counterparties with records in your own system.

All optional name, contact, and address fields can be supplied at creation time or added later via the edit endpoint.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Counterparty created successfully.

Bodyapplication/json

🟠400

🟠401

🟠409

Request Example

Shell

JavaScript

Java

Swift

cURL

Minimal — email onlyWith name and phone numberAll fields

curl --location '/counterparties' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "jane.doe@example.com"
}'

Response Example

201 - Success

{
    "message": "Counterparty created successfully",
    "status": "success",
    "data": {
        "id": "01HZ9KPQR3VTXMN84JWYB65CD0",
        "entity_id": "01HZ9ABCD1234EFGH5678IJKL90",
        "email": "jane.doe@example.com",
        "status": "active",
        "first_name": "Jane",
        "last_name": "Doe",
        "phonenumber": "+2348031234567",
        "client_reference": "cust-00412",
        "created": 1722870000000,
        "updated": 1722870000000
    }
}

Modified at 2026-08-12 16:05:45

List my entities

List counterparties