VOvoygr
core

Validate a place

Changed on

Validate a place's existence and operating status using evidence about the place.

post/v1/validate

Request

  • Base URL
    https://api.voygr.tech
  • URL
    https://api.voygr.tech/v1/validate
  • Auth
    API key in header X-API-Key

Request body

idstring nullable

Client-provided identifier

poi_namestring required

POI name

streetstring nullable

Street address

citystring nullable

City

regionstring nullable

State/province

postcodestring nullable

Postal/ZIP code

countrystring nullable

2-letter ISO country code

addressstring nullable

Unstructured address string. May also be sent as freeform_address (input-only alias).

latitudenumber nullable

Latitude in decimal degrees (WGS84). Optional but recommended.

longitudenumber nullable

Longitude in decimal degrees (WGS84). Optional but recommended.

Example request

{
  "id": "bakery-001",
  "poi_name": "Example Bakery",
  "address": "123 Example Street",
  "country": "US",
  "latitude": 37.7749,
  "longitude": -122.4194
}

Response

Successful Response

successboolean required

Whether validation succeeded

idstring nullable

Client-provided ID (pass-through)

existence_confidencenumber nullable

Confidence (0-1) that a matching place ever existed at this address. A score of 0.5 or more means we judge that the place exists. Below 0.5 we judge that it does not. A closed place can still have high existence confidence. This does not describe whether it is operating today. Interpret closure only when existence is established; use operational_status.status for the decision.

errorstring nullable

Error message if success=false

error_codestring nullable

Error category code (VALIDATION_ERROR, MODEL_ERROR, EXTERNAL_API_ERROR, etc.)

request_idstring nullable

Request ID for tracing

validation_timestampstring nullable

UTC timestamp when validation was produced (ISO 8601).

Changes

  • 03b7688c4c40Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 892990bd38e1Revision changes
    • info

      endpoint added