Skip to main content
POST
Create subsidiary

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 Customer Request

The legal name of the business

Minimum string length: 1
country
string
required

The country where the business is located

Required string length: 3
onboardingFlow
enum<string>
required
Available options:
direct
businessInformation
object
required

Basic business information required for customer creation.

Conditional Field Requirements:

  • businessTradeName: Required when hasDBA is true
  • describeIndustry: Required when industry is Other
  • regulatorName, regulatoryLicenseNumber, hasIndependentAmlAuditReport: Required when isFinancialInstitution is true
  • regulatoryAuthorityOther: Required when regulatorName is Other
  • flowOfFundsDescription: Required when isFinancialInstitution is false
  • stockExchange and tickerSymbol: Required when isStockExchangeListed is true
  • stockExchangeOther: Required when stockExchange is Other
  • accountPurposeDescription: Required when accountPurpose is Payments for Goods or Services
  • highRiskIndustryDetails: Required when highRiskIndustry is not None
  • nestedFlowDescription: Required when hasNestedFlows is true
  • blockchainWallets: Required when usesBlockChainWallets is true
  • revenueCoverage: Required when isGeneratingRevenues is true
  • revenueCoverageExplanation: Required when revenueCoverage is Less than 25% of expenses
  • runwayDurationExplanation: Required when runwayDurationMonths is less than 12 months
  • deniedUsBankAccount: Required when hasUsBankAccount is false

See individual field descriptions for more details.

Example:
orgId
string
isSubsidiary
boolean
kybSetupBy
enum<string>
Available options:
client

Response

The created client (subsidiary)

Subsidiary creation response. Response shape depends on the onboardingFlow used in the request.

onboardingFlow
enum<string>
required
Available options:
kyb_link
Minimum string length: 1
id
string
required

A valid Client ID

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

"client_2ofTA13AD0xBtbEvBl20aEb1hEu"

Minimum string length: 1