Skip to main content
GET
/
customers
/
{id}
Get customer
curl --request GET \
  --url https://api.conduit.financial/customers/{id} \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>'
{
  "id": "cus_2ofTA13AD0xBtbEvBl20aEb1hEu",
  "type": "business",
  "businessLegalName": "Acme Corporation",
  "businessTradeName": "Acme Corp",
  "industry": "Technology",
  "email": "contact@acmecorp.com",
  "entityType": "Bank",
  "phone": "+1234567890",
  "website": "https://acmecorp.com",
  "identifications": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "identificationType": "TIN",
      "identificationNumber": "12-3456789"
    }
  ],
  "registeredDate": "2020-01-01",
  "registeredAddress": {
    "streetLine1": "123 Business St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "USA"
  },
  "operatingAddress": {
    "streetLine1": "456 Office Ave",
    "city": "New York",
    "state": "NY",
    "postalCode": "10002",
    "country": "USA"
  },
  "status": "active",
  "paymentMethods": [],
  "isFinancialInstitution": false,
  "eddFormId": "c7ae9c5e-3db8-467b-b0c4-0ff00732f9ae"
}

Documentation Index

Fetch the complete documentation index at: https://docs.conduit.financial/llms.txt

Use this file to discover all available pages before exploring further.

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.

Path Parameters

​
id
string
required

A valid Customer ID

Pattern: ^cus_[a-zA-Z0-9]{27}$
Example:

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

Response

The retrieved customer object

Complete customer schema

​
type
string
required
Minimum string length: 1
​
businessLegalName
string
required
Minimum string length: 1
​
businessTradeName
string
required
Minimum string length: 1
​
industry
string
required
Minimum string length: 1
​
identifications
object[]
required
Minimum array length: 1
​
registeredDate
string
required
Minimum string length: 1
​
registeredAddress
object
required

Address information

Example:
{
  "streetLine1": "123 Main St",
  "streetLine2": "Suite 100",
  "city": "New York",
  "state": "NY",
  "postalCode": "10001",
  "country": "USA"
}
​
operatingAddress
object
required

Address information

Example:
{
  "streetLine1": "123 Main St",
  "streetLine2": "Suite 100",
  "city": "New York",
  "state": "NY",
  "postalCode": "10001",
  "country": "USA"
}
​
paymentMethods
(Bank Payment Method Response · object | object)[]
required
Example:
{
  "id": "bank_1234",
  "type": "bank",
  "rail": ["fedwire"],
  "bankName": "Bank of America",
  "accountOwnerName": "John Doe",
  "accountNumber": "1234567890",
  "currency": "USD",
  "routingNumber": "1234567890",
  "status": "enabled",
  "address": {
    "streetLine1": "123 Main St",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "USA"
  },
  "entity": {
    "id": "cp_1234567890123456789012345",
    "name": "Mark Davis",
    "entityType": "individual",
    "complianceEntityType": "counterparty"
  }
}
​
id
string

A valid Customer ID

Pattern: ^cus_[a-zA-Z0-9]{27}$
Example:

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

​
email
string<email>
​
phone
string
​
entityType
enum<string>

The type of entity

Available options:
Bank,
Insurance Company,
Securities Broker or Dealer,
Investment Company or other Passive Investment Vehicle,
Trust Company,
Hedge Fund,
Other
Example:

"Bank"

​
website
string<uri>
​
documents
object[]
​
createdAt
string
​
updatedAt
string
​
status
enum<string>
Available options:
active,
in_compliance_review,
compliance_rejected,
created,
kyb_in_progress,
kyb_expired,
kyb_missing_information,
account_onboarding_pending,
failed_to_create
​
tags
string[] | null
​
isFinancialInstitution
boolean
​
controlPersons
object[]
​
eddFormId
string