AIairtm
Account Status

Get account status

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

getaccount-status

Request

Query parameters

emailstring required

Email associated with the account to check.

Example:test-email@gmail.com

Response

OK

clientIdstring

Unique Airtm identifier of the user associated with the email.

statusstring

The user's account status (active or inactive).

isPrimaryboolean

Indicates if the queried email corresponds to the user's primary email

country_IDstring

The ISO alpha-3 code for the country where the user's ID was issued

is_verifiedboolean

Indicates whether the user is verified (true or false)

fullNamestring

The user's full name as registered in Airtm

Example response

{
  "clientId": "4dc6bf66-fc9d-4873-a1f2-9d2c8c9c5b9d",
  "status": "active",
  "country_ID": "ARG",
  "fullName": "Luciano PM"
}

Changes

No recorded changes to this operation across all 1 revision of this API.