How to Get Auth Status – Auth Armor

Endpoint: https://api.authanywhere.autharmor.com/v2/auth/{auth_request_id}

Method: GET

Get auth Info

NOTE: Before you can get Auth Info, you must make an Auth Request. This article covers getting Auth Info after a request has been made. To read about how to make an Auth Request, click here

After you have made your Auth Request, you will instantly get back an auth_request_id that you can use to get the status of your auth request. Simply make a GET request to: https://api.authanywhere.autharmor.com/v2/auth/{auth_request_id}

Request Example:

xxxxxxxxxx

GET https://api.authanywhere.autharmor.com/v2/auth/{auth_request_id} HTTP/1.1
​
Content-Length: [dynmaic]
Authorization: "Bearer [OauthTokenGoesHere]"

This will return the status of the auth request, and the auth response if it is available.

For example, if the Auth Request has been to be completed, you will get back a pending response.

Pending Response Example:

{
    "auth_request_status_id": 2,
    "auth_request_status_name": "Completed",
    "auth_response": {
        "auth_history_id": "870382e8-cd60-488d-81bb-90e62ac0a514",
        "response_code": 2,
        "response_message": "Success",
        "authorized": true,
        "auth_details": {
            "request_details": {
                "date": "2021-10-10T16:48:22.1075834Z",
                "auth_profile_details": {
                    "auth_profile_id": "ded6469f-8b39-40ac-a7d8-50a2d10968e3",
                    "nickname": "test-api-user",
                    "ref_id": null
                },
                "origin_location_data": {
                    "latitude": "33.7329",
                    "longitude": "-118.2951",
                    "ip_address": null
                },
                "accepted_auth_methods": [
                    {
                        "name": "MobileDevice"
                    },
                    {
                        "name": "SecurityKey"
                    },
                    {
                        "name": "WebAuthn"
                    }
                ]
            },
            "response_details": {
                "date": "2021-10-10T16:48:30.7401303Z",
                "auth_method": {
                    "name": "WebAuthn",
                    "usetype": "fido2_mobiledevice"
                },
                "secure_signed_message": {
                    "signed_data": "eyJtZXNzYW.....
                },
                "mobile_device_details": {
                    "platform": "Android",
                    "model": "SM-G973U"
                },
                "auth_profile_details": {
                    "auth_profile_id": "ded6469f-8b39-40ac-a7d8-50a2d10968e3",
                    "nickname": "test-api-user",
                    "ref_id": null
                }
            }
        }
    }
}

xxxxxxxxxx

{
    "auth_request_status_id": 1,
    "auth_request_status_name": "Pending",
    "auth_response": null
}

An Auth Request can only have two status values:

Pending
A request is pending until it is completed. The auth_response will be null for pending requests.
Completed
A Completed request means one of the following has occurred:
- Timeout - The request timed out per the timeout in the auth request response.
- Success - The user accepted the auth request
- Declined - The user declined the auth request

A completed auth request will contain the auth_response object. The auth_response object contains the result of the request.

Completed Response Example (Trimmed, see bottom for full response)

xxxxxxxxxx

{
    "auth_request_status_id": 2,
    "auth_request_status_name": "Completed",
    "auth_response": {
        "auth_history_id": "870382e8-cd60-488d-81bb-90e62ac0a514",
        "response_code": 2,
        "response_message": "Success",
        "authorized": true,
        "auth_details": {
            "request_details": {
                "date": "2021-10-10T16:48:22.1075834Z",
                "auth_profile_details": {
                    "auth_profile_id": "ded6469f-8b39-40ac-a7d8-50a2d10968e3",
                    "nickname": "test-api-user",
                    "ref_id": null
                },
                "origin_location_data": {
                    "latitude": "33.7329",
                    "longitude": "-118.2951",
                    "ip_address": null
                },
                "accepted_auth_methods": [
                    {
                        "name": "MobileDevice"
                    },