v6.0.1
  • 👋Welcome Home
  • OVERVIEW
    • OkHi Product Overview
    • Integration process overview
    • Verification terminology
    • Case Studies
  • Best Practices
    • Integration Best Practices
    • Live Examples
    • Tips for PMs & QA
      • Testing & QA Guide
      • Publishing to app stores
        • Google Play store
        • Apple App Store
    • Tips for designers
  • Code Libraries
    • Developer Quick Start
      • Environment setup
      • Release Notes
    • Android Guide
      • Android Dependencies
      • Migrating to the latest library
    • iOS Guide
    • React Native Guide
      • React Native Dependencies
      • React Native troubleshoot guide
    • Expo React Native Guide
    • Flutter Guide
      • Flutter Dependencies
    • JS library
      • API Reference
      • OkCollect Webhook
      • Changelog
    • WooCommerce Plugin
      • Changelog
  • Verification Status
    • Customer Dashboard
    • Verification Status Updates
      • Webhook v3
        • Webhook Signature Verification Guide
      • Webhook v2
      • Verification Status API
      • Proof Of Address Certificate API
      • FAQs
    • API reference docs
  • Troubleshooting
    • Error Responses
    • Common technical pitfalls
    • How to reduce "Unknowns"
    • FAQs
      • Technical FAQs
      • Compliance FAQs
    • Get in touch
Powered by GitBook
On this page
  • Pre-requisite
  • When to use a webhook
  • When to use the Verification status API

Was this helpful?

  1. Verification Status

Verification Status Updates

It is useful for your application to keep track of the verification status changes of your customers' OkHi addresses.

PreviousCustomer DashboardNextWebhook v3

Last updated 3 months ago

Was this helpful?

You may get the verification statuses of your customer's OkHi address by setting up a to capture these status changes as they occur or by using the for on-demand updates.

Pre-requisite

Integrate and start verification using any of the OkHi Verification libraries

When to use a webhook

It takes between 2 to 8 days to verify an address.

OkHi needs to notify your integration about changes to the verification status of an address so your integration can take subsequent steps. The specific actions your webhook endpoint may take differs based upon your business use case and the address verification status. Some examples include:

  • Indicating that a home delivery for a chequebook or credit card delivery is now possible

  • Updating a customer's eligibility for a larger loan limit

  • Prompting a customer to update their address in case they have moved houses

When to use the Verification status API

You may get the latest verification status for an address at any time, for many reasons such as:

  • Need for a fresh status to respond to a live customer support inquiry

  • Your webhook did not receive an update for some reason

webhook
verification status API
Android
React Native
iOS
Webhook v3
Verification Status API