Skip to main content
GET
Get counterparty

Authorizations

X-API-Key
string
header
required

Includes an API key in the HTTP headers to authenticate the client.

X-API-Secret
string
header
required

Includes an API secret in the HTTP headers to authenticate the client.

Path Parameters

id
string
required

A valid Counterparty ID

Pattern: ^cp_[a-zA-Z0-9]{27}$
Example:

"cp_2ofTA13AD0xBtbEvBl20aEb1hEu"

Response

The retrieved counterparty object

id
string
required

A valid Counterparty ID

Pattern: ^cp_[a-zA-Z0-9]{27}$
Example:

"cp_2ofTA13AD0xBtbEvBl20aEb1hEu"

type
enum<string>
required
Available options:
individual
firstName
string
required
lastName
string
required
nationality
string
required

ISO 3166-1 alpha-3 country code

Example:

"USA"

address
object
required
paymentMethods
object[]
required
Example:
documents
object[]
required
status
enum<string>
required
Available options:
active,
compliance_rejected,
in_compliance_review,
deleted
messages
object[]
required
createdAt
string
required
updatedAt
string
required
customerId
string

A valid Customer ID

Pattern: ^cus_[a-zA-Z0-9]{27}$
Example:

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

middleName
string
birthDate
string
email
string
phone
string
identificationType
enum<string>
Available options:
tin,
nit,
cc,
ce,
passport,
cpf,
cnpj,
rfc,
curp,
cuit,
cuil
identificationNumber
string