Troubleshooting Common Issues with the Face Search API

Introduction
While integrating the Face Search API, you may encounter various errors related to parameters, images, or timeouts. This guide addresses the most common issues and how to troubleshoot them effectively.

1. Invalid Image Format

Error Message: IMAGE_INVALID_FORMAT
Cause: The image format must be either JPEG or PNG, but your uploaded file was in an unsupported format.
Solution: Convert the image to either .jpg or .png format before making the API request.

2. Invalid Image Size

Error Message: IMAGE_INVALID_SIZE
Cause: The uploaded image exceeds the size limitations (2 MB or dimensions beyond 4096x4096 pixels).
Solution: Ensure the image is smaller than 2 MB and meets the resolution requirements (128x128 to 4096x4096 pixels).

3. Invalid ID Number

Error Message: INVALID_ID_NUMBER
Cause: The ID number provided is either too short or contains non-numeric characters. The ID number must be a 16-digit numeric string.
Solution: Verify the ID number, ensuring it is exactly 16 digits with no negative or floating-point values.

4. Face Search Timeout

Error Message: FACE_SEARCH_TIMEOUT
Cause: The request took too long to process, possibly due to network delays or server overload.
Solution: Retry the request after a short delay. Implement a retry mechanism in your code to handle this error gracefully.

5. No Face Detected

Error Message: NO_FACE_DETECTED
Cause: The API could not detect a face in the uploaded image. This might be due to poor image quality, occlusions, or improper framing.
Solution: Ensure the image contains a clear, front-facing photo of the person’s face with no obstructions or distortions.

6. Parameter Errors

Error Message: PARAMETER_ERROR
Cause: One or more request parameters are missing or incorrectly formatted.
Solution: Double-check that all required parameters are included in the API call and formatted correctly (e.g., idNumber, faceImage, referId, imageType).

7. Account Disabled

Error Message: ACCOUNT_DISABLED
Cause: Your account may have been deactivated or is not authorized to use the API.
Solution: Contact your account manager or technical support to resolve any account-related issues.

Conclusion
By understanding the common errors and applying the recommended solutions, you can avoid interruptions while integrating the Face Search API. Implementing retry mechanisms and thorough validation of your request parameters will improve reliability and user experience.

Further Assistance

If you continue to experience issues despite following the guidelines provided, please contact our support team for further assistance: