CollectionLocateResponseWrapper

successboolean

data object

loan_idstring

customer_idstring

consent_statusstring

registered_zones object[]

Array [

typestring

hex_codestring

labelstring

last_seenstring<date-time>

frequencystring

confidencestring

]

address_stableboolean

All zones seen within last 30 days

moved_flagboolean

Any zone not seen for 60+ days

collection_route object

recommended_timestring

evening (home) or morning (work)

recommended_zonestring

google_maps_urlstring

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

CollectionLocateResponseWrapper

{
  "success": true,
  "data": {
    "loan_id": "string",
    "customer_id": "string",
    "consent_status": "string",
    "registered_zones": [
      {
        "type": "string",
        "hex_code": "string",
        "label": "string",
        "last_seen": "2024-07-29T15:51:28.071Z",
        "frequency": "string",
        "confidence": "string"
      }
    ],
    "address_stable": true,
    "moved_flag": true,
    "collection_route": {
      "recommended_time": "string",
      "recommended_zone": "string",
      "google_maps_url": "string"
    }
  },
  "meta": {
    "request_id": "c86825f0-d8ca-4ae1-8226-514cc48e05c0",
    "cached": false,
    "latency": "1.802457582s",
    "boundary_distance_m": 1.42,
    "near_grid_boundary": false
  }
}