For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Home API Reference

Skip to navigation

Card API Companies

Get a company

||View as Markdown|

GET

/v1/companies/:companyId

GET

/v1/companies/:companyId

curl https://public-api.alphax.asia/v1/companies/companyId \
     -H "X-API-Key: <apiKey>"

{
  "company": {
    "id": "01KZ2WJKWVFPCVAB6MY106QRZV",
    "name": "Acme Ltd",
    "countryCode": "HK",
    "status": "ACTIVE",
    "createdAt": "2024-01-15T09:30:00Z"
  }
}

Authentication

X-API-Keystring

Your partner API key.

Path parameters

companyIdstringRequired

Response

OK

companyobjectOptional

Errors

403

Forbidden Error

Was this page helpful?

Onboard a company

Submit a KYB profile

Home API Reference

Overview
AlphaX API
Card API
Swap API