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 36 views

Base URL

www.awareid.aware-apis.com

Authentication Step 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",
        "verifyVoice"
    ]
}

Authentication Step 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
}

Verify voice

POST /onboarding/authentication/verifyVoice
{
    "authToken": "auth_token",
    "livenessData": {
        "voice": {
            "voiceSamples": [
                {
                    "data": "base64 voice sample package from SDK",
                    "Phrase": "\\"Hello, Testing BIMaaS Application.\\""
                }
            ],
            "workflow": "alfa2",
            "meta_data": {
                "client_device_brand": "Apple",
                "client_device_model": "iPhone 8",
                "client_os_version": "11.0.3",
                "client_version": "KnomiSLive_v:2.4.1_b:0.0.0_sdk_v:2.4.1_b:0.0.0",
                "localization": "en-US",
                "programming_language_version": "Swift 4.1",
                "username": "test"
            }
        }
    }
}

Response for Verify voice

{
  "livenessResult": true,
  "matchResult": true,
  "matchScore": 100,
  "authStatus": "2 (Complete)",
  "voiceLivenessResults": ""
}
CONTENTS