Create Counterparty

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

Log in to see full request history
Body Params
string
required

The counterparty's type.

string | null

The owning customer's identifier.

object
required

The address of the counterparty.

object | null

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

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.

array of strings | null

The labels associated with the counterparty.

labels
Responses

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