Guarantor Verification

Digitally validate the guarantor or reference of an applicant to document the relationship between the applicant and the prospective guarantor/reference. To conduct a live test

{{baseUrl}}/v1/guarantors

Request Body

Parameters	Type	Description
customerReference (REQUIRED)	string	Customer Reference
firstname* (REQUIRED)	string	Guarantor Firstname
lastname (REQUIRED)	string	Guarantor Lastname
phone (REQUIRED)	string	Guarantor Phone number
email (REQUIRED)	string	Guarantor email address
verifyAddress (OPTIONAL)	boolean	Should verify guarantor address
street (OPTIONAL)	string	Guarantor street address
lgaName (OPTIONAL)	string	Lga name of guarantor address
landmark (OPTIONAL)	string	Guarantor address landmark
acceptableIdType (REQUIRED)	array	Acceptable identity types from guarantor
applicant.firstname (REQUIRED)	string	Applicant Firstname
applicant.lastname (REQUIRED)	string	Applicant Lastname
applicant.phone (REQUIRED)	string	Applicant Phone
applicant.dob (OPTIONAL)	dateString	Applicant Date of Birth; Accepts: YYYY-MM-DD
applicant.idType (OPTIONAL)	enum: {nin, bvn, frsc, drivers_license}	Identity Type
applicant.idNumber (OPTIONAL)	string	Applicant Id Number

Response Sample

{
    "id": 39,
    "customerReference": "12314",
    "applicant": {
        "createdAt": "2022-09-21T22:47:32.000Z",
        "updatedAt": "2022-09-21T22:47:32.000Z",
        "id": 11,
        "firstname": "Jamxxx",
        "middlename": "string",
        "lastname": "Jaxxx",
        "gender": [
            "male"
        ],
        "maritalStatus": null,
        "phone": "+2349066277918",
        "email": null,
        "dob": "2022-09-21T22:42:33.145Z",
        "photo": null
    },
    "status": {
        "status": "IN_PROGRESS",
        "subStatus": "IN PROGRESS",
        "state": "IN_PROGRESS"
    },
    "guarantor": {
        "id": 39,
        "verificationTypeCode": "guarantor",
        "organisationId": 86923,
        "userId": null,
        "approvedAt": null,
        "requestedAt": "2022-09-23T10:37:18.000Z",
        "consentReference": "UvMMmhUVXHlpG0L9yv_fK",
        "requestSource": "api",
        "archived": false,
        "canContactPoc": false,
        "apiReference": null,
        "stateId": 12,
        "stateName": "Exx",
        "lgaId": 231,
        "lgaName": "Oredo",
        "customerReference": "123xx",
        "paymentMethodCode": "standard",
        "applicant": {
            "createdAt": "2022-09-21T22:47:32.000Z",
            "updatedAt": "2022-09-21T22:47:32.000Z",
            "id": 11,
            "firstname": "Jamxx",
            "middlename": "string",
            "lastname": "Jacob",
            "gender": [
                "male"
            ],
            "maritalStatus": null,
            "phone": "+23490662779xx",
            "email": null,
            "dob": "2022-09-21T22:42:33.145Z",
            "photo": null
        },
        "guarantorDetail": {
            "addressId": null,
            "availableForContact": null,
            "guarantorId": 9
        },
        "guarantorIdentity": {
            "identity": null,
            "identityPhoto": null,
            "identityType": null,
            "permissibleIdentityType": "nin,frsc"
        },
        "guarantorVerification": {
            "comment": null,
            "deviceFingerprint": null,
            "verifyAddress": true,
            "viewedAt": null
        },
        "guarantorRelationship": {
            "relationshipLength": null,
            "relationshipType": null
        },
        "price": 1000,
        "status": {
            "status": "IN_PROGRESS",
            "subStatus": "IN PROGRESS",
            "state": "IN_PROGRESS"
        }
    }
}

