Submit Employment History Verification

Please note that you are required to have a webhook set for employment verification requests to be successful. If they are not set, you will not get notified when the verification has been completed.

post
Submit Employment History for Verification

https://vapi.verifyme.ng/v1/verifications/employments
This endpoint allows you to create employment verification requests
Request
Response
Request
Headers
Authentication
required
string
Authentication Token
Body Parameters
jobTitle
required
string
Job title held by the applicant
contactPersonName
required
string
Company's Contact person name
currentlyEmployed
required
array
Boolean that represents if the applicant still works there
employerName
required
string
Name of company/employer
employerEmail
required
string
Email of company/employer
employerPhone
required
string
Phone Number of company/employer
startDate
required
string
Employment start date
endDate
required
string
Employment end date
applicant.firstname
required
string
Applicants first name
applicant.lastname
required
string
Applicants last name
applicant.dob
optional
string
Applicants date of birth ( DD-MM-YYYY )
applicants.phone
optional
string
Applicants phone number
applicant.idType
required
string
Applicants Id type ( "BVN" ,"NIN", "KYC" )
applicant.idNumber
required
string
Applicants Identity Number ("BVN", "NIN", "Phone No")
Response
201: Created
Guarantor verification created.
{
"status": "success",
"data": {
"id": 2455,
"employerName": "verifyme",
"employerPhone": "08128730170",
"employerEmail": "[email protected]",
"startDate": "5/6/2020",
"endDate": "10/12/2020",
"title": "software engineer",
"applicant": {
"firstname": "John",
"lastname": "Doe",
"middlename": " ",
"phone": "+234812345678",
"gender": "Male",
"photo": "<base64 image>"
},
"status": {
"status": "PENDING",
"subStatus": "PENDING",
"state": "PENDING"
},
"currentlyEmployed": true
}
}
401: Unauthorized
Unauthorized
{
"status": "error",
"message": "string",
"code": "ACCESS_DENIED"
}

Sample Request

JSON
CURL
JSON
{
"applicant": {
"idType": "NIN",
"idNumber": "10000000001",
"firstname": "john",
"lastname": "doe",
"dob":"04-04-1944",
"phone": "08121234567"
},
"employerName":"verifyme",
"employerEmail":"[email protected]",
"employerPhone":"0812345678",
"startDate":"5/6/2020",
"endDate":"10/12/2020",
"jobTitle":"plumber",
"currentlyEmployed":true,
"contactPersonName":"james bay"
}
CURL
curl --location --request POST 'https://vapi.verifyme.ng/v1/verifications/employment' \
--header 'Authorization: Bearer <live or test key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"applicant": {
"idType": "NIN",
"idNumber": "10000000001",
"firstname": "john",
"lastname": "doe",
"dob":"04-04-1944",
"phone": "08121234567"
},
"employerName":"verifyme",
"employerEmail":"[email protected]",
"employerPhone":"0812345678",
"startDate":"5/6/2020",
"endDate":"10/12/2020",
"jobTitle":"plumber",
"currentlyEmployed":true,
"contactPersonName":"james bay"
}'