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

List companies

||View as Markdown|

GET

/v1/companies

GET

/v1/companies

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

200Retrieved

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

The companies linked to your partner account.

Authentication

X-API-Keystring

Your partner API key.

Response

OK

companieslist of objectsOptional

Was this page helpful?

Get card sensitive-details token

Onboard a company