AEaero
User Management

user

Changed on

Create a user associated with the authorized merchant.

When creating a user, a userId is returned. This userId is required for referencing the user within the AeroPay system.

<details> <summary><strong>Error Glossary</strong> (click to expand)</summary>
CodeHTTP StatusMessage
AP006401Client not authorized for this scope
AP101401No authenticated user
AP102200Unable to create user
AP105200Phone number missing area code
AP106200Improperly formatted phone number
AP115200Unsupported phone type
AP118200Name cannot contain numbers or special characters
AP119200Unsupported country code - US numbers only
AP700400Missing or invalid required parameter
</details>
post/v2/user

Request

Headers

Content-Typestring required
authorizationstring required

A merchant scoped token.

Request body

firstNamestring required

First name of user being created

lastNamestring required

Last name of user being created

phoneNumberstring required

Phone number of user in international format (+11234567890). Landlines, VOIPs, or prepaid numbers are invalid.

emailstring required

Email of user being created

Example request

{
  "firstName": "Stephanie",
  "lastName": "Jones",
  "phoneNumber": "+11234567890",
  "email": "stephjones@aeropay.com"
}

Response

Success or Validation Failure (Unified 200)

OR

Example response

{
  "user": {
    "id": "2ac82269-9315-4bb6-8a19-f37e20d50238",
    "firstName": "JohnNew",
    "lastName": "DoeNew",
    "type": "consumer",
    "email": "test-1754932665@aeropay.com",
    "phoneNumber": "+11754932665",
    "createdDate": "2025-02-27T12:59:32+00:00",
    "userStatus": "Active"
  },
  "mfaType": "sms"
}

Changes

  • e7a372a209e8Revision changes
    • info

      added the optional property / to the response with the status