v5.1.0

Webhook

Use a webhook to keep track of changes in verification statuses of your user's addresses.

Integration steps

Configure a webhook listener

A webhook listener is a server that listens at a specific URL for incoming HTTP POST notification messages that are triggered when an event occurs.

See example below

import express, { Request, Response } from "express";
// This example uses Express to receive webhooks
const app = express();
const port = 3000;
app.post(
    '/webhook',
    // handleAuthentication()
    express.raw({ type: 'application/json' }),
    (request, response) => {
        // Retrieve the request's body
        // Validate custom headers
        const profile = request.body.verification_profile;
        const status = profile?.result?.status;

        if (!status) {
            // stop
            return response.sendStatus(200);
        }

        switch (status) {
            case 'in_progress':
                // Then define and call a method to handle the verification in progress status
                // handleVerificationInProgress()
                break;
            case 'verified':
                // Then define and call a method to handle the successful verification status
                // handleVerificationSuccessful()
                break;
            case 'unverifiable':
                // Then define and call a method to handle the unverifiable verification status
                // handleVerificationFailed()
                break;
            default:
                console.log(`Unhandled event type ${status}`);
        }
        // Do something with event
        response.sendStatus(200);
    },
);

app.listen(port, () => {
  console.log(`Example app listening at http://localhost:${port}`);
});

Test your webhook (optional)

Once you have configured your webhook, test it by making a POST request to your webhook similar to the example below. See description of the JSON body parameters here.

curl --location --request POST 'localhost:3000/webhook' \
--header 'Content-Type: application/json' \
--header 'okhi-authorization: N2Y2YzQzOGUtNGRkZS00ZDkzLTllZmItN2JmYmYwMjE3OTI5' \
--data-raw '{
    "verification_profile": {
        "address_verification_id": "HfkERnjGlB",
        "result": {
            "status": "in_progress",
            "score": 0.87
        }
    },
    "user": {
        "id": "5kCeK8AO",
        "phone": "+254712345678",
        "first_name": "Bob",
        "last_name": "Mark",
        "display_name": "Bob Mark"
    },
    "location": {
        "id": "Z6j4RyXs3O",
        "geo_point": {
            "lat": -1.27,
            "lon": 36.81
        },
        "street_name": "Ojijo road",
        "property_name": "Parklands",
        "url": "https://sandbox-okhi.dev/Z6j3XyJs3D",
        "plus_code": "6GCRPRF9+XH",
        "title": "Parklands, Ojijo Road",
        "display_title": "Parklands, Ojijo Road"
    },
    "branch": {
        "id": "xuKuseDkfP",
        "name": "web"
    },
}'

Next, subscribe your listener to events.

Subscribe to events

To subscribe your webhook listener to events, fill out this form

Simulate verification status change (Optional)

Prerequisite

You will require a valid location ID, this is part of the payload returned by OkCollect after successfully creating an OkHi address.

Mock verification status change

Once you have subscribed your webhook listener to events, you may simulate verification status changes to ensure that your webhook receives notifications and behaves as expected.

Use the verification status simulator API for this.

Congratulations!

You have a basic webhook endpoint ready to accept verification events from OkHi. Now add the application logic that your business needs to handle the events you care the most about. You can also extend the endpoint with the steps below to verify the authenticity of the requests.

Secure your webhook

You can verify webhook event notifications that your listener receives when events occur. To verify event notifications, add a custom header to your webhook. We will then send the custom header along with each webhook event and you can validate the events based on correctness of the custom header.

JSON Body Parameters

PreviousVerification StatusNextVerification Status API

Last updated