StreamlineAppearance
Get KCCA Trading Licence Verification Details By Id
Endpoint for getting details of a specific KCCA licence Verification request by unique id.
Endpoint
https://kcca-api-test.streamline.laboremus.ug/api/verifylicense/{id}https://kcca-api-test.streamline.laboremus.ug/api/verifylicense/{id}Request
Request Type : GET
Path Parameters Values
| Name | Type | Required | Description |
|---|---|---|---|
| id | string(uuid) | yes | The Unique ID of a KCCA Licence request |
Query Parameters Values
| Name | Type | Required | Description |
|---|---|---|---|
| v | string | yes | The version of the API |
Header Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| Bearer | string(JwtToken) | no | The token for accessing the resource |
Response
Content type
application/json
Response Values
| 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. |
| errors | array of errors | The errors that are returned. |
| 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. |
errors
| Name | Type | Description |
|---|---|---|
| suggestion | string[] | List of suggestions related to the error. |
| code | string | The error code. |
| message | string | The short message describing the error. |
| description | string | A detailed description of the error. |
| type | string | The type or category of the error. |
Example Response Body
json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"applicationReference": "string",
"status": "Pending",
"text": "string",
"success": true,
"isError": true,
"errors": [
{
"suggestion": [
"Something went wrong, Please contact support at email support@laboremus.ug"
],
"code": "S0001",
"message": "FAILED_TO_VERIFY_KCCA_LICENCE_NUMBER",
"description": "Failed to verify KCCA Licence Numbe",
"type": "Fatal"
}
],
"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"
}{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"applicationReference": "string",
"status": "Pending",
"text": "string",
"success": true,
"isError": true,
"errors": [
{
"suggestion": [
"Something went wrong, Please contact support at email support@laboremus.ug"
],
"code": "S0001",
"message": "FAILED_TO_VERIFY_KCCA_LICENCE_NUMBER",
"description": "Failed to verify KCCA Licence Numbe",
"type": "Fatal"
}
],
"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 |
Error Codes
When working with our KCCA Trading Licence Verifcation API, you'll encounter errors shown below. Each type of error comes with an appropriate code and suggestion to aid in troubleshooting.
All errors share the same basic response format.code indicating the error code,message providing an overview of the error, description to show more information about the error, suggestion to aid in troubleshooting and type describing the error type
| Code | Message | Description | Suggestion | Type |
|---|---|---|---|---|
| S0001 | FAILED_TO_VERIFY_KCCA_LICENCE_NUMBER | Failed to verify KCCA Licence Number | Something went wrong, Please contact support at email support@laboremus.ug | Fatal |
| S0002 | INVALID_KCCA_LICENCE_NUMBER | The KCCA Licence number provided is invalid. | The KCCA Licence Number provided is invalid. Please check and try again. | Data |
| S0003 | INVALID_CREDENTIALS | The connection credentials provided are invalid. | Please check whether the subscription key is correct or contact support at email support@laboremus.ug | Authentication |