The ProjectFlow object

Attributes

project- String - Required

The project is that _id generated when creating a project correctly.

type - String - Required

The type determines what type of service you want to generate in this project flow. can be “type”:”login” or "type":"onboarding".

loginSettings- Object- Required

Login Settings refers to all the validations that will be performed in this flow, the parameters are:

  • searchMode

  • email

  • emailGateway

  • phone

  • phoneGateway

  • faceLiveness

  • livenessMinScore

  • searchMinScore

  • showFaceLivenessRecommendation

redirectUrl- String - Required

URL where users will be redirected after finish the validation process.

security- Object- Required

Object to add all the security asociated to the projectFlow. It has the following params:

  • strategy

  • apiTestType

  • source

  • apiUrl

  • apiTestValue

whitelist- Object- Required

Object to add all the persons that will have access or not in the projectFlow. It has the following params:

  • project

  • name

  • email

  • countryCode

  • phone

The ProjectFlow object

{
    "project": "6671e17e6e950a78d6a88299",
    "type": "login",
    "status": "active",
    "redirectUrl": "https://verifik.co",
    "allowedCountries": [
        "Colombia"
    ],
    "loginSettings": {
        "email": false,
        "emailGateway": "mailgun",
        "phone": true,
        "phoneGateway": "both",
        "faceLiveness": true,
        "showFaceLivenessRecommendation": true,
        "livenessMinScore": 0.65,
        "searchMode": "FAST",
        "searchMinScore": 0.85
    },
    "security": {
        "strategy": "whitelist",
        "source": "CSV",
        "apiTestType": "email",
        "apiUrl": "https://faas-nyc1-2ef2e6cc.doserverless.co/api/v1/web/fn-b88d2a3d-137b-4d8c-95af-9c4f33f69af4/passwordless-validation-url/[email protected]",
        "apiTestValue": "[email protected]"
    },
    "usesWhiteList": false,
    "whiteList": {
    {
        "project": "6671e17e6e950a78d6a88299",
        "name": "Nicolas",
        "email": "[email protected]",
        "countryCode": "57",
        "phone": "3201234567"
    }
    }
}
PreviousProject FlowsNextCreate a project flow

Last updated