Summary 

This article explains how to use specific endpoints to request and update a user's identity confidence score when developing a custom authentication agent or portal. These endpoints are not required when using RSA My Page or RSA Web-Based Agents.    

Important Note:

• RISK AI is an optional ID Plus feature and may not be available to all ID Plus customers.
• The endpoints described in this article are not enabled by default for RISK AI users. To use these endpoints, contact RSA for assistance.

Identity Confidence Score API

Use this public API endpoint to request a user's identity confidence score based on the information included in the request. Invoke this endpoint before or during the associated authentication event.

The response returns a transactionId, which is required when submitting a subsequent update request to update the user's identity confidence score.

Score Request URL 

https://example.auth-dev.securid.com/mfa/v1_1/identityconfidence/score

Request Headers 

Connection: keep-alive
Content-Type: application/json; charset=utf-8
Accept: application/json
client-key: dff4e77689bd118d01427ead7b092fe61f86b2ca

JSON Payload 

{
  "subjectName": "johnsmith@example.com", 
  "initiatingIp": "128.221.224.77",
  "html5Latitude": 47.61070354245329,
  "html5Longitude": -122.2028987590239,
  "geoLocationCollTimestamp": 1602008314509,
  "uniqueIdentifyingId": "73d03f80-877e-4e7f-8388-daa89176bd39",
  "tenantId": "example",
  "clientId": "client-ex",
  "httpHeaders": {
    "content-type": "application/x-www-form-urlencoded",
    "accept-language": "en-us",
    "connection": "keep-alive",
    "accept-encoding": "gzip, deflate",
    "Origin": "https://portal.example.com",
   },
"riskFingerprint":"version%3D%3D1%2E0%2E0%2E0%2E0%26rsa%5Frisk%5FuserAgent%3D%3DNaviUA%3Dmozilla%2F5%2E0%20%28x11%3B%20linux%20x86%5F64%29%20applewebkit%2F537%2E36%20%28khtml%2C%20like%20gecko%29%20chrome%2F84%2E0%2E4147%2E135%20safari%2F537%2E36%7CNaviAppVer%3D5%2E0%20%28X11%3B%20Linux%20x86%5F64%29%20AppleWebKit%2F537%2E36%20%28KHTML%2C%20like%20Gecko%29%20Chrome%2F84%2E0%2E4147%2E135%20Safari%2F537%2E36%7CNaviPlatform%3DLinux%20x86%5F64%7CNaviProduct%3DGecko%7CNaviVendor%3DGoogle%20Inc%2E%7CNaviProductSub%3D20030107%7CNaviVendorSub%3D%26rsa%5Frisk%5FscreenInfo%3D%3D24%7C1920%7C1080%7C1920%7C1055%26rsa%5Frisk%5Ftimezone%3D%3D%2D5%26rsa%5Frisk%5Flanguage%3D%3Dlang%3Den%2DUS%7Csyslang%3D%7Cuserlang%3D%26rsa%5Frisk%5Fjava%3D%3D0%26rsa%5Frisk%5FcookieEnabled%3D%3D1%26rsa%5Frisk%5FgeoLocationEnabled%3D%3D1%26rsa%5Frisk%5FallSoftware%3D%3Dinternal%2Dpdf%2Dviewer%7Cmhjfbmdgcfjbbpaeojofohoefgiehjai%7Cinternal%2Dnacl%2Dplugin%26rsa%5Frisk%5FnaviAppName%3D%3DNetscape%26rsa%5Frisk%5FappCodeName%3D%3DMozilla%26rsa%5Frisk%5Fonline%3D%3Dtrue%26rsa%5Frisk%5FosProfile%3D%3D%26rsa%5Frisk%5FuserProfile%3D%3D%26rsa%5Frisk%5FscreenPixelDepth%3D%3D24%26rsa%5Frisk%5FscreenBufferDepth%3D%3D%26rsa%5Frisk%5FscreenDeviceXPI%3D%3D%26rsa%5Frisk%5FscreenDeviceYDPI%3D%3D%26rsa%5Frisk%5FscreenLogicalXDPI%3D%3D%26rsa%5Frisk%5FscreenLogicalYDPI%3D%3D%26rsa%5Frisk%5FscreenSystemXDPI%3D%3D%26rsa%5Frisk%5FscreenSystemYDPI%3D%3D%26rsa%5Frisk%5FwindowDevicePixelRatio%3D%3D0%2E8999999761581421%26rsa%5Frisk%5Fwindow%5FpositionXY%3D%3D0%7C0%26rsa%5Frisk%5FwindowOuterWH%3D%3D1920%7C1055%26rsa%5Frisk%5FwindowInnerWH%3D%3D2133%7C1056%26rsa%5Frisk%5FscreenFontSmoothingEnabled%3D%3D%26rsa%5Frisk%5FscreenUpdateInterval%3D%3D%26rsa%5Frisk%5Ffonts%3D%3DArial%7CCourier%20New%7CLoma%7CRachana%7CSawasdee%7CTimes%20New%20Roman%7CTlwgMono%7CUbuntu%7CUmpush%26rsa%5Frisk%5Flatency%3D%3D10401%7C10413%26rsa%5Frisk%5Fcanvas%3D%3D9815bb5b3e8f63d75c8a101dd351d6a6948a2e5894f3878ec66508f1ef537ea6"
}

Include the following parameters in the JSON payload when making the request. 

var rsa_tp = encode_deviceprint();
var rsa_tp_canvas = urlEncode("&rsa_risk_canvas==" + sha256.hash(deviceprint_canvas()));
riskFingerprint = rsa_tp + rsa_tp_canvas;

Expected Response 

{
 "transactionId": "8d8464f7-9aaf-4621-adee-9b75a975ded7",
 "score": 0.20448663494348018,
 "scoreThreshold": 0.37,
 "normalizedScore": "LOW",
 "miniScores": {
   "deviceConfidence": 0.37224438513720404,
   "behaviorConfidence": 0.4432296864706946,
   "locationConfidence": 0.17309866349362057
 },
 "contributingFactors": {
   "New cookie or multiple cookies": 0,
   "Region or state changed": 0.0010233335866157711,
   "ISP changed": 0.008350620812921594,
   "Device language changed": 0.011702074050407907
 },
 "scoreResponseCode": "SUCCESS",
 "scoreReasonCode": null
}

Identity Confidence Update API

Use this public API endpoint to update a user's identity confidence score associated with a previously submitted scoring request. The update must be submitted within 15 minutes of the original score request and requires the transactionId returned in the score response. This is critical for the learning capability of the risk engine.

Update Request URL

https://example.auth-dev.securid.com/mfa/v1_1/identityconfidence/update

Request Headers 

Connection: keep-alive
Content-Type: application/json; charset=utf-8
Accept: application/json
client-key: dff4e77689bd118d01427ead7b092fe61f86b2ca

JSON Payload 

{
"tenantId": "example", 
"clientId": "client-ex",
"transactionId": "e8d8464f7-9aaf-4621-adee-9b75a975ded7",
"authenticationResult": "SUCCESS",
"satisfiedMethods": ["FIDO", "APPROVE"],
"failedMethods": null
}

Include the following parameters in the JSON payload when making the request. 

Expected Response 

{  
  "updateResponseCode":"SUCCESS",  
  "updateReasonCode":null
}