VerificationTimelineResponseWrapper

successboolean

data object

customer_idstring

countinteger

entries object[]

Array [

verification_idstring<uuid>

hex_codestring

ghanapost_codestring

methodstring

quality_scorenumber<double>

address object

regionstring

districtstring

areastring

postcodestring

confidencestring

risk_signals object

known_residential_areaboolean

address_densitystring

previously_verified_by_othersboolean

created_atstring<date-time>

certificate object

Short reference embedded in the proximity response so callers know where to fetch and verify the full certificate.

idstring

verification_urlstring

Public verification endpoint (no auth required).

json_urlstring

Full signed certificate JSON (auth required).

pdf_urlstring

PDF certificate with embedded QR code (auth required).

jwks_urlstring

JWK Set used to verify the signature.

issued_atstring

certificate_revoked_atstring<date-time>

Set when the linked certificate was later revoked — the entry still shows the certificate, this just flags it.

certificate_revoke_reasonstring

]

meta object

request_idstring<uuid>

Unique request identifier

Example: c86825f0-d8ca-4ae1-8226-514cc48e05c0

cachedboolean

Whether the response was served from cache

Example: false

latencystring

Server-side processing time

Example: 1.802457582s

boundary_distance_mnumber<double>nullable

Reverse-geocode responses only. Distance in metres from the queried coordinate to the nearest edge of the resolved GhanaPostGPS grid cell. Omitted when the upstream response carried no cell bounds.

Example: 1.42

near_grid_boundaryboolean

Reverse-geocode responses only. True when boundary_distance_m is small enough that an ordinary GPS fix's jitter could plausibly have resolved to the neighbouring cell's code instead — the documented cause of the same property getting different GhanaPostGPS codes depending on where you stand.

Example: false

VerificationTimelineResponseWrapper

{
  "success": true,
  "data": {
    "customer_id": "string",
    "count": 0,
    "entries": [
      {
        "verification_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "hex_code": "string",
        "ghanapost_code": "string",
        "method": "string",
        "quality_score": 0,
        "address": {
          "region": "string",
          "district": "string",
          "area": "string",
          "postcode": "string"
        },
        "confidence": "string",
        "risk_signals": {
          "known_residential_area": true,
          "address_density": "string",
          "previously_verified_by_others": true
        },
        "created_at": "2024-07-29T15:51:28.071Z",
        "certificate": {
          "id": "string",
          "verification_url": "string",
          "json_url": "string",
          "pdf_url": "string",
          "jwks_url": "string",
          "issued_at": "string"
        },
        "certificate_revoked_at": "2024-07-29T15:51:28.071Z",
        "certificate_revoke_reason": "string"
      }
    ]
  },
  "meta": {
    "request_id": "c86825f0-d8ca-4ae1-8226-514cc48e05c0",
    "cached": false,
    "latency": "1.802457582s",
    "boundary_distance_m": 1.42,
    "near_grid_boundary": false
  }
}