VerifyKit Docs
Search…
⌃K
💻

Connect App

You must first add your app from the panel to start using VerifyKit.

How Do I Connect an App?

After logging into your account, select “My Apps” and then “Connect Your App”.
The app you connect can have iOS, Android, Web and REST platforms.
You can update the name of your apps.
Choose which messaging platforms you want to include in your app. VerifyKit allows you to verify your users with WhatsApp, SMS OTP, Inbound SMS, Flash Call, and Outbound Call. You can select WhatsApp and SMS OTP methods from this screen. Please send an email to [email protected] if you want to use the Outbound Call, Flash Call, or Inbound SMS methods. You can always change this setting in the future.
WhatsApp and SMS OTP verification methods are available on all platforms. Inbound SMS, Outbound Call, and FlashCall methods are currently only available in the iOS SDK and Android SDK. It will be available very soon in REST API and Web SDK.

How Do I Set up My App?

VerifyKit works with iOS and Android operating systems and all web browsers.
Before setting up your app, you need to determine which platforms you will be using. Then you can set up your application on these platforms individually.

iOS

If you’d like to use VerifyKit in your iOS app, select the “iOS” box in the “Add Platform” section.
Fill in the fields in the new window. You’ll need to enter a deep link to redirect your users to the relevant pages in your app, and type in the App Store Bundle ID.
Deep links are necessary for your users to return to the app after they complete the verification process. You can find more information on deep link integration here.
Enter your deep link and Bundle ID, then click Save. The page will refresh automatically and your Server Key, Client Key, and Client Secret will be displayed on the screen.
For more information on how to use the Server Key, the Client Key, and the Client Secret, click here.

Apple Review Mode

To activate Apple Review mode, choose the Review mode option, and save your settings. Upon saving your settings, you’ll be presented with the “Phone Number” and “One Time Password” parameters generated specifically for your app in the “Apple Review Mode” field.
When sending your app to Apple Store for review, be sure to include these parameters and specify that it’s possible to log into the app with them in the review note field.
You can also enable the Apple Review Mode even if your app’s SMS setting is off.
When this mode is enabled, the number and the password we’ll give you will be valid only for the version number you’ve entered.
Be sure to disable the Apple Review Mode feature after your application is approved by Apple.
We’ll send you a daily e-mail to remind you that you have apps in Apple review mode and you should turn this feature off.

Android

If you’d like to use the VerifyKit verification solution in your Android app, select the “Android” box in the “Add Platform” section.
Fill in the fields in the new window. You’ll need to enter a deep link to redirect your users to the relevant pages in your app and type in the Package Name you got from Google Play Store.
Deep links are necessary for your users to return to the app after they complete the verification process. You can find more information on deep link integration here.
For more information on how to use the Server Key, the Client Key, and the Client Secret, click here.

Web SDK

If you’d like to use the VerifyKit verification solution in your Web app, select the “Web” box in the “Add Platform” section.
Enter the full URL of your website in the “Trusted Domain” box.
WEB-SDK is a service that works within an iframe. For security purposes, you can only run VerifyKit on the sub-pages of the domain name that you’ve entered into the Trusted Domain field.
For more details on integration, click here.

Rest API

The Rest API platform will automatically be defined for all your apps. You can also integrate VerifyKit using Rest API. For more details on how to integrate it into your app using the server-key parameter, click here.

Need to Know

A deep link is required where the user sends a message to VerifyKit in WhatsApp verifications. Deep links allow users who complete the verification process with WhatsApp to return to your application. It’s crucial that your deep link settings are done properly in order to ensure a successful verification process.

What Is a Server Key, a Client Key and a Client Secret?

Client key and Client Secret are parameters that you’ll need to use in order to integrate Android and iOS SDKs.
The Server Key parameter is used in all REST API requests that are sent to VerifyKit:
  • When using iOS and Android SDKs, with the last request to complete the end-to-end verification process,
  • With the first request when using Web-SDK,
  • And with requests to other REST API endpoints
You’ll need to send this parameter to VerifyKit as a header parameter.
IMPORTANT
The End-user should never have access to the Server Key parameter. Never hardcode this parameter into the codebase of you iOS and Android app and do not share it with anyone. If you lose this parameter, retrieve it from your app details page in the panel or contact us as soon as possible at [email protected]

What Do the Verification Screens Look Like?

Here is an example of the verification screen you'll see while using VerifyKit. Only the methods you’ve selected will be listed.