LogoLogo
Useful links
  • Home
  • Product guides
  • API
  • SDKs
  • Overview
  • CORE API
    • Authentication
    • Available resources
      • Transaction
      • Onboarding
      • Profile
      • Synchronous services
        • OCR Sync
        • Basic Data Sync (Individual)
    • Transaction details
      • Services
        • Document OCR
        • Documentscopy
        • Face Liveness
        • Facematch
        • Facial Biometrics
        • Private Faceset
        • Shared Faceset
        • Document Liveness
      • Background check
        • Data structure
        • KYC
          • Driver
          • Financial
          • Labor
          • Register data
          • Relationships
          • Risk
        • KYB
          • Financial
          • Labor
          • Register data
          • Risk
        • Vehicle
          • Register data
      • Validation rules
      • Manual reprovals
    • Webhooks
      • Transaction
      • Profile
      • Face authentication
  • MOBILE API
    • Authentication
    • Available resources
      • Face liveness (deprecated)
      • Face registration (deprecated)
      • Face authentication (deprecated)
    • Response signature
  • GLOBAL API
    • Authentication
    • Available resources
      • Services
        • Company search
        • Company record
        • Basic Data Sync (Individual)
        • Sanctions
      • Orchestrations
        • Transactions
          • Services
            • KYB
              • Credit Report
              • Business Identity
            • KYC
              • Adverse Media
              • PEPs
              • Sanctions
              • Warnings
              • Global identity verification
              • Global identity double verification
            • DOC ID
              • Global Document Verification
      • Onboardings
        • Links
    • Webhooks
  • SMART AUTH API
    • Authentication
    • Available resources
      • Authentications
      • Create identity
  • Joint resolution 6 API
    • Authentication
    • Available resources
      • Suspected fraud creation
      • Suspected fraud query
      • Suspected fraud update
      • Suspected fraud deletion
    • Using mTLS
    • Changelog
LogoLogo

2025 © Caf. - All rights reserved

On this page
  1. CORE API
  2. Transaction details
  3. Services

Private Faceset

Comparison of the submitted photo with the photo on private database faces of client.

Section: privateFaceset

Required files: selfie or document image containing a picture

Attribute
Type
Description

statusCode

String

Response status code

data

Object

Return data

data.suspect

Boolean

General indicator that a similar face was found. This value considers the manual confirmation of the verified field of each face match.

data.faceMatches

Array

Array of images match with the face input

data.faceMatches[X].similarity

String

Level of similarity in the compared images

data.faceMatches[X].verified

Boolean

Indicates that the match was manually confirmed by our operators.

data.faceMatches[X].faceset

Object

Data of face inserted in private faceset

data.faceMatches[X].faceset._id

Object

Id of face inserted in private faceset

data.faceMatches[X].faceset.createdAt

Object

Creation date of face inserted in private faceset

data.faceMatches[X].faceset.description

Object

Description of face inserted in private faceset

{
  "privateFaceset": {
    "statusCode": "01",
    "data": {
      "faceMatches": [
        {
          "similarity": "99.99998474121094",
          "verified": true,
          "faceset": {
            "_id": "6349abae10920e000909b47a",
            "createdAt": "2022-10-14T18:34:24.606Z",
            "description": "Changed Document"
          }
        }
      ],
      "suspect": true
    }
  }
}
Rule
Description

private_faceset_not_contains_face

The rule will be invalid if the submitted selfie matches one of the selfies registered in the Private Face Database.

Last updated 2 months ago