Overview

Still using API v1?

This page documents the flow based Verify API V2. View V1 docs

Developers can integrate OTP verification functionalities into their applications using the D7 Verify API, a RESTful interface to send, re-send and verify OTP messages.

Verify API V2 is flow based. You create a verification flow in the user dashboard once, and the flow holds all the OTP settings such as channel, message content, OTP type, code length, expiry and retry options. Your application only needs to pass the recipient and the flow_id to send an OTP, so the OTP settings can be changed from the dashboard without any change in your code.

Get Started with D7 Verify API:

Signup to D7 Platform

• Your D7 account will be active after the verification
• We are providing some free credits while signup and you can test the service in this trial version
• Your trial version is valid until you use the free credits
• You will be limited to use our predefined D7 demo senderID and please contact [email protected] for registration

How it works

1. Create a verification flow - Create a flow in the user dashboard and configure the channel, content, OTP type, code length, expiry and retry settings. Note the flow_id of the flow. See the user guide for how to create a flow from the dashboard.
2. Send OTP - Call the Send OTP endpoint with the recipient and flow_id. The OTP is generated and sent to the recipient as per the flow settings, and an otp_id is returned.
3. Resend OTP (optional) - If the recipient did not receive the OTP, call the Resend OTP endpoint with the otp_id. The retry delay and retry count from the flow are applied.
4. Verify OTP - When the recipient enters the code in your application, call the Verify OTP endpoint with the otp_id and otp_code.
5. Get Status (optional) - Check the current status of an OTP at any time using the Get Status endpoint with the otp_id.

Features

• Reusable verification flows managed from the user dashboard
• Send OTP using only the recipient and flow_id
• Generate alpha, numeric and alphanumeric OTPs
• Custom OTP message content
• Configurable OTP expiry time
• Configurable OTP code length
• OTP retry options

Endpoints

Path	Method	Description
/verify/v2/otp/send-otp	POST	send an OTP
/verify/v2/otp/resend-otp	POST	Re-send an OTP
/verify/v2/otp/verify-otp	POST	Verify the OTP
/verify/v2/report/{otp_id}	Get	Get the status of OTP