zipdial to verify api
TRANSCRIPT
ZipDial Mobile
Number Verification
API
ZipDial Mobile Solutions Pvt Ltd
Introduction ZipDial to Verify is an innovative way to verify the mobile number by dialing numbers. Each call to action
would disconnect after 1 ring – end users are not charged for the call. There is no dependency on SMS
delivery of authorization code, or on any delay in delivery of SMSes. The system works for Indian as well
as International numbers. Also, the system is meant to verify mobile numbers as well as landline
numbers. The following tutorial explains the flow for a client to verify the mobile number of a user. Registration:
Customer needs to register for ZipDial Mobile Verification by contacting ZipDial Team. Send an email to info@zipdial to receive your Customer Credentials. Or you can sign up for Mobile Verification product by registering on www.zipdial.com
Once you register for the product, our sales team will share a customerToken and z2vToken, which is required for API Integration. While registering, a Callback URL (Post Callback URL to be provided by the client) has to be configured with the account. The rest of the document is focused on the integration.
Important taxonomy before you read ahead:
Client – A client of ZipDial or the system where ZipDial is being integrated.
customerToken – Provided by ZipDial to the client during registration. This is unique for every client.
z2vToken - Provided by ZipDial to the client during registration. This is unique for every Callback URL.
CALLBACK URL – The URL on the client’s end that ZipDial would invoke to inform that a given transaction is successful. Hence it can be considered as verified.
Transaction – Each verification process is referred to as a transaction throughout this document.
ZipDial Number – The number that user needs to dial for verification.
System Flow The integration flow can be summarized in the following steps
1) End Consumer enters a mobile number on the client application, which has to be verified. Client application invokes ZipDial startTransaction API, which returns the ZipDial Number to be displayed to the user, and also a transaction token to identify the transaction.
ZipDial Mobile Solutions Pvt Ltd 2
API: https://www.zipdial.com/z2v/startTransaction.action?customerToken=<CUSTOMERTOKEN>&clientTransactionId=<ID>&callerid=<CALLERID>&duration=180&countryCode=91&z2vToken=<Z2VTOKEN>
Parameters
customerToken (mandatory) – Customer Token shared at registration time
clientTransactionId(mandatory) – Transaction identifier on client application
callerid (mandatory) – end consumer mobile number for verification
duration (optional) – number of seconds for which the verification request has
to be live on ZipDial. By default its 180 secs. Max 1 hour or 3600 secs.
countryCode (optional) – Country Code for the verification request. By default, its 91. We support the following country codes: o 91 (for India 1800 ZipDial numbers),
o Country ISD Code (for India +91 non 1800 ZipDial numbers). This should
be used for verifying International dialers. Example – 1 for USA.
z2vToken (mandatory) – Token to identify a given instance of verification
account. A customer, depending on the commercial package chosen, can
configure multiple instances under a verification account. A verification account
is identified based on the CALLBACK_URL at client’s end to be invoked by ZipDial
after a successful verification. A client application has to use different z2vtokens
for different instances. This is usually helpful for Staging and Production
environment. Please ensure that Callback URLs are public URLs and not behind
any firewall.
Response JSON response is returned for a successful request. Or else appropriate error messages are
shared. If message =ok, then it’s a successful request. {"message":"ok","display_num":"180030000860","client_transaction_id":"7161680","transaction_token":"2b7ee70ea9b3884f1a8f48eb04ecada4b21824b8","status":"1","dial_num":"08030088563","img":"http://www.zipdial.com/zip2auth/images/access/2b7ee70ea9b3884f1a8f48eb04ecada4b21824b8"}
message: indicates status. ok means successful
dial_num: returns ZipDial number in Text Format (optional parameter)
transaction_token: transaction identifier for the verification request. This is generated by ZipDial and is unique to every transaction.
status: 1 (indicates an active verification request. 0 indicates an either verified verification
request or an expired verification request.) img: returns the image URL for display of the ZipDial Number in Image Format
To display the ZipDial number, insert the image URL on the page that user is viewing. ZipDial Mobile Solutions Pvt Ltd 3
Error Code: ERRO1: Insufficient information to process Z2V Request [implies some of the mandatory parameters are missing] ERRO3: Invalid Customer Credentials. Please contact ZipDial Support ([email protected]) [implies a customer credentials is Invalid (customerToken or z2vToken] ERRO4: Invalid CallerID for verification. For any issues, please contact ZipDial Support [implies the callerid is not a valid number]
2) The client application would display the ZipDial number to the end consumer on the browser (or any client interface) and request the user to make a ZipDial (or a Missed Call) to the ZipDial number, from the mobile number entered on the screen.
3) Once the user ZipDials or gives a Missed Call, ZipDial would notify the client application on the CALLBACK URL, and pass the transaction_token.
Post the verification; the client application can implement the end consumer flows.
Contact Information: Amit Malhotra [email protected] (E) 7760967758 (M)