StreamlineAppearance
Get Verify Business Request Details
Endpoint for getting details of a specific URSB verification request by unique id.
Endpoints
| Environment | URL |
|---|---|
| Sandbox | https://api-test.streamline.laboremus.ug/verify-business/api/business/file/pdf/{handle}?v=3.0 |
| Production | https://api.streamline.laboremus.ug/verify-business/api/business/file/pdf/{handle}?v=3.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-Verification request |
Query Parameters Values
| Name | Type | Required | Description |
|---|---|---|---|
| v | string | yes | The version of the API |
Response
The verify business endpoint can potentially return successful response or error response
Response Values
| Name | Type | Description |
|---|---|---|
| registrationNumber | string (uuid) | The business/company unique registered identification number. |
| businessName | string or null | The legal name of the business/company filed with URSB. |
| businessType | string or null | The business type of the business/company |
| businessSubType | string or null | The business sub-type of the business/company |
| incorporationDate | string or null (dateTime) | The date when business/company was legally formed. |
| registrationDate | string or null (dateTime) | The date of registration of the business/company |
| registrationStatus | string or null | The status of the registration of the business/company |
| location | string or null | The location of the business/company |
| annualReturns | string or null | The total change in value of investment of business/company over the course of one year. |
| businessAddress | object | The address of the business/company |
| shareInfo | object | The unit of equity ownership of the business/company. |
| requesterId | string or null | The ID of the user who made the request |
| 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 |
| referenceId | string or null | A Guid / uuid / A set of unique Alphanumerical characters assigned to this verification request. |
| 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 |
| ursbErrorCode | string or null | The error code returned by the URSB Api. |
| version | string or null | The version of the API |
| isError | boolean | A flag to show whether the request has errors |
| errors | array of errors | The errors that are returned. |
businessAddress
| Name | Type | Description |
|---|---|---|
| country | string or null | The country where it is located |
| district | string or null | The district where it is located |
| county | string or null | The county where it is located |
| town | string or null | The town where it is located |
| village | string or null | The village where it is located |
shareInfo
| Name | Type | Description |
|---|---|---|
| capital | string or null | The capital of the company |
| secretary | string or null | The name of the secretary of the company |
| directors | Array of strings or null | List of Directors |
| shareHolders | Array of strings or null | List of ShareHolders |
| subscribers | Array of strings or null | List of Subscribers |
| partners | Array of strings or null | List of Partners |
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
{
"registrationNumber": "string",
"businessName": "string",
"businessType": "string",
"businessSubType": "string",
"incorporationDate": "string",
"registrationDate": "string",
"registrationStatus": "string",
"location": "string",
"annualReturns": "string",
"businessAddress": {
"country": "string",
"district": "string",
"county": "string",
"town": "string",
"village": "string"
},
"shareInfo": {
"capital": "string",
"secretary": "string",
"directors": [],
"shareHolders": [],
"subscribers": [],
"partners": []
},
"requesterId": "string",
"status": "Pending",
"sentAt": "2019-08-24T14:15:22Z",
"referenceId": "string",
"processedAt": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"ursbErrorCode": "string",
"version": 3.0,
"isError": true,
"errors": [
{
"suggestion": [
"string"
],
"code": "string",
"message": "string",
"description": "string",
"type": "string"
}
]
}{
"registrationNumber": "string",
"businessName": "string",
"businessType": "string",
"businessSubType": "string",
"incorporationDate": "string",
"registrationDate": "string",
"registrationStatus": "string",
"location": "string",
"annualReturns": "string",
"businessAddress": {
"country": "string",
"district": "string",
"county": "string",
"town": "string",
"village": "string"
},
"shareInfo": {
"capital": "string",
"secretary": "string",
"directors": [],
"shareHolders": [],
"subscribers": [],
"partners": []
},
"requesterId": "string",
"status": "Pending",
"sentAt": "2019-08-24T14:15:22Z",
"referenceId": "string",
"processedAt": "2019-08-24T14:15:22Z",
"errorCode": "string",
"errorMessage": "string",
"ursbErrorCode": "string",
"version": 3.0,
"isError": true,
"errors": [
{
"suggestion": [
"string"
],
"code": "string",
"message": "string",
"description": "string",
"type": "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 |