LogoLogo
Home
  • Youverify API Documentation
  • Getting Started
    • Getting your API Key
    • Getting your Public Merchant Key
    • Environment
    • Response Codes
  • Know Your Customer Services (KYC)
    • ID Document Verification (SDK)
      • Web SDK
      • iOS SDK
        • iOS Liveness SDK
        • iOS (Compat) Liveness SDK
        • iOS Document Capture SDK
      • Android SDK
        • Android Document Capture SDK
        • Android Liveness SDK
      • Document Capture Supported Countries
        • 🌏Asia
        • πŸ‡ͺπŸ‡ΊEurope
        • 🌎Latin America and the Caribbean
        • 🌍Middle East and Africa
        • 🌎North America
        • 🌏Oceania
    • ID Data Matching (eIDV)
      • 🌐Global
        • Supported Countries
      • πŸ‡ΏπŸ‡¦South Africa
        • Verify South African ID Number (SAID)
        • Verify South African Phone Number
        • Bank Account Verification
        • Proof of Address Verification
      • πŸ‡°πŸ‡ͺKenya
        • Verify International Passport
        • Verify Alien ID
        • Verify Drivers License
        • Verify Plate Number
        • Verify Collateral ID
        • Kenyan Bank Account Verification
          • Bank List
        • Credit History
        • Employment History
        • Verify Address Information
        • Verify Phone Number
        • Verify Identity Number
        • Verify Tax PIN
      • πŸ‡¬πŸ‡­Ghana
        • Verify International Passport
        • Verify Social Security and National Insurance Trust (SSNIT)
        • Verify Ghana Voters Card (GVC)
      • πŸ‡³πŸ‡¬Nigeria
        • Verify Bank Verification Number (BVN)
        • Verify Bank Verification Number (BVN Premium)
        • Verify Virtual National Identification Number (vNIN)
        • Verify National Identification Number (NIN)
        • Verify Nigerian Driver's License (Driver's License)
        • Advanced Phone Search
        • Verify Nigerian International Passport (Passport)
        • Verify Nigerian Permanent Voters Card (PVC)
        • Verify Phone Number
        • Individual Credit Report
        • Bank Account Verification
          • Basic Bank Account Verification
          • Bank List
            • Getting the list of Banks for Basic Bank Account
    • Facial Comparison
    • Retrieve an Identity
    • Identity History
  • Know Your Business Services (KYB)
    • 🌍Business Verification
    • 🌍Search for Businesses
    • Get Supported Countries and Regions
    • Retrieve Business details
    • Country-Specific KYB Services
      • πŸ‡³πŸ‡¬Nigeria
        • Tax Identification Number (TIN) Verification
      • πŸ‡ΏπŸ‡¦South Africa
        • Business Account Verification
        • Business Address Verification
  • Know Your Transaction Service (KYT)
    • Customer Management
      • Create an Individual Client
      • Create a Business Client
      • Initiate an Individual Client Assessment
      • Initiate an Business Client Assessment
      • Update a Client
      • Retrieve all Clients
      • Retrieve a Client
      • Delete a Client
    • Transaction Management
      • Create a Transaction
      • Retrieve an Evaluation
  • Risk Intelligence
    • Risk Intelligence: Initialise Risk Check
    • Retrieve Risk Intelligence Profile
    • Retrieve Risk Intelligence History
  • AML Services (Anti-Money Laundering)
    • PEP and Sanction Screening
      • Search using Name
        • Advanced Filters
      • Search using Identity
        • Advanced Filters
      • Search using Crypto
        • Advanced Filters
      • Retrieve a PEP and Sanction Screening Search
      • Screening Data Sources
      • Domestic PEP Search
    • Adverse Media Intelligence
    • Custom AML Watchlist
      • AML Watchlist (Sample list)
      • AML Watchlist Upload (Bulk Upload)
      • AML Watchlist Upload
      • Retrieve AML Watchlist
      • AML Watchlist Entity Update
      • AML Watchlist Entity Removal
  • Custom Workflow Builder (CWB)
    • CWB Webhook
    • CWB External API
      • Retrieve CWB History
      • Retrieve CWB Responses
      • Retrieve CWB Report
  • Youverify OS Error Codes
  • Webhooks
    • Know Your Customer Webhooks
      • Identity Verification
      • Address Verification
    • Know Your Transaction Webhooks
      • Customer Management Webhooks
        • Client Created
        • Client Updated
      • Alert Service Webhooks
        • Alert Created
        • Alert Triage Created
        • Alert Updated
      • Evaluation Webhooks
        • Evaluation Completed
        • Evaluation Started
        • Transaction Updated
  • Test Data
  • Our Legacy API and SDK
Powered by GitBook
On this page

Was this helpful?

  1. Know Your Customer Services (KYC)

Facial Comparison

Compare Images

POST {{baseurl}}/v2/api/identity/compare-image

This endpoint allows you to compare the similarity between two different images.

Headers

Name
Type
Description

token*

String

API secret token

Request Body

Name
Type
Description

image1*

String

valid image URL or Base64 encoded string of image

image2*

String

valid image URL or Base64 encoded string of image

isSubjectConsent*

Boolean

Indicate subject has given consent. Must be true

{
    "image1": "https://cdn.youverify.co/1655426991330-nbkHP7qYykVYiXJP-pZr3.jpg",
    "image2": "https://cdn.youverify.co/1655261851961-za9BbHiHvWwROm19hRlv7.jpg",
    "isSubjectConsent": true
}
{
            "success": true,
            "statusCode": 200,
            "message": "success",
            "data": {
                "id": "62abcfcb4f9005b0ddaa4a7a",
                "parentId": null,
                "status": "completed",
                "reason": "Provided image does not match ID image",
                "selfieValidation": true,
                "imageComparison": {
                    "confidenceLevel": 47,
                    "threshold": 80,
                    "match": false,
                    "image1": "https://cdn.youverify.co/1655426991330-nbkHP7qYykVYiXJP-pZr3.jpg",
                    "image2": "https://cdn.youverify.co/1655261851961-za9BbHiHvWwROm19hRlv7.jpg"
                },
                "isConsent": true,
                "idNumber": "62ABCFCD4F9005B0DDAA4A7B",
                "businessId": "61d880f1e8e15aaf24558f1a",
                "type": "facial_compare",
                "requestedAt": "2022-06-17T00:50:21.567Z",
                "requestedById": "61d880f2e8e15aaf24558f9b",
                "createdAt": "2022-06-17T00:50:21.716Z",
                "lastModifiedAt": "2022-06-17T00:50:21.716Z",
                "requestedBy": {
                    "firstName": "Famous",
                    "lastName": "Ehichioya",
                    "middleName": "Prior",
                    "id": "61d880f2e8e15aaf24558f9b"
                }
            },
            "links": []
        }
HTTP/1.1 404 NotFound
{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}
PreviousGetting the list of Banks for Basic Bank AccountNextRetrieve an Identity

Last updated 1 year ago

Was this helpful?