GuidesRecipesAPI ReferenceChangelog
API Reference

Create Counterparty

post
https://bank.sandbox.cybrid.app/api/counterparties

Creates a counterparty.

Counterparty Type

Counterparty resources are an abstraction for real world individuals and businesses that are not directly on the Cybrid Platform.

State

StateDescription
storingThe Platform is storing the counterparty details in our private store
unverifiedThe Platform has not yet verified the counterparty's identity
verifiedThe Platform has verified the counterparty's identity
rejectedThe Platform was not able to successfully verify the counterparty's identity

Required scope: counterparties:execute

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The counterparty's type.

Allowed:
string | null

The owning customer's identifier.

address
object
required

The address of the counterparty.

name
object | null

The name of the counterparty. Required when type is business or type is individual.

aliases
array of objects | null

The aliases of the counterparty. Optional when type is business.

aliases
date | null

The counterparty's date of birth. Optional when type is individual.

string | null

The counterparty's email address.

identification_numbers
array of objects | null

The counterparty's identification numbers.

identification_numbers
string
enum
required

The source of the identification number.

string
required

The ISO 3166 country 2-Alpha country code of the identification number issuer.

string
required

The identification number.

labels
array of strings | null

The labels associated with the counterparty.

labels
Responses

Updated 6 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago