Skip to main content

BulkAddressValidateResult

One row's outcome. Either result or error is present.

rowinteger

1-based position in the input.

Example: 1
idstring

The id sent with this row, if any.

Example: order-1001
result object
successboolean
Example: true
data object
verdict object
input_granularitystring

The most precise thing the input gave.

Possible values: [none, region, locality, street, landmark, premise]

geocode_granularitystring

How precisely the returned geocode locates the address.

Possible values: [none, region, locality, street, landmark, premise]

address_completeboolean

Located to the premise and the locality is known.

has_unconfirmed_componentsboolean
has_inferred_componentsboolean
possible_next_actionstring

Possible values: [accept, confirm, fix]

address object
formattedstring
Example: Oxford Street, Osu, La Dade Kotopon, Greater Accra — GA1838164
components object[]
  • Array [
  • typestring

    Possible values: [house_number, house, road, landmark, area, district, locality, region, gps_code]

    valuestring
    confirmationstring

    confirmed: matches the registry or a located landmark. unconfirmed: given, but nothing independent supports it. inferred: not given; filled in from the located address.

    Possible values: [confirmed, unconfirmed, inferred]

  • ]
  • geocode object

    The best location found. Absent when the address could not be located.

    latnumber<double>
    lngnumber<double>
    granularitystring

    Possible values: [region, locality, street, landmark, premise]

    sourcestring

    Possible values: [gps_code, point, plus_code, landmark, text]

    gps_codestring

    Present for premise-level locations known to the registry.

    plus_codestring
    hexstring

    AfriHex resolution-7 code.

    landmark object

    The landmark the address referred to, when found.

    namestring
    slugstring
    relationstring

    As written, e.g. adjacent, opposite, behind.

    latnumber<double>
    lngnumber<double>
    distance_minteger

    From the premise location, when there is one.

    issues object[]
  • Array [
  • codestring

    For example LOCATION_CONFLICT, COMPONENT_MISMATCH, LANDMARK_FAR, LANDMARK_NOT_FOUND, GPS_CODE_NOT_FOUND, GPS_CODE_INVALID, GPS_CODE_UNVERIFIED, PLUS_CODE_NEEDS_REFERENCE, PLUS_CODE_INVALID, LOCALITY_NOT_FOUND, NOT_LOCATABLE, NOT_PREMISE_LEVEL, PARSER_UNAVAILABLE.

    severitystring

    Possible values: [error, warning, info]

    messagestring
    suggestionstring
  • ]
  • noticestring
    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
    errorstring

    Why the row could not be checked, e.g. no usable input.

    BulkAddressValidateResult
    {
    "row": 1,
    "id": "order-1001",
    "result": {
    "success": true,
    "data": {
    "verdict": {
    "input_granularity": "none",
    "geocode_granularity": "none",
    "address_complete": true,
    "has_unconfirmed_components": true,
    "has_inferred_components": true,
    "possible_next_action": "accept"
    },
    "address": {
    "formatted": "Oxford Street, Osu, La Dade Kotopon, Greater Accra — GA1838164",
    "components": [
    {
    "type": "house_number",
    "value": "string",
    "confirmation": "confirmed"
    }
    ]
    },
    "geocode": {
    "lat": 0,
    "lng": 0,
    "granularity": "region",
    "source": "gps_code",
    "gps_code": "string",
    "plus_code": "string",
    "hex": "string"
    },
    "landmark": {
    "name": "string",
    "slug": "string",
    "relation": "string",
    "lat": 0,
    "lng": 0,
    "distance_m": 0
    },
    "issues": [
    {
    "code": "string",
    "severity": "error",
    "message": "string",
    "suggestion": "string"
    }
    ],
    "notice": "string"
    },
    "meta": {
    "request_id": "c86825f0-d8ca-4ae1-8226-514cc48e05c0",
    "cached": false,
    "latency": "1.802457582s",
    "boundary_distance_m": 1.42,
    "near_grid_boundary": false
    }
    },
    "error": "string"
    }