StreamlineAppearance
Search KCCA Trading Licence verification Requests
Endpoint for searching for KCCA Licence Verification request by selected criteria.
Endpoint
https://kcca-api-test.streamline.laboremus.ug/api/verifylicensehttps://kcca-api-test.streamline.laboremus.ug/api/verifylicenseRequest
Request Type : GET
Header Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| Bearer | string(JwtToken) | no | The token for accessing the resource |
Query Parameters Values
| Name | Type | Required | Description |
|---|---|---|---|
| v | string | yes | The version of the API |
| Id | string | no | Search for a request using the unique ID. |
| ApplicationReference | string | no | Search for a request using the application reference. |
| Date.From | string(date-time) | no | The start date of the date range. |
| Date.To | string(date-time) | no | The end date of the date range. |
| Coin | string | no | Search using City Operator Identification Number (COIN). |
| Status | string (Pending,Successful,Failed) | no | Search using the status of the request. |
| BusinessName | string | no | Search using the business Name. |
| TaxPayerName | string | no | Search using the tax payer Name. |
| Tin | string | no | Search using the Tax Identification Number. |
| Division | string | no | Search using the division in which the business is situated. |
| Parish | string | no | Search using the parish in which the business is situated. |
| Category | string | no | Search using the category in which the business is. |
| Nature | string | no | Search using the category in which the business is. |
| PRN | string | no | Search using the category in which the business is. |
| Initiator | string | no | Search using the user that initiated the request. |
| Amount | number (double) | no | Search using the Amount paid by a business. |
| Year | integer (int32) | no | Search using the Year of the licences for a business. |
| Pagination.Page | integer (int32) | no | Page number |
| Pagination.ItemsPerPage | integer (int32) | no | Number of requests returned per page. |
| Pagination.TotalItems | integer (int32) | no | Total number of requests. |
Response
Content type
application/json
Response Values
| Name | Type | Description |
|---|---|---|
| pagination | object (uuid) | The details of pagination of the requests. |
| requests | Array of objects or null | A list of the requests that match a search criteria. |
pagination
| Name | Type | Description |
|---|---|---|
| page | integer | Page number |
| itemsPerPage | object | Number of requests returned per page |
| totalItems | string or null | Total number of requests |
requests
| Name | Type | Description |
|---|---|---|
| id | string (uuid) | The unique Id of the request. |
| applicationReference | string or null | The application reference of a given verification request. |
| status | string (Pending,Successful,Failed) | The code of the error returned. |
| text | string or null | The verification description. |
| success | boolean | True if the request was processed, and false if it was not processed. |
| isError | boolean | True if there was an error that occurred during the verification process. |
| errorCode | integer or null (int32) | The error code, if isError is true. |
| coin | integer or null (int32) | The City Operator Identification Number. |
| taxPayerName | string or null | The name of the tax-payer. |
| tin | string or null | The Tax Identification Number of the tax-payer. |
| businessName | string or null | The name of the business. |
| category | string or null | The category in which the business is. |
| nature | string or null | The nature of the business. |
| year | integer or null (int32) | The year in which the business was licenced. |
| issueDate | string or null (date-time) | The date in which the licence was issued. |
| expiryDate | string or null | The expiry date of the licence. |
| amount | number or null (double) | The amount paid by the business. |
| division | string or null | The division in which the business is situated. |
| parish | string or null | The parish in which the business is situated. |
| village | string or null | The village in which the business is situated. |
| street | string or null | The street on which the business is situated. |
| building | string or null | The building in which the business is situated. |
| shopNo | string or null | The shop number which the business is situated. |
| prn | string or null | The Payment Reference Number used to track payments. |
| initiator | string or null | The user that initiated the request. |
| sentAt | string or null (date-time) | Date the request was sent. |
| processedAt | string or null (date-time) | Date at which the verification request was processed. |
| createdAt | string or null (date-time) | Date at which the verification request was created. |
| lastUpdated | string or null (date-time) | Date at which the verification request was last updated. |
Example Response Body
json
{
"pagination": {
"page": 0,
"itemsPerPage": 0,
"totalItems": 0
},
"requests": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"applicationReference": "string",
"status": "Pending",
"text": "string",
"success": true,
"isError": true,
"errorCode": 0,
"coin": 0,
"taxPayerName": "string",
"tin": "string",
"businessName": "string",
"category": "string",
"nature": "string",
"year": 0,
"issueDate": "2019-08-24T14:15:22Z",
"expiryDate": "string",
"amount": 0,
"division": "string",
"parish": "string",
"village": "string",
"street": "string",
"building": "string",
"shopNo": "string",
"prn": "string",
"initiator": "string",
"sentAt": "2019-08-24T14:15:22Z",
"processedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z"
}
]
}{
"pagination": {
"page": 0,
"itemsPerPage": 0,
"totalItems": 0
},
"requests": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"applicationReference": "string",
"status": "Pending",
"text": "string",
"success": true,
"isError": true,
"errorCode": 0,
"coin": 0,
"taxPayerName": "string",
"tin": "string",
"businessName": "string",
"category": "string",
"nature": "string",
"year": 0,
"issueDate": "2019-08-24T14:15:22Z",
"expiryDate": "string",
"amount": 0,
"division": "string",
"parish": "string",
"village": "string",
"street": "string",
"building": "string",
"shopNo": "string",
"prn": "string",
"initiator": "string",
"sentAt": "2019-08-24T14:15:22Z",
"processedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"lastUpdated": "2019-08-24T14:15:22Z"
}
]
}Error Response
400 Bad Request
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 |
401 Unauthorized
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 Forbidden
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 Not Found
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 Server 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 |