https://app.liveensure.com/live-identity/rest
API Required Environment
Pre-condition: service is activated (applicable only to custom installations)
Error: 412 PRE-CONDITION FAILED
Endpoint: /host/session
Method: PUT
REQUEST
| Key | Value | Required? |
|---|
| apiVersion | String | Yes |
| apiKey | String | Yes |
| agentId | String | Yes |
| userId | String | Yes |
| locale | String | No |
| successMessage | String | No |
| failureMessage | String | No |
RESPONSE
| Key | Value |
|---|
| sessionToken | String |
ERRORS
| Code | Reason |
|---|
401 | Missing required User ID |
401 | Missing or invalid API Version |
401 | Missing or invalid API Key |
401 | Missing or invalid API Password |
401 | Missing or invalid Agent ID |
403 | Invalid Key/Password combination |
403 | Invalid Key/Agent ID combination |
Endpoint: /host/challenge
Method: PUT
REQUEST
| Key | Value | Required? |
|---|
| sessionToken | String | Yes |
| agentId | String | Yes |
| challengeType | String (one of PROMPT, LAT_LONG_V6, HOST_BEHAVIOR_V6, BIOMETRIC, WEARABLE, TIME) | Yes |
| challengeDetails | Key/Value Map | Yes |
PROMPT challengeDetails Map
| Key | Value | Required? |
|---|
| question | String | Yes |
| answer | String | Yes |
| required | String (one of true, false) | Yes |
| maximumAttempts | Integer (minimum of 1) | Yes |
| fallbackChallengeID | Integer | No |
LAT_LONG_V6 challengeDetails Map
| Key | Value | Required? |
|---|
| latitude | Number (in degrees) | Yes |
| longitude | Number (in degrees) | Yes |
| radius | Number (in km) | Yes |
| inout | String (one of true means in, false means out) | Yes |
| required | String (one of true, false) | Yes |
| maximumAttempts | Integer (minimum of 1) | Yes |
| fallbackChallengeID | Integer (optional) | No |
HOST_BEHAVIOR_V6 challengeDetails Map
| Key | Value | Required? |
|---|
| touches | Comma-separated patten string. Pattern is start and end point. (Ex. (1,9), (8,8), (7,3)) | Yes |
| required | String (one of true, false) | Yes |
| maximumAttempts | Integer (minimum of 1) | Yes |
| fallbackChallengeID | Integer (optional) | No |
BIOMETRIC challengeDetails Map
| Key | Value | Required? |
|---|
| touches | String (one of true, false) | Yes |
| required | String (one of true, false) | Yes |
| maximumAttempts | Integer (minimum of 1) | Yes |
| fallbackChallengeID | Integer | No |
WEARABLE challengeDetails Map
| Key | Value | Required? |
|---|
| deviceId | Comma-separated list (Ex. id1,id2,id3...) | Yes |
| required | String (one of true, false) | Yes |
| maximumAttempts | Integer (minimum of 1) | Yes |
| fallbackChallengeID | Integer | No |
TIME challengeDetails Map
| Key | Value | Required? |
|---|
| startDate | String (Ex. 2020-05-21 04:00 AM) | Yes |
| endDate | String (Ex. 2020-05-21 05:00 AM) | Yes |
| inout | String (one of true means in, false means out) | Yes |
| required | String (one of true, false) | Yes |
| maximumAttempts | Integer (minimum of 1) | Yes |
| fallbackChallengeID | Integer (optional) | No |
RESPONSE
| Key | Value |
|---|
| statusMessage | String |
| challengeID | Integer |
ERRORS
| Code | Reason |
|---|
401 | Missing or invalid session token |
401 | Invalid session state (cannot accept the addition of a new challenge) |
401 | Missing required challenge details |
401 | Invalid challenge details for specified challenge type |
The following are the types of session objects you can present to your user on their device or browser
to scan, tap or link internally to engage the authentication.
qurl: <leHostBase>/QR?w=<240>&sessionToken=<session token>
furl: <leHostBase>/launcher?sessionToken=<session token>
lirl: <leHostBase>/launcher?sessionToken=<session token>&light=<1>
lurl: liveensure://?sessionToken=<session token>&status=<leHostBase>/rest
Method: GET
DESCRIPTIONS
| Key | Value |
|---|
| qurl | QR code image to scan from device |
| furl | Full QR to scan, or tap to make OOB PIN entry box |
| lirl | Light agent. i.e. OOB PIN entry box only |
| lurl | Link only for on-mobile or app2app use |
ERRORS
| Code | Reason |
|---|
401 | Missing or invalid session token |
Endpoint: /host/session/<session token>/<agent id>
Method: GET
RESPONSE
| Key | Value |
|---|
| sessionToken | String |
| statusMessage | String |
| clientType | String |
| sessionType | String |
| knownDevice | String |
| country | String |
| oobToken |
String (one of pending, none, or the token value to deliver) |
| message | String |
| sessionStatus |
String (one of SUCCESS, FAILED, SESSION_UNDETERMINED) |
| sessionUUID | String |
| challengeStatuses | Key/Value Map |
challengeStatuses Map
| Key | Value |
|---|
| challengeID | Integer |
| challengeType | String |
| answerState | String (one of SUCCESS, FAILED, LEGACY, NA) |
ERRORS
| Code | Reason |
|---|
401 | Missing or invalid session token |
Endpoint: /host/user
Method: DELETE
REQUEST
| Key | Value | Required? |
|---|
| apiVersion | String | Yes |
| apiKey | String | Yes |
| agentID | String | Yes |
| userID | String | Yes |
RESPONSE
| Key | Value |
|---|
| userID | String |
| statusMessage | String |
ERRORS
| Code | Reason |
|---|
401 | Missing required User ID |
401 | Missing or invalid API Key |
401 | Missing or invalid API Password |
403 | Invalid Key/Password combination |
409 | Unable to delete user |