Jobzy Logo
KYCKenya

Credit History Verification

Here's how you can verify an employee's Credit History using the Talent API


Service Endpoint:
baseUrl/kye/ke/credit-history
For the baseUrl refer Here

Sample Request Body Object with idType: set to "national-id" or "passport":

const sampleRequest = {
  id: "1234567",
  idType: "national-id | passport",
};

Sample Response Body Object when idType: is set to "national-id":

const sampleNationalIdFoundResponse = {
  success: true,
  statusCode: 200,
  message: "success",
  data: {
    id: "64eed55d89002f8e454bdce2",
    parentId: null,
    status: "found",
    reason: null,
    dataValidation: false,
    selfieValidation: false,
    dateOfBirth: "1999-12-31T21:00:00Z",
    identityType: "national-id",
    isConsent: true,
    idNumber: "1234567",
    businessId: "628b38f03ae28a14f52d4bf7",
    firstName: "Kangethe",
    middleName: "Kariuki",
    lastName: "Simon",
    fullName: "Kangethe Kariuki  Simon",
    gender: "Male",
    maritalStatus: "Married",
    contractSummary: {
      closedContracts: "2",
      openContracts: "10",
    },
    inquiries: {
      numberOfInquiriesLast12Months: "89",
      numberOfInquiriesLast1Month: "6",
      numberOfInquiriesLast24Months: "355",
      numberOfInquiriesLast3Months: "12",
      numberOfInquiriesLast6Months: "27",
    },
    type: "keCreditHistory",
    allValidationPassed: true,
    requestedAt: "2023-08-30T05:36:30.407Z",
    requestedById: "628b38f03ae28a5a122d4bf3",
    country: "KE",
    createdAt: "2023-08-30T05:36:30.593Z",
    lastModifiedAt: "2023-08-30T05:36:30.593Z",
    metadata: {},
    requestedBy: {
      firstName: "API",
      lastName: "User",
      middleName: "",
      id: "628b38f03ae28a5a122d4bf3",
    },
  },
  links: [],
};

Sample Response Body Object when idType: is set to "passport":

const samplePassportFoundResponse = {
  success: true,
  statusCode: 200,
  message: "success",
  data: {
    id: "64eed55d89002f8e454bdce2",
    parentId: null,
    status: "found",
    reason: null,
    dataValidation: false,
    selfieValidation: false,
    dateOfBirth: "1999-12-31T21:00:00Z",
    identityType: "national-id",
    isConsent: true,
    idNumber: "1234567",
    businessId: "628b38f03ae28a14f52d4bf7",
    firstName: "Kangethe",
    middleName: "Kariuki",
    lastName: "Simon",
    fullName: "Kangethe Kariuki  Simon",
    gender: "Male",
    maritalStatus: "Married",
    contractSummary: {
      closedContracts: "2",
      openContracts: "10",
    },
    inquiries: {
      numberOfInquiriesLast12Months: "89",
      numberOfInquiriesLast1Month: "6",
      numberOfInquiriesLast24Months: "355",
      numberOfInquiriesLast3Months: "12",
      numberOfInquiriesLast6Months: "27",
    },
    type: "keCreditHistory",
    allValidationPassed: true,
    requestedAt: "2023-08-30T05:36:30.407Z",
    requestedById: "628b38f03ae28a5a122d4bf3",
    country: "KE",
    createdAt: "2023-08-30T05:36:30.593Z",
    lastModifiedAt: "2023-08-30T05:36:30.593Z",
    metadata: {},
    requestedBy: {
      firstName: "API",
      lastName: "User",
      middleName: "",
      id: "628b38f03ae28a5a122d4bf3",
    },
  },
  links: [],
};

NOTE: For a full request function sample refer to Sample Request Function

On this page