Appearance
Create Company Verification Requests.
Accepts requests for performing KYC Verifications on a Company Profile.
Endpoints
| Environment | API Endpoint |
|---|---|
| Sandbox | https://onprem-test.streamline.laboremus.ug/routing/v1/company-verifications |
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.
Content type
multipart/form-data
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| profileId | string | yes | Unique profile ID. |
| referenceId | string | no | Unique reference ID. |
| tenantId | string | yes | Tenant ID associated. |
| verification | object | yes | The verifications to be performed |
verification
| Name | Type | Required | Description |
|---|---|---|---|
| businessNames | array | no | List of business names. |
| tins | array | no | List of TINs associated with the profile. |
| kccaLicences | array | no | List of KCCA licenses. |
| amlPepScreening | object | no | Anti-Money Laundering (AML) screening details. |
businessNames
| Name | Type | Required | Description |
|---|---|---|---|
| registrationNumber | string | yes | Business registration number. |
| country | string | yes | Country where the business is registered. |
| referenceId | string | no | Reference ID for the business. |
tins
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Name associated with the TIN. |
| country | string | yes | Country of the TIN. |
kccaLicences
| Name | Type | Required | Description |
|---|---|---|---|
| applicationReference | string | yes | The reference of a given application. |
amlPepScreening
| Name | Type | Required | Description |
|---|---|---|---|
| companyName | string | yes | Name of the company screened. |
Example Request Body
json
{
"profileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenantId": "string",
"verification": {
"businessNames": [
{
"registrationNumber": "string",
"country": "string",
"referenceId": "string"
}
],
"tins": [
{
"name": "string",
"country": "string"
}
],
"kccaLicences": [
{
"applicationReference": "string"
}
],
"amlPepScreening": {
"companyName": "string"
}
}
}{
"profileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tenantId": "string",
"verification": {
"businessNames": [
{
"registrationNumber": "string",
"country": "string",
"referenceId": "string"
}
],
"tins": [
{
"name": "string",
"country": "string"
}
],
"kccaLicences": [
{
"applicationReference": "string"
}
],
"amlPepScreening": {
"companyName": "string"
}
}
}Response
Content type
application/json
Response Body
| Name | Type | Description |
|---|---|---|
| profileId | string | A unique identifier for the profile. |
| referenceId | string | A reference identifier. |
| message | string | A message associated with the request. |
Example Response Body
json
{
"profileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "string"
}{
"profileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "string"
}Error Response
400 Bad Request
application/json
| Name | Type | Description |
|---|---|---|
| type | string or null | Type of error response |
| title | string or null | The title of the error response |
| status | integer(int32) | The status of the error response |
| traceId | string or null | The traceId of the error request producing the error |
| errors | object | Object defining the errors |
errors
| Name | Type | Description |
|---|---|---|
| property | Array of strings | The definition of the errors |
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 |