Skip to main content
Prontiq APIs use stable field names so integrations can make decisions without reading implementation details.

Naming

  • JSON response fields use camelCase, except stable v1 fields such as distance_m, address_count, top_left, bottom_right, and error.request_id.
  • *Id fields are opaque strings. Do not parse them.
  • *At fields are RFC 3339 timestamps with a timezone.
  • *Date fields are calendar dates in YYYY-MM-DD format.
  • *Count means dataset cardinality.
  • *Credits means billing or usage units.

Address match quality

prontiqMatchScore and prontiqMatchQuality are Prontiq-computed request match-quality fields. Use them for thresholds, sorting, prompts, analytics, and accept/review flows. They are not G-NAF source confidence, deliverability, or geocode precision.

G-NAF confidence

confidence on full address documents is G-NAF source-record metadata. It tells you how many contributor datasets support the address record: Autocomplete does not return G-NAF confidence by default.

Debug diagnostics

Public Address endpoints accept debug=true for support diagnostics. Debug fields are not business-decision fields. debug.searchScore, when present, is an unstable internal search relevance score. It may change between requests, data refreshes, or implementation releases. Do not store it, sort by it, or use it for business logic.