Mastering Face Search v2.0 API - Frequently Asked Questions

1. What is Face Search v2.0 API? Face Search v2.0 is an advanced API for facial recognition, allowing users to create and manage face sets, add and delete faces, and perform face searches with high accuracy.

2. How do I authenticate with the API? Use the X-ACCESS-TOKEN header for authentication. Refer to the Token Authentication section in the API documentation to generate a valid token.

3. What is the structure of the API response? The response includes the following fields:

• code: Status code of the API response.

• transactionId: Unique identifier for the request.

• pricingStrategy: Indicates if the request is free or paid (FREE/PAY).

• message: Error message for debugging.

• data: Data object specific to the API call.

• extra: Additional response information.

4. How do I create a new FaceSet? Send a POST request to /intl/openapi/face-search/facesets with the required fields:

• name: Unique name (max 32 characters, supports letters, numbers, underscores, and hyphens).

• country: Alpha-2 country code.

5. What are the possible responses for creating a FaceSet?

• SUCCESS: The FaceSet ID is returned.

• PARAMETER_ERROR: Occurs if a FaceSet with the same name already exists.

6. How do I retrieve details of a specific FaceSet? Use the Get FaceSet by ID API by sending a GET request to /intl/openapi/face-search/facesets with the required id parameter.

7. Can I list all FaceSets? Yes, use the List all FaceSets API by sending a GET request to /intl/openapi/face-search/facesets/list.

8. How do I delete a FaceSet? Send a POST request to /intl/openapi/face-search/facesets/delete with the id of the FaceSet you want to delete.

9. How do I add a face to a FaceSet? Send a POST request to /intl/openapi/face-search/facereferences with the following fields:

• faceSetId (required)

• faceImage (required)

• Optional fields: externalReferenceId, idNumber, idCardType, country, name.

10. What are common errors when adding faces?

• NO_FACE_DETECTED: No face detected in the image.

• IMAGE_TYPE_NOT_SUPPORTED: Image format not supported.

• IMAGE_SIZE_TOO_LARGE: File size exceeds 2MB.

• IMAGE_RESOLUTION_ERROR: Resolution must be between 256x256 and 4096x4096.

11. How do I perform a face search? Use the Search APIs by sending a request to /intl/openapi/face-search/search with fields like:

• faceSetId (required)

• faceImage (required)

• Optional fields: topK, threshold.

12. Where can I find more information about the API? Visit the Glossary section in the API documentation for detailed information about terms and response codes.