Appearance
Get Last Run Verificiation.
Endpoint for retrieving last run KYC Verification Details by Profile Id (Company / Person) .
Endpoints
Environment | API Endpoint |
---|---|
Sandbox | https://onprem-test.streamline.laboremus.ug/routing/kyc/api/verifications/lastrun/{profileId} |
Request
Request Type : GET
Authorization
INFO
Always add your Subscription key
to the request.
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
v | string | yes | The version of the API |
Path Parameters Values
Name | Type | Required | Description |
---|---|---|---|
id | string(uuid) | yes | The Unique ID of an application |
Response
Content type
application/json
Response Body
Here's the markdown table for the given JSON object, including nested objects but excluding the required column:
amlPepScreeningCheck
Name | Type | Description |
---|---|---|
processedAt | string (datetime) | The date and time when the screening was processed. |
createdAt | string (datetime) | The date and time when the screening was created. |
verifiedAt | string (datetime) | The date and time when the screening was verified. |
lastUpdated | string (datetime) | The date and time when the screening was last updated. |
id | string | Unique identifier for the screening check. |
errorCode | string | Error code if applicable. |
errorMessage | string | Error message if applicable. |
status | string | Current status of the screening check. |
surname | string | Surname of the individual screened. |
givenName | string | Given name of the individual screened. |
otherNames | string | Any other names of the individual screened. |
gender | string | Gender of the individual screened. |
dateOfBirth | string | Date of birth of the individual screened. |
response | Array | List of response objects. |
Response
Name | Type | Description |
---|---|---|
createdAt | string | The date and time when the response was created. |
processedAt | string | The date and time when the response was processed. |
status | string | Status of the response. |
totalHits | integer | Total number of hits found. |
details | Array | List of detail objects related to the response. |
option | string | Option chosen for the screening. |
isError | boolean | Indicates if there was an error in the response. |
errors | Array | List of error objects, if any. |
Details
Name | Type | Description |
---|---|---|
gender | string | Gender of the individual. |
siblings | string | Siblings of the individual. |
dateOfBirth | Array | List of date of birth entries. |
placeOfBirth | Array | List of places of birth. |
placeOfBirthRemarks | string | Remarks about the place of birth. |
politicalParties | string | Political parties associated with the individual. |
description | string | Description of the individual. |
occupations | string | Occupations of the individual. |
spouse | string | Spouse of the individual. |
givenNames | Array | List of given names. |
aliasGivenNames | Array | List of alias names. |
children | Array | List of children. |
links | Array | List of links associated with the individual. |
lastNames | Array | List of last names. |
citizenship | Array | List of citizenships. |
citizenshipRemarks | Array | List of remarks about citizenships. |
positions | Array | List of positions held by the individual. |
sourceType | string | Source type of the information. |
addressRemarks | string | Remarks about the address. |
entityType | string | Type of entity (individual, organization, etc.). |
pepType | string | Type of PEP (Politically Exposed Person) status. |
name | string | Name of the individual. |
sourceId | string | Source identifier. |
sanctionDetails | Array | List of sanction details, if applicable. |
parents | Array | List of parents. |
functions | Array | List of functions held by the individual. |
otherInformation | Array | List of other information. |
titles | Array | List of titles held by the individual. |
tlName | string | Name as per the T&L records. |
Errors
Name | Type | Description |
---|---|---|
code | string | Error code. |
message | string | Error message. |
description | string | Description of the error. |
type | string | Type of error. |
suggestion | Array | List of suggestions to resolve the error. |
companyAmlScreeningCheck
Name | Type | Description |
---|---|---|
processedAt | string (datetime) | The date and time when the screening was processed. |
createdAt | string (datetime) | The date and time when the screening was created. |
verifiedAt | string (datetime) | The date and time when the screening was verified. |
lastUpdated | string (datetime) | The date and time when the screening was last updated. |
id | string | Unique identifier for the screening check. |
errorCode | string | Error code if applicable. |
errorMessage | string | Error message if applicable. |
status | string | Current status of the screening check. |
companyName | string | Name of the company screened. |
response | string | Response details. |
photoMatchCheck
Name | Type | Description |
---|---|---|
processedAt | string (datetime) | The date and time when the screening was processed. |
createdAt | string (datetime) | The date and time when the screening was created. |
verifiedAt | string (datetime) | The date and time when the screening was verified. |
lastUpdated | string (datetime) | The date and time when the screening was last updated. |
id | string | Unique identifier for the screening check. |
errorCode | string | Error code if applicable. |
errorMessage | string | Error message if applicable. |
status | string | Current status of the screening check. |
biometricType | string | Type of biometric used for matching. |
result | boolean | Indicates if the photo match was successful. |
livenessDetectionCheck
Name | Type | Description |
---|---|---|
processedAt | string (datetime) | The date and time when the screening was processed. |
createdAt | string (datetime) | The date and time when the screening was created. |
verifiedAt | string (datetime) | The date and time when the screening was verified. |
lastUpdated | string (datetime) | The date and time when the screening was last updated. |
id | string | Unique identifier for the screening check. |
errorCode | string | Error code if applicable. |
errorMessage | string | Error message if applicable. |
status | string | Current status of the screening check. |
biometricType | string | Type of biometric used for liveness detection. |
result | boolean | Indicates if liveness detection was successful. |
fingerprintCheck
Name | Type | Description |
---|---|---|
processedAt | string (datetime) | The date and time when the screening was processed. |
createdAt | string (datetime) | The date and time when the screening was created. |
verifiedAt | string (datetime) | The date and time when the screening was verified. |
lastUpdated | string (datetime) | The date and time when the screening was last updated. |
id | string | Unique identifier for the screening check. |
errorCode | string | Error code if applicable. |
errorMessage | string | Error message if applicable. |
status | string | Current status of the screening check. |
biometricType | string | Type of biometric used for fingerprint verification. |
result | boolean | Indicates if fingerprint verification was successful. |
Biometric Actions
Name | Type | Description |
---|---|---|
processedAt | string (datetime) | The date and time when the biometric action was processed. |
createdAt | string (datetime) | The date and time when the biometric action was created. |
verifiedAt | string (datetime) | The date and time when the biometric action was verified. |
lastUpdated | string (datetime) | The date and time when the biometric action was last updated. |
id | string | Unique identifier for the biometric action. |
errorCode | string | Error code if applicable. |
errorMessage | string | Error message if applicable. |
status | string |
Example Response Body
Content type
application/json
json
{
"amlPepScreeningCheck": {
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"surname": "string",
"givenName": "string",
"otherNames": "string",
"gender": "string",
"dateOfBirth": "string",
"response": [
{
"createdAt": "string",
"processedAt": "string",
"status": "string",
"totalHits": 0,
"details": [
{
"gender": "string",
"siblings": "string",
"dateOfBirth": [
"string"
],
"placeOfBirth": [
"string"
],
"placeOfBirthRemarks": "string",
"politicalParties": "string",
"description": "string",
"occupations": "string",
"spouse": "string",
"givenNames": [
"string"
],
"aliasGivenNames": [
"string"
],
"children": [
"string"
],
"links": [
"string"
],
"lastNames": [
"string"
],
"citizenship": [
"string"
],
"citizenshipRemarks": [
"string"
],
"positions": [
"string"
],
"sourceType": "string",
"addressRemarks": "string",
"entityType": "string",
"pepType": "string",
"name": "string",
"sourceId": "string",
"sanctionDetails": [
"string"
],
"parents": [
"string"
],
"functions": [
"string"
],
"otherInformation": [
"string"
],
"titles": [
"string"
],
"tlName": "string"
}
],
"option": "string",
"isError": true,
"errors": [
{
"code": "string",
"message": "string",
"description": "string",
"type": "string",
"suggestion": [
"string"
]
}
]
}
]
},
"companyAmlScreeningCheck": {
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"companyName": "string",
"response": "string"
},
"photoMatchCheck": {
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"biometricType": "string",
"result": true
},
"livenessDetectionCheck": {
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"biometricType": "string",
"result": true
},
"fingerprintCheck": {
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"biometricType": "string",
"result": true,
"biometricActions": [
{
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"type": "string",
"result": true,
"comment": "string",
"performedBy": "string",
"performedById": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
},
"businessNameCheck": {
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"registrationNumber": "string",
"country": "string",
"responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"response": {
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"registrationNumber": "string",
"businessName": "string",
"businessType": "string",
"businessSubType": "string",
"incorporationDate": "string",
"registrationDate": "string",
"registrationStatus": "string",
"location": "string",
"annualReturns": "string",
"businessAddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"businessAddress": {
"country": "string",
"district": "string",
"county": "string",
"town": "string",
"village": "string"
},
"shareInfoId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"shareInfo": {
"capital": "string",
"secretary": "string",
"directors": [
"string"
],
"shareHolders": [
"string"
],
"subscribers": [
"string"
],
"partners": [
"string"
]
},
"requesterId": "string",
"sentAt": "string",
"referenceId": "string",
"ursbErrorCode": "string",
"version": "string",
"oldDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"oldData": {
"status": "string",
"requestUri": "string"
},
"userId": "string",
"userName": "string",
"runDate": "string",
"isError": true,
"errors": [
{
"code": "string",
"message": "string",
"description": "string",
"type": "string",
"suggestion": [
"string"
]
}
]
}
},
"identityDocumentChecks": [
{
"processedAt": "2024-10-01T08:41:25.941Z",
"createdAt": "2024-10-01T08:41:25.941Z",
"verifiedAt": "2024-10-01T08:41:25.941Z",
"lastUpdated": "2024-10-01T08:41:25.941Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"idType": "string",
"idNumber": "string",
"documentNumber": "string",
"country": "string",
"dateOfBirth": "string",
"dateOfIssue": "string",
"dateOfExpiry": "string",
"surname": "string",
"givenNames": "string",
"otherNames": "string",
"requiresValidation": true,
"useFingerprint": true,
"fingerprintPosition": "string",
"response": "string"
}
],
"kccaLicenceChecks": [
{
"processedAt": "2024-10-01T08:41:25.941Z",
"createdAt": "2024-10-01T08:41:25.941Z",
"verifiedAt": "2024-10-01T08:41:25.941Z",
"lastUpdated": "2024-10-01T08:41:25.941Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"applicationReference": "string",
"response": {
"applicationReference": "string",
"status": "string",
"text": "string",
"success": true,
"isError": true,
"errorCode": 0,
"coin": 0,
"taxPayerName": "string",
"tin": "string",
"businessName": "string",
"category": "string",
"nature": "string",
"year": 0,
"issueDate": "string",
"expiryDate": "string",
"amount": 0,
"division": "string",
"parish": "string",
"village": "string",
"street": "string",
"building": "string",
"shopNo": "string",
"prn": "string",
"sentAt": "string",
"processedAt": "string"
}
}
],
"phoneNumberChecks": [
{
"processedAt": "2024-10-01T08:41:25.941Z",
"createdAt": "2024-10-01T08:41:25.941Z",
"verifiedAt": "2024-10-01T08:41:25.941Z",
"lastUpdated": "2024-10-01T08:41:25.941Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"value": "string",
"country": "string",
"vendorCode": "string",
"nationalIdNumber": "string",
"response": {
"createdAt": "string",
"status": "string",
"verificationStatus": "string",
"phoneNumber": "string",
"sentAt": "string",
"responsePayload": "string",
"processedAt": "string",
"nameFound": "string",
"network": "string",
"phoneNumberStatus": true,
"errorCode": "string",
"errorMessage": "string",
"vendorCode": "string",
"isPhoneNumberValid": true,
"isOwner": "string",
"lastSimSwapDate": "string",
"isError": true,
"errors": [
{
"code": "string",
"message": "string",
"description": "string",
"type": "string",
"suggestion": [
"string"
]
}
]
}
}
],
"tinChecks": [
{
"processedAt": "2024-10-01T08:41:25.941Z",
"createdAt": "2024-10-01T08:41:25.941Z",
"verifiedAt": "2024-10-01T08:41:25.941Z",
"lastUpdated": "2024-10-01T08:41:25.941Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"number": "string",
"country": "string",
"response": {
"tin": "string",
"errorCode": "string",
"errorDescription": "string",
"initiator": "string",
"contactNumber": "string",
"county": "string",
"district": "string",
"isCustomsAgent": "string",
"isLicenseValid": "string",
"licenseNumber": "string",
"mobileNumber": "string",
"postalAddress": "string",
"registrationStatus": "string",
"subCounty": "string",
"taxPayerEmail": "string",
"taxPayerName": "string",
"telephoneNumber": "string",
"typeofUser": "string",
"village": "string",
"nitaFaultCode": "string",
"nitaFaultMessage": "string",
"nitaFaultDescription": "string",
"nitaFaultAms": "string",
"nitaFaultText": "string",
"status": "string",
"sentAt": "string",
"processedAt": "string",
"createdAt": "string",
"lastUpdated": "string",
"isError": true,
"errors": [
{
"code": "string",
"message": "string",
"description": "string",
"type": "string",
"suggestion": [
"string"
]
}
]
}
}
],
"riskProfileCheck": {
"processedAt": "2024-10-01T08:41:25.941Z",
"createdAt": "2024-10-01T08:41:25.941Z",
"verifiedAt": "2024-10-01T08:41:25.941Z",
"lastUpdated": "2024-10-01T08:41:25.941Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"nationality": "string",
"occupation": "string",
"district": "string",
"monthlyIncome": "string",
"usePhoneNumber": true,
"useTin": true,
"usePep": true,
"useIdentityDocument": "string",
"response": {
"riskScore": 0,
"riskClass": "string",
"processedAt": "2024-10-01T08:41:25.941Z",
"createdAt": "2024-10-01T08:41:25.941Z",
"status": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"computedRiskRatings": [
{
"score": 0,
"riskFactor": "string"
}
]
}
}
}
{
"amlPepScreeningCheck": {
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"surname": "string",
"givenName": "string",
"otherNames": "string",
"gender": "string",
"dateOfBirth": "string",
"response": [
{
"createdAt": "string",
"processedAt": "string",
"status": "string",
"totalHits": 0,
"details": [
{
"gender": "string",
"siblings": "string",
"dateOfBirth": [
"string"
],
"placeOfBirth": [
"string"
],
"placeOfBirthRemarks": "string",
"politicalParties": "string",
"description": "string",
"occupations": "string",
"spouse": "string",
"givenNames": [
"string"
],
"aliasGivenNames": [
"string"
],
"children": [
"string"
],
"links": [
"string"
],
"lastNames": [
"string"
],
"citizenship": [
"string"
],
"citizenshipRemarks": [
"string"
],
"positions": [
"string"
],
"sourceType": "string",
"addressRemarks": "string",
"entityType": "string",
"pepType": "string",
"name": "string",
"sourceId": "string",
"sanctionDetails": [
"string"
],
"parents": [
"string"
],
"functions": [
"string"
],
"otherInformation": [
"string"
],
"titles": [
"string"
],
"tlName": "string"
}
],
"option": "string",
"isError": true,
"errors": [
{
"code": "string",
"message": "string",
"description": "string",
"type": "string",
"suggestion": [
"string"
]
}
]
}
]
},
"companyAmlScreeningCheck": {
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"companyName": "string",
"response": "string"
},
"photoMatchCheck": {
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"biometricType": "string",
"result": true
},
"livenessDetectionCheck": {
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"biometricType": "string",
"result": true
},
"fingerprintCheck": {
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"biometricType": "string",
"result": true,
"biometricActions": [
{
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"type": "string",
"result": true,
"comment": "string",
"performedBy": "string",
"performedById": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
},
"businessNameCheck": {
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"registrationNumber": "string",
"country": "string",
"responseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"response": {
"processedAt": "2024-10-01T08:41:25.940Z",
"createdAt": "2024-10-01T08:41:25.940Z",
"verifiedAt": "2024-10-01T08:41:25.940Z",
"lastUpdated": "2024-10-01T08:41:25.940Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"registrationNumber": "string",
"businessName": "string",
"businessType": "string",
"businessSubType": "string",
"incorporationDate": "string",
"registrationDate": "string",
"registrationStatus": "string",
"location": "string",
"annualReturns": "string",
"businessAddressId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"businessAddress": {
"country": "string",
"district": "string",
"county": "string",
"town": "string",
"village": "string"
},
"shareInfoId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"shareInfo": {
"capital": "string",
"secretary": "string",
"directors": [
"string"
],
"shareHolders": [
"string"
],
"subscribers": [
"string"
],
"partners": [
"string"
]
},
"requesterId": "string",
"sentAt": "string",
"referenceId": "string",
"ursbErrorCode": "string",
"version": "string",
"oldDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"oldData": {
"status": "string",
"requestUri": "string"
},
"userId": "string",
"userName": "string",
"runDate": "string",
"isError": true,
"errors": [
{
"code": "string",
"message": "string",
"description": "string",
"type": "string",
"suggestion": [
"string"
]
}
]
}
},
"identityDocumentChecks": [
{
"processedAt": "2024-10-01T08:41:25.941Z",
"createdAt": "2024-10-01T08:41:25.941Z",
"verifiedAt": "2024-10-01T08:41:25.941Z",
"lastUpdated": "2024-10-01T08:41:25.941Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"idType": "string",
"idNumber": "string",
"documentNumber": "string",
"country": "string",
"dateOfBirth": "string",
"dateOfIssue": "string",
"dateOfExpiry": "string",
"surname": "string",
"givenNames": "string",
"otherNames": "string",
"requiresValidation": true,
"useFingerprint": true,
"fingerprintPosition": "string",
"response": "string"
}
],
"kccaLicenceChecks": [
{
"processedAt": "2024-10-01T08:41:25.941Z",
"createdAt": "2024-10-01T08:41:25.941Z",
"verifiedAt": "2024-10-01T08:41:25.941Z",
"lastUpdated": "2024-10-01T08:41:25.941Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"applicationReference": "string",
"response": {
"applicationReference": "string",
"status": "string",
"text": "string",
"success": true,
"isError": true,
"errorCode": 0,
"coin": 0,
"taxPayerName": "string",
"tin": "string",
"businessName": "string",
"category": "string",
"nature": "string",
"year": 0,
"issueDate": "string",
"expiryDate": "string",
"amount": 0,
"division": "string",
"parish": "string",
"village": "string",
"street": "string",
"building": "string",
"shopNo": "string",
"prn": "string",
"sentAt": "string",
"processedAt": "string"
}
}
],
"phoneNumberChecks": [
{
"processedAt": "2024-10-01T08:41:25.941Z",
"createdAt": "2024-10-01T08:41:25.941Z",
"verifiedAt": "2024-10-01T08:41:25.941Z",
"lastUpdated": "2024-10-01T08:41:25.941Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"value": "string",
"country": "string",
"vendorCode": "string",
"nationalIdNumber": "string",
"response": {
"createdAt": "string",
"status": "string",
"verificationStatus": "string",
"phoneNumber": "string",
"sentAt": "string",
"responsePayload": "string",
"processedAt": "string",
"nameFound": "string",
"network": "string",
"phoneNumberStatus": true,
"errorCode": "string",
"errorMessage": "string",
"vendorCode": "string",
"isPhoneNumberValid": true,
"isOwner": "string",
"lastSimSwapDate": "string",
"isError": true,
"errors": [
{
"code": "string",
"message": "string",
"description": "string",
"type": "string",
"suggestion": [
"string"
]
}
]
}
}
],
"tinChecks": [
{
"processedAt": "2024-10-01T08:41:25.941Z",
"createdAt": "2024-10-01T08:41:25.941Z",
"verifiedAt": "2024-10-01T08:41:25.941Z",
"lastUpdated": "2024-10-01T08:41:25.941Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"number": "string",
"country": "string",
"response": {
"tin": "string",
"errorCode": "string",
"errorDescription": "string",
"initiator": "string",
"contactNumber": "string",
"county": "string",
"district": "string",
"isCustomsAgent": "string",
"isLicenseValid": "string",
"licenseNumber": "string",
"mobileNumber": "string",
"postalAddress": "string",
"registrationStatus": "string",
"subCounty": "string",
"taxPayerEmail": "string",
"taxPayerName": "string",
"telephoneNumber": "string",
"typeofUser": "string",
"village": "string",
"nitaFaultCode": "string",
"nitaFaultMessage": "string",
"nitaFaultDescription": "string",
"nitaFaultAms": "string",
"nitaFaultText": "string",
"status": "string",
"sentAt": "string",
"processedAt": "string",
"createdAt": "string",
"lastUpdated": "string",
"isError": true,
"errors": [
{
"code": "string",
"message": "string",
"description": "string",
"type": "string",
"suggestion": [
"string"
]
}
]
}
}
],
"riskProfileCheck": {
"processedAt": "2024-10-01T08:41:25.941Z",
"createdAt": "2024-10-01T08:41:25.941Z",
"verifiedAt": "2024-10-01T08:41:25.941Z",
"lastUpdated": "2024-10-01T08:41:25.941Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"errorCode": "string",
"errorMessage": "string",
"status": "string",
"nationality": "string",
"occupation": "string",
"district": "string",
"monthlyIncome": "string",
"usePhoneNumber": true,
"useTin": true,
"usePep": true,
"useIdentityDocument": "string",
"response": {
"riskScore": 0,
"riskClass": "string",
"processedAt": "2024-10-01T08:41:25.941Z",
"createdAt": "2024-10-01T08:41:25.941Z",
"status": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"computedRiskRatings": [
{
"score": 0,
"riskFactor": "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 |