Face Verify (facial) Response Object

Applies to: Direct

This JSON response is returned for a facial matching and liveness detection check.

👍

This response is returned by /get-results if you include the selfie signal in /start endpoint.

{
  "facial": {
    "type": "object",
    "description": "Facial matching and liveness detection signal (`facial`) response.",
    "properties": {
      "success": {
        "type": "boolean",
        "description": "True if the API call was successful; false otherwise."
      },
      "result": {
        "type": "boolean",
        "description": "True if data was returned in the data object; false otherwise."
      },
      "message": {
        "type": "string",
        "description": "A description of the result output, for example, \"success\" or an error message."
      },
      "data": {
        "type": "object",
        "description": "Contains the facial signal elements returned as a JSON object.",
        "properties": {
          "matched": {
            "type": "boolean",
            "description": "Indicates if the current facial image is matched with the document facial image."
          },
          "matchScore": {
            "type": "integer",
            "description": "Numeric representation of the degree to which the selfie matches the document facial image. Based on the comparison between the current facial image (selfie) and the document facial image."
          },
          "matchProbability": {
            "deprecated": true,
            "type": "null",
            "format": "float",
            "description": "Deprecated. Use `matched` for match decisioning."
          },
          "isLive": {
            "type": "boolean",
            "description": "Whether image is a live person."
          },
          "livenessScore": {
            "deprecated": true,
            "type": "null",
            "format": "float",
            "description": "Deprecated. Use `isLive` for liveness decisioning."
          },
          "livenessProbability": {
            "type": "number",
            "format": "float",
            "description": "Likelihood the image is a live person."
          },
          "errorMessage": {
            "type": "string",
            "description": "Indicates the cause of failed liveness detection. Either unable to recognize license or unable to parse data from license."
          },
          "photoFace": {
            "deprecated": true,
            "type": "string",
            "description": "Deprecated. Refer to [Submitted Images Response](doc:submitted-images-response). Selfie image in base64 format. This is optional and will only be returned if you subscribe to return of selfie image."
          }
        }
      }
    }
  }
}

Scoring guidelines

BooleanScore evaluatedPassing value
isLivelivenessProbability0.90 or greater
matchedmatchScore535 or greater
🚧

Intellicheck encourages customers to use only the matched and isLive Boolean results. This will simplify your future maintenance, as Intellicheck software updates can change threshold recommendations. If you choose to use matchScore or livenessProbability to determine your own Face Verify results, be sure to monitor customer support notices and keep up with release notes on changes to matchScore and livenessProbability that may impact your Face Verify decisioning. Contact support to let them know whether you use these scoring fields so we can support you more proactively, or to ask any questions.


Did this page help you?