Appearance
Create list of company files request
Accepts requests for getting a list of company files. All requests are queued and processed as soon as possible.
| Environment | URL |
|---|---|
| Sandbox | https://api-test.streamline.laboremus.ug/verify-business/api/business/files/{registrationNumber}?v=2.0 |
| Production | https://api.streamline.laboremus.ug/verify-business/api/business/files/{registrationNumber}?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.
Path Parameters Values
| Name | Type | Required | Description |
|---|---|---|---|
| registrationNumber | string | yes | The company registration number |
Response
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 |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
401 Unauthorized
application/json
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
403 Forbidden
application/json
| 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 |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
500 Server Error
application/json
| Name | Type | Description |
|---|---|---|
| code | string or null | The Error code |
| message | string or null | The Error message |
Error Codes
When working with our BNV 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_BUSINESS | Failed to verify business | Something went wrong, Please contact support at email support@laboremus.ug | Fatal |
| S0002 | INVALID_BUSINESS_REGISTRATION_NUMBER | The business registration number provided is invalid. | The business registration number provided should have 14 digits (e.g 80020001441337) | Data |
| S0003 | INVALID_CREDENTIALS | The connection credentials provided are invalid. | Please check your credentials or contact support at email support@laboremus.ug | Authentication |
| S0004 | UNKNOWN_ERROR | An unknown error has occurred, preventing the requested action from being completed. | Please try again later.If the issue persists, contact our support team at support@laboremus.ug with details about the action you were attempting to perform. | Fatal |