API Reference
Add a new face
Upload and store a new facial image within a specific collection
POST
Add a new face to a collection
The “Add a new face to a collection” section allows users to easily upload and store a new facial image within a specific collection. By utilizing this functionality, users can efficiently manage and organize their facial recognition data by adding new faces to their existing database. This section streamlines the process of expanding collections with additional facial data for enhanced accuracy and efficiency in facial recognition applications.
Request
Headers
The API key used for authentication and access control. This header parameter is required for authorization to add a new face to a collection.
Body Parameters
Response
Success Response (200)
Error Responses
Bad Request (400)
Identifies the specific error for troubleshooting:
- 6010: CollectionId is required
- 6011: WorkspaceId is required
- 6012: Fail to add face
- 6013: Cannot find collection info
- 6014: This collection is unavailable
- 6015: Failed to validate liveness of face
- 6016: Image size is too large
- 6017: Unsupported image format
Forbidden (403)
Related documents
Face ID Overview
Learn about Face ID API for facial recognition and identity verification
Face ID: How It Works
Understanding the Face ID workflow and integration process
Face ID Best Practices
Best practices for implementing Face ID in your application
Body
application/json
Response
Face successfully added to collection