Authentication
The authentication workflow involves 3 steps:
- initiate authentication
- verify device
- verify device security
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",
"deviceSecurity"
]
}
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 Device Security
POST /onboarding/authentication/deviceProfile/checkDevice
Authorization: 'Bearer AccessToken'
apikey: 'apikey'
{
"authToken": authToken,
"apSessionId": sessionID,
}
Response for Verify Device Security
{
"errorCode": null,
"errorMsg": null,
"responseDetail": {
"errorCode": "",
"errorDescription": "",
"transaction_id": "483131a7-d243-4ce6-8372-07e1d766c259",
"userAttributes": [
{
"attributeType": "APSessionID",
"dateCreated": "06/03/2024 13:43:34",
"values": { "apSessionId": "a830c091ff854e6c82a8fda5e7e8285e" }
}
],
"acquiredAttributes": [
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "SmartIDBrowserstringPersonaAgeMonths",
"dateCreated": "06/03/2024 13:43:35",
"values": { "smartIDBrowserStringPersonaAge": "0" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "TrueIPConnectionType",
"dateCreated": "06/03/2024 13:43:35",
"values": { "trueIPConnectionType": "tx" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "TrueIPCity",
"dateCreated": "06/03/2024 13:43:35",
"values": { "trueIPCity": "brookline" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "BiometricReasonCode",
"dateCreated": "06/03/2024 13:43:35",
"values": { "biometricReasonCode": "Not Found" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "BiometricAssessmentScore",
"dateCreated": "06/03/2024 13:43:35",
"values": { "biometricAssessmentScore": "174.51" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "BiometricAnomalyScore",
"dateCreated": "06/03/2024 13:43:35",
"values": { "biometricAnomalyScore": "Not Found" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "TMXScore",
"dateCreated": "06/03/2024 13:43:35",
"values": { "tmxScore": "0" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "TrueIPGeoCountry",
"dateCreated": "06/03/2024 13:43:35",
"values": { "trueIPGeoCountry": "US" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "TrueIPLineSpeed",
"dateCreated": "06/03/2024 13:43:35",
"values": { "trueIPLineSpeed": "high" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "DigitalID",
"dateCreated": "06/03/2024 13:43:35",
"values": { "digitalID": "89ecdf561a3b4639a0d1b569f3395b26" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "TrueIP",
"dateCreated": "06/03/2024 13:43:35",
"values": { "trueIP": "38.140.59.226" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "SocialEngineeringScore",
"dateCreated": "06/03/2024 13:43:35",
"values": { "socialEngineeringScore": "Not Found" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "Platform",
"dateCreated": "06/03/2024 13:43:35",
"values": { "platform": "agent_mobile" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "BiometricFraudScore",
"dateCreated": "06/03/2024 13:43:35",
"values": { "biometricFraudScore": "500.00" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "HTMLLocationAccuracy",
"dateCreated": "06/03/2024 13:43:35",
"values": { "htmlLocationAccuracy": "Not Found" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "ExactIDIPPersonaAgeMonths",
"dateCreated": "06/03/2024 13:43:35",
"values": { "exactIDIPPersonaAge": "0" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "HTMLLocationLongitude",
"dateCreated": "06/03/2024 13:43:35",
"values": { "htmlLocationLongitude": "Not Found" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "FuzzyDeviceID",
"dateCreated": "06/03/2024 13:43:35",
"values": { "fuzzyDeviceID": "81b4da7a6a23441d8ca6eda259407ad8" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "OperatingSystem",
"dateCreated": "06/03/2024 13:43:35",
"values": { "operatingSystem": "iOS" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "OperatingSystemVersion",
"dateCreated": "06/03/2024 13:43:35",
"values": { "operatingSystemVersion": "17.4.1" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "BrowserSpoofReason",
"dateCreated": "06/03/2024 13:43:35",
"values": { "browserSpoofReason": "Not Found" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "TrueIPLatitude",
"dateCreated": "06/03/2024 13:43:35",
"values": { "trueIPLatitude": "42.34334" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "OperatingSystemAnomaly",
"dateCreated": "06/03/2024 13:43:35",
"values": { "operatingSystemAnomaly": "Not Found" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "HTMLLocationLatitude",
"dateCreated": "06/03/2024 13:43:35",
"values": { "htmlLocationLatitude": "Not Found" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "HoneypotFingerprintMatch",
"dateCreated": "06/03/2024 13:43:35",
"values": { "honeypotFingerprintMatch": "Not Found" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "ScreenResolution",
"dateCreated": "06/03/2024 13:43:35",
"values": { "screenResolution": "1792x828" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "BiometricBotScore",
"dateCreated": "06/03/2024 13:43:35",
"values": { "biometricBotScore": "500.00" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "TrueIPLongitude",
"dateCreated": "06/03/2024 13:43:35",
"values": { "trueIPLongitude": "-71.12276" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "NEATPersonaAgeMonths",
"dateCreated": "06/03/2024 13:43:35",
"values": { "NEATPersonaAge": "0" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "DigitalIDConfidence",
"dateCreated": "06/03/2024 13:43:35",
"values": { "digitalIDConfidence": "7223" }
},
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"attributeType": "FuzzyDeviceIDConfidence",
"dateCreated": "06/03/2024 13:43:35",
"values": { "fuzzyDeviceIDConfidence": "100.00" }
}
],
"userAssertionList": [
{
"provider": "Threatmetrix",
"serviceOffering": "Threatmetrix Session Query Low Location Accuracy",
"dateAsserted": "06/03/2024 13:43:35",
"assertions": {
"blacklist.ofacIP": "pass",
"blacklist.device": "pass",
"test.gte3Credential1d": "pass",
"detect.browserAnomaly": "pass",
"test.gte5Credential1d": "pass",
"test.lte3ProxyToday": "pass",
"test.trustedDevice6mo": "fail",
"test.trustedDevice": "fail",
"test.lte3CredentialsDevice7d": "pass",
"detect.possibleVPNOrTunnel": "pass",
"test.gte5Device1d": "pass",
"link.timeZone_TrueGeo": "pass",
"test.gte5CredentialDevice1d": "pass",
"test.credentialLTE500mi1hr": "pass",
"detect.vpn": "pass",
"test.trueIPLTE500miInputIP": "pass",
"test.exactIDAgeGTE7d": "pass",
"detect.proxyAnonymous": "pass",
"test.apSessionIDNotReplay": "pass",
"detect.jailbreak": "pass",
"blacklist.ip": "pass",
"test.expectedLanguage": "pass",
"link.proxyOrg_TrueOrg": "pass",
"detect.malware": "pass",
"detect.torExitNode90d": "pass",
"test.gte10Credential1d": "pass",
"detect.mobileTethering": "pass",
"test.trustedDevice28days": "fail",
"test.gte20Credential1d": "pass",
"detect.aggregator": "pass",
"test.smartIDAgeGTE7d": "pass",
"detect.unusualActivity": "pass",
"detect.proxyOpenTransparent": "pass",
"detect.proxyHidden": "pass",
"link.proxyISP_TrueISP": "pass",
"detect.tor": "pass",
"detect.torNode": "pass",
"detect.knownVPNISP": "pass",
"link.proxyGeo_TrueGeo": "pass",
"test.gte2Credential1d": "fail"
}
}
],
"mbun": "2533a66f-1e28-4202-845b-1d9d5eb208e2",
"forwardApiKey": "",
"policyObligation": false,
"policyDecision": "approve"
},
"authStatus": 2
}