Onboard a company | AlphaX

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"
}'

{
  "company": {
    "id": "01KZ2WJKWVFPCVAB6MY106QRZV",
    "name": "Acme Ltd",
    "countryCode": "HK",
    "status": "Pending",
    "createdAt": "2024-01-15T09:30:00Z",
    "swap": {
      "kycUrl": "https://public-api.alphax.com/kyc/9f2c1d84e7b6a5309c8f",
      "kycStatus": "awaiting_ubo",
      "tosUrl": "https://public-api.alphax.com/kyc/9f2c1d84e7b6a5309c8f/terms",
      "tosAccepted": false
    }
  }
}

Onboards a new company and links it to your partner account. Send products: ["Swap"] to provision the swap product — the response’s swap block carries the verification link.

products defaults to ["Card"] when omitted, so send it explicitly. You may only request products AlphaX has enabled for you.

Authentication

X-API-Keystring

Your partner API key.

Request

This endpoint expects an object.

namestringRequired<=255 characters

countryCodestringRequired=2 characters

directorNamestringRequired

directorEmailstringRequiredformat: "email"

Where the verification invitation is addressed.

directorPhonestringRequired

addressLine1stringRequired<=30 characters

citystringRequired

statestringRequired

postalCodestringRequired<=20 characters

addressLine2stringOptional<=30 characters

productslist of enumsOptional

Products to provision. Defaults to ["Card"] when omitted.

redirectUristringOptionalformat: "uri"

Where the customer is sent once verification is complete. Defaults to an AlphaX completion page.

Response

Created

companyobjectOptional

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error