Appearance
Get Photo Match Request Details
Endpoint for getting photo match request details by Id.
Endpoints
| Environment | URL |
|---|---|
| Sandbox | https://api-test.streamline.laboremus.ug/idv/api/biometrics/photomatch/{id}?v=2.0 |
| Production | https://api.streamline.laboremus.ug/idv/api/biometrics/photomatch/{id}?v=2.0 |
Request
Request Type : GET
Authorization
INFO
Always add your Subscription key to the request.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string(uuid) | yes | The Unique ID of the id photo match request |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| v | string | yes | The API Version |
Result
The result for a photo match request
| Name | Type | Description |
|---|---|---|
| id | string | Unique Id of the request |
| externalReference | string or null | External reference for the request if it exists |
| result | object | The result for a photo match request |
| idFrontFace | string or null | The unique id for the ID front face image |
| selfie | string or null | The unique id for the selfie image |
| initiator | string or null | The names of the request initiator |
| initiatorId | string or null | The unique id of the request initiator |
| receivedAt | string or null (date-time) | Date the request was received |
| completedAt | string or null (date-time) | Date the request was completed |
| requestStatus | integer (Enum: 1, 2, 3) | The stage of processing at which the request is |
Example Response Body
Content type
application/json
json
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalReference": null,
"result": {
"match": null,
"score": null,
"comment": null,
"status": null,
"percentageScore": null,
"isError": null,
"errorMessage": null
},
"idFrontFace": null,
"selfie": null,
"initiator": null,
"initiatorId": null,
"receivedAt": null,
"completedAt": null,
"requestStatus": 1
}{
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalReference": null,
"result": {
"match": null,
"score": null,
"comment": null,
"status": null,
"percentageScore": null,
"isError": null,
"errorMessage": null
},
"idFrontFace": null,
"selfie": null,
"initiator": null,
"initiatorId": null,
"receivedAt": null,
"completedAt": null,
"requestStatus": 1
}Error Response
400 The request data is invalid
application/json
| Name | Type | Description |
|---|---|---|
| type | string or null | Type of error response |
| title | string or null | The title of the error response |
| status | integer(int32) | The status of the error response |
| traceId | string or null | The traceId of the error request producing the error |
| errors | object | Object defining the errors |
errors
| Name | Type | Description |
|---|---|---|
| property | Array of strings | The definition of the errors |
401 Not authorized to access the endpoint
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
403 Refuse to authorize access to the endpoint
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
404 Request does not exist
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
500 The server encountered an unexpected error
application/json
| Name | Type | Description |
|---|---|---|
| error | object(Error) | Type of error response |
Error
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |