v1

latestOpenAPI 3.1.02026-07-2611041.1 KB

Get Guarantor Verification By ID

Get guarantor's verification by guarantor id

get/v1/guarantors/{guarantorId}

Path parameters

guarantorIdstring required

Guarantor's ID

Response

200

idinteger

customerReferencestring

verificationTypeCodestring

organisationIdinteger

requestedAtstring

consentReferencestring

requestSourcestring

archivedboolean

canContactPocboolean

paymentMethodCodestring

priceinteger

updatedAtstring

Example response

{
  "id": 75,
  "customerReference": "aasfcgn",
  "applicant": {
    "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"
}