Counterparties

Create a counterparty

post/v1/counterparties

Headers

X-API-Keystring

API key

Request body

namestring required

Counterparty legal name

beneficiaryType'INDIVIDUAL' | 'BUSINESS' required

Entity type (individual or business)

Example request

{
  "name": "Jane Doe",
  "beneficiaryType": "BUSINESS",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94102",
    "country": "US",
    "transliterated": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Apt 4B",
      "city": "Beijing",
      "state": "Hebei"
    }
  }
}

Response

Counterparty created successfully

idstring required

Counterparty ID

namestring required

Counterparty legal name

beneficiaryType'INDIVIDUAL' | 'BUSINESS' required

Entity type (individual or business)

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Example response

{
  "id": "cp_abc123",
  "name": "Jane Doe",
  "beneficiaryType": "INDIVIDUAL",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94102",
    "country": "US",
    "transliterated": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Apt 4B",
      "city": "Beijing",
      "state": "Hebei"
    }
  }
}

Changes

No recorded changes to this endpoint across all 2 revisions of this API.