Airtm Users API
# UsersThe 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.## OverviewUser 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 PayoutsVerifying 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 RatesPre-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 ExperienceUser 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
Airtm Users API is one of 24 APIs that Airtm publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 1 operation across 1 path, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.155.0.
Requests are made against 2 base URLs: https://api.enterprise.airtm.com/v2, https://api.stg.enterprise.airtm.com/v2.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Airtm Users API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Users The Users API provides essential user management capabilities for your Airtm Enterprise integration. This endpoint allows you to verify recipient information, check account…
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed is User (7 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Airtm 12
Other APIs Airtm publishes across the network.
This is an independent, third-party profile of Airtm Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.