Skip to main content
POST
Send one address and your reference. Run returns the full verification object. Requires scope: ava:write The same key is not charged twice. If you omit Idempotency-Key, Run uses your reference plus the address. A later search of the same address, with a new key, is a new check and is charged again.

Headers

string
required
Bearer API key (Bearer <api_key>).
string
Your own key for this check. When you omit it, Run uses external_ref plus the trimmed address.
string
required
application/json

Body

string
required
The address to check.
string
required
Your reference for this check.

Response

The body is one verification. Every field is listed here. address.normalized, address.lat, and address.lng are present only when status is confirmed. Otherwise they are null. evidence is one object, or null when Run has not recorded evidence yet.
string
Run’s id for this check. It starts with avr_.
string
Your reference for this check.
string
confirmed, not_found, declined, processing, not_confirmed, or unreachable. See Verification statuses.
string
When you created the check, in ISO 8601. Null only if the time is missing.
string
When the check finished, in ISO 8601. null until then.
string
The address you sent.
string
The address Run confirmed. null unless status is confirmed.
number
Latitude of the confirmed address. null unless status is confirmed.
number
Longitude of the confirmed address. null unless status is confirmed.
object
One evidence object, or null. type is delivered_record for a past delivery, or location_verification for a check Run recorded.
string
delivered_record or location_verification. null when evidence is null.
string
When this evidence was recorded, in ISO 8601, or null.
string
When a past delivery arrived, in ISO 8601, or null.
string
When the evidence was confirmed, in ISO 8601, or null.
string
How it was checked: field_visit, rider, agent, local_contact, or desk_review. null when this evidence has no method.
string
confirmed, not_confirmed, or unreachable. null when this evidence has no outcome.
string
The address that was found, or null.
string
The area that was recorded, or null.
number
Latitude recorded with the evidence, or null.
number
Longitude recorded with the evidence, or null.
boolean
Whether the address could be reached. null when that was not recorded.
string
The note stored with the evidence, or null.
string
A reference stored with the evidence, or null.
string[]
Photo links. An empty list when there are no photos. Omitted from the object only when evidence itself is null.
boolean
true when you can still accept or decline a field visit.
number
The visit price in naira when available is true. null when no visit is offered. This is the rate on your account.
string
Always NGN.
string
The note for this check, or null.
number
The amount taken from the wallet, in naira, or null when this check has not been charged.
string
Always NGN.
string
historical for a normal check, or field_visit for a visit. null when this check has not been charged.
string
The wallet transaction id, or null when this check has not been charged.
A successful call returns HTTP 200. Read status to see what happened. Address matched. status is confirmed. The pin is filled in, and charge.amount_ngn is the rate on your account. Run does not send ava.verification.completed for this result. Still checking. The address did not match a past record, so Run is checking it. status is processing. The pin is null. Run holds the normal check price. notes is “We are checking this address. You will get an update when the check is finished.” There is no field-visit offer. Run sends the webhook when this check finishes. Field visit offered. The address did not match a past record, and a field visit is available on your account. status is not_found. field_visit_offer.available is true, and field_visit_offer.amount_ngn is your visit rate. Nothing is charged and nothing is held. You accept or decline that offer with Field visit. See Verification statuses for the bodies after a check is closed.

Staging samples

On the staging API, these five addresses always return the same result. Send each address as written. Letter case and extra spaces do not change the result. A live key on production treats the same text as a normal address. The price is the rate on your account. A repeat of the same idempotency key is not charged again.

12 Bourdillon Road, Ikoyi, Lagos

Status is confirmed. The pin is filled in. The normal check price is charged. No webhook.

5 Thompson Avenue, Ikoyi, Lagos

Status is processing. The normal check price is held. The note says the check is still running. No webhook yet. Poll this check to see it stay open.

22 Fola Osibo Street, Lekki Phase 1, Lagos

Status is not_found, with a field visit offered. Nothing is charged and nothing is held. Accept or decline the visit.

54 Admiralty Way, Lekki Phase 1, Lagos

Opens as processing, then closes as not_confirmed. The hold is released. ava.verification.completed is sent.

9 Oduduwa Street, GRA Ikeja, Lagos

Opens as processing with the visit price held, then closes as unreachable. The visit rate is charged. The note is “The address was not there.” ava.verification.completed is sent.