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.
Last updated
Was this helpful?
The API generates a PDF proof of address certificate for a given OkHi location ID. It combines generation and download into a single endpoint.
Last updated
Was this helpful?
Path Parameter: locationId(required) - The unique OkHi identifier of the location for which the certificate is requested.
This API requires basic authentication. Username branchID and password: server key. Find your branch ID and server key on OkDash.
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
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
Response:
Response:
/locations/{locationId}/certificate
OkHi unique identifier of the location
No body