Biointellic - API
Biointellic Liveness is Imageware's anti-spoofing facial recognition system designed to prevent secured system breaches through accredited biometric authentication.
FaceMatch is Imageware's face-authenticating system that enables users to compare two face images and determine match pass or fail.
Retrieve Auth Token (JWT)#
POST {biointellic_url}/api/authenticate
Creates a JWT token to authorize clients accessing secured Biointellic and FaceMatch functions.
The returned access_token will need to be included with all calls made to Biointellic and FaceMatch, otherwise a 401 - Unauthorized error is returned.
JWT tokens expire often and will need to be renewed frequently and automatically.
Example Request
Example Response
Request Headers
Authorization: Basic {base64_creds}
Where {base64_creds} is the base64 encoding of {userId}:{password}
For example:
userId = "admin" and password = "hunter2" would produce base64 creds of
YWRtaW46aHVudGVyMg== thus giving a final header of,
Authorization: Basic YWRtaW46aHVudGVyMg==
Biointellic Liveness#
POST {biointellic_url}/api/liveness
Liveness calculates the likelihood that the provided face image is spoofed.
The request MUST include an Authorization header filled with Bearer {auth_token} where {auth_token} is a valid JWT.
The request MUST contain an image file uploaded as multipart/form-data
The request MAY contain a debug flag at the end of the URI. If you want Imageware
to store uploaded images for debugging purposes, please set ?debug=true, as
any other value will default to NOT store images.
note
This will make the request take slightly longer#
Image Requirements
Attached image files must adhere the following parameters:
- Recommended height: 720 or 1080px; Minimum supported height: 480px
- Image format: PNG
- Out-of-plane rotation (face pitch and yaw) angle: -20±3 — 20±3 °
- In-plane rotation (face roll) angle: -30±3 — 30±3 °
- Interpupillary distance: ~90±5 px
- Minimal face size: 224px
- Tinted eyewear, motion blur, poor lighting, image filters, lens-altering (such as "fish eye"), and other factors can interfere with validation success
Example Request
Example Response (Good Image with Passing Score)
Example Response (Good Image with Failing Score)
Example Response (Bad Image)
With this error code and message, Imageware can help troubleshoot the image quality.
Biointellic Face Match#
POST {biointellic_url}/api/match
Performs a biometric match comparison between two face images using Imageware's patented algorithms and returns a pass or fail flag and confidence score: PASS ≥ 48.
The request MUST include an Authorization header filled with Bearer {auth_token} where {auth_token} is a valid JWT.
The request MUST contain two image files uploaded as multipart/form-data
The request MAY contain a debug flag at the end of the URI. If you want Imageware
to store uploaded images for debugging purposes, please set ?debug=true, since
any other value will default to NOT store images.
note
This will make the request take slightly longer#
Image Requirements
Attached image files must adhere to the following parameters:
- Format: JPG / JPEG or PNG
- Dimensions: Minimum 150x150; Maximum 1024x1024px
- File size: Maximum 2MB
Example Request
Example Response (Good Images with Passing Score)
Example Response (Good Images with Failing Score)
Example Response (Bad Images)
With this error code and message, Imageware can help troubleshoot the image quality.