Request a Guarantor Address Verification

This endpoint request guarantor address verification

Note: Before you create an address verification you must have created a candidate (the information of the person to be verified). If you missed how to create a candidate click here.

Guarantor Address Request

POST {{baseurl}}/v2/api/addresses/guarantor/request

Headers

Name
Type
Description

token*

String

API secret token

Request Body

Name
Type
Description

candidateId*

String

candidate ID

subjectConsent*

Object

Candidate consent must be true

description

String

Description or any information for the agent

address*

Object

Guarantor address object

flatNumber

String

Address flat number

buildingName

String

Address building name

buildingNumber*

String

Address building number

landmark*

String

Address landmark

street*

String

Address street

subStreet

String

Address sub stree

state*

String

Address state

city*

String

Address city

lga

String

Address local government

guarantor*

Object

Guarantor object

firstName*

String

Guarantor first name

lastName*

String

Guarantor last name

mobile*

String

Guarantor mobile

email*

String

Guarantor email address

image*

String

Guarantor image

metadata

Object

Metadata object. Any valid object can be passed here. It gets returned as is.

Last updated

Was this helpful?