Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-027801.5 MB
Location Verification v1.0.0

Verify the location of a device

Verify whether the location of a device is within a requested area. The operation returns a verification result and, optionally, a match rate estimation for the location verification in percent.

post/location-verification/v1/verify

Headers

x-correlatorstring

Correlation id for the different services

x-rapidapi-hoststring required
Example:network-as-code.p-eu.rapidapi.com

The API's Host value as defined in the RapidAPI Hub.

Request body

maxAgeinteger

The maximum age (in seconds) for the location known by the implementation, which is accepted for the verification. Absence of maxAge means "any age" and maxAge=0 means a fresh calculation.

Response

lastLocationTimestring date-time

Timestamp of the last location information. It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)

verificationResult'TRUE' | 'FALSE' | 'UNKNOWN' | 'PARTIAL' required

Result of a verification request:

  • TRUE: when the network locates the device within the requested area,
  • FALSE: when the requested area does not match the area where the network locates the device,
  • UNKNOWN: when the network cannot locate the device,
  • PARTIAL: when the requested area partially match the area where the network locates the device. A match_rate is included in the response.
matchRateinteger

Estimation of the match rate between the area in the request (R), and area where the network locates the device (N), calculated as the percent value of the intersection of both areas divided by the network area, that is (R ∩ N) / N * 100. Included only if VerificationResult is PARTIAL.