Skip to navigation
Identity verification APIAddress

Retrieve the navigation packet

Returns the location details your own flow collected for the entity, packaged for a delivery or recovery team: the pin, its Plus Code, the directions the person gave and a link to the entrance photo. Read only, and not billed.

Error codes

errorStatusMeaning
entity_not_found404No live entity has this reference in this organisation and environment.
no_address_pin422The entity has no captured address pin.
secret_key_required403A publishable key was used. This API accepts secret keys only.
environment_mismatch403The key belongs to an environment this host does not serve.
rate_limited429The request rate limit for this key was reached. Retry after a short wait.
rate_limit_store_unavailable503Rate limiting is temporarily unavailable. Retry shortly.

A missing or unknown key returns 401 with a plain sentence in error rather than a code.

Requires a secret (sk_) key. A publishable key receives 403 secret_key_required.

Authentication

AuthorizationBearer
Send the API key as a Bearer token. Each operation states whether a publishable key is enough or a secret key is required.

Path parameters

externalUserIdstringRequired
Your own stable reference for the person or business, as sent when the entity was registered.

Response

Success
pinobject
plusCodestring
The Plus Code for the pin, which can be typed into any maps application.
directionsstring or null
The directions the person gave when the pin was captured.
photoUrlstring or nullformat: "uri"
A link to the entrance photo. Fetch it with a secret key in the Authorization header.
osmUrlstringformat: "uri"
A link that opens the pin on OpenStreetMap.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error