Onboard a company | AlphaX

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.

Response

Company created

companyobjectOptional

Errors

422

Unprocessable Entity Error

$	curl -X POST https://public-api.alphax.com/v1/companies \
>	-H "X-API-Key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Acme Ltd",
>	"countryCode": "HK",
>	"directorName": "Jane Director",
>	"directorEmail": "jane@acme.example",
>	"directorPhone": "+85251234567",
>	"addressLine1": "10 Queen'\''s Road",
>	"city": "Hong Kong",
>	"state": "Hong Kong",
>	"postalCode": "999077"
>	}'

1	{
2	"company": {
3	"id": "01KZ2WJKWVFPCVAB6MY106QRZV",
4	"name": "Acme Ltd",
5	"countryCode": "HK",
6	"status": "ACTIVE",
7	"createdAt": "2024-01-15T09:30:00Z"
8	}
9	}