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/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/challenge
Method: PUT
REQUEST
| Key | Value | Required? |
|---|
| sessionToken | String | Yes |
| agentId | String | Yes |
| challengeType | String (one of PROMPT, LAT_LONG, HOST_BEHAVIOR, PEBBLE) | 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 challengeDetails Map
| Key | Value | Required? |
|---|
| latitude | Number (in degrees) | Yes |
| longitude | Number (in degrees) | Yes |
| radius | Number (in km) | Yes |
| required | String (one of true, false) | Yes |
| maximumAttempts | Integer (minimum of 1) | Yes |
| fallbackChallengeID | Integer (optional) | No |
HOST_BEHAVIOR challengeDetails Map
| Key | Value | Required? |
|---|
| orientation | Integer
0 Portrait
1 Upside down
2 Landscape left
3 Landscape right |
 | Yes |
| touches | Comma-separated list of up to six Integers (1-6) | Yes |
| regionCount | 6 (currently the only accepted count) | Yes |
| required | String (one of true, false) | Yes |
| maximumAttempts | Integer (minimum of 1) | Yes |
| fallbackChallengeID | Integer (optional) | No |
PEBBLE (Wearable) challengeDetails Map
| Key | Value | Required? |
|---|
| required | String (one of true, false) | Yes |
| maximumAttempts | Integer (usually "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 |
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 |