Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CAMARA Project Location verification API

Verification of the location of a device

CAMARA Project Location verification API is one of 30 APIs that CAMARA Project publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Location verification. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 18 schemas. It is described by OpenAPI 3.0.3, at version wip.

Requests are made against a single base URL, {apiRoot}/call-forwarding-signal/vwip.

1 operations 1 paths 18 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
wip
Server
{apiRoot}/call-forwarding-signal/vwip
Authentication
OpenID Connect
License
Resource Areas
1

Authentication & Security 1

CAMARA Project Location verification API declares 1 security scheme for authenticating requests. It supports OpenID Connect (openId) discovered at https://example.com/.well-known/openid-configuration.

  • openId — to support Consent Management

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Location verification 1

Verification of the location of a device

POST
/verify
Verify the location of a device
verifyLocation 1 param body → 200400401403404422

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Device (4 properties), VerifyLocationResponse (4 properties), DeviceIpv4Addr (3 properties), ErrorInfo (3 properties). Each schema is shown below with its type and property counts.

SingleIpv4Addr
string
A single IPv4 address with no subnet mask
VerificationResult
string
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 ar…
MatchRate
integer
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 int…
DeviceResponse
An identifier for the end-user equipment able to connect to the network that the response refers to. This parameter is only returned when the API consumer incl…
VerifyLocationResponse
object
Response to a location verification request
4 properties 2 required
LastLocationTime
string
Timestamp of the last location information. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) and must have time zone.
AreaType
string
Type of this area. CIRCLE - The area is defined as a circle.
XCorrelator
string
PhoneNumber
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…
DeviceIpv4Addr
object
The device should be identified by either the public (observed) IP address and port as seen by the application server, or the private (local) and any public (o…
3 properties
Area
object
Base schema for all areas
1 property 1 required
VerifyLocationRequest
object
Request to verify the location of a device. Device is not required when using a 3-legged access token, following the rules in the description.
3 properties 1 required
MaxAge
integer
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…
ErrorInfo
object
Common schema for errors
3 properties 3 required
DeviceIpv6Address
string
The device should be identified by the observed IPv6 address, or by any single IPv6 address from within the subnet allocated to the device (e.g. adding ::0 to…
Port
integer
TCP or UDP port number
Device
object
End-user device able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators. The developer can choose to provide the…
4 properties
NetworkAccessIdentifier
string
A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({Loc…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

camara-project-location-verification-api-openapi.yml Raw ↑

Other APIs CAMARA Project publishes across the network.

CAMARA Project Age Verification API
CAMARA Project Call Forwarding information retrieval API
CAMARA Project Check Device Swap API
CAMARA Project Check SIM swap API
CAMARA Project Connected Network Type API
CAMARA Project Device reachability status API
CAMARA Project Discovery API
CAMARA Project Fill-in API
CAMARA Project Geofencing subscriptions API
CAMARA Project Home Devices QoD API
CAMARA Project Location retrieval API
CAMARA Project Match API