Skip to main content
POST
/
customers
Create a customer
curl --request POST \
  --url https://api.conduit.financial/customers \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>' \
  --data '{
  "businessLegalName": "Acme Corp",
  "country": "USA",
  "isDirectSetup": true,
  "businessInformation": {
    "businessDescription": "Provider of industrial widgets and services",
    "isSubsidiary": false,
    "entityType": "Bank",
    "isOperating": true,
    "regulatorName": "SEC",
    "businessEntityType": "Corporation",
    "businessLegalName": "Acme Corp",
    "registeredDate": "2024-01-01T00:00:00.000Z",
    "website": "https://acme.com",
    "email": "contact@acme.com",
    "phone": "+1234567890",
    "industry": "Technology",
    "taxIdentificationNumber": "123456789",
    "businessEntityId": "BE001",
    "naicsCode": "NAIS001",
    "isFinancialInstitution": false,
    "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"
    },
    "isStockExchangeListed": false,
    "accountPurpose": "Payroll/ Employee Payouts",
    "higRiskIndustry": "Third-party / OBO payments",
    "hasNestedFlows": true,
    "keyGeographicBusinessCountries": [
      "USA",
      "CAN"
    ],
    "anticipatedTransactionsVolume": 1500,
    "usesBlockChainWallets": false,
    "sourceOfFunds": "Sales Revenue",
    "isGeneratingRevenues": true,
    "hasInstitutionalInvestors": true,
    "runwayDurationMonths": 12,
    "cashOnHandUsd": 500000,
    "hasAdvisor": true
  }
}'
{
  "id": "cus_2ofTA13AD0xBtbEvBl20aEb1hEu",
  "kybLink": "https://example.com/kyb/verify/abc123",
  "kybLinkExpiration": "2024-12-31T23:59:59.000Z",
  "businessLegalName": "Example Business"
}

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
  • Option 1
  • Option 2

Request to create a new customer. If isDirectSetup is true, businessInformation is required

​
businessLegalName
string
required

The legal name of the business

Minimum length: 1
​
country
string
required

The country where the business is located

​
isDirectSetup
boolean
required
​
businessInformation
object
required

Basic business information required for customer creation

Example:
{
  "businessLegalName": "Acme Corp",
  "businessTradeName": "Acme Corp",
  "industry": "Technology",
  "entityType": "Bank",
  "website": "https://acme.com",
  "registeredDate": "2024-01-01T00:00:00.000Z",
  "email": "contact@acme.com",
  "phone": "+1234567890",
  "taxIdentificationNumber": "123456789",
  "taxClassification": "LLC",
  "businessEntityId": "BE001",
  "naicsCode": "NAIS001",
  "isFinancialInstitution": false,
  "registeredAddress": {
    "streetLine1": "123 Business St",
    "streetLine2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "USA"
  },
  "operatingAddress": {
    "streetLine1": "456 Office Ave",
    "city": "New York",
    "state": "NY",
    "postalCode": "10002",
    "country": "USA"
  },
  "mailingAddress": {
    "streetLine1": "789 Mailing Rd",
    "city": "New York",
    "state": "NY",
    "postalCode": "10003",
    "country": "USA"
  },
  "isSubsidiary": false,
  "isOperating": true,
  "entityTaxedAs": "C-Corporation",
  "anticipatedMonthlyVolume": {
    "ach": { "incoming": 100000, "outgoing": 80000 },
    "wire": { "incoming": 50000, "outgoing": 30000 },
    "check": { "incoming": 10000, "outgoing": 5000 }
  },
  "expectedAverageDailyBalance": 250000,
  "regulatorName": "SEC",
  "hasAdvisor": true,
  "businessDescription": "Provider of industrial widgets and services",
  "businessEntityType": "Corporation",
  "isStockExchangeListed": false,
  "accountPurpose": "Payroll/ Employee Payouts",
  "higRiskIndustry": "Third-party / OBO payments",
  "hasNestedFlows": true,
  "keyGeographicBusinessCountries": ["USA", "CAN"],
  "anticipatedTransactionsVolume": 1500,
  "usesBlockChainWallets": false,
  "sourceOfFunds": "Sales Revenue",
  "isGeneratingRevenues": true,
  "hasInstitutionalInvestors": true,
  "runwayDurationMonths": 12,
  "cashOnHandUsd": 500000
}
​
orgId
string
​
isSubsidiary
boolean
​
kybSetupBy
enum<string>
Available options:
client

Response

The created object

Customer creation response

​
kybLink
string
required
Minimum length: 1
​
kybLinkExpiration
string<date-time>
required
​
id
string
required

A valid Customer ID

Example:

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

​
businessLegalName
string
required
Minimum length: 1
⌘I