Overview

You can create a counterparty via the POST /api/counterparties endpoint for individual and business customers. Counterparties can be associated with a bank or a customer.

Individual

View the following POST body in the code block below for creating an individual counterparty associated with a customer, and a bank. To create a counterparty associated with a bank, call with a bank token and do not pass a customer_guid.

{  
  "type": "individual",
  "name": {
    "first": "string",
    "middle": "string",
    "last": "string",
    "full": "string"
  },
  "address": {
    "street": "string",
    "street2": "string",
    "city": "string",
    "subdivision": "string",
    "postal_code": "string",
    "country_code": "string"
  },
  "aliases": [
    {
      "first": "string",
      "middle": "string",
      "last": "string",
      "full": "string"
    }
  ],
  "date_of_birth": "string",
  "labels": [
    "string"
  ],
  "customer_guid": "string"
}

{
  "type": "individual",
  "name": {
    "first": "string",
    "middle": "string",
    "last": "string",
    "full": "string"
  },
  "address": {
    "street": "string",
    "street2": "string",
    "city": "string",
    "subdivision": "string",
    "postal_code": "string",
    "country_code": "string"
  },
  "aliases": [
    {
      "first": "string",
      "middle": "string",
      "last": "string",
      "full": "string"
    }
  ],
  "date_of_birth": "string",
  "labels": [
    "string"
  ]
}

Business

View the following POST body in the code block below for creating a business counterparty associated with a customer, and a bank. To create a counterparty associated with a bank, call with a bank token and do not pass a customer_guid. The date_of_birth is not required for business counterparties.

{  
  "type": "business",
  "name": {
    "first": "string",
    "middle": "string",
    "last": "string",
    "full": "string"
  },
  "address": {
    "street": "string",
    "street2": "string",
    "city": "string",
    "subdivision": "string",
    "postal_code": "string",
    "country_code": "string"
  },
  "aliases": [
    {
      "first": "string",
      "middle": "string",
      "last": "string",
      "full": "string"
    }
  ],
  "date_of_birth": "string",
  "labels": [
    "string"
  ],
  "customer_guid": "string"
}

{
  "type": "business",
  "name": {
    "first": "string",
    "middle": "string",
    "last": "string",
    "full": "string"
  },
  "address": {
    "street": "string",
    "street2": "string",
    "city": "string",
    "subdivision": "string",
    "postal_code": "string",
    "country_code": "string"
  },
  "aliases": [
    {
      "first": "string",
      "middle": "string",
      "last": "string",
      "full": "string"
    }
  ],
  "labels": [
    "string"
  ]
}