Submit Guarantor Verification

Please note that you are required to have a webhook set for guarantor verification requests to be successful. If they are not set, you will not get notified when the verification has been completed.
post
Submit Guarantor for Verification
https://vapi.verifyme.ng/v1/verifications/guarantors
This endpoint allows you to create guarantor verifications
Request
Response
Request
Headers
Authentication
required
string
Authentication Token
Body Parameters
state
required
string
State name
street
required
string
Street address
landmark
optional
string
Guarantors Address landmark
acceptableIdType
required
array
An Array of IDs to accept from the guarantor
( "BVN", "NIN" or "Drivers license")
verifyAddress
optional
boolean
should verify Guarantors address (defaults to false )
lga
required
string
Local Government Area
email
required
string
Guarantor Email
phone
required
string
Guarantor Phone
lastname
required
string
Guarantor lastname
firstname
required
string
Guarantor firstname
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": 3456
  "applicant": {
    "idType": "NIN", 
    "idNumber": "8989999988443", 
    "firstname": "John",
    "middlename": "Jane", 
    "lastname": "Doe",
    "phone": "08060000001", 
    "gender": "female" 
    "birthdate": "17-01-1988", 
    "photo":"Base64 Encoded", 
  },
  "firstname": "Moses",
  "lastname": "Mavin",
  "phone": "080000000000",
  "email": "[email protected]",
  "acceptableIdType": ["NIN", "BVN", "FRSC", "VIN", "PN"],
  "address": {
    "formattedAddress": "23, John Boomg Street, Osogbo, Osun State, Nigeria",
    "state":"Osun",
    "lga": "Olorunda",
    "street": "23, John Boomg Street",
    "city": "Osogbo",
    "country": "Nigeria",
  }
  "verifyAddress": false,
  "status": {
    "status": "IN_PROGRESS", 
    "subStatus": "IN_PROGRESS", 
    "state": "IN_PROGRESS"
  },
  "createdAt": "2020-02-05T10:24:12.000",
}
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"
    },
    "firstname": "James",
    "lastname": "Ademola",
    "phone": "0800000000",
    "email": "[email protected]",
    "street": "23, John Boomg Street",
    "lga": "olorunda",
    "landmark": "luke telecommunication",
    "acceptableIdType": [
        "BVN"
    ],
    "verifyAddress": true
}
CURL
curl --verbose  
--header "Authorization: Bearer <token>"
--data '{    "applicant": {        "idType": "NIN",        "idNumber": "10000000001",        "firstname": "john",        "lastname": "doe",        "dob":"04-04-1944",        "phone": "08121234567"    },    "firstname": "James",    "lastname": "Ademola",    "phone": "0800000000",    "email": "[email protected]",    "street": "23, John Boomg Street",    "lga": "olorunda",    "landmark": "luke telecommunication",    "acceptableIdTypes": [        "BVN"    ],    "verifyAddress": true}' 
--request "POST" "https://vapi.verifyme.ng/v1/verifications/guarantor"
Cancel Address Verification
Next - Guarantor Verification
Get Guarantor Verifications
Last updated 1 month ago
Submit Guarantor Verification

postSubmit Guarantor for Verification

Sample Request

post
Submit Guarantor for Verification
