StreamlineAppearance
Get Company Files Request Details
Endpoint for getting details of a specific URSB Company Files list request by unique id
| Environment | URL |
|---|---|
| Sandbox | https://api-test.streamline.laboremus.ug/verify-business/api/business/files/{id}?v=2.0 |
| Production | https://api.streamline.laboremus.ug/verify-business/api/business/files/{id}?v=2.0 |
Request
Request Type : GET
Authorization
There are two ways to be authorized when making this request.
js
const token = 'eyJhbGciOiJIUzI1NiIsInR5.eyJzd...ssw5c'
axios.get(API_ENDPOINT,
headers: {
Authorization: `Bearer ${token}`
}
)const token = 'eyJhbGciOiJIUzI1NiIsInR5.eyJzd...ssw5c'
axios.get(API_ENDPOINT,
headers: {
Authorization: `Bearer ${token}`
}
)js
import axios from 'axios'
import oauth from 'axios-oauth-client'
const getClientCredentials = oauth.clientCredentials(
axios.create(),
'https://oauth.com/2.0/token',
'CLIENT_ID',
'CLIENT_SECRET'
)
const auth = await getClientCredentials('OPTIONAL_SCOPES')
// => { "access_token": "...", "expires_in": 900, ... }
axios.get(API_ENDPOINT,
headers: {
Authorization: `Bearer ${auth.access_token}`
}
)import axios from 'axios'
import oauth from 'axios-oauth-client'
const getClientCredentials = oauth.clientCredentials(
axios.create(),
'https://oauth.com/2.0/token',
'CLIENT_ID',
'CLIENT_SECRET'
)
const auth = await getClientCredentials('OPTIONAL_SCOPES')
// => { "access_token": "...", "expires_in": 900, ... }
axios.get(API_ENDPOINT,
headers: {
Authorization: `Bearer ${auth.access_token}`
}
)INFO
Always add your Subscription key to the request.
js
axios.get(API_ENDPOINT,
headers: {
'Ocp-Apim-Subscription-Key': 'd484a1f0d34f43019'
}
)axios.get(API_ENDPOINT,
headers: {
'Ocp-Apim-Subscription-Key': 'd484a1f0d34f43019'
}
)js
const res = await axios.get(API_ENDPOINT, {
params: {
Ocp-Apim-Subscription-Key: 'd484a1f0d34f43019'
}
});const res = await axios.get(API_ENDPOINT, {
params: {
Ocp-Apim-Subscription-Key: 'd484a1f0d34f43019'
}
});Path Parameters Values
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | yes | The Unique ID of a URSB-Company-Files-List request |
Query Parameters Values
| Name | Type | Required | Description |
|---|---|---|---|
| v | string | yes | The version of the API |
Response
Response Values
| Name | Type | Description |
|---|---|---|
| id | string (uuid) | The Guid / uuid / A set of unique Alphanumerical characters assigned to this URSB-Company-Files-List request |
| registrationNumber | string (uuid) | The business/company unique registered identification number. |
| status | string(Enum : Pending,Successful,Failed) | Status of the request sent to verify |
| sentAt | string or null(dateTime) | The date and time the request was made |
| processedAt | string or null(dateTime) | The date at which the verification request was processed at URSB. |
| errorCode | string or null | The error code |
| errorMessage | string or null | The error message |
| companyFiles | array of objects | The list of Business/Company Files |
| isError | boolean | A flag to show whether the request has errors |
| errors | array of errors | The errors that are returned. |
companyFiles
| Name | Type | Description |
|---|---|---|
| typeofDocument | string or null | The type of the document |
| dateOfNameReservation | string or null | The date when the business name was reserved |
| nominalShareCapital | any or null | The maximum amount of share capital a company is authorized to issue to shareholders |
| companyName | string or null | The business name |
| oldRegistrationNo | string or null | The old registration Number of the business |
| newRegistrationNo | string or null | The new registration Number of the business |
| documentHandle | string or null | The name of the secretary of the company |
| docTypeNumber | string or null | The document type number |
| docTypeName | string or null | The document type name |
| name | string or null | The name of the document |
| dateStored | string or null | The day the document was saved in UBRS |
| docDate | string or null | The day the document was saved was created |
| docStatus | string or null | The status of the document |
| createdBy | string or null | The person/application that created the document |
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",
"registrationNumber": "string",
"status": "Pending",
"sentAt": "2019-08-24T14:15:22Z",
"processedAt": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"isError": true,
"errors": [
{
"suggestion": [
"string"
],
"code": "string",
"message": "string",
"description": "string",
"type": "string"
}
],
"companyFiles": [
{
"typeofDocument": "string",
"dateOfNameReservation": null,
"nominalShareCapital": null,
"companyName": "string",
"oldRegistrationNo": null,
"newRegistrationNo": "string",
"documentHandle": "string",
"docTypeNumber": "string",
"docTypeName": "string",
"name": "string",
"dateStored": "string",
"docDate": "string",
"docStatus": "string",
"createdBy": "string"
}
]
}{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"registrationNumber": "string",
"status": "Pending",
"sentAt": "2019-08-24T14:15:22Z",
"processedAt": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"isError": true,
"errors": [
{
"suggestion": [
"string"
],
"code": "string",
"message": "string",
"description": "string",
"type": "string"
}
],
"companyFiles": [
{
"typeofDocument": "string",
"dateOfNameReservation": null,
"nominalShareCapital": null,
"companyName": "string",
"oldRegistrationNo": null,
"newRegistrationNo": "string",
"documentHandle": "string",
"docTypeNumber": "string",
"docTypeName": "string",
"name": "string",
"dateStored": "string",
"docDate": "string",
"docStatus": "string",
"createdBy": "string"
}
]
}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 whether the subscription key is correct 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 |