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

NameValue

Content-Type

application/json

Authorization

Bearer <token>

Body Example

{
    "project": "65b03015c03e1a1b595fe61c",
    "type": "login",
    "status": "active",
    "redirectUrl": "<https://verifik.co>",
    "identityUrl": "<https://faas-nyc1-2ef2e6cc.doserverless.co/api/v1/web/fn-b88d2a3d-137b-4d8c-95af-9c4f33f69af4/passwordless-validation-url/demo-passwordless-validation-url?email=daniel@gomat.co>",
    "loginSettings": {
        "searchMode": "FAST",
        "email": true,
        "emailGateway": "mailgun",
        "phone": false,
        "phoneGateway": "both",
        "faceLiveness": true,
        "showFaceLivenessRecommendation": false,
        "livenessMinScore": 0.9,
        "searchMinScore": 0.95
    },
    "security": {
        "strategy": "whitelist",
        "apiTestType": "email",
        "_id": "65c166926d38504eb418d1ed",
        "source": "API",
        "apiUrl": "<https://faas-nyc1-2ef2e6cc.doserverless.co/api/v1/web/fn-b88d2a3d-137b-4d8c-95af-9c4f33f69af4/passwordless-validation-url/demo-passwordless-validation-url?email=daniel@gomat.co>",
        "apiTestValue": "daniel@gomat.co"
    }
}

The creation of a project flow involves various components, which will be listed below:

project & type

  • project: the project is the _id generated when creating a project correctly.

  • type: The type determines what type of service you want to generate in this project flow. Options [login, onboarding]

Login Settings

Login Settings

Security Settings

Security Settings

Response

{
  "data": {
    "type": "login",
    "status": "draft",
    "version": 1,
    "_id": "6577a671c3abfb14dcfc55ad", 
    "deleted": false,
    "project": "6577a0f3c3abfb14dcfc54b5",
    "loginSettings": {
      "steps": []
    },
    "client": "613375a1eab2fe08527f81e2",
    "updatedAt": "2023-12-12T00:16:49.946Z",
    "createdAt": "2023-12-12T00:16:49.946Z",
    "__v": 0
  }
}

Last updated