Appearance
Create Photo Match Request
Accepts requests for Photo Matching. All requests are queued and processed as soon as possible.
Endpoints
| Environment | URL |
|---|---|
| Sandbox | https://api-test.streamline.laboremus.ug/idv/api/biometrics/photomatch?v=2.0 |
| Production | https://api.streamline.laboremus.ug/idv/api/biometrics/photomatch?v=2.0 |
Request
Request Type : POST
Authorization
INFO
Always add your Subscription key to the request.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| v | string | yes | The API Version |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| idFrontPhoto | File | yes | File to be verified |
| selfie | File | yes | Reference file to check the source file |
| externalReference | string | no* | External Reference for the request |
INFO
Allowed image formats: jpeg, jpg, ico, png, bmp, gif, tif, tiff, webp. Max size is 5Mb
Example Request Body
bash
curl 'http://id-test.streamline.laboremus.ug/api/biometrics/photomatch?api-version=' \
--request POST \
--header 'Content-Type: multipart/form-data' \
--form 'externalReference=' \
--form 'idFrontPhoto=@filename' \
--form 'selfie=@filename'curl 'http://id-test.streamline.laboremus.ug/api/biometrics/photomatch?api-version=' \
--request POST \
--header 'Content-Type: multipart/form-data' \
--form 'externalReference=' \
--form 'idFrontPhoto=@filename' \
--form 'selfie=@filename'Response
Response Values
| Name | Type | Description |
|---|---|---|
| externalReference | string or null | External Reference for the request if it exists |
| id | string | Unique Id of the request |
| requestUri | string or null | The Url to find the request |
| status | string (Enum: Pending, Completed, Failed) | The stage of processing at which the request is |
Example Response Body
Content type
application/json
json
{
"status": "Pending",
"externalReference": null,
"id": "3a78a929-ed39-485a-b041-b4bb2176225b",
"requestUri": "/api/biometrics/photomatch/3a78a929-ed39-485a-b041-b4bb2176225b?v=2.0"
}{
"status": "Pending",
"externalReference": null,
"id": "3a78a929-ed39-485a-b041-b4bb2176225b",
"requestUri": "/api/biometrics/photomatch/3a78a929-ed39-485a-b041-b4bb2176225b?v=2.0"
}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 |