/Enroll API

The enroll API is used to register a user's face biometric information with FACEKI. This is the first step in enabling biometric authentication for the user.

Base URL

sdkbio.faceki.com

Enroll End Point API

https://sdkbio.faceki.com/enroll

This API is used to register a new user under a particular client, you should use this API along with your existing signup flow whereupon getting user info you can pass that info into the request and followed by the live image capturing, with all this data make a post-form-data request to register a new user. Make sure the image captured is a live face image as the system will not bypass any fake image like in photos on mobile, paper, masking, etc.

Method: POST

Authorization: Bearer Token

Parameter:

image (Image File) (*Mandatory)

Image data is the file type of PNG, JPEG, PNG

First Step to Select POST, then add the API End Point and click on Authorization to add Bearer Token

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

Headers

Name	Type	Description
Content-Type:*	String	multipart/form-data
authorization:*	String	Bearer [token]

Request Body

Name	Type	Description
image*	File

200: OK

```json
{
    "response": "Already Registered"
}
```

401: Unauthorized

Error:- 
    "error": "Authentication failed"

400: Bad Request

{
    "status": false,
    "message": "Image is required",
    "statusCode": 422,
    "data": {}
}

400: Bad Request

{
    "status": false,
    "message": "name is required",
    "statusCode": 401,
    "data": {}
}

400: Bad Request

{
    "status": false,
    "message": "email is required",
    "statusCode": 401,
    "data": {}
}

400: Bad Request

{
    "status": false,
    "message": "Mobile number is required",
    "statusCode": 401,
    "data": {}}

Response Parameters

face_id: *This is a unique identifier for each face, you can keep this to retrieve user information in your DB while Sign up you can store and use here to retrieve information, each face can have multiple images ID's.

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