StreamlineAppearance
Get Customer Application KYC
Endpoint for getting a list of customer onboarding application checks, which is representative of the verification checks that were conducted on the applicant's information.
Endpoints
| Environment | URL |
|---|---|
| Sandbox | https://api-test.streamline.laboremus.ug/kyc/api/verifications/lastrun/{profileId} |
| Production | https://api.streamline.laboremus.ug/kyc/api/verifications/lastrun/{profileId} |
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'
}
});Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| v | string | no | The API Version |
Header Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| x-version | string | no | The API Version |
| Bearer | string(JwtToken) | no | The Token required for authorization |
Response
Aml-Pep Screening Check
| Field | Type | Description |
|---|---|---|
| surname | string | Surname of the individual |
| givenName | string | Given name or first name of the individual |
| otherNames | string or null | Other names or middle names of the individual |
| gender | string | Gender of the individual (e.g., Male, Female) |
| dateOfBirth | string | Date of birth of the individual |
| response | array of objects | Array containing details of the screening response |
| errorCode | string or null | Error code if there was an error during the screening |
| errorMessage | string or null | Error message if there was an error during the screening |
| status | string | Status of the screening check |
| processedAt | string | Timestamp indicating when the check was processed |
| verifiedAt | string | Timestamp indicating when the check was verified |
| id | string | Unique identifier for the screening check |
| createdAt | string | Timestamp indicating when the screening check was created |
[] response
| Field | Type | Description |
|---|---|---|
| createdAt | string | Timestamp indicating when the response was created |
| status | string | Status of the response (e.g., Successful, Failed) |
| totalHits | integer | Number of hits found during the screening |
| processedAt | string | Timestamp indicating when the response was processed |
| option | string | Type of screening performed (e.g., Aml, Pep) |
| details | array | Array containing additional details of the response |
| isError | boolean or null | Indicates if there was an error during the response processing |
| errors | string or null | Error details if there was an error during the response |
Photo Match Check
Details for the photo match check.
| Field | Type | Description |
|---|---|---|
| photoMatchScore | string | Score indicating the match between photos |
| biometricType | string | Type of biometric check performed |
| result | boolean | Result of the photo match check |
| biometricActions | array of objects | Array containing details of biometric actions |
| errorCode | string or null | Error code if there was an error during the check |
| errorMessage | string or null | Error message if there was an error during the check |
| status | string | Status of the photo match check |
| processedAt | string | Timestamp indicating when the check was processed |
| verifiedAt | string | Timestamp indicating when the check was verified |
| id | string | Unique identifier for the photo match check |
| createdAt | string | Timestamp indicating when the photo match check was created |
| lastUpdated | string | Timestamp indicating when the photo match check was last updated |
[] biometricActions
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the biometric action |
| type | string | Type of biometric action performed |
| result | boolean | Result of the biometric action |
| comment | string | Comment related to the biometric action |
| performedBy | string | Name of the person who performed the biometric action |
| performedById | string | Unique identifier of the person who performed the action |
| createdAt | string | Timestamp indicating when the biometric action was created |
| lastUpdated | string | Timestamp indicating when the biometric action was last updated |
Liveness Detection Check
Details for the liveness detection check.
| Field | Type | Description |
|---|---|---|
| livenessScore | string | Score indicating the liveness of the individual |
| numberOfFrames | integer | Number of frames used in the liveness detection |
| biometricType | string | Type of biometric check performed |
| result | boolean | Result of the liveness detection check |
| biometricActions | array of objects | Array containing details of biometric actions |
| errorCode | string or null | Error code if there was an error during the check |
| errorMessage | string or null | Error message if there was an error during the check |
| status | string | Status of the liveness detection check |
| processedAt | string | Timestamp indicating when the check was processed |
| verifiedAt | string | Timestamp indicating when the check was verified |
| id | string | Unique identifier for the liveness detection check |
| createdAt | string | Timestamp indicating when the liveness detection check was created |
| lastUpdated | string | Timestamp indicating when the liveness detection check was last updated |
Biometric Actions
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the biometric action |
| type | string | Type of biometric action performed |
| result | boolean | Result of the biometric action |
| comment | string | Comment related to the biometric action |
| performedBy | string | Name of the person who performed the biometric action |
| performedById | string | Unique identifier of the person who performed the action |
| createdAt | string | Timestamp indicating when the biometric action was created |
| lastUpdated | string | Timestamp indicating when the biometric action was last updated |
Identity Document Checks
Details for the identity document checks.
| Field | Type | Description |
|---|---|---|
| idType | string | Type of identification document |
| idNumber | string | Identification number of the document |
| documentNumber | string | Document number associated with the identification |
| country | string | Country of issuance |
| dateOfBirth | string | Date of birth of the individual |
| dateOfIssue | string or null | Date of issue of the document |
| dateOfExpiry | string | Expiry date of the document |
| surname | string | Surname of the individual |
| givenNames | string | Given names of the individual |
| otherNames | string or null | Other names of the individual |
| requiresValidation | boolean | Indicates if the document requires validation |
| response | object | Details of the document verification response |
| errorCode | string or null | Error code if there was an error during the check |
| errorMessage | string or null | Error message if there was an error during the check |
| status | string | Status of the document check |
| processedAt | string | Timestamp indicating when the check was processed |
| verifiedAt | string | Timestamp indicating when the check was verified |
| id | string | Unique identifier for the document check |
| createdAt | string | Timestamp indicating when the document check was created |
| lastUpdated | string | Timestamp indicating when the document check was last updated |
[] response
| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the response |
| participantId | string or null | Unique identifier for the participant |
| receivedAt | string | Timestamp indicating when the response was received |
| submittedAt | string | Timestamp indicating when the response was submitted |
| receivedFromNira | string | Timestamp indicating when the response was received from NIRA |
| requestStatus | string | Status of the request |
| surname | string | Surname of the individual |
| givenNames | string | Given names of the individual |
| otherNames | string or null | Other names of the individual |
| cardNumber | string | Card number of the individual |
| maskedCardNumber | string | Masked card number of the individual |
| nin | string | National Identification Number |
| maskedNin | string | Masked National Identification Number |
| multipleReferenceId | string or null | Multiple reference identifier |
| dateOfBirth | string | Date of birth of the individual |
| resultJson | object | JSON object containing the result of the check |
{} resultJson
| Field | Type | Description |
|---|---|---|
| matchingStatus | boolean | Indicates if the document details (Surname, Given Names, Date of birth) match NIRA records |
| cardStatus | string | Status of the card |
| status | string | Status of the check |
| error | string or null | Error details if there was an error during the check |
Example Response Body
Content type
application/json
json
{
"amlPepScreeningCheck": {
"surname": "KAGGWA",
"givenName": "JOHN",
"otherNames": "PETER",
"gender": "M",
"dateOfBirth": "1985-06-15T00:00:00",
"response": [
{
"createdAt": "2024-08-08T10:09:14.734963Z",
"status": "Successful",
"totalHits": 0,
"processedAt": "2024-08-08T13:09:15.891019+03:00",
"option": "Aml",
"details": [],
"isError": null,
"errors": null
},
{
"createdAt": "2024-08-08T10:09:14.734963Z",
"status": "Successful",
"totalHits": 0,
"processedAt": "2024-08-08T13:09:15.891019+03:00",
"option": "Pep",
"details": [],
"isError": null,
"errors": null
}
],
"errorCode": null,
"errorMessage": null,
"status": "Successful",
"processedAt": "2024-08-08T13:09:14.359185+03:00",
"verifiedAt": "2024-08-08T13:09:16.160686+03:00",
"id": "9b8b5f62-e3f7-4d2d-8c5d-1a2e6b7b9f9a",
"createdAt": "2024-08-08T13:09:11.182305+03:00",
"lastUpdated": "2024-08-08T13:09:16.160686+03:00"
},
"companyAmlScreeningCheck": null,
"photoMatchCheck": {
"photoMatchScore": "0.7825314",
"biometricType": "PhotoMatch",
"result": true,
"biometricActions": [
{
"id": "8a9e6b27-d5b4-4f0e-8e5a-9f7e7d5a9b6a",
"type": "override",
"result": false,
"comment": "Customer mismatch",
"performedBy": "Daniel Okello",
"performedById": "5b8e6f77-1c4d-4cb7-8421-67e3e2973810",
"createdAt": "2024-07-12T22:02:34.623079+03:00",
"lastUpdated": "2024-07-12T22:02:34.62308+03:00"
}
],
"errorCode": null,
"errorMessage": null,
"status": "Successful",
"processedAt": "2024-08-08T16:08:48+03:00",
"verifiedAt": "2024-08-08T16:08:48+03:00",
"id": "3c6e2d9b-f7d5-4e6e-8e2d-7b8f7e5d7a9b",
"createdAt": "2024-08-08T13:09:11.230275+03:00",
"lastUpdated": "2024-07-12T22:02:34.623081+03:00"
},
"livenessDetectionCheck": {
"livenessScore": "0.99645321",
"numberOfFrames": 1,
"biometricType": "LivenessDetection",
"result": true,
"biometricActions": [
{
"id": "4e6a5f33-2b5d-4a5e-8e5a-4a5b7d5a9b6a",
"type": "override",
"result": false,
"comment": "Customer is fake",
"performedBy": "Daniel Okello",
"performedById": "5b8e6f77-1c4d-4cb7-8421-67e3e2973810",
"createdAt": "2024-07-12T22:02:22.71781+03:00",
"lastUpdated": "2024-07-12T22:02:22.717811+03:00"
}
],
"errorCode": null,
"errorMessage": null,
"status": "Successful",
"processedAt": "2024-08-08T16:08:48+03:00",
"verifiedAt": "2024-08-08T16:08:48+03:00",
"id": "9c8d7e6f-4a5e-4b5d-8e5a-7d5b7d5a9b6a",
"createdAt": "2024-08-08T13:09:11.248392+03:00",
"lastUpdated": "2024-07-12T22:02:22.717811+03:00"
},
"fingerprintCheck": null,
"businessNameCheck": null,
"identityDocumentChecks": [
{
"idType": "Nationalid",
"idNumber": "CF87036100PJKL",
"documentNumber": "007651234",
"country": "Uganda",
"dateOfBirth": "1985-06-15T00:00:00",
"dateOfIssue": "2015-06-15T00:00:00",
"dateOfExpiry": "2025-06-15T00:00:00",
"surname": "KAGGWA",
"givenNames": "JOHN PETER",
"otherNames": "",
"requiresValidation": false,
"response": {
"id": "9e6f7d5a-4b5d-4a5e-8e5a-4a5b7d5a9b6a",
"participantId": null,
"receivedAt": "2024-08-08T13:09:14.3339273",
"submittedAt": "2024-08-08T13:09:14.4936214Z",
"receivedFromNira": "2024-08-08T13:09:14.8165861Z",
"requestStatus": "Completed",
"surname": "KAGGWA",
"givenNames": "JOHN PETER",
"otherNames": "",
"cardNumber": "007651234",
"maskedCardNumber": "00765****",
"nin": "CF87036100PJKL",
"maskedNin": "CF8703********",
"multipleReferenceId": null,
"dateOfBirth": "1985-06-15T00:00:00",
"resultJson": {
"matchingStatus": true,
"cardStatus": "Valid",
"status": "Ok",
"error": null,
"isError": false,
"ninStatus": "Ok"
}
},
"errorCode": null,
"errorMessage": null,
"status": "Successful",
"processedAt": "2024-08-08T13:09:14.321421+03:00",
"verifiedAt": "2024-08-08T13:09:14.960204+03:00",
"id": "4d6e7a5d-4a5e-4b5d-8e5a-4a5b7d5a9b6a",
"createdAt": "2024-08-08T13:09:11.161489+03:00",
"lastUpdated": "2024-08-08T13:09:14.960205+03:00"
}
],
"kccaLicenceChecks": [],
"phoneNumberChecks": [
{
"value": "+256704567890",
"nationalIdNumber": "CF87036100PJKL",
"vendorCode": "STRM_01",
"country": "Uganda",
"response": {
"createdAt": "2024-08-08T10:09:25.768812Z",
"status": "Completed",
"verificationStatus": "Valid",
"phoneNumber": "256704567890",
"sentAt": "2024-08-08T13:09:25.7688123+03:00",
"responsePayload": "{\"Name\":\"JOHN KAGGWA\",\"Network\":\"MTN\",\"Status\":1}",
"processedAt": "2024-08-08T13:09:27.6775565+03:00",
"nameFound": "JOHN KAGGWA",
"network": "MTN",
"phoneNumberStatus": true,
"errorCode": null,
"errorMessage": null,
"isError": null,
"errors": null,
"vendorCode": "STRM_01",
"isPhoneNumberValid": null,
"isOwner": null,
"lastSimSwapDate": null
},
"errorCode": null,
"errorMessage": null,
"status": "Successful",
"processedAt": "2024-08-08T13:09:14.339972+03:00",
"verifiedAt": "2024-08-08T13:09:28.571369+03:00",
"id": "6a7e8f9b-2b5d-4a5e-8e5a-4a5b7d5a9b6a",
"createdAt": "2024-08-08T13:09:11.171449+03:00",
"lastUpdated": "2024-08-08T13:09:28.571369+03:00"
},
{
"value": "+256704567890",
"nationalIdNumber": "CF87036100PJKL",
"vendorCode": "STRM_02",
"country": "Uganda",
"response": {
"createdAt": "2024-08-08T10:09:14.3509363Z",
"status": "Completed",
"verificationStatus": "Valid",
"phoneNumber": "256704567890",
"sentAt": "2024-08-08T13:09:14.3509365+03:00",
"responsePayload": "{\"KycCheck\":{\"StatusMessage\":\"Success.\",\"Data\":{\"PhoneNumber\":\"256704567890\",\"IsPhoneNumberValid\":true,\"NationalIdNumber\":\"CF87036100PJKL\",\"IsOwner\":true},\"SentAt\":\"2024-08-08T10:09:16.156623Z\",\"ProcessedAt\":\"2024-08-08T10:09:15.4855567Z\",\"Initiator\":\"streamline_PhoneId_API\",\"Id\":\"e0254b4a-ae7b-4e77-b0dc-08dc5ae6f68d\",\"CreatedAt\":\"2024-08-08T13:09:15.4853645Z\"},\"SimSwapCheck\":{\"StatusMessage\":\"Success\",\"Data\":{\"LastSimSwapDate\":\"2017-07-04T15:53:46+03:00\"},\"SentAt\":\"2024-08-08T10:09:21.6552174Z\",\"ProcessedAt\":\"2024-08-08T10:09:21.4557791Z\",\"Initiator\":\"streamline_PhoneId_API\",\"Id\":\"88ac8e54-a8fe-4a1c-01dd-08dc5ae6fb95\",\"CreatedAt\":\"2024-08-08T13:09:21.4557781Z\"},\"Status\":1}",
"processedAt": "2024-08-08T13:09:25.5352764+03:00",
"nameFound": null,
"network": null,
"phoneNumberStatus": null,
"errorCode": null,
"errorMessage": null,
"isError": null,
"errors": null,
"vendorCode": "STRM_02",
"isPhoneNumberValid": true,
"isOwner": true,
"lastSimSwapDate": "2017-07-04T15:53:46+03:00"
},
"errorCode": null,
"errorMessage": null,
"status": "Successful",
"processedAt": "2024-08-08T13:09:14.330482+03:00",
"verifiedAt": "2024-08-08T13:09:25.746302+03:00",
"id": "7b8f9d5a-4a5e-4b5d-8e5a-4a5b7d5a9b6a",
"createdAt": "2024-08-08T13:09:11.169455+03:00",
"lastUpdated": "2024-08-08T13:09:25.746302+03:00"
}
],
"tinChecks": [
{
"number": "0201456789",
"country": "Uganda",
"response": {
"tin": "0201456789",
"errorCode": "E004",
"errorDescription": "INVALID TIN",
"initiator": "JOHN KAGGWA",
"contactNumber": null,
"county": null,
"district": null,
"isCustomsAgent": null,
"isLicenseValid": "Not applicable",
"licenseNumber": null,
"mobileNumber": null,
"postalAddress": null,
"registrationStatus": null,
"subCounty": null,
"taxPayerEmail": null,
"taxPayerName": null,
"telephoneNumber": null,
"typeofUser": null,
"village": "Not applicable",
"nitaFaultCode": "Not applicable",
"nitaFaultMessage": "Not applicable",
"nitaFaultDescription": "Not applicable",
"nitaFaultAms": "Not applicable",
"nitaFaultText": "Not applicable",
"status": "Failed",
"isError": false,
"errors": null,
"sentAt": "2024-08-08T10:09:14.7604114",
"processedAt": "2024-08-08T10:09:14.4718832",
"createdAt": "2024-08-08T10:09:14.4718819",
"lastUpdated": "2024-08-08T10:09:17.7246633"
},
"errorCode": null,
"errorMessage": null,
"status": "Failed",
"processedAt": "2024-08-08T13:09:14.349599+03:00",
"verifiedAt": "2024-08-08T13:09:19.112599+03:00",
"id": "8c9d7e5a-4a5e-4b5d-8e5a-4a5b7d5a9b6a",
"createdAt": "2024-08-08T13:09:11.180203+03:00",
"lastUpdated": "2024-08-08T13:09:19.112599+03:00"
}
],
"riskProfileCheck": {
"nationality": "Uganda",
"occupation": "Engineer",
"district": "KAMPALA",
"monthlyIncome": "UGX 3 million - UGX 5 million",
"usePhoneNumber": false,
"useTin": false,
"usePep": true,
"useIdentityDocument": false,
"response": {
"riskScore": 1.75,
"riskClass": "Moderate",
"processedAt": "2024-08-08T13:09:28.009206+03:00",
"status": "Processed",
"computedRiskRatings": [
{
"score": 1.0,
"riskFactor": "District"
},
{
"score": 1.0,
"riskFactor": "PepStatus"
},
{
"score": 0.0,
"riskFactor": "Occupation"
},
{
"score": 0.5,
"riskFactor": "Nationality"
},
{
"score": 2.0,
"riskFactor": "MonthlyIncome"
}
],
"id": "5f7e8d9b-2b5d-4a5e-8e5a-4a5b7d5a9b6a",
"createdAt": "2024-08-08T13:09:21.404645+03:00"
},
"errorCode": null,
"errorMessage": null,
"status": "Successful",
"processedAt": null,
"verifiedAt": "2024-08-08T13:09:29.614239+03:00",
"id": "6a7e8d5a-4a5e-4b5d-8e5a-4a5b7d5a9b6a",
"createdAt": "2024-08-08T13:09:11.209552+03:00",
"lastUpdated": "2024-08-08T13:09:29.61424+03:00"
}{
"amlPepScreeningCheck": {
"surname": "KAGGWA",
"givenName": "JOHN",
"otherNames": "PETER",
"gender": "M",
"dateOfBirth": "1985-06-15T00:00:00",
"response": [
{
"createdAt": "2024-08-08T10:09:14.734963Z",
"status": "Successful",
"totalHits": 0,
"processedAt": "2024-08-08T13:09:15.891019+03:00",
"option": "Aml",
"details": [],
"isError": null,
"errors": null
},
{
"createdAt": "2024-08-08T10:09:14.734963Z",
"status": "Successful",
"totalHits": 0,
"processedAt": "2024-08-08T13:09:15.891019+03:00",
"option": "Pep",
"details": [],
"isError": null,
"errors": null
}
],
"errorCode": null,
"errorMessage": null,
"status": "Successful",
"processedAt": "2024-08-08T13:09:14.359185+03:00",
"verifiedAt": "2024-08-08T13:09:16.160686+03:00",
"id": "9b8b5f62-e3f7-4d2d-8c5d-1a2e6b7b9f9a",
"createdAt": "2024-08-08T13:09:11.182305+03:00",
"lastUpdated": "2024-08-08T13:09:16.160686+03:00"
},
"companyAmlScreeningCheck": null,
"photoMatchCheck": {
"photoMatchScore": "0.7825314",
"biometricType": "PhotoMatch",
"result": true,
"biometricActions": [
{
"id": "8a9e6b27-d5b4-4f0e-8e5a-9f7e7d5a9b6a",
"type": "override",
"result": false,
"comment": "Customer mismatch",
"performedBy": "Daniel Okello",
"performedById": "5b8e6f77-1c4d-4cb7-8421-67e3e2973810",
"createdAt": "2024-07-12T22:02:34.623079+03:00",
"lastUpdated": "2024-07-12T22:02:34.62308+03:00"
}
],
"errorCode": null,
"errorMessage": null,
"status": "Successful",
"processedAt": "2024-08-08T16:08:48+03:00",
"verifiedAt": "2024-08-08T16:08:48+03:00",
"id": "3c6e2d9b-f7d5-4e6e-8e2d-7b8f7e5d7a9b",
"createdAt": "2024-08-08T13:09:11.230275+03:00",
"lastUpdated": "2024-07-12T22:02:34.623081+03:00"
},
"livenessDetectionCheck": {
"livenessScore": "0.99645321",
"numberOfFrames": 1,
"biometricType": "LivenessDetection",
"result": true,
"biometricActions": [
{
"id": "4e6a5f33-2b5d-4a5e-8e5a-4a5b7d5a9b6a",
"type": "override",
"result": false,
"comment": "Customer is fake",
"performedBy": "Daniel Okello",
"performedById": "5b8e6f77-1c4d-4cb7-8421-67e3e2973810",
"createdAt": "2024-07-12T22:02:22.71781+03:00",
"lastUpdated": "2024-07-12T22:02:22.717811+03:00"
}
],
"errorCode": null,
"errorMessage": null,
"status": "Successful",
"processedAt": "2024-08-08T16:08:48+03:00",
"verifiedAt": "2024-08-08T16:08:48+03:00",
"id": "9c8d7e6f-4a5e-4b5d-8e5a-7d5b7d5a9b6a",
"createdAt": "2024-08-08T13:09:11.248392+03:00",
"lastUpdated": "2024-07-12T22:02:22.717811+03:00"
},
"fingerprintCheck": null,
"businessNameCheck": null,
"identityDocumentChecks": [
{
"idType": "Nationalid",
"idNumber": "CF87036100PJKL",
"documentNumber": "007651234",
"country": "Uganda",
"dateOfBirth": "1985-06-15T00:00:00",
"dateOfIssue": "2015-06-15T00:00:00",
"dateOfExpiry": "2025-06-15T00:00:00",
"surname": "KAGGWA",
"givenNames": "JOHN PETER",
"otherNames": "",
"requiresValidation": false,
"response": {
"id": "9e6f7d5a-4b5d-4a5e-8e5a-4a5b7d5a9b6a",
"participantId": null,
"receivedAt": "2024-08-08T13:09:14.3339273",
"submittedAt": "2024-08-08T13:09:14.4936214Z",
"receivedFromNira": "2024-08-08T13:09:14.8165861Z",
"requestStatus": "Completed",
"surname": "KAGGWA",
"givenNames": "JOHN PETER",
"otherNames": "",
"cardNumber": "007651234",
"maskedCardNumber": "00765****",
"nin": "CF87036100PJKL",
"maskedNin": "CF8703********",
"multipleReferenceId": null,
"dateOfBirth": "1985-06-15T00:00:00",
"resultJson": {
"matchingStatus": true,
"cardStatus": "Valid",
"status": "Ok",
"error": null,
"isError": false,
"ninStatus": "Ok"
}
},
"errorCode": null,
"errorMessage": null,
"status": "Successful",
"processedAt": "2024-08-08T13:09:14.321421+03:00",
"verifiedAt": "2024-08-08T13:09:14.960204+03:00",
"id": "4d6e7a5d-4a5e-4b5d-8e5a-4a5b7d5a9b6a",
"createdAt": "2024-08-08T13:09:11.161489+03:00",
"lastUpdated": "2024-08-08T13:09:14.960205+03:00"
}
],
"kccaLicenceChecks": [],
"phoneNumberChecks": [
{
"value": "+256704567890",
"nationalIdNumber": "CF87036100PJKL",
"vendorCode": "STRM_01",
"country": "Uganda",
"response": {
"createdAt": "2024-08-08T10:09:25.768812Z",
"status": "Completed",
"verificationStatus": "Valid",
"phoneNumber": "256704567890",
"sentAt": "2024-08-08T13:09:25.7688123+03:00",
"responsePayload": "{\"Name\":\"JOHN KAGGWA\",\"Network\":\"MTN\",\"Status\":1}",
"processedAt": "2024-08-08T13:09:27.6775565+03:00",
"nameFound": "JOHN KAGGWA",
"network": "MTN",
"phoneNumberStatus": true,
"errorCode": null,
"errorMessage": null,
"isError": null,
"errors": null,
"vendorCode": "STRM_01",
"isPhoneNumberValid": null,
"isOwner": null,
"lastSimSwapDate": null
},
"errorCode": null,
"errorMessage": null,
"status": "Successful",
"processedAt": "2024-08-08T13:09:14.339972+03:00",
"verifiedAt": "2024-08-08T13:09:28.571369+03:00",
"id": "6a7e8f9b-2b5d-4a5e-8e5a-4a5b7d5a9b6a",
"createdAt": "2024-08-08T13:09:11.171449+03:00",
"lastUpdated": "2024-08-08T13:09:28.571369+03:00"
},
{
"value": "+256704567890",
"nationalIdNumber": "CF87036100PJKL",
"vendorCode": "STRM_02",
"country": "Uganda",
"response": {
"createdAt": "2024-08-08T10:09:14.3509363Z",
"status": "Completed",
"verificationStatus": "Valid",
"phoneNumber": "256704567890",
"sentAt": "2024-08-08T13:09:14.3509365+03:00",
"responsePayload": "{\"KycCheck\":{\"StatusMessage\":\"Success.\",\"Data\":{\"PhoneNumber\":\"256704567890\",\"IsPhoneNumberValid\":true,\"NationalIdNumber\":\"CF87036100PJKL\",\"IsOwner\":true},\"SentAt\":\"2024-08-08T10:09:16.156623Z\",\"ProcessedAt\":\"2024-08-08T10:09:15.4855567Z\",\"Initiator\":\"streamline_PhoneId_API\",\"Id\":\"e0254b4a-ae7b-4e77-b0dc-08dc5ae6f68d\",\"CreatedAt\":\"2024-08-08T13:09:15.4853645Z\"},\"SimSwapCheck\":{\"StatusMessage\":\"Success\",\"Data\":{\"LastSimSwapDate\":\"2017-07-04T15:53:46+03:00\"},\"SentAt\":\"2024-08-08T10:09:21.6552174Z\",\"ProcessedAt\":\"2024-08-08T10:09:21.4557791Z\",\"Initiator\":\"streamline_PhoneId_API\",\"Id\":\"88ac8e54-a8fe-4a1c-01dd-08dc5ae6fb95\",\"CreatedAt\":\"2024-08-08T13:09:21.4557781Z\"},\"Status\":1}",
"processedAt": "2024-08-08T13:09:25.5352764+03:00",
"nameFound": null,
"network": null,
"phoneNumberStatus": null,
"errorCode": null,
"errorMessage": null,
"isError": null,
"errors": null,
"vendorCode": "STRM_02",
"isPhoneNumberValid": true,
"isOwner": true,
"lastSimSwapDate": "2017-07-04T15:53:46+03:00"
},
"errorCode": null,
"errorMessage": null,
"status": "Successful",
"processedAt": "2024-08-08T13:09:14.330482+03:00",
"verifiedAt": "2024-08-08T13:09:25.746302+03:00",
"id": "7b8f9d5a-4a5e-4b5d-8e5a-4a5b7d5a9b6a",
"createdAt": "2024-08-08T13:09:11.169455+03:00",
"lastUpdated": "2024-08-08T13:09:25.746302+03:00"
}
],
"tinChecks": [
{
"number": "0201456789",
"country": "Uganda",
"response": {
"tin": "0201456789",
"errorCode": "E004",
"errorDescription": "INVALID TIN",
"initiator": "JOHN KAGGWA",
"contactNumber": null,
"county": null,
"district": null,
"isCustomsAgent": null,
"isLicenseValid": "Not applicable",
"licenseNumber": null,
"mobileNumber": null,
"postalAddress": null,
"registrationStatus": null,
"subCounty": null,
"taxPayerEmail": null,
"taxPayerName": null,
"telephoneNumber": null,
"typeofUser": null,
"village": "Not applicable",
"nitaFaultCode": "Not applicable",
"nitaFaultMessage": "Not applicable",
"nitaFaultDescription": "Not applicable",
"nitaFaultAms": "Not applicable",
"nitaFaultText": "Not applicable",
"status": "Failed",
"isError": false,
"errors": null,
"sentAt": "2024-08-08T10:09:14.7604114",
"processedAt": "2024-08-08T10:09:14.4718832",
"createdAt": "2024-08-08T10:09:14.4718819",
"lastUpdated": "2024-08-08T10:09:17.7246633"
},
"errorCode": null,
"errorMessage": null,
"status": "Failed",
"processedAt": "2024-08-08T13:09:14.349599+03:00",
"verifiedAt": "2024-08-08T13:09:19.112599+03:00",
"id": "8c9d7e5a-4a5e-4b5d-8e5a-4a5b7d5a9b6a",
"createdAt": "2024-08-08T13:09:11.180203+03:00",
"lastUpdated": "2024-08-08T13:09:19.112599+03:00"
}
],
"riskProfileCheck": {
"nationality": "Uganda",
"occupation": "Engineer",
"district": "KAMPALA",
"monthlyIncome": "UGX 3 million - UGX 5 million",
"usePhoneNumber": false,
"useTin": false,
"usePep": true,
"useIdentityDocument": false,
"response": {
"riskScore": 1.75,
"riskClass": "Moderate",
"processedAt": "2024-08-08T13:09:28.009206+03:00",
"status": "Processed",
"computedRiskRatings": [
{
"score": 1.0,
"riskFactor": "District"
},
{
"score": 1.0,
"riskFactor": "PepStatus"
},
{
"score": 0.0,
"riskFactor": "Occupation"
},
{
"score": 0.5,
"riskFactor": "Nationality"
},
{
"score": 2.0,
"riskFactor": "MonthlyIncome"
}
],
"id": "5f7e8d9b-2b5d-4a5e-8e5a-4a5b7d5a9b6a",
"createdAt": "2024-08-08T13:09:21.404645+03:00"
},
"errorCode": null,
"errorMessage": null,
"status": "Successful",
"processedAt": null,
"verifiedAt": "2024-08-08T13:09:29.614239+03:00",
"id": "6a7e8d5a-4a5e-4b5d-8e5a-4a5b7d5a9b6a",
"createdAt": "2024-08-08T13:09:11.209552+03:00",
"lastUpdated": "2024-08-08T13:09:29.61424+03:00"
}Error Response
400 The request data is invalid
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 Not authorized to access the endpoint
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 |
402 No active subscription
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 Refuse to authorize access to the endpoint
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 Request does not exist
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 The server encountered an unexpected 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 |