QualityCheck Web API
With the quality check Web API a single facial media sample can be uploaded to the BWS to perform a rigorous quality check according to ICAO (International Civil Aviation Organization) requirements for machine readable travel documents (MRTDs), which include a standard for the digital image quality of facial images, defining requirements for photographic and digital characteristics (see ISO/IEC 19794-5:2011, ISO/IEC 29794-5:2010 or ICAO Document 9303).
Quality checks for traits other than face are currently not supported with this API.
The quality checks performed with this method are descried with the SOAP Quality Check API.
|full||Optional, defaults to |
|issuer||Optional, defaults to ICAO. The quality checks of facial images can be performed according to document-issuer specific settings defined by this parameter. Currently supported issuers are: ICAO (the default settings as specified by ICAO), BioID (similar to ICAO but with a bigger token image) and various ISO 3166-1 alpha-2 country codes specifying the document issuing country.|
|state||Optional parameter that is simply passed through to the BWS log and to the returned object.|
Request Body Format
This API call requires Basic Authentication, i.e. you have to provide an HTTP authorization header using the authorization method Basic and the base64 encoded string App-ID:App-Secret. To receive the necessary BWS Web API access data (App-ID and App-Secret) you have to register your application on the BWS Portal first. This requires a valid BWS subscription.
The QualityCheck Web API returns a
QualityCheckResult object, which informs about the Success of the check and lists Errors that occurred during the check. Refer to the SOAP Quality Check API for a list of possible error-codes. Additionally the coordinates of the found EyeCenters are returned. Finally the processed image is returned in the ProcessedSample element if possible, encoded into a Data-URL.
Response Body Format
Response HTTP Status Codes
The call returns one of the standard HTTP status codes. With the success code (200) you receive the
QualityCheckResult object in the body text. With erroneous codes you typically receive a Message field within the body text describing the error. The most commonly return codes are:
|200 OK||The response body contains the |
|400 Bad Request||No or an invalid sample data has been uploaded.|
|401 Unauthorized||No or an invalid authentication header has been specified. This call requires Basic Authentication.|
|403 Forbidden||Access has been denied (typically due to a wrong or invalid app-id).|
|500 Internal Server Error||A server side exception occurred.|