StreamlineAppearance
Verify Business
Accepts requests for verifying business details. All requests are queued and processed as soon as possible.
Endpoints
| Environment | URL |
|---|---|
| Sandbox | https://api-test.streamline.laboremus.ug/verify-business/api/business?v=1.0 |
| Production | https://api.streamline.laboremus.ug/verify-business/api/business?v=1.0 |
Request
The following input parameters should be contained in a JSON body object submitted to the endpoint
Request Type : POST
Authorization
There are two ways to be authorized when making this request.
js
const token = 'eyJhbGciOiJIUzI1NiIsInR5.eyJzd...ssw5c'
axios.post(API_ENDPOINT,
headers: {
Authorization: `Bearer ${token}`
}
)const token = 'eyJhbGciOiJIUzI1NiIsInR5.eyJzd...ssw5c'
axios.post(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')
axios.post(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')
axios.post(API_ENDPOINT,
headers: {
Authorization: `Bearer ${auth.access_token}`
}
)INFO
Always add your Subscription key to the request.
js
axios.post(API_ENDPOINT,
headers: {
'Ocp-Apim-Subscription-Key': 'd484a1f0d34f4301916d0f2c9e9106a2'
}
)axios.post(API_ENDPOINT,
headers: {
'Ocp-Apim-Subscription-Key': 'd484a1f0d34f4301916d0f2c9e9106a2'
}
)js
const res = await axios.post(API_ENDPOINT, {
params: {
Ocp-Apim-Subscription-Key: 'd484a1f0d34f4301916d0f2c9e9106a2'
}
});const res = await axios.post(API_ENDPOINT, {
params: {
Ocp-Apim-Subscription-Key: 'd484a1f0d34f4301916d0f2c9e9106a2'
}
});Request Values
| Name | Type | Required | Description |
|---|---|---|---|
| referenceId | string or null | no | A Guid / uuid / A set of unique Alphanumerical characters assigned to this verification request. |
| registrationNumber | string | yes | The business/company unique registered identification number. |
| dateOfIncorporation | string or null (date-time) | no | The date when business/company was legally formed. |
| businessName | string or null | yes | The legal name of the business/company filed with URSB. |
Example Request Body
json
{
"referenceId": "string",
"registrationNumber": "string",
"dateOfIncorporation": "2019-08-24T14:15:22Z",
"businessName": "string"
}{
"referenceId": "string",
"registrationNumber": "string",
"dateOfIncorporation": "2019-08-24T14:15:22Z",
"businessName": "string"
}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 | he business type of the business/company |
| businessSubType | string or null | The business sub-type of the business/company |
| incorporationDate | string or null | The date when business/company was legally formed. |
| registrationDate | string or null | 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 | TThe 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 | 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 |
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 string or null | List of Directors |
| shareHolders | Array of string or null | List of ShareHolders |
| subscribers | Array of string or null | List of Subscribers |
| partners | Array of string or null | List of Partners |
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": 0
}{
"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": 0
}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 |