Counterparties

A counterparty represents a payout recipient — a person or business you send funds to. Counterparties hold identity information. Payment routing details (bank account numbers, wallet addresses) are stored separately as payment details attached to the counterparty.

The Counterparty object

string

Unique counterparty identifier.

string

The entity this counterparty belongs to.

string

individual or business.

string

Display label. Defaults to full name for individuals and legal name for businesses.

string

active or inactive. Inactive counterparties cannot receive transfers.

object

Identity details. Shape depends on type.

Show Individual profile fields

string

First name of the individual.

string

Last name of the individual.

string

Relationship to the sending entity. Allowed values: vendor, supplier, customer, employee.

string

Email address of the individual.

object

Physical address.

Show Address fields

string

Street address line 1. Required.

string

Street address line 2. Optional.

string

City. Required.

string

State or province. Optional.

string

Postal or ZIP code. Optional.

string

ISO alpha-2 country code. Required.

array

Government-issued identification documents.

Show Identification fields

string

Document type. P = passport, D = driving licence, N = national ID.

string

Document number.

string

ISO alpha-2 country code of the issuing authority.

object

Phone contact details.

Show Phone fields

string

Phone number in E.164 format.

string

mobile, work, home, or other.

string

ISO alpha-2 country code.

Show Business profile fields

string

Registered legal name of the business.

string

Trading or DBA name, if different from the legal name. Optional.

string

Relationship to the sending entity. Allowed values: vendor, supplier, customer, employee.

string

Business contact email.

object

Registered business address. Same shape as individual address.

array

Business registration documents.

Show Identification fields

string

L = business registration number.

string

Registration number.

string

ISO alpha-2 country code of the registering authority.

object

Phone contact details. Same shape as individual phone.

object

Arbitrary key-value metadata.

number

Unix timestamp (milliseconds) when the counterparty was created.

number

Unix timestamp (milliseconds) when the counterparty was last updated.

Example counterparty object

{
  "id": "01KM37EZ0AYCVDXJ3WDHXPPSZ9",
  "entity_id": "01KBCFY3VB1XT0MC8VMZXME6RS",
  "type": "individual",
  "nickname": "Jane Smith",
  "status": "active",
  "profile": {
    "first_name": "Jane",
    "last_name": "Smith",
    "relationship": "vendor",
    "email": "jane.smith@example.com",
    "address": {
      "line1": "123 Main St",
      "city": "Austin",
      "state_or_province": "TX",
      "postal_code": "78701",
      "country": "US"
    }
  },
  "meta": {},
  "created": 1735725600000,
  "updated": 1735725600000
}

Create a counterparty

POST /counterparties Creates a counterparty of type individual or business. Attach payment details separately after creation.

Request parameters

string

required

individual or business.

string

required

The entity this counterparty belongs to.

string

Display label. Defaults to first name + last name for individuals or legal name for businesses.

object

required

Identity details. Required fields differ by type.

Show Individual profile

string

required

First name.

string

required

Last name.

string

required

Relationship to the sending entity. One of: vendor, supplier, customer, employee.

string

required

Email address.

object

required

Physical address.

Show Address fields

string

required

Street address line 1.

string

Street address line 2.

string

required

City.

string

State or province.

string

Postal or ZIP code.

string

required

ISO alpha-2 country code (e.g. US, GB).

array

Government-issued identification documents.

Show Identification fields

string

required

Document type. P = passport, D = driving licence, N = national ID.

string

required

Document number.

string

required

ISO alpha-2 country code of the issuing authority.

object

Phone contact details.

Show Phone fields

string

required

Phone number in E.164 format.

string

required

mobile, work, home, or other.

string

required

ISO alpha-2 country code.

Show Business profile

string

required

Registered legal name of the business.

string

Trading or DBA name, if different from the legal name.

string

required

Relationship to the sending entity. One of: vendor, supplier, customer, employee.

string

required

Business contact email.

object

required

Registered business address. Same shape as individual address.

array

Business registration documents.

Show Identification fields

string

required

L = business registration number.

string

required

Registration number.

string

required

ISO alpha-2 country code of the registering authority.

object

Phone contact details. Same shape as individual phone.

object

Arbitrary key-value metadata. Keys and values must be strings.

Request

curl -X POST https://api.nuvion.dev/counterparties \
  -H "Authorization: Bearer $NUVION_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "individual",
    "entity_id": "01KBCFY3VB1XT0MC8VMZXME6RS",
    "profile": {
      "first_name": "Jane",
      "last_name": "Smith",
      "relationship": "vendor",
      "email": "jane.smith@example.com",
      "address": {
        "line1": "123 Main St",
        "city": "Austin",
        "state_or_province": "TX",
        "postal_code": "78701",
        "country": "US"
      }
    }
  }'

curl -X POST https://api.nuvion.dev/counterparties \
  -H "Authorization: Bearer $NUVION_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "business",
    "entity_id": "01KBCFY3VB1XT0MC8VMZXME6RS",
    "profile": {
      "legal_name": "Acme Corp Ltd",
      "relationship": "supplier",
      "email": "accounts@acmecorp.com",
      "registered_address": {
        "line1": "456 Business Ave",
        "city": "New York",
        "state_or_province": "NY",
        "postal_code": "10001",
        "country": "US"
      }
    }
  }'

