Skip to main content
POST
Create counterparty

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Headers

Idempotency-Key
string
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.

Body

application/json

Counterparty parameters

financial_address
IBAN · object
required

Financial address of the counterparty.

Example:
name
string

Name of the counterparty.

physical_address
object

Physical address of the counterparty.

date_of_birth
string<date>

Date of birth in YYYY-MM-DD format.

entity_type
enum<string>

Whether the counterparty is a business or an individual. Defaults to business.

Available options:
business,
individual
is_self_owned
boolean
default:false

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

metadata
object | null

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

200 - application/json

The created counterparty

id
string<uuid>
required

Unique identifier of the counterparty.

type
enum<string>
required

Resource type discriminator.

Available options:
counterparty
name
string | null
required

Name of the counterparty, or null if not recorded.

entity_type
enum<string>
required

Whether the counterparty is a business or an individual.

Available options:
business,
individual
physical_address
object | null
required

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

financial_address
IBAN · object
required

Financial address of the counterparty.

Example:
date_of_birth
string<date> | null
required

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

is_self_owned
boolean
required

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

blocked
boolean
required

Whether payments to or from this counterparty are currently blocked.

metadata
object
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: