Result Web API
Fetches the result of the last biometric operation (i.e. verification, identification, enrollment or liveness detection) performed with the token provided. Typically this is necessary if the token has been transmitted to another application to perform the biometric task and you now want to know what the result has been. An example for this procedure is the unified user interface.
|access_token||Required. The BWS web token that was used to perform the biometric task.|
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.
You should use the same authentication information as it was used to request the token with the Token Web API, as the API will verify whether the token matches the application identified by this authentication information.
The Result Web API returns an
OperationResult object describing the result of the last biometric operation. The operation itself is in the Action element, the Biometric Class ID of the involved user or partition in the BCID field. The Success flag indicates whether the operation succeeded or not. In case that the operation failed (i.e. Success is set to
false) an error is reported:
|null (i.e no error)||In the case of a verification operation this simply indicates that the user has not been recognized. Enrollment should always report an error if the operation fails.|
|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.|
|NoTemplateAvailable||The user has not yet been enrolled.|
|NotEnoughSamples||Not enough valid samples have been provided.|
|ExecutionOfJobTimedOut||Server seems to be too busy.|
In case that the operation was an identification, a sorted array of BCIDs together with their scores is returned in the Matches element, containing a list of BCID and Score elements.
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 described
OperationResult 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 |
|204 No Content||No result has been logged for the specified token.|
|400 Bad Request||No or an invalid token has been specified.|
|401 Unauthorized||No or an invalid authentication header has been specified.|
|500 Internal Server Error||A server side exception occurred.|
For a complete sample refer to the walkthrough.