Star illustrationStar illustrationStar illustration

Hello, what can we help you find?

We're here for you. Whether you need help building authentication into your banking app, need access control or HR verification and onboarding tools you can find all of that here.

Authentication

Estimated reading: 1 minute 59 views

The authentication workflow involves 3 steps:

  1. initiate authentication
  2. verify device
  3. verify face

Base URL

www.awareid.aware-apis.com

1. Initiate Authentication

POST /onboarding/authentication/authenticate
Authorization: 'Bearer AccessToken'
apikey: 'apikey'

{
    "registrationCode": "registrationToken",
    "deviceId": "deviceID"
}

Response for initiate Authentication

STATUS CODE 200
{
    "authToken": "b8bf6f22-6f93-4bcb-a5b6-871b689c6750",
    "requiredChecks": [
        "verifyDevice",
        "verifyFace"
    ]
}

2. Verify Device

POST /onboarding/authentication/verifyDevice
Authorization: 'Bearer AccessToken'
apikey: 'apikey'

{
    "authToken": "authToken",
    "signature": "signature",
    "deviceId": "deviceID"
}

Response for Verify Device

STATUS CODE 200
{
    "message": "Device verified.",
    "authStatus": 1
}

3. Verify face

POST /onboarding/authentication/verifyFace
{
    "authToken": "{{atoken}}",
    "faceLivenessData": 
       {
         "video": {
        "workflow_data": {
            "workflow": "hotel2",
            "rotation": 0,
            "frames": [
                {
                    "data": "",
										"data": "",
										"data": "",
                    "tags": [],
                    "timestamp": 1609002526076.1338
                }
            ]
        },
        "meta_data": {
            "client_device_brand": "Unknown",
            "username": "Xiao",
            "client_version": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36 Edg/87.0.664.66"
        },
        "client_version": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36 Edg/87.0.664.66"
    }
  }
}

Response for Verify face

STATUS CODE 200
{
    "livenessResult": true,
    "matchResult": true,
    "matchScore": 53.154655,
    "authStatus": 2,
    "faceLivenessResults": {
        "video": {
            "liveness_result": {
                "decision": "LIVE",
                "feedback": [],
                "score_frr": 1.1757098732441127
            }
        }
    },
    "faceMatchResults": {
        "statusMessages": [],
        "verifyResult": true,
        "matchScore": 53.154655,
        "biometricMatchedCount": 1,
        "biometricsOnServer": "",
        "biometricMatchResultList": [
            {
                "verifyResult": true,
                "modality": "FACE",
                "fmrScore": 53.154655,
                "biometricMatchedCount": 1,
                "biometricsOnServer": "Front",
                "matchResultReference": null
            }
        ],
        "matchingMinutia": null
    }
}
CONTENTS