StreamlineAppearance
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/photomatches/{id}?v=2.0 |
| Production | https://api.streamline.laboremus.ug/idv/api/photomatches/{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 |
Response
Response Values
| 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 |
| sourceImage | string or null | The unique id for the source image |
| targetImage | string or null | The unique id for the target image |
| initiator | string or null | The names for the request initiator |
| initiatorId | string or null | The unique id for the request initiator |
| receivedAt | string or null (date-time) | Date the request was created |
| completedAt | string or null (date-time) | Date the request was submitted to NIRA |
| requestStatus | string (Enum: Pending, Completed, Failed) | The stage of processing at which the request is |
result
The result for a photo match request
| Name | Type | Description |
|---|---|---|
| match | boolean | Indicates if there is a match. |
| score | double or null | A number between 0 and 1 representing the similarity score of the two photos |
| percentageScore | string or null | A number between 0 and 100 representing the similarity score of the two photos |
| isError | boolean | Indicates if there is an error with the request |
| errorMessage | string or null | The reason why the processing was unsuccessful |
Example Response Body
Content type
application/json
json
{
"id": "3a16b2ca-b30e-4302-9834-192ea16cc946",
"externalReference": null,
"result": {
"match": true,
"score": 0.99764,
"percentageScore": "99.76%",
"isError": false,
"errorMessage": null
},
"sourceImage": "85d2b4f3-4b53-4995-9d61-c89d6f2d22e9",
"targetImage": "1b4db7eb-4057-5ddf-91e0-36dec72071f5",
"initiator": "John Doe",
"initiatorId": "a704eede-2d7f-4803-bdc4-58fb922edaed",
"receivedAt": "2024-11-18T07:54:59.57633+03:00",
"completedAt": "2024-11-18T07:55:03.95475+03:00",
"requestStatus": "Completed"
}{
"id": "3a16b2ca-b30e-4302-9834-192ea16cc946",
"externalReference": null,
"result": {
"match": true,
"score": 0.99764,
"percentageScore": "99.76%",
"isError": false,
"errorMessage": null
},
"sourceImage": "85d2b4f3-4b53-4995-9d61-c89d6f2d22e9",
"targetImage": "1b4db7eb-4057-5ddf-91e0-36dec72071f5",
"initiator": "John Doe",
"initiatorId": "a704eede-2d7f-4803-bdc4-58fb922edaed",
"receivedAt": "2024-11-18T07:54:59.57633+03:00",
"completedAt": "2024-11-18T07:55:03.95475+03:00",
"requestStatus": "Completed"
}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 |