Identify Web API
Performs a one-to-many comparison of the uploaded samples with stored biometric templates in order to identify the individuals that are most likely represented by the given samples.
The samples to be identified are those that have previously uploaded (see Upload Web API) using the same token that has been used for the authorization of this call. These samples are fetched from the BWS storage (and removed from the storage, so that they cannot be used for any other purpose), sent to the live data detection procedure and finally, if the liveness detection determined that the given data is live data (or liveness detection is disabled) transferred to the identification procedure.
The biometric templates which are compared against the samples are taken from the storage and partition as specified by the BCID in the provided BWS token.
This API call requires BWS Token Authentication, i.e. you have to provide an HTTP authorization header using the authorization method Bearer (for compatibility issues you can also use the JWT identifier) and a previously issued BWS token, which can be requested using the Token Web API.
Optional, defaults to the setting in the BWS Token. A boolean parameter to explicitly switch on live data detection.
When set to
No live data detection will be performed if the token does not require liveness detection and this flag is set to
|maxResults||Optional, defaults to |
The Identify Web API returns a
IdentifyResult object that contains the flag Success, which shows, whether the identification could be performed or not. In case that the identification failed (i.e. Success is set to
false) an Error is reported:
|null (i.e no error)||Typically there are simply no users enrolled in the specified partition.|
|LiveDetectionFailed||The submitted samples do not prove that they are recorded from a live person.|
|ChallengeResponseFailed||The submitted samples do not prove that they are recorded from a live person as they do not fulfill the challenge-response criteria.|
|NotEnoughSamples||Not enough valid samples have been provided.|
|ExecutionOfJobTimedOut||Server seems to be too busy.|
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
IdentifyResult object in the body text. With erroneous codes you typically get a Message field within the body text describing the error. The most commonly returned codes are:
|200 OK||The response body contains the |
|400 Bad Request||No samples have been uploaded.|
|401 Unauthorized||No or an invalid authentication header has been specified. This call requires JWT Bearer Token Authentication. If a BWS token has been passed, this error typically indicates that the token has expired.|
|403 Forbidden||The number of allowed identification attempts with this token has been exceeded.|
|500 Internal Server Error||A server side exception occurred.|