v1

latestOpenAPI 3.1.02026-07-2611041.1 KB

Guarantor Verification

Verify a guarantor

post/v1/guarantors

Request body

customerReferencestring required

Customer reference

firstnamestring required

Guarantor's first name

lastnamestring required

Guarantor's last name

phonestring required

Guarantor's phone number

emailstring required

Guarantor's email address

streetstring required

Guarantor's street

lganamestring required

Guarantor's local government

landmarkstring

Guarantor's address landmark

acceptableIdtype'nin' | 'bvn' | 'drivers_license' required

Guarantor's identification type

Response

200

idinteger

customerReferencestring

verificationTypeCodestring

organisationIdinteger

requestedAtstring

consentReferencestring

requestSourcestring

archivedboolean

canContactPocboolean

paymentMethodCodestring

priceinteger

updatedAtstring

Example response

{
  "id": 75,
  "customerReference": "aasfcgn",
  "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"
  },
  "verificationTypeCode": "guarantor",
  "organisationId": 86923,
  "requestedAt": "2022-11-02T22:44:36.000Z",
  "consentReference": "r2ZghWYRbHnbQh45Vy4GJ",
  "requestSource": "api",
  "paymentMethodCode": "standard",
  "guarantorDetail": {
    "guarantorId": 25
  },
  "guarantorIdentity": {
    "permissibleIdentityType": "nin,bvn"
  },
  "updatedAt": "2022-11-02T22:44:36.000Z"
}