Connect your Database
Smart Access is an authentication solution which allows organizations to sign in previously registered end users, either by connecting a database through an API or the upload of CSV file. In this guide, you will learn the instructions of how to provide Verifik with valid users that can make use of Smart Access.
There are two ways that you can provide this “Whitelist” to Verifik which are:
Upload a CSV
Basically here you provide to Verifik a list of maximum 500 users in a CSV that are going to use Smart Access, we have a template that have some basic instructions on how to properly send the information.
We need 4 basic param in order to operate, which are:
name
phone
countryCode
email
All the parameters in the template cannot be modified, so make sure to never change the letters or anything with them, if some change is made the system no longer can identify the parameters, so try to avoid this at all cost.
Also, if you tap the Create CSV button you can create the list directly in the UI of Verifik.
No matter how you send the data you will have a view like the one above, just click the send button, and you have successfully allowed all those users to make use of your Smart Access project.
This is the view of the current users with access, you can make any modifications as you want as long that you follow this acceptance criteria:
You can only send a CSV as a valid type of file.
The names of the parameters must not be changed.
A maximum of 500 users can be sent at a time; with more than 500, the system will not allow the information to be entered.
Depending on the entry method used, you must supply the corresponding parameter to be able to perform the respective validation. If phone is selected, you must send phone and countryCode; if email is selected, you must send this parameter; if both are selected, you must send all the parameters within the CSV. You must always send a name.
The email must be real and have an inbox.
The phone must be able to receive SMS text messages or messages via WhatsApp, depending on the validation method established.
Connect with API
The connect with API solutions it’s meant to be used for companies that have a constant growth in their users, with this solution you don’t need to update your whitelist manually, simply make all the necessary configurations and the system will be automated.
First you need to provide an API that will send us the user every time it’s updated, when you put the API you need to provide to us a test data, this test data is a valid email or phone (depending on how you configure your Login methods) then when you make a test we must receive the information like in the image below.
if we don’t find any valid data, the system will return with a null response, this means that we don’t find any information using the test data provided.
When to use each one of the solutions to create a whitelist?
Both solutions have the same goal, to provide Verifik the list of valid user for the use of Smart Access, however depending on the amount of user, and your code knowledge one of these solutions is more valid than the other.
Upload a CSV
Static list of users that not change constantly.
No code knowledge / no need for a developer.
Connect with API
Have a developer that can help you in creating an API that exposes your clients with only the email, name, phone number.
By using the API, you have the advantage of having a dynamic list that can change multiple times in the future, by reducing users or adding more to the API.
Last updated