/Verify API

Login by Face image for signup with user details api.

Base URL

sdkbio.faceki.com

Verify API End Point

https://sdkbio.faceki.com/verify

The Verify API is used to authenticate a user's identity by comparing a submitted image of their face to the biometric data that was previously enrolled and stored in your application's database.

To use the Verify API, you will need to make a POST request to the API endpoint with the image of their face. The API will then compare the submitted image with the stored biometric data and return a response indicating whether the two images match or not.

The response from the Verify API will include a confidence score, which indicates the level of certainty that the submitted image and stored biometric data match. A high confidence score indicates a strong likelihood that the user's identity has been verified, while a low confidence score indicates that further verification may be required.

It is important to note that the Verify API does not store any biometric data or images. The API only compares the submitted image with the previously enrolled biometric data and returns a result based on that comparison.

To ensure the security and privacy of your users' biometric data, it is recommended to use encryption and other security measures when transmitting and storing the data.

*Image file type of png, jpeg, jpg (*Mandatory)

Error Codes

  • FACE_TOO_CLOSE: A distance between face and camera is too small for preprocessing issues

  • FACE_CLOSE_TO_BORDER: Face is too close to one or more borders. May reduce the accuracy of spoofing detection because edges of face may not be seen

  • FACE_CROPPED: Face is cropped. May reduce the accuracy of spoofing detection because edges of face may not be seen

  • FACE_NOT_FOUND: Face detector can't find face on image

  • FACE_TOO_SMALL: Facial area is not big enough for analysis. Either interpupillary distance or face size is below the configured value.

  • FACE_ANGLE_TOO_LARGE: Facial out-of-plane rotation angle is extremely large

  • FAILED_TO_PREDICT_LANDMARKS: Landmarks prediction error

  • FAILED_TO_PREPROCESS_IMAGE_WHILE_DETECT: Face detection error

  • FAILED_TO_PREPROCESS_IMAGE_WHILE_PREDICT: Liveness prediction error

  • FAILED_TO_READ_IMAGE: File decoding error

  • FAILED_TO_READ_MODEL: Model deserializing error

  • FAILED_TO_WRITE_IMAGE: File encoding error

  • INVALID_CONFIG: Configuration file deserializing error

  • INVALID_FUSE_MODE: Invalid fuse mode provided

  • NO_SUCH_OBJECT_IN_BUILD: Engine or backend is not supported by the build

  • NULLPTR Nullptr provided: TOO_MANY_FACES Too many faces detected (more than maximum faces number in configuration, one face by default)

  • UNKNOWN: Unhandled exception in the code

POST https://sdkbio.faceki.com/verify

Query Parameters

NameTypeDescription

Headers

NameTypeDescription

authorization*

String

Bearer [token]

Content-Type*

String

multipart/form-data

Request Body

NameTypeDescription

image*

File

Selfie live image

```json
{
    "responseCode": 0,
    "data": {
        "logedIn": true,
        "all_face_ids": [
            "2f1ebdb7-e6d1-448e-9b2c-3ddfe97672d7"
        ],
        "user": {
            "_id": "644b7a0571acced04ea09904",
            "userId": "e4fe7610-9ea8-4894-9e61-bc2ecb7bc305",
            "companyId": "d2504fcc-a1bd-4f4c-9874-dec3706123b4",
            "userType": "Member",
            "email": "name@faceki.com",
            "language": "",
            "roleID": "Admin",
            "status": "ACTIVE",
            "blockStatus": "UNBLOCKED",
            "selfieImage": "https://faceki-kyc-images.s3.amazonaws.com/faces/5262079000000.jpeg",
            "faceID": "2f1ebdb7-e6d1-448e-9b2c-3ddfe97672d7",
            "imageID": "ff56ce6a-0326-3eaa-92c4-345d4a80a2db",
            "createdAt": "2023-04-28T07:47:17.325Z",
            "updatedAt": "2023-04-28T07:47:17.325Z",
            "__v": 0
        },
        "packageInfo": {
            "subscription": {
                "_id": "643d06cd312cfeacfdd1bb03",
                "subscriptionType": "Stripe",
                "subscriptionStatus": "ACTIVE",
                "subscriptionId": "sub_1MxnfASELEOLtiPwDdMSkJcs",
                "userEmail": "fc1@mailinator.com",
                "companyId": "d2504fcc-a1bd-4f4c-9874-dec3706123b4",
                "packageId": "2e7773a8-cec5-4d49-9728-d8ad8f87274f",
                "packageType": "KYC",
                "subscriptionDateTime": "2023-04-17T08:43:57.126Z",
                "allowExcessiveUse": false,
                "nextBillingDate": "2024-04-17T08:43:57.126Z",
                "availableCredit": 9999,
                "excessCharge": 0,
                "createdAt": "2023-04-17T08:43:57.127Z",
                "updatedAt": "2023-04-28T08:08:50.514Z",
                "__v": 0
            },
            "subscriptionUsage": {
                "_id": "643d06cdad232a17e6056b4e",
                "companyId": "d2504fcc-a1bd-4f4c-9874-dec3706123b4",
                "subscriptionId": "sub_1MxnfASELEOLtiPwDdMSkJcs",
                "subscriptionDate": "1681689600000-1713312000000",
                "subscriptionPackage": "Rosales",
                "subscriptionLimit": 10000,
                "subscriptionUsage": 4,
                "smsLimit": 100,
                "smsUsage": 0,
                "extraUsage": 0,
                "overTimeUsage": 0,
                "extraUsageInvoiceCreated": false,
                "createdAt": "2023-04-17T08:43:57.335Z",
                "updatedAt": "2023-04-28T08:08:50.405Z",
                "__v": 0
            }
        },
        "message": "Login Success."
    }
}
```

Response Parameters

You must make all your requests to the API over HTTPS and TLS 1.2, with Server Name Indication enabled. Any requests made over HTTP will fail.

Responses return JSON with a consistent structure, except downloads.

// Content-Type: application/json

Previous/Enroll APINext/Liveliness API

Last updated