Skip to main content
GET
Retrieve counterparty

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Path Parameters

id
string<uuid>
required

Unique identifier of the counterparty.

Response

200 - application/json

The counterparty resource

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.

Example:

"Acme Sandbox Ltd."

entity_type
enum<string>
required

Whether the counterparty is a business or an individual.

Available options:
business,
individual
Example:

"business"

physical_address
object | null
required

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

financial_address
ABA · 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.

Example:

"1990-01-15"

phone
string | null
required

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

Example:

"+55 11 91234 5678"

email
string | null
required

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

Example:

"finance@example.com"

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

Example:

"12.345.678/0001-95"

is_self_owned
boolean
required

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

Example:

false

blocked
boolean
required

Whether payments to or from this counterparty are currently blocked.

Example:

false

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: