StreamlineAppearance
Create KCCA Trading Licence Verification Request
Accepts requests for creating KCCA licence Verification Request.
Endpoint
https://kcca-api-test.streamline.laboremus.ug/api/verifylicensehttps://kcca-api-test.streamline.laboremus.ug/api/verifylicenseRequest
Request Type : POST
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| v | string | yes | The version of the API |
Header Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| Bearer | string(JWT Token) | yes | An access token |
Content type
application/json
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| applicationReference | string or null | no | The reference of a given application. |
Example Request Body
json
{
"applicationReference": "string"
}{
"applicationReference": "string"
}Response
Content type
application/json
Response Values
| Name | Type | Description |
|---|---|---|
| id | string (uuid) | A Guid / uuid / A set of unique Alphanumerical characters assigned to this verification request. |
| requestUri | string or null | The URL to find the request |
| status | string(Enum : Pending,Successful,Failed) | Status of the request sent to verify |
Example Response Body
json
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"requestUri": "string",
"status": "Pending"
}{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"requestUri": "string",
"status": "Pending"
}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 |