Create a project flow
POST -https://api.verifik.co/v2/project-flows
Project flows define a specific use for Verifik services and how we want to implement them. In this context, we will define various data points that Verifik will use to perform validations using passwordless and liveness detection technologies.
Headers
| Name | Value |
|---|---|
Content-Type |
|
Authorization |
|
Body Example
The creation of a project flow involves various components, which will be listed below:
project & type
project: If you have followed this guide, the project is that _id generated when creating a project correctly. So, this parameter is that _id but with the name "project."
type: The type determines what type of service you want to generate in this project flow. As this is a Smart Access guide, we will generate a “type”:”login”.
loginSettings
Login Settings refers to all the validations that will be performed in this flow. For these implementations to be created correctly, the type of the project flow must be set to login. The following explains each of these elements and what they refer to in the configuration:
phone: This is a Boolean that determines whether a phone is required in the flow or not.
phoneGateway: Determines the provider for phone validation, for sending an OTP (One Time Password) for its validation. Valid parameters for this case include: "WhatsApp," "SMS," "both," and "none."
email: This is a Boolean that determines whether an email is required in the flow or not.
emailGateway: Determines the provider for email validation, for sending an OTP (One Time Password) for its validation. Currently, there are two possible values: "mailgun" and "none."
faceLiveness: This is a Boolean that determines whether a liveness detection process will be performed in the flow or not.
livenessMinScore: Determines the minimum score that the liveness detection process must surpass to be successful. This value ranges between 0 and 1; Verifik recommends a value higher than 0.7 for better results.
searchMode: Determines the mode for searching facial matches in the database of your project. You can send "FAST" or "ACCURATE."
searchMinScore: Determines the minimum match threshold for a match to be considered between a submitted face and one stored in the database.
showFaceLivenessRecommendation: sds
security
This part of the body refers to the security system that will be used to allow or deny access to certain users in your project flow. Here, we will list each element and how it should be used:
strategy: Specifies whether users will be allowed entry or denied access. Use "whitelist" if you want the users you send to be able to access the project flow or "blacklist" if you want to deny them access.
source: Defines how we will send the list of users for our security system. We have two options:
CSV
In case we use the CSV source, we should provide the list of users in the following way in an array of objects called whitelist. We need to send the following data in each of the objects:
name: User's name
email: Email associated with this user.
countryCode: Country code prefix of the phone.
phone: Phone to be associated with this user.
API
If we use the API source, we must provide the following fields in the security object:
apiUrl: This field is an API that should be able to return information about your users. Here, you should have data such as email, phone, country code, and name.
apiTestType: Here, you determine the test value that will be used, whether it's an email or a phone.
apiTestValue: This is an example; it is a real data point that, when used to query the API, will return the appropriate information to add people to the whitelist.
Response
Last updated