Streamline

Appearance

On this page

Get Company AML Screening Details By Id. ​

Endpoint for getting details of a specific Company AML Screening request by unique id.

Endpoints ​

EnvironmentURL
Sandboxhttps://api-test.streamline.laboremus.ug/aml-pep/screening/company/aml/{id}?v=2.0
Productionhttps://api.streamline.laboremus.ug/screenings/company/{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 ​

NameTypeRequiredDescription
idstring(uuid)yesThe Unique ID of a Company Screening request

Response ​

Response Values ​

Content type

application/json

NameTypeDescription
idstring (uuid)A Guid / uuid / A set of unique Alphanumerical characters assigned to this verification request.
createdAtstring (date-time)The date when the screening request was created.
requesterIdstring or nullThe unique Id of the request.
statusstring(Enum: Pending, Completed, Failed)Status of the request sent to verify
totalHitsinteger(int32)The total number of hits from a specific candidate's screening.
optionstring(Enum : Pep, Aml, Both)The URL to find the request
processedAtstring or null (date-time)Date at which the verification request was processed.
detailsArray of objects or nullSpecific attributes which are returned in the screening response. (Empty if no hit is returned)

details ​

NameTypeDescription
aliasNamesArray of string or nullA list of alias names of the entity
aliasGivenNamesArray of string or nullA list of alias given names of the entity
linksArray of string or nullA list of links for the entity This can be websites but also email addresses.
sourceTypestring or nullThe source type (Sanction, PEP, Criminal or Other).
addressArray of string or nullA list of addresses for entity
addressRemarksArray of string or nullA list of address remarks for entity
companyNumberArray of string or nullA list of company numbers for this entity.
jurisdictionArray of string or nullA list of jurisdictions for this entity.
entityTypestring or nullThe entity type for the entity
pepTypestring or nullThe Pep type for the entity
namestring or nullThe name of the entity
nameRemarksArray of string or nullA list of name remarks for this entity.
sourceIdstring or nullThe source id of the list that can be queried by the listSources API method call
sanctionDetailsArray of string or nullA list of sanction details for the entity
otherInformationArray of string or nullA list of other information for the screening candidate that cannot be categorized otherwise.
tlNamestring or nullA third party tool is used for the transliteration of the name from Arabic or Chinese script into Latin script.

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, Kamwokya, 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 33",
				"Kanjokya Street",
				"Kamwokya",
				"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
		}		
	],
	"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, Kamwokya, 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 33",
				"Kanjokya Street",
				"Kamwokya",
				"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
		}		
	],
	"id": "303b28bb-7488-49db-ad6c-08db89be27fb",
	"createdAt": "2023-07-21T07:43:21.0088895Z"
}

Error Response ​

Tech served right

© 2023-present Laboremus Uganda Ltd