Employment Verification
Verify the Current or previous employment of an applicant to document employment details of the applicant with the requested institution/organization.
{{baseUrl}}/v1/employments
Request Body
Parameters | Type | Description |
---|---|---|
customerReference (REQUIRED) | string | Customer Reference |
employerName (REQUIRED) | string | Employer Name |
employerEmail (REQUIRED) | string | Employer Email |
employerPhone (REQUIRED) | string | Employer Phone |
startDate (OPTIONAL) | dateString | Employment start date |
endDate (OPTIONAL) | dateString | Employment end date |
jobTitle (OPTIONAL) | string | Employee job title |
currentlyEmployed (OPTIONAL) | string | Employee currently employed? |
contactPersonName (OPTIONAL) | string | Employer Contact person name |
applicant.firstname (REQUIRED) | string | Applicant Firstname |
applicant.lastname (REQUIRED) | string | Applicant Lastname |
applicant.dob (OPTIONAL) | dateString | Applicant Date of Birth; Accepts: YYYY-MM-DD |
applicant.phone (REQUIRED) | string | Applicant Phone |
applicant.idNumber (OPTIONAL) | enum : {nin, bvn, frsc, drivers_license} | ID Number |
Response Sample
{
"id": 63,
"customerReference": "eyt",
"applicant": {
"createdAt": "2022-11-02T21:38:46.000Z",
"updatedAt": "2022-11-02T21:38:46.000Z",
"id": 23,
"firstname": "Kolade",
"middlename": "toyosi",
"lastname": "Alade",
"gender": "female",
"phone": "+2348111111111",
"dob": "2022-09-14"
},
"status": {
"status": "IN_PROGRESS",
"subStatus": "IN PROGRESS",
"state": "IN_PROGRESS"
},
"employment": {
"id": 63,
"verificationTypeCode": "employment",
"isAsset": false,
"organisationId": 86923,
"requestedAt": "2022-11-02T22:24:36.000Z",
"consentReference": "nU__RQf9Zwgd-qWsiKVXg",
"requestSource": "api",
"archived": false,
"canContactPoc": false,
"isVague": false,
"customerReference": "eyt",
"paymentMethodCode": "standard",
"employmentDetails": {
"currentlyEmployed": false,
"endDate": "2022-09-14T00:00:00.000Z",
"jobTitle": "QA",
"startDate": "2022-09-14T00:00:00.000Z"
},
"employerDetails": {
"contactPersonName": "Okeke chukwu",
"email": "[email protected]",
"name": "VerifyMe",
"phone": "08111111111"
},
"price": 0,
"updatedAt": "2022-11-02T22:24:36.000Z",
"status": {
"status": "IN_PROGRESS",
"subStatus": "IN PROGRESS",
"state": "IN_PROGRESS"
}
}
}
{
"bodyRaw": "{\"event\":\"employment\",\"event_type\":\"verification_completed\",\"data\":{\"id\":3846137,\"summary\":null,\"customerReference\":\"1rebyytv-8\",\"employment\":{\"id\":3846137,\"verificationTypeCode\":\"employment\",\"isAsset\":false,\"organisationId\":86923,\"userId\":86923,\"approvedAt\":\"2023-04-26T10:59:53.000Z\",\"requestedAt\":\"2023-04-26T10:45:10.000Z\",\"consentReference\":\"cROXg3l2ivenq4MGs61yE\",\"identityVerificationId\":null,\"requestSource\":\"api\",\"archived\":false,\"canContactPoc\":false,\"apiReference\":null,\"bundleCode\":null,\"stateId\":null,\"lgaId\":null,\"applicationId\":131,\"latitude\":null,\"longitude\":null,\"isVague\":false,\"isLive\":true,\"customerReference\":\"1rebyytv-8\",\"paymentMethodCode\":\"standard\",\"criminalRecord\":{\"offence\":null,\"policeReport\":null,\"policeReportNumber\":null,\"policeStationAddress\":null},\"employmentDetails\":{\"averageHours\":null,\"compensationRate\":\"Monthly\",\"currentlyEmployed\":false,\"employeeDepartment\":null,\"employeeEndDate\":\"2011-01-04T00:00:00.000Z\",\"employeeStartDate\":\"2011-01-08T00:00:00.000Z\",\"employeeTitle\":\"MARKETING MANAGER\",\"employerConsented\":true,\"employmentType\":\"Full-Time\",\"endDate\":\"2022-09-14T00:00:00.000Z\",\"jobBenefits\":\"Health Insurance,Severance Package,Paid Time Off,Transport Allowance,Housing Allowance,Training, Certification and Professional Membership Dues,Parental Leave,Stock Options,others\",\"jobLeaveReason\":null,\"jobTermination\":\"voluntary\",\"jobTitle\":\"QA\",\"offence\":null,\"rehire\":true,\"salaryRange\":\"101,000 - 3000,000\",\"startDate\":\"2022-09-14T00:00:00.000Z\",\"supervisorEmail\":\"[email protected]\",\"supervisorName\":\"JOHN DOE\",\"supervisorPhone\":\"+2349011111000\",\"supervisorTitle\":\"DIRECTOR\"},\"employerDetails\":{\"comment\":\"TEST ACCOUNT\",\"companyAddress\":\"13 MUHAMMED STREET LAGOS ISLAND LAGOS\",\"companyCac\":\"12345\",\"companySize\":\"11 - 50\",\"contactPersonName\":\"Okeke chukwu\",\"email\":\"[email protected]\",\"industry\":\"Mass Media\",\"name\":\"TEST COMPANY\",\"phone\":\"+2349012345678\"},\"attestator\":{\"email\":\"[email protected]\",\"name\":\"JOHN DOE\",\"phone\":null,\"title\":\"Head Marketing and HR\"},\"applicant\":{\"firstname\":\"Kolade\",\"middlename\":\"toyosi\",\"lastname\":\"Alade\",\"gender\":\"female\",\"maritalStatus\":null,\"phone\":\"+2349012345678\",\"email\":\"[email protected]\",\"dob\":\"2022-09-14\",\"photo\":null},\"price\":2500,\"status\":{\"status\":\"VERIFIED\",\"subStatus\":\"VERIFIED\",\"state\":\"COMPLETE\"}}}}",
"body": {
"event": "employment",
"event_type": "verification_completed",
"data": {
"id": 3846137,
"summary": null,
"customerReference": "1rebyytv-8",
"employment": {
"id": 3846137,
"verificationTypeCode": "employment",
"isAsset": false,
"organisationId": 86923,
"userId": 86923,
"approvedAt": "2023-04-26T10:59:53.000Z",
"requestedAt": "2023-04-26T10:45:10.000Z",
"consentReference": "cROXg3l2ivenq4MGs61yE",
"identityVerificationId": null,
"requestSource": "api",
"archived": false,
"canContactPoc": false,
"apiReference": null,
"bundleCode": null,
"stateId": null,
"lgaId": null,
"applicationId": 131,
"latitude": null,
"longitude": null,
"isVague": false,
"isLive": true,
"customerReference": "1rebyytv-8",
"paymentMethodCode": "standard",
"criminalRecord": {
"offence": null,
"policeReport": null,
"policeReportNumber": null,
"policeStationAddress": null
},
"employmentDetails": {
"averageHours": null,
"compensationRate": "Monthly",
"currentlyEmployed": false,
"employeeDepartment": null,
"employeeEndDate": "2011-01-04T00:00:00.000Z",
"employeeStartDate": "2011-01-08T00:00:00.000Z",
"employeeTitle": "MARKETING MANAGER",
"employerConsented": true,
"employmentType": "Full-Time",
"endDate": "2022-09-14T00:00:00.000Z",
"jobBenefits": "Health Insurance,Severance Package,Paid Time Off,Transport Allowance,Housing Allowance,Training, Certification and Professional Membership Dues,Parental Leave,Stock Options,others",
"jobLeaveReason": null,
"jobTermination": "voluntary",
"jobTitle": "QA",
"offence": null,
"rehire": true,
"salaryRange": "101,000 - 3000,000",
"startDate": "2022-09-14T00:00:00.000Z",
"supervisorEmail": "[email protected]",
"supervisorName": "JOHN DOE",
"supervisorPhone": "+2349011111000",
"supervisorTitle": "DIRECTOR"
},
"employerDetails": {
"comment": "TEST ACCOUNT",
"companyAddress": "13 MUHAMMED STREET LAGOS ISLAND LAGOS",
"companyCac": "12345",
"companySize": "11 - 50",
"contactPersonName": "Okeke chukwu",
"email": "[email protected]",
"industry": "Mass Media",
"name": "TEST COMPANY",
"phone": "+2349012345678"
},
"attestator": {
"email": "[email protected]",
"name": "JOHN DOE",
"phone": null,
"title": "Head Marketing and HR"
},
"applicant": {
"firstname": "Kolade",
"middlename": "toyosi",
"lastname": "Alade",
"gender": "female",
"maritalStatus": null,
"phone": "+2349012345678",
"email": "[email protected]",
"dob": "2022-09-14",
"photo": null
},
"price": 2500,
"status": {
"status": "VERIFIED",
"subStatus": "VERIFIED",
"state": "COMPLETE"
}
}
}
}
}
Updated over 1 year ago