REST API reference¶
This reference contains all endpoints the IAD Server provides.
api_version¶
GET /api_version
Returns the information about IAD Server:
- Version of IAD Server.
- Expiration date for the license.
{
"product": "IADServer",
"version": "1.7.3",
"expirationDate": "2025-08-25T23:59:59Z"
}
check_capture_liveness¶
POST /check_capture_liveness
Performs a capture liveness check on a bundle generated by IAD client. Bundle should be sent as an application/octet-stream request.
On success response will contain capture_liveness field
{ "capture_liveness": { "probability": 1.0 } }
On error response will contain message field with error description and error_code field with the corresponding error code for image validation errors or UNKNOWN for any other error.
{"timestamp":"2222-1-30T00:30:00.000+00:00","status":400,"error":"Bad Request","message":"Failed to parse file","path":"/check_capture_liveness","error_code":"UNKNOWN"}
This request can return the following errors:
| HTTP code | Message | Error code | Description |
|---|---|---|---|
| 400 | Failed to parse file | UNKNOWN | File is not a correct encrypted blob payload or is corrupted |
| 400 | Failed to read a meta data | UNKNOWN | Encrypted blob data is not generated with the correct format |
| 400 | Failed to decrypt message | UNKNOWN | Wrong public-private key pair is set on server and capture library (see Payload encryption) |
extract_image¶
POST /extract_image
Extracts an image from a bundle. Bundle should be sent as an application/octet-stream request.
The response contains binary data with an image/jpeg media type.
This request can return the following errors:
| HTTP code | Message | Description |
|---|---|---|
| 400 | Failed to parse file | File is not a correct encrypted blob payload or is corrupted |
| 400 | Failed to decrypt message | Wrong public-private key pair is set on server and capture library (see Payload encryption) |
System endpoints¶
health¶
GET /health
Provides a means of checking the health of a running Server. Returns 200 if everything is ok, and 503 if there is a problem.
metrics¶
GET /metrics
The metrics in the Prometheus format. You can use them to monitor a license expiration date.