Skip to content
Open
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
03b1810
Create APIproposal_Voice OTP Call
mbkhanhex Oct 9, 2025
2bd5b64
Update APIproposal_Voice OTP Call
mbkhanhex Oct 16, 2025
92d5b5b
Update APIproposal_Voice OTP Call
mbkhanhex Oct 17, 2025
2874f41
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 3, 2025
1ea62cd
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 3, 2025
3f7c0de
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 3, 2025
66e7e5b
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 3, 2025
369e172
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 3, 2025
68a16e0
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 3, 2025
30f744f
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 26, 2025
992df41
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 26, 2025
e9cb367
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 26, 2025
03461b5
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 26, 2025
03399a4
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 26, 2025
af8316a
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 26, 2025
92a07b1
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 26, 2025
c1da7c6
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 26, 2025
ae8875e
Apply suggestion from @albertoramosmonagas
mbkhanhex Nov 26, 2025
85c677c
Update APIproposal_Voice OTP Call
mbkhanhex Nov 26, 2025
e98cc0e
Update APIproposal_Voice OTP Call
mbkhanhex Nov 26, 2025
0e99810
Rename APIproposal_Voice OTP Call to APIproposal_Voice OTP Call.md
mbkhanhex Nov 26, 2025
924cc4a
change voice otp .md file
mbkhanhex Dec 26, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions documentation/API proposals/APIproposal_Voice OTP Call.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# API Proposal Template
This template captures all the information that a partner should fill out when proposing a new API (or API family) to CAMARA.


### API family name
Voice One-Time Password (OTP) Call

### API family owner
Heksagon

### API summary
The “Voice One Time Password Call” API is used to send short-lived one time passwords (OTP) to a phone number via voice call and validate it afterwards, in order to provide a proof of possession of the phone number.
Voice OTP Call API performs real-time checks to verify that the user possessed the device that carries the indicated mobile phone number. It provides a frequent method of verifying possession of the device by delivering an OTP through voice call and validating it afterwards.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reading this in more depth, I see it more as a scope enhancement of the current OTP repository than a new API. Could you have a conversation via an issue with the OTP group?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@albertoramosmonagas if you can kindly elaborate the exact requirement and I would be happy to do so.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would simply create an issue in the group or a discussion thread asking if there could be an overlap in functionality between this API proposal and the existing OTPValidation API, because after reading the description of this proposal, I feel that it could be an improvement on the current API.

Voice OTP Call API is a secure method for providing one-time access to an application or performing a single transaction. It is possible to deliver OTP code in different languages including regional and local languages in different countries. Upon answering the voice call, the recipient would hear OTP code two to three times in different supported languages e.g. English-German-Spanish, English-Hindi-Urdu etc.
The recipient then uses this code or password as an additional layer of security to login to a service, website or app.
Use cases
• Online Banking: To authenticate users during login and transactions, ensuring secure access to financial accounts.
• Account Registration: To confirm user identity during account creation by sending a verification code to their mobile device.
• Password Recovery: To securely verify users when they request to reset their passwords, ensuring only the rightful owner can make changes.
• Two-Factor Authentication (2FA): To enhance security for sensitive applications by requiring a second verification step via call after entering a password.
Benefits
The One Time Password Call API has several benefits for the API consumer:
• Enhanced Security: OTPs provide an additional layer of security beyond passwords, reducing the risk of unauthorized access.
• User Verification: Ensures that the user has access to the registered mobile device, confirming their identity.
• Cost-Effective: Reduces the need for complex authentication systems while providing strong security.
• User Trust: Increases user confidence in the security of the platform, leading to higher user satisfaction.

### Technical viability
API represents an attempt to standardize interfaces between OTP Call solutions deployed by MNOs or external providers and their enterprise users. As such the API is not bound to any specific cloud platform or specific solution but aims to encourage vendors providing MNO or enterprise solution to support this API format and assure interoperability between different solutions.

### Commercial viability
For user registration, part of 2FA, dynamic verification codes, payment confirmation, and other scenarios.

### YAML code available?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And if you already have a YAML file from the API, you can upload it to this PR, but to the documentation/SupportingDocuments path with the API name.

Copy link
Author

@mbkhanhex mbkhanhex Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@albertoramosmonagas I dont have the privileges to do so, please check the snapshot below
CAMARA

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case, it is not “uploading a file” by attaching it to the pull request. In the “mbkhanhex:patch-3” branch you created, you would create a new file in the “documentation/SupportingDocuments” path for the YAML and another for the PPT associated with the proposal.

YES

### Validated in lab/productive environments?
YES, Lab environment
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Specify if was a lab network or productive network

Copy link
Author

@mbkhanhex mbkhanhex Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is already mentioned as Lab environment, please check


### Validated with real customers?
NO. API has not been deployed real use yet but we are in communication with several interested parties and expect PoC by Q1 2026

### Validated with operators?
Not yet. It is one of our new products and hence we didn’t get an opportunity to get it validated with some telco operators. We are expecting some PoC to start by Q1 2026

### Supporters in API Backlog Working Group
List of supporters.
*NOTE: That shall be added by the Working Group. Supporting an API proposal means that the supporting company must provide at least 1 (one) Maintainer at the time of the Sub Project creation.*