OkHi Documentation
  • 👋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

Was this helpful?

  1. Verification Status
  2. Verification Status Updates

Proof Of Address Certificate API

The API generates a PDF proof of address certificate for a given OkHi location ID. It combines generation and download into a single endpoint.

PreviousVerification Status APINextFAQs

Last updated 7 months ago

Was this helpful?

API Endpoint

Endpoint:

GET https://api.okhi.io/v5/locations/:locationId/certificate 

Path Parameter: locationId(required) - The unique OkHi identifier of the location for which the certificate is requested.

Authentication

This API requires basic authentication. Username branchID and password: server key. Find your branch ID and server key on .

Response Formats

Success Responses:

Status Code

Body

Description

202 Accepted

{ "id": "1234567890", message: "PDF generation in progress" }

PDF generation initiated, certificate will be available later

200 OK

PDF file

Certificate generated and downloaded successfully

Error Responses:

Status Code

Body

Description

400

{ "error": "Invalid location ID" }

Invalid location ID provided

401

{ "message": "missing_token", "error": "Unauthorized", "statusCode": 401 }

Invalid or missing token

409

{ "error": "PDF generation request already exists" }

A PDF generation request for the same location ID already exists

429

{ "error": "Too many requests" }

Rate limit exceeded

Usage Example

Request 1: Initiate PDF Generation

GET https://api.okhi.io/v5/locations/66960f3965fefa8c59cf5f70/certificate
Authorization: Basic bWFya2V0X3Byb2Zfb2FkZHJlc5M6c3VydmVyX2tleQ==

Response:

HTTP/1.1 202 Accepted
Content-Type: application/json
{
  "id": "66960f3965fefa8c59cf5f70"
}

Request 2: Download Generated Certificate

GET https://api.okhi.io/v5/locations/66960f3965fefa8c59cf5f70/certificate HTTP/1.1
Authorization: Basic bWFya2V0X3Byb2Zfb2FkZHJlc5M6c3VydmVyX2tleQ==

Response:

HTTP/1.1 200 OK
Content-Type: application/pdf
OkDash

Generate or retrieve a proof of address certificate

get
Authorizations
Path parameters
locationIdstringRequired

OkHi unique identifier of the location

Responses
200
Certificate generated and downloaded successfully
application/pdf
202
PDF generation initiated, certificate will be available later
application/json
400
Bad request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
409
Conflict
application/json
429
Too many requests
application/json
500
Internal server error
application/json
get
GET /v5/locations/{locationId}/certificate HTTP/1.1
Host: api.okhi.io
Authorization: Basic username:password
Accept: */*

No content

  • API Endpoint
  • Endpoint:
  • Authentication
  • GETGenerate or retrieve a proof of address certificate
  • Response Formats
  • Usage Example