List customers

List customers

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

{
  "data": [],
  "links": {
    "first": "/customers",
    "next": null,
    "last": null,
    "prev": null
  }
}

GET

customers

List customers

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

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

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

Response

A list of customers

Service response for listing customers.

data

object[]

required

Show child attributes

data.id

string

required

data.type

string

required

data.businessLegalName

string

required

data.businessTradeName

string

required

data.industry

string

required

data.identifications

object[]

required

Show child attributes

data.identifications.identificationType

string

required

data.identifications.identificationNumber

string

required

data.identifications.id

string

data.registeredDate

string

required

data.registeredAddress

object

required

Show child attributes

data.registeredAddress.streetLine1

string

required

data.registeredAddress.city

string

required

data.registeredAddress.state

string

required

data.registeredAddress.country

string

required

data.registeredAddress.streetLine2

string

data.registeredAddress.postalCode

string

data.operatingAddress

object

required

Show child attributes

data.operatingAddress.streetLine1

string

required

data.operatingAddress.city

string

required

data.operatingAddress.state

string

required

data.operatingAddress.country

string

required

data.operatingAddress.streetLine2

string

data.operatingAddress.postalCode

string

data.paymentMethods

object[]

required

Option 1
Option 2

Show child attributes

data.paymentMethods.id

string

required

data.paymentMethods.type

enum<string>

required

Available options:

bank

data.paymentMethods.bankName

string

required

data.paymentMethods.accountOwnerName

string

required

data.paymentMethods.status

string

required

data.paymentMethods.clientId

string

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.currency

unknown

data.paymentMethods.accountType

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

data.paymentMethods.rail

string[]

data.paymentMethods.ownerType

string

data.paymentMethods.ownerId

string

data.email

string

data.phone

string

data.website

string

data.isFinancialInstitution

boolean

data.documents

null[]

data.createdAt

unknown

data.updatedAt

unknown

data.status

string

links

object

required

Show child attributes

links.first

string

required

links.next

string | null

required

links.last

string | null

required

links.prev

string | null

required

Delete counterparty payment methods Create a customer

⌘I

Accounts

Documents

Counterparties

Customers

Quotes

Transactions

Webhooks

Authorizations

Query Parameters

Response