OkVerify Webhook

OkHi's address verification algorithm enables you to start receiving verification results after integrating any of the OkHi verification libraries via a webhook you provide

Pre-requisite

1. Register your webhook by filling out this form

2. Integrate any of the OkHi Verification libraries

   • Android

   • React Native

Verification Webhook

POST https://mydomain.com/address-verification

The request describes the parameters that will used while calling your webhook.

Headers

Name	Type	Description
my-custom-header	String	A header key/value that you define and will be used when calling your webhook.

Request Body

Name	Type	Description
verification_profile	object	Information about the status of verification
location	object	Information about the created OkHi address
user	object	Information about the user who's address is being verified
branch	object	Information about your branch

200

Sample payload

{
    "branch": {
        "id": "xuKuseDkfP",
        "name": "web"
    },
    "user": {
        "id": "5kCeK8AO",
        "phone": "[phone]",
        "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",
        "place_id": "SVsDMkwQZD",
        "user_id": "5kBYI3G6AO",
        "other_information": "Black gate with yellow sign",
        "url": "https://sandbox-okhi.dev/Z6j3XyJs3D",
        "plus_code": "6GCRPRF9+XH",
        "title": "Parklands, Ojijo Road",
        "display_title": "Parklands, Ojijo Road"
    },
    "verification_profile": {
        "address_verification_id": "HfkERnjGlB",
        "result": {
            "status": "in_progress",
            "score": 0.87
        }
    }
}

Address verification ID

Every Address verification request will generate a unique alphanumeric identifier.

Address verification score

We will provide you with a score, between 0 and 1. The score is calculated every 24 hours. You can expect our API to push this score to you whenever the status of the address changes, eg.

1. from "in_progress" to "verified".

2. from "in_progress" to "unverifiable"

We expect an address to be verified within 3-7 days.

Verification profile cycles run for a maximum of 7 days inclusive of the 7th day. Between the 3rd and 7th day you can expect to get a status of "verified" if the address is verified otherwise on the 8th day you'd get a status update that the address is "unverifiable". At this stage the verification profile will end and is considered complete.

Immediately after you get either of these status changes, and if the client is still sending data, a new verification profile is created with a new "address_verification_id" where the initial status for the new verification profile is set to "in_progress". The cycle then repeats as described above.

Address verification statuses

Status	Description
in_progress	the verification process is ongoing
verified	the verification process has completed and the address is verified.
unverifiable	the verification process has completed and the address was not verified.