API reference docs

Welcome to our REST API Reference Documentation. This comprehensive guide is designed to help developers understand and effectively utilize our RESTful API services. It provides detailed information about our API endpoints, request/response models, error codes, and authentication methods. Whether you're integrating our services into your application for the first time or troubleshooting an issue, this documentation will serve as a valuable resource. It's designed to be easy to navigate, with clear, concise explanations to ensure a smooth development experience.

Authentication

Authenticate with OkHi server by sending your branch ID and server key along with every request. Authenticate by passing a header value of base64 encoding of branchId:serverKey prepended with the string "Token " to the Authorization property.

In practice that means taking your branch ID, e.g. if your branch ID is abc adding a :, and then appending your server key to it, e.g., if your server key is xyz. After base64 encoding abc:xyz becomes YWJjOnh5eg==, and this is passed in the authorization header like so: Authorization: Token YWJjOnh5eg==.

Verification Status

The verification status API allows you to gain insights into the verification status of an address for a user so as to understand if the address has been verified, is currently being verified, or was not verifiable.

Retrieve user verification status

POST https://api.okhi.io/v5/locations/:id/verifications/status

Gain insights into the verification status of an address for a user

Path Parameters

Name	Type	Description
id*	locationID	a valid location ID, this is part of the payload returned by OkCollect after successfully creating an OkHi address

200: OK Ok

Example Response

{
  "most_recent_profile": {
    "status": "verified",
    "score": 0.58,
    "address_verification_id": "ONYgUOybCU",
    "source": "DB"
  },
  "webhook_profile": {
    "verification_status": "verified",
    "verification_mode": "continuous"
  },
  "location_id": "C0DTxgjRdn"
}