VerifyMe API
  • Welcome
  • general
    • Getting Started
    • Introduction
    • Authentication
    • About Verifications
  • Identity verifications
    • Bank Verification Number (BVN)
    • Corporate Affairs Commission
    • Drivers License
    • Identity Biometrics
    • BVN Identity Matching
    • Virtual NIN (vNIN)
    • National Identification Number(NIN)
    • Tax Identification Number
    • Voters Card
  • Address Verification
  • Submit Address Verification
  • Get Address Verification By ID
  • Get Address Verifications
  • Cancel Address Verification
  • Fetch an Address By Identity
  • Business Verification
    • Submit Business Verification
    • Get Business Verification By ID
    • Get Business Verifications
    • Cancel Business Verification
  • Guarantor Verification
    • Submit Guarantor Verification
    • Get Guarantor Verifications
    • Get Guarantor Verification By ID
    • Cancel Guarantor Verification
  • employment Verification
    • Submit Employment History Verification
    • Get Employment History Verifications
    • Get Employment History Verification By ID
    • Cancel Employment History Verification
  • Property Verification
    • Submit Property Verification
  • Liveness Verification
  • LOCATION
    • Get Countries
    • Get Country By ID
    • Get State By ID
    • Get State For Country
    • Get Lga By Country
    • Get Lga By State
    • Get Lga By ID
  • Bank
    • Get Banks
    • Get Account Details
  • BVN NUBAN
    • Get Nuban Banks
    • Get BVN details by NUBAN
  • webhooks
    • About Webhooks
    • Verified Address
    • Verified Guarantor
    • Verified Employment History
    • Verified Property
  • Product statuses
  • Error Status Codes
  • Glossary
  • Widget Services
    • VerifyMe Liveness Widget
    • Requery Liveness Verification
Powered by GitBook
On this page

Was this helpful?

Product statuses

Our Products can be tracked via theirstatus object. This field basically shows the current state of your request ie if it has been completed, is pending or is in progress.

{
    status: "",
    subStatus: "",
    state: "",
}

The structure of the status object for our different verifications can be seen below:

status - This represents the status of the address verification

the possible values are :

  • VERIFIED - Successful Verification

  • UNVERIFIED - Unsuccessful Verification

  • IN PROGRESS - Verification In Progress

state - They indicate if verifications have been completed or not. They are similar to the status field but they are not prone to change anytime soon.

Possible Values:

  • COMPLETE

  • IN_PROGRESS

  • PENDING

subStatus - This contains more descriptive information about the status of the address verification. It varies for our different products as can be seen in the table below:

Product

Possible subStatus fields

Address Verification

  • IN PROGRESS

  • FAILED - NOT IN RESIDENCE

  • FAILED - INVALID ADDRESS

  • VERIFIED

  • CANCELLED

  • CANNOT ACCESS ADDRESS

PreviousVerified PropertyNextError Status Codes

Last updated 4 years ago

Was this helpful?