π API Guide for Developer
Welcome to the Face IDENTITY API guide. Face Identity offers a suite of APIs enabling you to manage collections, add and delete faces, and perform face searches within a designated workspace. To ensure secure API communication, all requests must include a valid API key in the header.
Getting Started
Authentication
For all requests to the Face ID API, you must provide your API key in the request header as follows:
Replace your_api_key_here with your actual API key.
'x-api-key' : 'string'
Error (403)
Error code | Error message | Description |
---|---|---|
6039 | API Key is required. | Missing API Key: x-api-key is missing in header |
6040 | Access Denied: API Key is unavailable. | Unregistered API Key: Access restriction |
Below is a list of APIs supported by FACE IDENTITY.
API Name | Type | Link |
---|---|---|
Add Face | POST | https://docs.argosidentity.com/docs/post-add-face |
Delete Face | DELETE | https://docs.argosidentity.com/docs/delete-delete-face |
Get List of Faces | GET | https://docs.argosidentity.com/docs/get-get-list-of-faces |
Search Face | POST | https://docs.argosidentity.com/docs/post-search-face-by-image |
Updated 2 months ago
Whatβs Next