API Reference
Log inSign up
v1.7.3
v1.7.3
  • ComplyCube API Reference
  • Integration
  • Test and Live
  • Authentication
  • Rate Limits
  • Service Quota
  • Errors
  • Pagination
  • Filtering
  • Versioning
  • Core resources
    • Clients
      • Create a client
      • Get a client
      • Update a client
      • Delete a client
      • List clients
      • Filtering clients
    • Addresses
      • Create an address
      • Get an address
      • Update an address
      • Delete an address
      • List addresses
      • Filtering addresses
    • Documents
      • Create a document
      • Get a document
      • Update a document
      • Upload image attachment
      • Delete image attachment
      • Download image attachment
      • Redact image attachment
      • Delete a document
      • List documents
      • Filtering documents
    • Live Photos
      • Upload a live photo
      • Get a live photo
      • Download live photo
      • Redact live photo
      • Delete a live photo
      • List live photos
    • Live Videos
      • Get a live video
      • Redact live video
      • Delete live video
      • List live videos
    • Checks
      • Create a check
      • Get a check
      • Update a check
      • Validate check outcome
      • Redact check outcome
      • List checks
      • Filtering checks
    • Risk Profile
      • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
    • Enhanced Identity Check
    • Proof of Address Check
    • Multi-Bureau Check
    • Face Authentication Check
    • Age Estimation Check
  • Lookups
    • Company Search
      • Search company
      • Get company details
    • Address Search
      • Search address
  • Tools
    • Custom Lists
      • Get a custom list
      • Add entity to custom list
      • List custom lists
  • Static Data
    • Screening Lists
    • Supported Documents
  • Other Resources
    • Flow (Hosted Solution)
      • Create a session
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • SDK Tokens
      • Generate a token
    • Autofill
      • Perform autofill
    • Reports
      • Generate a client report
      • Generate a check report
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
    • Account Info
      • Get account info
  • Useful Resources
    • Testing Data
    • User Docs
Powered by GitBook
On this page
  • Run a face authentication check
  • Check request
  • Example request
  • Result object
  • Outcome
  • Breakdown
  • Sample Response

Was this helpful?

  1. Check types

Face Authentication Check

PreviousMulti-Bureau CheckNextAge Estimation Check

Last updated 1 year ago

Was this helpful?

Run a face authentication check

To run a Face Authentication Check, you must with type set to face_authentication_check.

This check can only be performed on a of type person. Furthermore, the provided client must have been enrolled previously.

.

Get in touch with your Account Manager or to enable this service.

Check request

Attribute
Type
Description

clientId

string

The ID of the client associated with this check. (Required)

livePhotoId

string

The ID of the live photo. (Required)

Example request

curl -X POST https://api.complycube.com/v1/checks \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          "clientId":"CLIENT_ID",
          "livePhotoId":"LIVE_PHOTO_ID",
          "type": "face_authentication_check"
        }'
const check = await complycube.check.create("CLIENT_ID", {
        livePhotoId: "LIVE_PHOTO_ID",
        type: "face_authentication_check"
});
check = cc_api.check.create(
    'CLIENT_ID',
    'face_authentication_check', 
    livePhotoId='LIVE_PHOTO_ID'
)
$result = $ccapi->checks()->create(
    'CLIENT_ID',
    [
        'type' => 'face_authentication_check',
        'livePhotoId' => 'LIVE_PHOTO_ID'
    ]
);
var checkRequest = new CheckRequest {
  clientId = "CLIENT_ID",
  livePhotoId = "LIVE_PHOTO_ID",
  type = "face_authentication_check"
};

var check = await checkApi.CreateAsync(checkRequest);

Result object

The result object is only returned when the status of the check is complete . It has two components - outcome and breakdown.

Outcome

The outcome attribute represents the overall check result. Returned values include:

  1. clear: Indicates the face on the provided live photo matches one of the client's previously enrolled faces, and hence the client's face authentication is successful.

  2. attention: Indicates the face on the live photo does not match any of the client's previously enrolled faces, hence requiring attention.

Breakdown

The breakdown comprises the following objects:

faceAuthentication object

The face authentication results. It has the following constituents:

  • facialSimilarity: Indicates whether the face on the live photo matches a client's enrolled face.

  • breakdown: Breakdown related to face authentication.

    • facesMatched: If the live photo matches an enrolled face, this attribute will be returned. It contains the following:

      • livePhotoId: The ID of the live photo corresponding to the enrolled face that matched.

      • liveVideoId: The ID of the live video corresponding to the enrolled face that matched.

      • facialSimilarityScore: Indicates the similarity level of the face on the live photo provided against the enrolled face. The score will be 100 for a perfect match.

    • enrolledFaces: This contains details about previously enrolled faces for a given client. It comprises of the following:

      • livePhotoIds: An array of live photo IDs used for enrolling the client's face.

      • liveVideoIds: An array of live video IDs used for enrolling the client's face.

Sample Response

{
    "id": "6231d54079f59b1530fc76e3",
    "entityName": "John Doe",
    "type": "face_authentication_check",
    "clientId": "6230d4ab58ed4a434afbf2cc",
    "livePhotoId": "6231d137095afa000955ffc2",
    "status": "complete",
    "result": {
        "outcome": "clear",
        "breakdown": {
            "faceAuthentication": {
                "facialSimilarity": "clear",
                "breakdown": {
                    "facesMatched": [
                        {
                            "livePhotoId": "6230d4f928e6ae00091747f9",
                            "facialSimilarityScore": 100
                        }
                    ],
                    "enrolledFaces": {
                        "livePhotoIds": [
                            "6230d4f928e6ae00091747f9",
                            "6230d4f928e6ae00091747fa"
                        ]
                    }
                }
            }
        }
    },
    "updatedAt": "2022-03-01T12:17:06.046Z",
    "createdAt": "2022-03-01T12:17:04.809Z"
}
create a check
client
Learn more about Face Authentication Checks
contact us