List verifications
List address checks for your business. Each item is the full verification.
GET
List address checks for your business. Each item in
Each item in
data is the full verification object.
Requires scope: ava:read
Headers
string
required
Bearer API key (
Bearer <api_key>).Query parameters
number
Page number. The default is
1.number
Page size. The default is
20. The maximum is 100.string
Pass
open to list checks that are not_found and still have a field visit you can accept or decline.Response
array
One full verification per item. Every field on each item is listed below.
number
The page you requested.
number
The page size used for this response.
number
The number of checks that match the filter.
Each item in data
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.