Response

Returns the created Counterparty object.

Errors

Code	Description
`422`	Validation error — a required field is missing or a field value is invalid.
`422`	A counterparty with these details already exists for this entity.
`409`	The specified `entity_id` was not found.

List counterparties

GET /counterparties Returns a paginated list of counterparties.

Query parameters

string

Filter by entity. Required when authenticating with an API key.

string

Filter by counterparty type. individual or business.

string

Filter by status. active or inactive.

integer

Number of results to return. Between 1 and 100. Defaults to 20.

string

Pagination cursor returned in the previous response’s meta.pagination.next_cursor.

Request

curl "https://api.nuvion.dev/counterparties?entity_id=01KBCFY3VB1XT0MC8VMZXME6RS&status=active" \
  -H "Authorization: Bearer $NUVION_API_KEY"

Response

{
  "data": [
    {
      "id": "01KM37EZ0AYCVDXJ3WDHXPPSZ9",
      "entity_id": "01KBCFY3VB1XT0MC8VMZXME6RS",
      "type": "individual",
      "nickname": "Jane Smith",
      "status": "active",
      "profile": {
        "first_name": "Jane",
        "last_name": "Smith",
        "relationship": "vendor",
        "email": "jane.smith@example.com",
        "address": {
          "line1": "123 Main St",
          "city": "Austin",
          "state_or_province": "TX",
          "postal_code": "78701",
          "country": "US"
        }
      },
      "meta": {},
      "created": 1735725600000,
      "updated": 1735725600000
    }
  ],
  "meta": {
    "pagination": {
      "has_more": false,
      "next_cursor": null
    }
  }
}

Get a counterparty

GET /counterparties/{counterparty_id} Retrieves a single counterparty by ID.

Path parameters

string

required

The counterparty ID. 26-character ULID.

Query parameters

string

Required when authenticating with an API key.

Request

curl "https://api.nuvion.dev/counterparties/01KM37EZ0AYCVDXJ3WDHXPPSZ9" \
  -H "Authorization: Bearer $NUVION_API_KEY"

Response

Returns the Counterparty object.

Update a counterparty

PATCH /counterparties/{counterparty_id} Partially updates a counterparty. Only the fields you provide are changed — omitted fields remain unchanged.

Path parameters

string

required

The counterparty ID. 26-character ULID.

Request parameters

string

Required when authenticating with an API key.

string

Updated display label.

object

Any subset of profile fields for the counterparty’s type. Only provided fields are updated.

Request

curl -X PATCH https://api.nuvion.dev/counterparties/01KM37EZ0AYCVDXJ3WDHXPPSZ9 \
  -H "Authorization: Bearer $NUVION_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entity_id": "01KBCFY3VB1XT0MC8VMZXME6RS",
    "profile": {
      "email": "jane.updated@example.com"
    }
  }'

Response

Returns the updated Counterparty object.

List Counterparty Payment Details

To get the list of payment details associated with a counterparty, use the GET /counterparties/{counterparty_id}/payment-details endpoint.

curl -X GET https://api.nuvion.dev/counterparties/01KM37EZ0AYCVDXJ3WDHXPPSZ9/payment-details \
  -H "Authorization: Bearer $NUVION_API_KEY" \
  -H "Content-Type: application/json" \

Deactivate a counterparty

POST /counterparties/{counterparty_id}/deactivate Sets the counterparty’s status to inactive. Deactivated counterparties cannot receive new transfers.

Deactivation cannot be reversed via the API.

Path parameters

string

required

The counterparty ID. 26-character ULID.

Request parameters

string

Required when authenticating with an API key.

Request

curl -X POST "https://api.nuvion.dev/counterparties/01KM37EZ0AYCVDXJ3WDHXPPSZ9/deactivate" \
  -H "Authorization: Bearer $NUVION_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "entity_id": "01KBCFY3VB1XT0MC8VMZXME6RS" }'

Response

Returns the updated Counterparty object with status: "inactive".

Errors

Code	Description
`409`	The counterparty is already inactive.

​The Counterparty object

​Create a counterparty

​Request parameters

​Request

​Response

​Errors

​List counterparties

​Query parameters

​Request

​Response

​Get a counterparty

​Path parameters

​Query parameters

​Request

​Response

​Update a counterparty

​Path parameters

​Request parameters

​Request

​Response

​List Counterparty Payment Details

​Deactivate a counterparty

​Path parameters

​Request parameters

​Request

​Response

​Errors

The Counterparty object

Create a counterparty

Request parameters

Request

Response

Errors

List counterparties

Query parameters

Request

Response

Get a counterparty

Path parameters

Query parameters

Request

Response

Update a counterparty

Path parameters

Request parameters

Request

Response

List Counterparty Payment Details

Deactivate a counterparty

Path parameters

Request parameters

Request

Response

Errors