Appearance
Make Company AML Screening Request
This endpoint performs a synchronous AML screening for a company. The screening results are returned immediately in the response.
| Environment | URL |
|---|---|
| Sandbox | https://api-test.streamline.laboremus.ug/aml-pep/screening/company/aml?v=2.0 |
| Production | https://api.streamline.laboremus.ug/api/company/screening?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.
Request Values
| Name | Type | Required | Description |
|---|---|---|---|
| companyName | string | yes | The name of the company. |
| referenceId | string | no | A Guid / uuid / A set of unique Alphanumerical characters assigned to this verification request. |
| requesterId | string | no | The unique Id of the request initiator. |
| option | string (Aml) | no | The option for screening . |
Example Request Body
json
{
"referenceId": "string",
"requesterId": "string",
"companyName": "string",
"option": "AML"
}{
"referenceId": "string",
"requesterId": "string",
"companyName": "string",
"option": "AML"
}Response
A successful request returns a 200 OK status with the complete screening results.
Response Values
Content type
application/json
| Name | Type | Description |
|---|---|---|
| id | string (uuid) | A Guid / uuid / A set of unique Alphanumerical characters assigned to this verification request. |
| createdAt | string (date-time) | The date when the screening request was created. |
| requesterId | string or null | The unique Id of the request. |
| status | string(Enum: Completed, Failed) | Status of the screening request |
| totalHits | integer(int32) | The total number of hits from the screening |
| option | string(Enum: Pep, Aml, Both) | The screening option that was used |
| processedAt | string or null (date-time) | Date and time when the screening was processed |
| details | Array of objects or null | Screening results with detailed information about matches (empty if no hits) |
| isError | boolean | A flag indicating whether the request encountered errors |
| errors | array of errors | List of errors if any occurred |
details
| Name | Type | Description |
|---|---|---|
| aliasNames | Array of string or null | A list of alias names of the entity |
| aliasGivenNames | Array of string or null | A list of alias given names of the entity |
| links | Array of string or null | A list of links for the entity This can be websites but also email addresses. |
| sourceType | string or null | The source type (Sanction, PEP, Criminal or Other). |
| address | Array of string or null | A list of addresses for entity |
| addressRemarks | Array of string or null | A list of address remarks for entity |
| companyNumber | Array of string or null | A list of company numbers for this entity. |
| jurisdiction | Array of string or null | A list of jurisdictions for this entity. |
| entityType | string or null | The entity type for the entity |
| pepType | string or null | The Pep type for the entity |
| name | string or null | The name of the entity |
| nameRemarks | Array of string or null | A list of name remarks for this entity. |
| sourceId | string or null | The source id of the list that can be queried by the listSources API method call |
| sanctionDetails | Array of string or null | A list of sanction details for the entity |
| otherInformation | Array of string or null | A list of other information for the screening candidate that cannot be categorized otherwise. |
| tlName | string or null | A third party tool is used for the transliteration of the name from Arabic or Chinese script into Latin script. |
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
{
"requesterId": "7eac581f-5f1a-4336-a052-2704fbbf2fb8",
"status": "Successful",
"totalHits": 2,
"option": "Aml",
"processedAt": "2023-07-21T10:43:21.7198813+03:00",
"details": [
{
"aliasNames": null,
"aliasGivenNames": null,
"links": null,
"sourceType": "SANCTION",
"address": [
"Plot ##, Kanjokya Street, Kasera, Kampala, Uganda (Tel.: +256 51 543 578/9); PO BOX 33709, Kampala, Uganda Listed on: 29 Mar. 2007 (amended on 19 August 2020)"
],
"addressRemarks": null,
"companyNumber": null,
"jurisdiction": null,
"entityType": "UNKNOWN",
"pepType": null,
"name": " COMMERCIAL IMPEX (UCI) LTD",
"nameRemarks": null,
"sourceId": "ua_blacklist_sanction_list",
"sanctionDetails": [
"РБ ООН (Комітет 1533 (2004))"
],
"otherInformation": [
" “Inactive – status inactive” by the authorities of the Republic of Uganda. INTERPOL-UN Security Council Special Notice web link: https://www.interpol.int/en/How-we-work/Notices/View-UN-Notices-Entities."
],
"tlName": null
},
{
"aliasNames": [
" COMMERCIAL IMPEX (UCI) LTD"
],
"aliasGivenNames": null,
"links": [
"https://www.gov.uk/government/publications/financial-sanctions-consolidated-list-of-targets/consolidated-list-of-targets"
],
"sourceType": "SANCTION",
"address": [
"Plot 001",
"Kanjokya Street",
"Kasera",
"Kampala",
"Uganda",
"PO Box 33709"
],
"addressRemarks": null,
"companyNumber": null,
"jurisdiction": null,
"entityType": "ENTITY",
"pepType": null,
"name": "COMMERCIAL IMPEX (UCI) LTD",
"nameRemarks": null,
"sourceId": "uk_hmt_financial_sanction_list",
"sanctionDetails": [
"Date listed: 30/03/2007",
"Date designated: 29/03/2007",
"DRC0023",
"CDe.009",
"Group status: Asset Freeze Targets"
],
"otherInformation": [
"INTERPOL-UN Security Council Special Notice web link: https://www.interpol.int/en/How-we-work/Notices/View-UN-Notices-Entities.",
"Democratic Republic of the Congo",
"+256 41 533 578/9"
],
"tlName": null
}
],
"isError": false,
"errors": [],
"id": "303b28bb-7488-49db-ad6c-08db89be27fb",
"createdAt": "2023-07-21T07:43:21.0088895Z"
}{
"requesterId": "7eac581f-5f1a-4336-a052-2704fbbf2fb8",
"status": "Successful",
"totalHits": 2,
"option": "Aml",
"processedAt": "2023-07-21T10:43:21.7198813+03:00",
"details": [
{
"aliasNames": null,
"aliasGivenNames": null,
"links": null,
"sourceType": "SANCTION",
"address": [
"Plot ##, Kanjokya Street, Kasera, Kampala, Uganda (Tel.: +256 51 543 578/9); PO BOX 33709, Kampala, Uganda Listed on: 29 Mar. 2007 (amended on 19 August 2020)"
],
"addressRemarks": null,
"companyNumber": null,
"jurisdiction": null,
"entityType": "UNKNOWN",
"pepType": null,
"name": " COMMERCIAL IMPEX (UCI) LTD",
"nameRemarks": null,
"sourceId": "ua_blacklist_sanction_list",
"sanctionDetails": [
"РБ ООН (Комітет 1533 (2004))"
],
"otherInformation": [
" “Inactive – status inactive” by the authorities of the Republic of Uganda. INTERPOL-UN Security Council Special Notice web link: https://www.interpol.int/en/How-we-work/Notices/View-UN-Notices-Entities."
],
"tlName": null
},
{
"aliasNames": [
" COMMERCIAL IMPEX (UCI) LTD"
],
"aliasGivenNames": null,
"links": [
"https://www.gov.uk/government/publications/financial-sanctions-consolidated-list-of-targets/consolidated-list-of-targets"
],
"sourceType": "SANCTION",
"address": [
"Plot 001",
"Kanjokya Street",
"Kasera",
"Kampala",
"Uganda",
"PO Box 33709"
],
"addressRemarks": null,
"companyNumber": null,
"jurisdiction": null,
"entityType": "ENTITY",
"pepType": null,
"name": "COMMERCIAL IMPEX (UCI) LTD",
"nameRemarks": null,
"sourceId": "uk_hmt_financial_sanction_list",
"sanctionDetails": [
"Date listed: 30/03/2007",
"Date designated: 29/03/2007",
"DRC0023",
"CDe.009",
"Group status: Asset Freeze Targets"
],
"otherInformation": [
"INTERPOL-UN Security Council Special Notice web link: https://www.interpol.int/en/How-we-work/Notices/View-UN-Notices-Entities.",
"Democratic Republic of the Congo",
"+256 41 533 578/9"
],
"tlName": null
}
],
"isError": false,
"errors": [],
"id": "303b28bb-7488-49db-ad6c-08db89be27fb",
"createdAt": "2023-07-21T07:43:21.0088895Z"
}Error Response
400 Bad Request
application/json
| Name | Type | Description |
|---|---|---|
| statusCode | integer(int32) | The status of the error response |
Example Error Response
json
{
"statusCode": 0
}{
"statusCode": 0
}401 Unauthorized
application/json
| Name | Type | Description |
|---|---|---|
| statusCode | integer(int32) | The status of the error response |
Example Error Response
json
{
"statusCode": 0
}{
"statusCode": 0
}500 Server Error
No response
Error Codes
When working with our AML/PEP 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_KCCA_LICENCE_NUMBER | Failed to verify KCCA Licence Number | Something went wrong, Please contact support at email support@laboremus.ug | Fatal |
| S0002 | INVALID_KCCA_LICENCE_NUMBER | The KCCA Licence number provided is invalid. | The KCCA Licence Number provided is invalid. Please check and try again. | Data |
| S0003 | INVALID_CREDENTIALS | The connection credentials provided are invalid. | Please check your credentials or contact support at email support@laboremus.ug | Authentication |
| S0004 | KCCA_LICENCE_NUMBER_NOT_FOUND | The KCCA Licence Number provided was not found. | The KCCA Licence Number provided was not found. Please contact support at email support@laboremus.ug | Data |
| S0005 | 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 |