{
  "bodyRaw": "{\"event\":\"guarantor\",\"event_type\":\"verification_completed\",\"data\":{\"id\":3846139,\"summary\":null,\"customerReference\":\"aasfcg6\",\"guarantor\":{\"id\":3846139,\"verificationTypeCode\":\"guarantor\",\"applicationId\":131,\"organisationId\":86923,\"userId\":null,\"approvedAt\":\"2023-04-26T11:07:16.000Z\",\"requestedAt\":\"2023-04-26T10:55:34.000Z\",\"consentReference\":\"5xiGVFmQOCpCSa8C4NWUN\",\"identityVerificationId\":null,\"requestSource\":\"api\",\"archived\":false,\"canContactPoc\":false,\"apiReference\":null,\"stateId\":25,\"stateName\":\"Lagos\",\"lgaId\":515,\"lgaName\":\"Mushin\",\"status\":{\"status\":\"VERIFIED\",\"subStatus\":\"VERIFIED\",\"state\":\"COMPLETE\"},\"customerReference\":\"aasfcg6\",\"isLive\":true,\"paymentMethodCode\":\"standard\",\"applicant\":{\"firstname\":\"Kolade\",\"middlename\":\"toyosi\",\"lastname\":\"Alade\",\"gender\":\"female\",\"maritalStatus\":null,\"phone\":\"+2349012345678\",\"email\":\"[email protected]\",\"dob\":\"2022-09-14\",\"photo\":null},\"guarantorDetail\":{\"firstname\":\"Joshua\",\"lastname\":\"Orubebe\",\"middlename\":null,\"phone\":\"+2349012345678\",\"email\":\"[email protected]\",\"addressId\":null,\"availableForContact\":false},\"guarantorIdentity\":{\"identity\":\"JZ426633988976CH\",\"identityPhoto\":null,\"identityType\":\"vnin\",\"permissibleIdentityType\":\"vnin\"},\"guarantorVerification\":{\"comment\":\"This is a test account\",\"deviceFingerprint\":null,\"landmark\":\"mushin\",\"lgaName\":\"mushin\",\"street\":\"13\",\"verifyAddress\":false,\"viewedAt\":\"2023-04-26 11:6:53\"},\"guarantorRelationship\":{\"relationshipLength\":\"1-3 years\",\"relationshipType\":\"Immediate family\"},\"price\":2500}}}",
  "body": {
    "event": "guarantor",
    "event_type": "verification_completed",
    "data": {
      "id": 3846139,
      "summary": null,
      "customerReference": "aasfcg6",
      "guarantor": {
        "id": 3846139,
        "verificationTypeCode": "guarantor",
        "applicationId": 131,
        "organisationId": 86923,
        "userId": null,
        "approvedAt": "2023-04-26T11:07:16.000Z",
        "requestedAt": "2023-04-26T10:55:34.000Z",
        "consentReference": "5xiGVFmQOCpCSa8C4NWUN",
        "identityVerificationId": null,
        "requestSource": "api",
        "archived": false,
        "canContactPoc": false,
        "apiReference": null,
        "stateId": 25,
        "stateName": "Lagos",
        "lgaId": 515,
        "lgaName": "Mushin",
        "status": {
          "status": "VERIFIED",
          "subStatus": "VERIFIED",
          "state": "COMPLETE"
        },
        "customerReference": "aasfcg6",
        "isLive": true,
        "paymentMethodCode": "standard",
        "applicant": {
          "firstname": "Kolade",
          "middlename": "toyosi",
          "lastname": "Alade",
          "gender": "female",
          "maritalStatus": null,
          "phone": "+2349012345678",
          "email": "[email protected]",
          "dob": "2022-09-14",
          "photo": null
        },
        "guarantorDetail": {
          "firstname": "Joshua",
          "lastname": "Orubebe",
          "middlename": null,
          "phone": "+2349012345678",
          "email": "[email protected]",
          "addressId": null,
          "availableForContact": false
        },
        "guarantorIdentity": {
          "identity": "JZ426633988976CH",
          "identityPhoto": null,
          "identityType": "vnin",
          "permissibleIdentityType": "vnin"
        },
        "guarantorVerification": {
          "comment": "This is a test account",
          "deviceFingerprint": null,
          "landmark": "mushin",
          "lgaName": "mushin",
          "street": "13",
          "verifyAddress": false,
          "viewedAt": "2023-04-26 11:6:53"
        },
        "guarantorRelationship": {
          "relationshipLength": "1-3 years",
          "relationshipType": "Immediate family"
        },
        "price": 2500
      }
    }
  }
}