List counterparties

curl --request GET \
  --url https://api.conduit.financial/counterparties \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>'

{
  "data": [
    {
      "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"
    }
  ],
  "links": {
    "first": "/counterparties",
    "next": null
  }
}

GET

counterparties

List counterparties

curl --request GET \
  --url https://api.conduit.financial/counterparties \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>'

{
  "data": [
    {
      "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"
    }
  ],
  "links": {
    "first": "/counterparties",
    "next": null
  }
}

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.

Query Parameters

page[size]

string

default:50

The number of items to return per page.

Example:

"0"

page[after]

string

The cursor to start the page after.

Example:

"cp_2ofTA13AD0xBtbEvBl20aEb1hEu"

Response

A page of listed counterparty objects

data

object[]

required

Option 1
Option 2

Show child attributes

data.id

string

required

A valid Counterparty ID A valid Counterparty ID

Example:

"cp_2ofTA13AD0xBtbEvBl20aEb1hEu"

data.type

enum<string>

required

Available options:

individual

data.firstName

string

required

data.lastName

string

required

data.nationality

string

required

data.address

object

required

Show child attributes

data.address.streetLine1

string

data.address.streetLine2

string

data.address.city

string

data.address.state

string

data.address.postalCode

string

data.address.country

string

ISO 3166-1 alpha-3 country code ISO 3166-1 alpha-3 country code

Example:

"USA"

data.paymentMethods

object[]

required

Option 1
Option 2

Show child attributes

data.paymentMethods.type

enum<string>

required

Available options:

bank

data.paymentMethods.rail

enum<string>[]

required

Maximum array length: 1

Available options:

ach_colombia,

ach,

pix,

swift,

fedwire,

ted,

spei,

sepa,

pse,

rtgs,

ars_bank_transfer,

fps,

chaps

data.paymentMethods.bankName

string

required

data.paymentMethods.accountOwnerName

string

required

data.paymentMethods.currency

enum<string>

required

The asset identifier. A fiat currency code. The asset identifier. A fiat currency code.

Available options:

USD,

MXN,

BRL,

COP,

EUR,

NGN,

ARS,

GBP

data.paymentMethods.id

string

required

A valid Bank Account ID A valid Bank Account ID

Example:

"bank_2ofTA5mz0T91pBmD3tMTeLE7T4X"

data.paymentMethods.accountType

enum<string>

Available options:

savings,

checking,

electronic_deposit

data.paymentMethods.accountNumber

string

data.paymentMethods.iban

string

data.paymentMethods.pixKey

string

data.paymentMethods.routingNumber

string

data.paymentMethods.swiftCode

string

data.paymentMethods.branchCode

string

data.paymentMethods.bankCode

string

data.paymentMethods.sortCode

string

data.paymentMethods.address

object

Show child attributes

data.paymentMethods.address.streetLine1

string

data.paymentMethods.address.streetLine2

string

data.paymentMethods.address.city

string

data.paymentMethods.address.state

string

data.paymentMethods.address.postalCode

string

data.paymentMethods.address.country

string

ISO 3166-1 alpha-3 country code ISO 3166-1 alpha-3 country code

Example:

"USA"

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"
}

data.documents

object[]

required

Show child attributes

data.documents.documentId

string

required

A valid Document ID A valid Document ID

Example:

"doc_2ofTAESrTs4uQ8N3yGBMhGj59jV"

data.documents.documentPurpose

string

required

data.documents.documentType

string

required

data.documents.documentName

string

required

data.documents.uploadedAt

string

data.status

enum<string>

required

Available options:

active,

compliance_rejected,

in_compliance_review,

deleted

data.messages

object[]

required

Show child attributes

data.messages.type

enum<string>

required

Available options:

error,

info

data.messages.message

string

required

data.messages.code

string

required

data.messages.field

string

data.messages.details

data.createdAt

string

required

data.updatedAt

string

required

data.customerId

string

A valid Customer ID A valid Customer ID

Example:

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

data.middleName

string

data.birthDate

string

data.email

string

data.phone

string

data.identificationType

enum<string>

Available options:

tin,

nit,

cc,

ce,

passport,

cpf,

cnpj,

rfc,

curp,

cuit,

cuil

data.identificationNumber

string

Example:

{
  "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"
}

links

object

required

Show child attributes

links.first

string

required

links.next

string | null

required

links.last

string | null

Example:

{ "first": "/counterparties", "next": null }

Upload document Create a counterparty

⌘I

Accounts

Documents

Counterparties

Customers

Quotes

Transactions

Webhooks

List counterparties

Authorizations

Query Parameters

Response