Identity

GET /2023-03-01/xhr/identity

List information of the user for the respective account

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • name string Required

      The name of the individual for the respective account, if known

    • email string Required

      The email of the individual for the respective account, if known

    • phone_number string | null Required

      The phone number of the individual for the respective account, if known. Nullable for tokens created prior to 2023-03-05

  • 401 application/json

    Authentication Error

    Hide response attributes Show response attributes object
    • error string Required

      The type of error

      Value is authentication_error.

    • message string Required

      A descriptive description of the error

    • code string Required

      Values are incorrect_username_or_password, incorrect_mfa_or_otp, reauthentication_required // cookies are now expired, additional_account_setup_required // password reset, etc, captcha_challenge // amazon type1 captcha challenge (currently unsovable), no_valid_accounts // not used currently but reserved for future use, or insufficient_permission // not enough privileges (ie not an admin, or not enough provider scopes on a provider api token for the Affix scopes requested).

  • 429 application/json

    Rate Limited / Too Many Requests

    Hide headers attribute Show headers attribute
    • Retry your call after the specified amount of seconds

    Hide response attribute Show response attribute object
  • 500 application/json

    Server Error

    Hide response attribute Show response attribute object
GET /2023-03-01/xhr/identity
curl \
 -X GET https://api.affixapi.com/2023-03-01/xhr/identity \
 -H "Authorization: $API_KEY"
Response examples (200)
{
  "name": "Laurine Barton",
  "email": "[email protected]",
  "phone_number": 14150000000
}
Response examples (401)
{
  "error": "authentication_error",
  "message": "Your password is incorrect",
  "code": "incorrect_username_or_password"
}
Response examples (429)
# Headers
Retry-After: 42

# Payload
{
  "message": "string"
}
Response examples (500)
{
  "message": "string"
}