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 Phone number verify API

API operation to verify a phone number received as input. It can be received either in plain text or hashed format.

CAMARA Project Phone number verify 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 Phone number verify. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 5 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 5 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 Phone number verify 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.

Phone number verify 1

API operation to verify a phone number received as input. It can be received either in plain text or hashed format.

POST
/verify
Verifies if the received hashed/plain text phone number matches the phone number associated with the access token
phoneNumberVerify 1 param body → 200400401403

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ErrorInfo (3 properties), NumberVerificationRequestBody (2 properties), NumberVerificationMatchResponse (1 property). Each schema is shown below with its type and property counts.

DevicePhoneNumberVerified
boolean
Number verification. True, if it matches
NumberVerificationRequestBody
object
Payload to verify the phone number.
2 properties
NumberVerificationMatchResponse
object
Number verification result
1 property 1 required
ErrorInfo
object
3 properties 3 required
XCorrelator
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

camara-project-phone-number-verify-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 Location verification API