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 OTP Management API

API operations to manage OTP codes

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

This API exposes 2 operations across 2 paths, and defines 9 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.

2 operations 2 paths 9 schemas 2 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 OTP Management 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 2

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

OTP Management 2

API operations to manage OTP codes

POST
/send-code
Sends a message including an OTP code to the given phone number
sendCode 1 param body → 200400401403404429
POST
/validate-code
Verifies the OTP received as input
validateCode 1 param body → 204400401403404429

Schemas 9

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

SendCodeResponse
object
Structure to provide authentication identifier
1 property 1 required
AuthenticationId
string
unique id of the verification attempt the code belongs to.
XCorrelator
string
ValidateCodeBody
object
Strcuture to request code verification
2 properties 2 required
ErrorInfo
object
Structure to describe error
3 properties 3 required
Code
string
temporal, short code to be validated
Message
string
Message template used to compose the content of the SMS sent to the phone number. It must include the following label indicating where to include the short cod…
SendCodeBody
object
Structure to request sending a code to a phone number
2 properties 2 required
PhoneNumber
string
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Num…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

camara-project-otp-management-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