1. Quick start
Airalo Partner API documentation
  • OVERVIEW
    • Introduction
    • Attribute descriptions
    • FAQ
    • Developer feedback
    • Quick start
      • Step 1: Request access token
        POST
      • Step 2: Get packages
        GET
      • Step 3: Submit order
        POST
      • Step 4: Get installation instructions
        GET
    • User journeys
      • Purchase journey
      • Top-up journey
    • Guides
      • How to set up a brand for eSIMs Cloud link sharing
      • How to get the eSIMs Cloud sharing link through API
      • How to generate the QR code for an eSIM
      • How to share eSIM installation instructions with users
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Product updates
    • Rate limits
    • Error handling
    • Go live checklist
    • Sandbox mode
    • IP allowlist / whitelisting
    • Endpoints
      • Authenticate
        • Request access token
      • Browse packages
        • Get packages
      • Request refund
        • Request refund
      • Place order
        • Future orders
        • Submit order
        • Submit order async
        • eSIM voucher
      • Install eSIM
        • Get eSIM
        • Get installation instructions
      • Monitor usage
        • Get usage (data, text & voice)
      • Top up eSIM
        • Get top-up package list
        • Submit top-up order
      • Manage orders
        • Get order list
        • Get order
        • Cancel future orders
        • Future Orders
      • Manage eSIMs
        • Update eSIM brand
        • Get eSIMs list
        • Get eSIM package history
      • Compatible devices
        • [Deprecated] Get compatible device list
        • Get compatible device lite list
      • Notifications
        • Airalo webhooks opt-in and flow
        • Webhooks guide
        • Webhook definition
        • Notification: Low data
          • Opt in
          • Get notification details
          • Opt out
        • Notification: Credit limit
          • Opt in
          • Get notification details
          • Opt out
        • Notification: Async orders
          • Opt in
          • Get notification details
          • Opt out
        • Webhook simulator
      • Check balance
        • Get balance
      • Product Information
        • Get Product Information (PIB)
    • Guides
      • Step #1 - Authentication
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Product updates
    • Guides
      • How to install the Airalo Plugin for WooCommerce
      • How to set up prices in WooCommerce
      • How to customize the "My eSIMs" page colors in WooCommerce
      • How to convert prices into your local currency
      • How to finalize your WooCommerce shop setup
      • How to test in sandbox mode
      • How to go live
      • How to customize WooCommerce email templates for eSIM sales
    • Troubleshooting
      • Troubleshooting
  • SHOPIFY APP
    • Introduction
    • Guides
      • How to set up prices in Shopify
      • How to install the Airalo Shopify App
  • Whitelabel eSIM platform
    • Whitelabel eSIM platform integration guide
  1. Quick start

Step 1: Request access token

POST
/v2/token
💡
This endpoint comes with a Rate Limit: You can send up to 3 requests per minute to get your Access token. Access token is valid for 24 hours.
This endpoint lets you obtain an access token, which is necessary for making requests to the Airalo Partners API. Submit your client_id and client_secret to obtain your 24 hour valid token.
It's important to call this endpoint every 24 hours to ensure your token is not expired and avoid disruptions in your integration.
✍
Got a Minute? We'd love to hear your feedback. Share your thoughts →

Request

Header Params

Body Params application/x-www-form-urlencoded

Responses

🟢200Request Access Token (200)
application/json
Bodyapplication/json

🟠422Request Access Token (422)
🟠422Request Access Token (401)
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/v2/token' \
--header 'Accept: application/json' \
--data-urlencode 'client_id=<replace with client id>' \
--data-urlencode 'client_secret=<replace with client secret>' \
--data-urlencode 'grant_type=client_credentials'
Response Response Example
200 - Request Access Token (200)
{
    "data": {
        "token_type": "Bearer",
        "expires_in": 31622400,
        "access_token": "<access token>"
    },
    "meta": {
        "message": "success"
    }
}
Modified at 2026-04-23 08:30:01
Previous
Quick start
Next
Step 2: Get packages
Built with