For the complete documentation index, see llms.txt. This page is also available as Markdown.

Verified Guarantor

This payload is sent to your webhook endpoint on successful guarantor verification.

Sample Webhook Payload

{
  "type": "guarantor",
  "data": {
    "id": 1,
    "applicant": {
      "idType": "nin",
      "idNumber": "10000000001",
      "firstname": "John",
      "middlename": "Doe",
      "lastname": "Doe",
      "phone": "08128730170",
      "gender": "female",
      "birthdate": "17-01-1988",
      "photo": "<base64 payload>"
    },
    "firstname": "kofo",
    "lastname": "joko",
    "phone": "08078878889",
    "email": "john@gmail.com",
    "acceptableIdType": [
      "nin",
      "bvn"
    ],
    "identityType": "NIN",
    "identityNumber": "38498598948859",
    "identityPhoto": "",
    "relationship": "Father",
    "relationshipLength": "24 Years",
    "comment": "I know him well",
    "address": false,
    "verifyAddress": false,
    "status": {
      "status": "VERIFIED",
      "subStatus": "VERIFIED",
      "state": "COMPLETE"
    },
    "createdAt": "Fri Sep 18 2020 14:17:33 GMT+0000 (Coordinated Universal Time)",
    "completedAt": "Fri Sep 18 2020 14:17:33 GMT+0000 (Coordinated Universal Time)"
  }
}

Last updated