Generate Token

Get an Authroization Bearer Token.

Base URL

sdk.faceki.com

Token Generation End Point

https://sdk.faceki.com/auth/api/access-token

Token Authentication Postman

Get a Bearer Token access token.

Authentication for the Faceki API is achieved through token-based authentication. To authenticate requests made to the API, you must include an API token in the Authorization of your requests.

For the GET method, the "Authorization" header should include "Bearer Token" followed by your parameters. which are "clientId" and "clientSecret". These parameters help to ensure that the request is valid and authorized.

By including the necessary authentication details in your requests, you can ensure that your requests are processed correctly and securely.

This API is used to generate tokens, this token is client-specific and used to authenticate client identity before performing operations in the system.

Method: GET

Authorization: Bearer Token

Parameter:

clientId *(mandatary)

clientSecret *(mandatory)

Each token will have a token refresh expiry of 5 minutes/ 3600 seconds. 

*All Params are mandatary required

Choose GET, add End point api, then select Params, add ClientID & clientSecert

ClientID and CleintSecert should be selected in Parms

GET https://sdk.faceki.com/auth/api/access-token

Headers

Name	Type	Description
clientSecret*	String	clientSecret will be found in the integration section. Example: "clientSecret":"00nl0cuq780ur007spqspa94kq6rkn1fap1e0kdre7gdl97lvspk".
clientid*	String	(string, required) Client Id from integration settings. Example: "client_id":"0NTS4CBV8MVII02VGVSPICB00".
Content-Type	String	application/json

200: OK

    "responseCode": 0,
    "data": {
        "access_token": "eyYkdDhiJuMVdFVFwvYWRPWFBCWTgxaCtTdEpcLytxUFVzSzFGSVlubXhSdUV4UWdJSkU9IiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiI3YnN2YW5jcGw0dGlvNjA2MDBwbjZobnI1OCIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoia3ljXC9hbGwiLCJhdXRoX3RpbWUiOjE2ODI1MTM5NDksImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC5tZS1zb3V0aC0xLmFtYXpvbmF3cy5jb21cL21lLXNvdXRoLTFfNHRvVUVCem9mIiwiZXhwIjoxNjgyNTE3NTQ5LCJpYXQiOjE2ODI1MTM5NDksInZlcnNpb24iOjIsImp0aSI6Ijg2NjY3N2FkLTcyMDctNDFkOC1hZjI5LTk3OWU3MDA3YWViNiIsImNsaWVudF9pZCI6Ijdic3ZhbmNwbDR0aW82MDYwMHBuNmhucjU4In0.NTs5EgFlTlfslPIFZpqK5ABAj7oZMPlGMEvH4YeUHOSB0m7jo_TkzNTHm1GCp32Mz3qCBOHZPiic0PPPCFJ1p1A2o7WSmV4x6GQ9vS55kvOUcgaY0_wS37_2TQ7ObVUeMKAeuSqdE9QBWIiMDdZyslDb-pGlXjC4WE0g30TGbKuu2twungoUztyDS1HqBQUNnZ1T3HV0fOTYXwKmXjGCoP-gZHW3TRG8woF4QnPqoAYItV-aRT01fv2H62NdlL_VZ7A1cCHEClDIs5U5nagGjVWeIxJUTLQT0tFVvYVh6ViCaRCv2hlFcSrSwym0hvtGgPNV0H_eZ2yytoFjq0danQ",
        "expires_in": 3600,
        "token_type": "Bearer"
    }
}

401: Unauthorized

{
  "status": false,
  "message": "",
  "statusCode": 422,
  "data": {}
}

402

{
  "clientSecret": ""
}

403

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

Response JSON format

Requests return a JSON object with the header:

// Content-Type: application/json

Responses return JSON with a consistent structure, except downloads.

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.

Token authentication Codes

HTTP

Authorization: Token token=<YOUR_API_TOKEN>

Bash

api_url='https://sdk.faceki.com/auth/api/access-token?clientId=7bsvancpl4tio60600pn6hnr58&clientSecret=1d5bssl48phc3vjfh5ljntkl9b2u6a0r80kit6vg08f9kpf70ch9'
curl -X GET $api_url

PHP

$api_url='https://sdk.faceki.com/auth/api/access-token?clientId=00svancpl4tio60600pn6hnr58&clientSecret=0000sl48phc3vjfh5ljntkl9b2u6a0r80kit6vg08f9kpf70ch9';

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, $api_url);

curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$output = curl_exec($curl);

curl_close($curl);

Java

import requests

api_url = 'https://sdk.faceki.com/auth/api/access-token?clientId=7bsvancpl4tio60600pn6hnr58&clientSecret=1d5bssl48phc3vjfh5ljntkl9b2u6a0r80kit6vg08f9kpf70ch9'

response = requests.get(api_url)

output = response.content

JavaScript

let api_url = 'https://sdk.faceki.com/auth/api/access-token?clientId=7bsvancpl4tio60600pn6hnr58&clientSecret=1d5bssl48phc3vjfh5ljntkl9b2u6a0r80kit6vg08f9kpf70ch9';

fetch(api_url)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));

This code uses the fetch API to make a GET request to the API endpoint and returns a Promise that resolves to the response data. The console.log method is used to log the data to the console, and the console.error method is used to log any errors that may occur during the request.

Ruby

require 'net/http'

api_url = URI('https://sdk.faceki.com/auth/api/access-token')
params = { clientId: '7bsvancpl4tio60600pn6hnr58', clientSecret: '1d5bssl48phc3vjfh5ljntkl9b2u6a0r80kit6vg08f9kpf70ch9' }
api_url.query = URI.encode_www_form(params)

response = Net::HTTP.get(api_url)

puts response

Python

api_url = 'https://sdk.faceki.com/auth/api/access-token?clientId=00svancpl4tio60600pn6hnr58&clientSecret=0000sl48phc3vjfh5ljntkl9b2u6a0r80kit6vg08f9kpf70ch9'

import requests

response = requests.get(api_url)
output = response.json()

print(output)

Error Code

    INTERNAL_SYSTEM_ERROR = 1000,
    SUCCESS = 0,
    NO_RULES_FOR_COMPANY = 7001,
    NEED_REQUIRED_IMAGES = 8001,
    DOCUMENT_VERIFY_FAILED = 8002,
    PLEASE_TRY_AGAIN = 8003,
    FACE_CROPPED = 8004,
    FACE_TOO_CLOSED = 8005,
    FACE_NOT_FOUND = 8006,
    FACE_CLOSED_TO_BORDER = 8007,
    FACE_TOO_SMALL = 8008,
    POOR_LIGHT = 8009,
    ID_VERIFY_FAIL = 8010,
    DL_VERIFY_FAIL = 8011,
    PASSPORT_VERIFY_FAIL = 8012,
    DATA_NOT_FOUND = 8013,
    INVALID_VERIFICATION_LINK = 8014,
    VERIFICATION_LINK_EXPIRED = 8015,
    FAIL_TO_GENERATE_LINK = 8016,
    KYC_VERIFICATION_LIMIT_REACHED = 8017,
    SELFIE_MULTIPLE_FACES = 8018,
    FACE_BLURR = 8019

/kyc-verification