Counterparties

Create counterparty

Changed on

Creates a counterparty owned by the merchant.

post/v1/counterparties

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/counterparties
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring required

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Request body

namestring

Name of the counterparty.

date_of_birthstring date

Date of birth in YYYY-MM-DD format.

phonestring

Phone number of the counterparty. Stored for operational contact only; it is not sent with payments.

emailstring email

Email address of the counterparty. Stored for operational contact only; it is not sent with payments.

legal_idstring

National tax or identity number of the counterparty, as issued in its country: CPF or CNPJ in Brazil, Cédula or NIT in Colombia, CUIL or CUIT in Argentina, DNI or RUC in Peru, RUT in Chile. Free text, up to 127 characters.

entity_type'business' | 'individual' | 'non_profit' | 'sole_proprietor'

Classification of the counterparty. Defaults to business.

is_self_ownedboolean

Whether the counterparty is self-owned. false if the counterparty is not owned by you, true if it is.

metadataobject nullable

Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.

Example request

{
  "name": "Acme Sandbox Ltd.",
  "physical_address": {
    "line_1": "548 Market St",
    "line_2": "Apartment 4B",
    "city": "San Francisco",
    "postal_code": "94103",
    "state": "CA",
    "country_code": "DE"
  },
  "financial_address": {
    "type": "aba",
    "routing_number": "110000000",
    "account_number": "000123456789",
    "account_holder_name": "Acme Sandbox Ltd.",
    "account_type": "checking"
  },
  "date_of_birth": "1990-01-15",
  "phone": "+55 11 91234 5678",
  "email": "finance@example.com",
  "legal_id": "12.345.678/0001-95",
  "metadata": {
    "invoice_id": "INV-2026-0042"
  }
}

Response

The created counterparty

status'pending' | 'active' | 'rejected' required

Counterparty lifecycle status. Blocking is separate.

idstring uuid required

Unique identifier of the counterparty.

type'counterparty' required

Resource type discriminator.

namestring nullable required

Name of the counterparty, or null if not recorded.

entity_type'business' | 'individual' | 'non_profit' | 'sole_proprietor' required

Classification of the counterparty.

date_of_birthstring date nullable required

Date of birth in YYYY-MM-DD format, or null if not recorded.

phonestring nullable required

Phone number of the counterparty, or null if not recorded.

emailstring nullable required

Email address of the counterparty, or null if not recorded.

legal_idstring nullable required

National tax or identity number of the counterparty, or null if not recorded.

is_self_ownedboolean required

Whether the counterparty is self-owned. false if the counterparty is not owned by you, true if it is.

blockedboolean required

Whether payments to or from this counterparty are currently blocked.

metadataobject required

Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.

Example response

{
  "status": "active",
  "name": "Acme Sandbox Ltd.",
  "entity_type": "business",
  "physical_address": {
    "line_1": "548 Market St",
    "line_2": "Apartment 4B",
    "city": "San Francisco",
    "postal_code": "94103",
    "state": "CA",
    "country_code": "DE"
  },
  "financial_address": {
    "type": "aba",
    "routing_number": "110000000",
    "account_number": "000123456789",
    "account_holder_name": "Acme Sandbox Ltd.",
    "account_type": "checking"
  },
  "date_of_birth": "1990-01-15",
  "phone": "+55 11 91234 5678",
  "email": "finance@example.com",
  "legal_id": "12.345.678/0001-95",
  "metadata": {
    "invoice_id": "INV-2026-0042"
  }
}

Changes

  • 618f161fdba7Revision changes
    • warning

      changed the pattern of the request property from ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ to ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

  • f7ded6c181abRevision changes
    • info

      endpoint added