Appearance
Create KCCA Trading Licence Verification Request
Accepts requests for creating KCCA licence Verification Request.
Endpoint
| Environment | URL |
|---|---|
| Sandbox | https://api-test.streamline.laboremus.ug/kcca/api/verifylicense?v=2.0 |
| Production | https://api.streamline.laboremus.ug/kcca/api/verifylicense?v=2.0 |
Request
Request Type : POST
Authorization
All requests must be authenticated using OAuth 2.0 Client Credentials. Follow the steps in the Authentication section to obtain an access token.
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 |