Airtm

Airtm Users API

# Users The Users API provides essential user management capabilities for your Airtm Enterprise integration. This endpoint allows you to verify recipient information, check account status, and ensure successful payout delivery before initiating transactions. ## Overview User verification is a critical step in the payout process that helps prevent failed transactions, reduces processing delays, and improves overall payment success rates. The API provides comprehensive user information including account status, verification level, and eligibility for receiving payments. ## Key Features - **User Verification**: Validate recipient accounts before creating payouts - **Status Checking**: Determine if users can receive payments - **Account Details**: Access user profile information and verification status - **Eligibility Validation**: Confirm compliance and geographic restrictions - **Real-time Data**: Get current user status and account information ## Why Verify Users ### Prevent Failed Payouts Verifying users before creating payouts helps identify potential issues early: - Inactive or suspended accounts - Unverified users who cannot receive payments - Geographic restrictions or compliance issues - Account limitations or restrictions ### Improve Success Rates Pre-verification significantly improves payout success rates by: - Ensuring recipients can actually receive payments - Identifying verification requirements in advance - Confirming account status before reserving funds - Reducing processing delays and failures ### Better User Experience User verification enables better customer service: - Provide clear error messages for invalid recipients - Guide users through account setup requirements - Offer alternative solutions for ineligible recipients - Reduce failed payment frustrations

Documentation GitHub OpenAPI

Operations 1

GET /users/{email} Get user details by email #

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-users-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Airtm Enterprise API V2 Users API
  version: 1.155.0
  description: '# Introduction


    The Airtm Enterprise API enables organizations to send and receive payments globally through a simple REST API.'
  contact:
    name: Airtm Enterprise
    email: enterprise@airtm.com
    url: https://www.airtm.com
servers:
- url: https://api.enterprise.airtm.com/v2
- url: https://api.stg.enterprise.airtm.com/v2
tags:
- name: Users
  description: '# Users


    The Users API provides essential user management capabilities for your Airtm Enterprise integration.'
paths:
  /users/{email}:
    get:
      operationId: GetUserByEmail
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        default:
          description: Error
          content:
            application/json:
              schema:
                properties:
                  code:
                    type: string
                    description: 'Machine-friendly error code


                      See the API error code catalog in the documentation for the endpoint surface you are using.'
                    example: '415096'
                  message:
                    type: string
                    description: Human-readable error message
                    example: Invalid email address
                  data:
                    $ref: '#/components/schemas/Record_string.unknown_'
                    description: Additional data related to the error
                    example:
                      email: invalid@address
                required:
                - code
                - message
                type: object
      description: 'Retrieve the current status of any user''s account by email.


        > [!important]

        > The email parameter should be URL Encoded.'
      summary: Get user details by email
      tags:
      - Users
      security:
      - basicAuth: []
      parameters:
      - description: The email of the user to retrieve
        in: path
        name: email
        required: true
        schema:
          $ref: '#/components/schemas/Email'
components:
  schemas:
    Record_string.unknown_:
      properties: {}
      additionalProperties: {}
      type: object
      description: Construct a type with a set of properties K of type T
    UserStatus:
      description: Whether the user is active or inactive in Airtm
      enum:
      - active
      - inactive
      type: string
      x-enum-varnames:
      - Active
      - Inactive
    User:
      description: A user in Airtm
      properties:
        id:
          $ref: '#/components/schemas/Uuid'
          description: Unique Airtm identifier of the user associated with the email.
        status:
          $ref: '#/components/schemas/UserStatus'
          description: The user's account status.
        primaryEmail:
          type: boolean
          description: 'Indicates if the queried email corresponds to the user''s primary email


            > [!tip]

            > Airtm allows accounts to register secondary emails'
        firstName:
          type: string
          description: The user's first name as registered in Airtm
        lastName:
          type: string
          description: The user's last name as registered in Airtm
        country:
          type: string
          description: The ISO alpha-3 code for the country where the user's ID was issued
        isVerified:
          type: boolean
          description: Indicates whether the user is verified
      required:
      - id
      - status
      - primaryEmail
      - isVerified
      type: object
      additionalProperties: false
    Email:
      type: string
      pattern: ^(.+)@(.+)$
    Uuid:
      type: string
      format: uuid
      pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-tagGroups:
- name: Payout Operations
  tags:
  - Payouts
  - Bulk Payouts
  - Users
- name: Payin Operations
  tags:
  - Payins
- name: Account
  tags:
  - Me
  - Deposits
  - Reports
- name: Direct Withdrawal
  tags:
  - External Bank Account
  - External Crypto Account
  - Withdrawals
- name: Webhooks
  tags:
  - Webhooks