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 Sim Swap Subscription API

Operation to manage event subscription on sim swap event (swapped)

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

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

4 operations 2 paths 16 schemas 1 DELETE2 GET1 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 Sim Swap Subscription 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 4

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

Sim Swap Subscription 4

Operation to manage event subscription on sim swap event (swapped)

POST
/subscriptions
Create a sim swap event subscription for a phone number
createSimSwapSubscription 1 param body → 201202400401403409422429
GET
/subscriptions
Retrieve a list of sim swap event subscription
retrieveSubscriptionList 1 param → 200400401403
GET
/subscriptions/{subscriptionId}
Retrieve a sim swap event subscription for a phone number
retrieveSubscription 2 params → 200400401403404
DELETE
/subscriptions/{subscriptionId}
Delete a sim swap event subscription
deleteSubscription 2 params → 204202400401403404

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Subscription (8 properties), CloudEvent (7 properties), SubscriptionRequest (5 properties), Config (3 properties). Each schema is shown below with its type and property counts.

SubscriptionId
string
The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this conce…
SubscriptionAsync
object
Response for a event-type subscription request managed asynchronously (Creation or Deletion)
1 property
CloudEvent
object
The notification callback
7 properties 5 required
SubscriptionRequest
object
The request for creating a sim swap event subscription
5 properties 4 required
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…
SubscriptionEventType
string
swapped - Event triggered when a sim swap occurs on the line
Source
string
Identifies the context in which an event happened, as a non-empty URI-reference like: - URI with a DNS authority: https://github.com/cloudevents mailto:cncf-wg…
Subscription
object
Represents a event-type subscription.
8 properties 5 required
ErrorInfo
object
3 properties 3 required
SinkCredential
object
A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
1 property 1 required
DateTime
string
Timestamp of when the occurrence happened. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) and must have time zone.
CreateSubscriptionDetail
object
The detail of the requested event subscription
1 property
Config
object
Implementation-specific configuration parameters needed by the subscription manager for acquiring events. In CAMARA we have predefined attributes like subscrip…
3 properties 1 required
SimSwapNotificationEventType
string
swapped - Event triggered when a sim swap was performed for this phone number - subscription-started: Event triggered when the subscription starts - subscripti…
Protocol
string
Identifier of a delivery protocol. Only HTTP is allowed for now

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

camara-project-sim-swap-subscription-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