post
https://api.verihubs.com/v1/face/enroll
This method helps you to enroll image containing face.
You will receive a response consists of message and an error code if the request fails to process. The following is a list of error codes.
| Error status | Error code | Description |
|---|---|---|
| 200 | FAIL_ON_1 | fail on liveness |
| 200 | FAIL_ON_2 | fail on attribute |
| 200 | FAIL_ON_3 | fail on liveness and attribute |
| 200 | FAIL_ON_4 | fail on quality |
| 200 | FAIL_ON_5 | fail on liveness and quality |
| 200 | FAIL_ON_6 | fail on attribute and quality |
| 200 | FAIL_ON_7 | fail on liveness, attribute, and quality |
| 200 | FAIL_ON_8 | fail on number of face (nface) |
| 200 | FAIL_ON_9 | fail on number of face (nface) and liveness |
| 200 | FAIL_ON_10 | fail on number of face (nface) and attribute |
| 200 | FAIL_ON_11 | fail on number of face (nface), attribute, and liveness |
| 200 | FAIL_ON_12 | fail on number of face (nface) and quality |
| 200 | FAIL_ON_13 | fail on number of face (nface), quality, and liveness |
| 200 | FAIL_ON_14 | fail on number of face (nface), quality, and attribute |
| 200 | FAIL_ON_15 | fail on number of face (nface), quality, attribute, and liveness |
| 400 | INVALID_PAYLOAD | no value in payload or empty string more than 1 |
| 400 | INVALID_PAYLOAD_IMAGE_MISSING | invalid payload image not a standard b64/url or image empty string |
| 400 | INVALID_PAYLOAD_SUBJECT_ID_MISSING | invalid payload subject id is empty string |
| 400 | INVALID_PAYLOAD_IMAGE_SIZE | invalid payload image size too large |
| 400 | MISSING_PAYLOAD_IMAGE | missing payload image |
| 400 | INVALID_PAYLOAD_IMAGE_TIMEOUT | timeout getting image from url in 15 seconds |
| 400 | INVALID_PAYLOAD_IMAGE_FORMAT | image unable to be decoded/got from url OR invalid image extension |
| 400 | FACE_NOT_DETECTED | face not detected from image |
| 400 | INVALID_PAYLOAD_QUALITY_VALIDATION_DEPENDENCY | is_quality must be true if validate_quality true |
| 400 | INVALID_PAYLOAD_ATTRIBUTE_VALIDATION_DEPENDENCY | is_attribute must be true if validate_attribute true |
| 400 | INVALID_PAYLOAD_LIVENESS_VALIDATION_DEPENDENCY | is_liveness must be true if validate_liveness true |
| 403 | INSUFFICIENT_QUOTA_ENROLL | usage reach it quota limit for enroll (only appears on testing mode) |
| 403 | INSUFFICIENT_QUOTA_LIVENESS | usage reach it quota limit for liveness (only appears on testing mode) |
| 500 | INTERNAL_SERVER_ERROR | internal server error |