Airtm Account Status API

## Overview The Account Status endpoint enables your organization to verify recipient account information before initiating payments. This powerful verification tool helps prevent payment failures, reduces transaction costs, and ensures smooth payment processing by validating recipient details and account capabilities in advance. ## What is Account Status Verification? Account Status Verification allows you to check the current status and capabilities of any Airtm user account by providing their email address. This pre-payment verification process helps identify potential issues before processing transactions, improving success rates and reducing operational overhead.

Operations 1

GET account-status Get account status #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/airtm-account-status-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

airtm-account-status-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Airtm Enterprise API V1 Account Status API
  version: 1.0.0
  description: '## Introduction


    Welcome to Airtm''s Enterprise Payments API - a comprehensive solution for programmatic payment processing that enables organizations worldwide to send and receive payments efficiently and securely.'
servers:
- url: https://payments.air-pay.io
- url: https://payments.static-stg.tests.airtm.org
tags:
- name: Account Status
  description: '## Overview


    The Account Status endpoint enables your organization to verify recipient account information before initiating payments.'
paths:
  account-status:
    get:
      security:
      - basicAuth: []
      tags:
      - Account Status
      summary: Get account status
      description: 'Retrieve the current status of any user''s account by providing their

        email in the request headers. The response will return the user''s client

        ID, account status, whether the email corresponds to the primary account

        (Airtm allows up to two secondary emails per account), the country where

        the account is registered, the verification status, and the full name

        registered on the account.


        **The email parameter should be URL Encoded. You can learn more about

        encoding urls here:**

        **https://www.w3schools.com/tags/ref\_urlencode.ASP**'
      operationId: Account Status_account-status/get-account-status
      parameters:
      - name: email
        in: query
        required: true
        schema:
          type: String
          example: test-email@gmail.com
          description: Email associated with the account to check.
          default: ''
        description: Email associated with the account to check.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  clientId:
                    type: string
                    description: 'Unique Airtm identifier of the user associated with the

                      email.

                      '
                    example: 4dc6bf66-fc9d-4873-a1f2-9d2c8c9c5b9d
                  status:
                    type: string
                    description: The user's account status (active or inactive).
                    example: active
                  isPrimary:
                    type: boolean
                    description: 'Indicates if the queried email corresponds to the user''s

                      primary email

                      '
                    example: false
                  country_ID:
                    type: string
                    description: 'The ISO alpha-3 code for the country where the user''s ID

                      was issued

                      '
                    example: ARG
                  is_verified:
                    type: boolean
                    description: Indicates whether the user is verified (true or false)
                    example: false
                  fullName:
                    type: string
                    description: The user's full name as registered in Airtm
                    example: Luciano PM
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic