AIRA

AIRA API Documentation

The AIRA API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the AIRA API in test mode, which doesn't affect your live data. The API key you use to authenticate the request determines whether the request is live mode or test mode.

Authentication

The AIRA API uses API keys to authenticate requests. You can view and manage your API keys in the AIRA Dashboard.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authentication to the API is performed via HTTP Bearer Auth. Provide your API key as the bearer token value:

Authorization: Bearer YOUR_API_KEY

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Base URL

All API requests should be made to the following base URL:

https://api.aira.ai/v1

Errors

AIRA uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, authentication failed, etc.). Codes in the 5xx range indicate an error with AIRA's servers.

200Everything worked as expected.
400Bad Request – The request was unacceptable, often due to missing a required parameter.
401Unauthorized – No valid API key provided.
404Not Found – The requested resource doesn't exist.
500Server Error – Something went wrong on AIRA's end.

Quick Start

Get started with the AIRA API in minutes:

  1. Obtain your API key – Contact our sales team to get access to the AIRA API and receive your API credentials.
  2. Make your first request – Try the API status endpoint to verify your connection:
    curl https://api.aira.ai/v1/status \
 -H "Authorization: Bearer YOUR_API_KEY"
  3. Create an account holder – Start by creating an account holder to issue cards to.
  4. Issue a card – Create virtual or physical cards for your account holders.
  5. Test with simulations – Use the simulation endpoints to test authorization flows without real transactions.

Need Help?

If you have questions or need assistance integrating with the AIRA API, our team is here to help.