Overview
\nWelcome to the FaceX API Documentation v2.0.
If you’re new to FaceX, create an account and follow this guide to get started.
\nThe FaceX API is built on REST principles. Authenticated users can interact with any of our URIs by using the specified HTTP request method. We recommend and also enforce that our users use SSL encryption by issuing requests through HTTPS. Our global endpoint for all APIs:
\nhttp://www.facexapi.com
\nFaceX also provides support to help our users meet the local legal and compliance requirements.
\nPrerequisites
\nThough we have PHP, NodeJS, Python, Java, C#, Perl and Ruby Sample Codes for our APIs in this documentation, it is always recommended to test the API before integration with your application. For testing, we recommend using cURL.
Note: cURL comes standard on Mac operating systems. On other OS, you might have to install the same.
\nBefore you can start using the API, you need to do the following:
\nNote: You will not be able to make requests if your account is deactivated or has reached the API Call limit.\n
With FaceX APIs you can now add Face Recognition capabilities to your App using our simple API Calls. Our services are implemented through state-of-the-art Deep learning techniques trained over millions of images to offer you the Highest Accuracy with the quickest turn-around time. Our services are perfect fit for you if you plan to have Face ID, Gender and Age Detection or even for face transformations (Masking/Swapping etc).
\nAll our services are currently hosted under our own secure cloud, processing with the latest rack of GeForce GPUs, promising you a result within 0.02sec and an up-time of 99.99%.
\nThe Basic three APIs that we provide in our FaceAPI plans are:
\nget_image_attr : For detecting faces , gender detection , age range prediction and facial landmark
\ncompare_faces : For comaparing two faces to check if it belongs to the same person
\nget_face_vec : Get 128 dimensional feature vector describing a face for recognition and identification purpose.
\nWe also have Face Search Plans using which you can create and search a database easily. The APIs that are active in Face Search plan are:
\nRawImage_Search : Compare a new image against your created database to recognize a person
\nBase64_Search : Use a base64 image to search your database to recognize a person
\nAdd_singleImage: an API to add an image directly into your online Image database for Face Search
\nUser Id: available on your FaceX Dashboard
\n"}],"body":{"mode":"formdata","formdata":[{"key":"image_attr","value":"","description":"multipart/base64 encoded image or remote url of image
\n","type":"text"}]},"url":"https://www.facexapi.com/get_image_attr","description":"Get Image Attributes
\nFace Detect API/ Get Image Attributes is one of the APIs accessible using FaceAPI plans.
\nUse facial attributes api to detect faces, facial landmark, gender and age.
\nIn example request code generated by postman the payload should be changed as:\n
payload = {\"image_attr\":\"multipart/base64 encoded image or remote url of image\"}\nWe recommend an image resolution no higher than 1024x, since it could slow down the request process. Supported image formats are JPEG/PNG format.
\nThis parameter is optional.
If bounding box coordinates are available set values for key 'bboxes' in format x1,y1,x1+w1,y1+h1 and the API will provided analysis for just one face.
User Id
\n","key":"user_id","value":"c884995e2ffdc8467558"}],"body":{"mode":"formdata","formdata":[{"description":"multipart/base64 encoded image or remote url of image
\n","key":"img_1","type":"file","value":null},{"description":"multipart/base64 encoded image or remote url of image
\n","key":"img_2","type":"file","value":null}]},"url":"https://www.facexapi.com/compare_faces","description":"Compare if two faces belong to same person and gives confidence score
\nFace Compare API (Compare Faces) is one of the APIs accessible using FaceAPI plans.
\nReturns a confidence value which is greater than 0.6 then it is a match
\nFor better results,face standard such as 90 pixels from eye to eye is required.
\nIn example request code generated by postman the payload should be changed as:
\npayload = {\"img_1\":\"multipart/base64 encoded image or remote url of image\",\"img_2\":\"multipart/base64 encoded image or remote url of image\"}\nWe recommend an image resolution no higher than 1024x1024, as it could slow down the request process. Supported image formats are JPEG/PNG format.
\nThis parameter is optional.
If bounding box coordinates are available set 'face_det' to '0' and set values for key 'bboxes' in format x1,y1,x2,y2 .\nWhen specifying both bboxes value: bboxes_1=590,119,832,452&bboxes_2=601,58,772,313
This parameter is optional.
If bounding box coordinates are available set 'face_det' to '0' and set values for key 'bboxes' in format x1,y1,x2,y2 .\nWhen specifying both bboxes value: bboxes_1=590,119,832,452&bboxes_2=601,58,772,313
User Id
\n","key":"user_id","value":"c884995e2ffdc8467558"}],"body":{"mode":"formdata","formdata":[{"description":"multipart/base64 encoded image or remote url of image
\n","key":"img_1","type":"file","value":null},{"description":"multipart/base64 encoded image or remote url of image
\n","key":"img_2","type":"file","value":null}]},"url":"https://www.facexapi.com/match_faces","description":"Match if two faces belong to same person and get the Euclidean Distance and match result
\nFace Match API (Match Faces) is one of the APIs accessible using FaceAPI plans.
\nReturns the exact Euclidean distance between the provided faces and a 'Match/Not a Match' result.
\nIf Euclidean distance is less than the current Threshold(0.5), it is a match. If it is more than the current Threshold, the faces are not a match.
\nFor better results,face standard such as 90 pixels from eye to eye is required.
\nIn example request code generated by postman the payload should be changed as:
\npayload = {\"img_1\":\"multipart/base64 encoded image or remote url of image\",\"img_2\":\"multipart/base64 encoded image or remote url of image\"}\nWe recommend an image resolution no higher than 1024x1024, as it could slow down the request process. Supported image formats are JPEG/PNG format.
\nThis parameter is optional.
If bounding box coordinates are available set 'face_det' to '0' and set values for key 'bboxes' in format x1,y1,x2,y2 .\nWhen specifying both bboxes value: bboxes_1=590,119,832,452&bboxes_2=601,58,772,313
This parameter is optional.
If bounding box coordinates are available set 'face_det' to '0' and set values for key 'bboxes' in format x1,y1,x2,y2 .\nWhen specifying both bboxes value: bboxes_1=590,119,832,452&bboxes_2=601,58,772,313
User Id
\n","key":"user_id","value":"c884995e2ffdc8467558"}],"body":{"mode":"formdata","formdata":[{"description":"multipart/base64 encoded image or remote url of image
\n","key":"img","type":"file","value":null}]},"url":"https://www.facexapi.com/get_face_vec","description":"Get 128-D feature vector extracted from the face.
\nFace Vector API (get face vec) is the one of the APIs accessible using FaceAPI plans.
\nUpload a image containing face
\nFeature vector of one person can be compared with feature vector of another person using euclidean distance:If F1 and F2 are feature vector corresponding to two faces then:
\n if euclidean(F1,F2)>Threshold(=0.6):\n Same Person\n \nExample:
\nFeature vector = [-0.133286, 0.0671902, 0.0648706, ............., -0.0325235, -0.0260845, 0.0237684, -0.0272609, -0.106857]
\npayload = {\"img\":\"multipart/base64 encoded image or remote url of image\"}This parameter is optional.
If bounding box coordinates are available set 'face_det' to '0' and set values for key 'bboxes' in format x1,y1,x2,y2 .\n'bboxes' values should be passed as string
Raw image File with Single face (please ensure unique file name)
\n","type":"file","value":null},{"key":"user_id","value":"c884995e2ffdc8467558","description":"User id as provided in your user dashboard
\n","type":"text"},{"key":"name","value":"Person's Name","description":"Name to be added to Dashboard
\n","type":"text"}]},"url":"https://search.facex.io:8443/images/singleImage/","description":"Add SingleImage to your online database
\nOnce you have an active Face Search Plan you can create an online database.
\nAdd singleImage API allows you to add an Image file directly into your online Image Database through a Post Request
\nThe API will work as long as you have an active Face Search Plan and you have not exceeded your database limit
\nRaw Image
\n","key":"image","type":"file","value":null},{"description":"User Id available in your FaceX Dashboard
\n","key":"user_id","type":"text","value":"c884995e2ffdc8467558"}]},"url":"https://search.facex.io:8443/auth/searchWithRawImage","description":"Search your online database using an Image file
\nOnce you have an active Face Search Plan you can create an online database directly from the user portal.
\nAfter the Database is created, you can compare a new photo against all the registered faces to find the person's identity
\nSearch by Raw Image API allows you to provide an Image file as input and get 3 closest matches from your database as output
\nAlong with the File Name and Registered Name of the closest possible matchs, the API will also provide Euclidian distance as output.
\nOnly if the Euclidian distance is less than 0.5, can the provided result be considered as a possible match
\nSearch your online database using Base64
\nOnce you have an active Face Search Plan you can create an online database directly from the user portal.
\nAfter the Database is created, you can compare a new photo against all the registered faces to find the person's identity
\nSearch by Base64 API allows you to provide an Image file as input and get 3 closest matches from your database as output
\nWhen using Base64, please ensure the encoded image has no Imagetag(JGEP,PNG) mentioned in the encoding.
\nAlong with the File Name and Registered Name of the closest possible matchs, the API will also provide Euclidian distance as output.
\nOnly if the Euclidian distance is less than 0.5, can the provided result be considered as a possible match
\nSearch your online database using an URL or Base64
\nOnce you have an active Face Search Plan you can create an online database directly from the user portal.
\nAfter the Database is created, you can compare a new photo against all the registered faces to find the person's identity
\nURL Search allows you to provide an Image URL as input and get 3 closest matches from your database as output
\nAlong with the File Name and Registered Name of the closest possible matchs, the API will also provide Euclidian distance as output.
\nOnly if the Euclidian distance is less than 0.5, can the provided result be considered as a possible match
\nDelete an image from your online database
\nYou can delete an image directly from your online database.
\nWhen an image is added to the image database, a unique image_id is provided which is associated with that image.
\ndeleteImageFromDB allows you to delete an image using the image_id
\nRaw image File with Single face (please ensure unique file name)
\n","key":"image","type":"file","value":null},{"description":"User id as provided in your user dashboard
\n","key":"user_id","type":"text","value":"c884995e2ffdc8467558"},{"description":"Name to be added to Dashboard
\n","key":"name","type":"text","value":"Person's Name"},{"key":"UID","value":"Unique ID (email or Employee ID)","description":"Unique ID for registering multiple photos for one person
\n","type":"text"}]},"url":"https://search.facex.io:8443/images/singleImageWithUID","description":"Add SingleImage to your online database
\nOnce you have an active Face Search Plan you can create an online database.
\nAdd singleImagewithUID API allows you to add an Image file directly into your online Image Database through a Post Request along with the Unique ID the person has to be registered under
\nThe API will work as long as you have an active Face Search Plan and you have not exceeded your database limit
\nRaw Image
\n","key":"image","type":"file","value":null},{"description":"User Id available in your FaceX Dashboard
\n","key":"user_id","type":"text","value":"c884995e2ffdc8467558"},{"key":"uid","value":"","description":"Unique ID for registering multiple photos for one person
\n","type":"text"}]},"url":"https://search.facex.io:8443/auth/searchWithUID","description":"Search your online database using an Image file & Unique ID
\nOnce you have an active Face Search Plan you can create an online database directly from the user portal.
\nAfter the Database is created, you can compare a new photo against photos registered under a unique ID(UID) to authenticate the person's identity
\nSearch by UID allows you to provide an Image file and a previously registered Unique ID (UID) as input and determine if the image matches the photos registered to the UID
\nAlong with the File Name and Registered Name of the closest possible matchs, the API will also provide Euclidian distance as output.
\nOnly if the Euclidian distance is less than 0.5, can the provided result be considered as a possible match
\n