Skip to navigation
Card APICompanies

Onboard a company

View as Markdown

Onboards a new company and links it to your partner account. Provisioning (KYB profile, spending account) continues asynchronously; watch the company.onboarding_status_changed webhook for progress. Address lines are limited to 30 characters.

Authentication

X-API-Keystring
Your partner API key.

Request

This endpoint expects an object.
namestringRequired<=255 characters
countryCodestringRequired=2 characters
directorNamestringRequired
directorEmailstringRequiredformat: "email"
directorPhonestringRequired
addressLine1stringRequired<=30 characters
citystringRequired
statestringRequired
postalCodestringRequired<=20 characters
addressLine2stringOptional<=30 characters
productslist of enumsOptional
Products to onboard the company onto.
Allowed values:

Response

Company created
companyobjectOptional

Errors

422
Unprocessable Entity Error