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"
}
}
}
Updated 5 months ago