Skip to main content
POST
/
counterparties
Create a counterparty
curl --request POST \
  --url https://api.conduit.financial/counterparties \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>' \
  --data '
{
  "type": "individual",
  "firstName": "John",
  "middleName": "Snow",
  "lastName": "Smith",
  "birthDate": "2020-03-15T00:00:00.000Z",
  "nationality": "US",
  "email": "[email protected]",
  "phone": "+1-555-123-4567",
  "customerId": "cus_2yxYsr0jkTQSDCjwe32YAZzL3Hp",
  "identificationType": "passport",
  "identificationNumber": "123",
  "address": {
    "streetLine1": "21 Jump Street",
    "streetLine2": "Unit 708",
    "city": "Boston",
    "state": "MA",
    "postalCode": "02111",
    "country": "USA"
  },
  "paymentMethods": [
    {
      "type": "bank",
      "rail": [
        "ted",
        "pix"
      ],
      "bankName": "First National Bank",
      "accountType": "checking",
      "accountOwnerName": "Global Tech Solutions",
      "accountNumber": "123456789",
      "routingNumber": "123",
      "swiftCode": "FNBOUS33",
      "branchCode": "1234",
      "bankCode": "123",
      "currency": "USD",
      "address": {
        "streetLine1": "21 Jump Street",
        "streetLine2": "Unit 708",
        "city": "Boston",
        "state": "MA",
        "postalCode": "02111",
        "country": "USA"
      }
    },
    {
      "type": "wallet",
      "rail": "ethereum",
      "walletAddress": "0X0000000",
      "walletLabel": "Gus Personal ETH Wallet"
    },
    {
      "type": "wallet",
      "rail": "tron",
      "walletAddress": "T0000000",
      "walletLabel": "Gus Personal Tron Wallet"
    }
  ],
  "documents": [
    {
      "documentId": "doc_1234"
    }
  ]
}
'
{
  "id": "1234",
  "type": "individual",
  "firstName": "John",
  "middleName": "Snow",
  "lastName": "Smith",
  "birthDate": "2020-03-15T00:00:00.000Z",
  "nationality": "US",
  "email": "[email protected]",
  "phone": "+1-555-123-4567",
  "identificationType": "curp",
  "identificationNumber": "123",
  "address": {
    "streetLine1": "21 Jump Street",
    "streetLine2": "Unit 708",
    "city": "Boston",
    "state": "MA",
    "postalCode": "02111",
    "country": "USA"
  },
  "paymentMethods": [
    {
      "id": "1234",
      "type": "bank",
      "rail": [
        "ted",
        "pix"
      ],
      "bankName": "First National Bank",
      "accountType": "checking",
      "accountOwnerName": "Global Tech Solutions",
      "accountNumber": "123456789",
      "routingNumber": "123",
      "swiftCode": "FNBOUS33",
      "branchCode": "1234",
      "bankCode": "123",
      "currency": "USD",
      "address": {
        "streetLine1": "21 Jump Street",
        "streetLine2": "Unit 708",
        "city": "Boston",
        "state": "MA",
        "postalCode": "02111",
        "country": "USA"
      }
    },
    {
      "id": "bank_1234",
      "type": "wallet",
      "rail": "ethereum",
      "walletAddress": "0X0000000",
      "walletLabel": "Gus Personal ETH Wallet"
    },
    {
      "id": "wlt_1234",
      "type": "wallet",
      "rail": "tron",
      "walletAddress": "T0000000",
      "walletLabel": "Gus Personal Tron Wallet"
    }
  ],
  "documents": [
    {
      "documentId": "doc_1234",
      "documentPurpose": "recurring_payment",
      "documentType": "invoice",
      "documentName": "invoice.png",
      "uploadedAt": "2023-10-15T09:30:00.000Z"
    }
  ],
  "messages": [],
  "status": "active",
  "createdAt": "2024-01-01T10:00:00.000Z",
  "updatedAt": "2024-02-15T15:45:00.000Z"
}

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.

Body

application/json
  • Create Individual Counterparty Request
  • Create Business Counterparty Request
​
type
enum<string>
required
Available options:
individual
​
firstName
string
required
​
lastName
string
required
​
birthDate
string
required

The date of birth in YYYY-MM-DD format.

​
address
object
required
​
paymentMethods
object[]
required
Minimum array length: 1
  • Option 1
  • Option 2
Example:
{
  "type": "bank",
  "rail": ["fedwire"],
  "bankName": "Bank of America",
  "accountOwnerName": "John Doe",
  "accountNumber": "1234567890",
  "currency": "USD",
  "routingNumber": "1234567890",
  "address": {
    "streetLine1": "123 Main St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "USA"
  }
}
​
middleName
string
​
nationality
string

ISO 3166-1 alpha-3 country code

Example:

"USA"

​
email
string<email>
​
phone
string
​
customerId
string

A valid Customer ID

Example:

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

​
identificationType
enum<string>
Available options:
tin,
nit,
cc,
ce,
passport,
cpf,
cnpj,
rfc,
curp,
cuit,
cuil
​
identificationNumber
string
​
documents
object[]

Response

The created object

  • Option 1
  • Option 2
​
id
string
required

A valid Counterparty ID

Example:

"cp_2ofTA13AD0xBtbEvBl20aEb1hEu"

​
type
enum<string>
required
Available options:
individual
​
firstName
string
required
​
lastName
string
required
​
nationality
string
required
​
address
object
required
​
paymentMethods
object[]
required
  • Option 1
  • Option 2
Example:
{
  "type": "bank",
  "rail": ["fedwire"],
  "bankName": "Bank of America",
  "accountOwnerName": "John Doe",
  "accountNumber": "1234567890",
  "currency": "USD",
  "routingNumber": "1234567890",
  "address": {
    "streetLine1": "123 Main St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "USA"
  },
  "id": "bank_1234",
  "sortCode": "12-34-56"
}
​
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

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