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

Termii Token API

Generate, deliver, and verify one-time passwords.

Termii Token API is one of 6 APIs that Termii publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Token. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.ng.termii.com/api.

4 operations 4 paths 8 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.ng.termii.com/api
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Termii Token API declares 1 security scheme for authenticating requests. An API key is passed in the query as api_key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Termii authenticates every request with an apikey. For GET requests it is passed as the apikey query parameter; for POST, PATCH, and DELETE requests it is incl…

Paths & Operations 4

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

Token 4

Generate, deliver, and verify one-time passwords.

POST
/sms/otp/send
Send token (OTP)
sendToken body → 200400
POST
/sms/otp/send/voice
Send voice token
sendVoiceToken body → 200400
POST
/sms/otp/generate
Generate in-app token
generateInAppToken body → 200400
POST
/sms/otp/verify
Verify token
verifyToken body → 200400

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are SendTokenRequest (10 properties), InAppTokenRequest (6 properties), VoiceTokenRequest (5 properties), VerifyTokenRequest (3 properties). Each schema is shown below with its type and property counts.

InAppTokenRequest
object
6 properties 6 required
VoiceTokenRequest
object
5 properties 5 required
ErrorResponse
object
1 property
SendTokenRequest
object
10 properties 10 required
InAppTokenResponse
object
2 properties
SendTokenResponse
object
3 properties
VerifyTokenRequest
object
3 properties 3 required
VerifyTokenResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

termii-token-api-openapi.yml Raw ↑

Other APIs Termii publishes across the network.

Termii Campaigns API
Termii Contacts API
Termii Insights API
Termii Messaging API
Termii Sender IDs API