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

Home API Reference

Overview
AlphaX API
Card API
Swap API

Swap API Companies

Get a company

||View as Markdown|

GET

/v1/companies/:companyId

GET

/v1/companies/:companyId

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

1 {
2   "company": {
3     "id": "01KZ2WJKWVFPCVAB6MY106QRZV",
4     "name": "Acme Ltd",
5     "countryCode": "HK",
6     "status": "Pending",
7     "createdAt": "2024-01-15T09:30:00Z",
8     "swap": {
9       "kycUrl": "https://public-api.alphax.com/kyc/9f2c1d84e7b6a5309c8f",
10       "kycStatus": "awaiting_ubo",
11       "tosUrl": "https://public-api.alphax.com/kyc/9f2c1d84e7b6a5309c8f/terms",
12       "tosAccepted": false
13     }
14   }
15 }

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

Get the verification link