Create a project flow

Endpoint [POST]

https://api.verifik.co/v2/project-flows

Project flows define a specific flow (like it's name says it) for a specific Project in Verifik. 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	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/[email protected]",
    "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/[email protected]",
        "apiTestValue": "[email protected]"
    }
}

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]

SmartAccess settings

Login settings

SmartEnroll settings

Onboarding settings

cURL

curl --location --request POST 'https://api.verifik.co/v2/project-flows' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsIn...ldKk8Tt5Kh_o' \
--data-raw '{
    "project": "6842ef5b80add6ddf5aa7fe0",
    "type": "onboarding",
    "status": "active",
    "redirectUrl": "https://debug.verifik.co",
    "onboardingSettings": {
        "steps": {
            "signUpForm": "mandatory",
            "basicInformation": "mandatory",
            "document": "mandatory",
            "liveness": "mandatory",
            "form": "mandatory"
        },
        "signUpForm": {
            "fullName": true,
            "firstName": true,
            "lastName": true,
            "email": true,
            "emailGateway": "mailgun",
            "phone": true,
            "phoneGateway": "whatsapp",
            "extraFields": [],
            "showTermsAndConditions": true,
            "showPrivacyNotice": true
        },
        "basicInformation": {
            "age": true,
            "dateOfBirth": true,
            "gender": true,
            "address": true,
            "postalCode": true
        },
        "document": {
            "useGovernmentID": true,
            "usePassport": true,
            "useLicense": true,
            "verifyNames": true,
            "verifyCriminalHistory": true,
            "criminalEndpoints": [],
            "uploadDocumentAllowed": true,
            "scanDocumentAllowed": true,
            "validationMethod": "SCAN_PROMPT",
            "fallbackValidationMethod": "SCAN_PROMPT",
            "compareMinScore": 0.67,
            "maxAttempts": 3
        },
        "liveness": {
            "livenessMinScore": 0.9,
            "searchMode": "FAST",
            "searchMinScore": 0.95,
            "maxAttempts": 3
        }
    },
    "security": {
        "strategy": "blacklist",
        "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",
        "apiTestType": "email",
        "apiTestValue": "[email protected]"
    }
}'

Node.js

const axios = require('axios');
let data = JSON.stringify({
  "project": "6842ef5b80add6ddf5aa7fe0",
  "type": "onboarding",
  "status": "active",
  "redirectUrl": "https://debug.verifik.co",
  "onboardingSettings": {
    "steps": {
      "signUpForm": "mandatory",
      "basicInformation": "mandatory",
      "document": "mandatory",
      "liveness": "mandatory",
      "form": "mandatory"
    },
    "signUpForm": {
      "fullName": true,
      "firstName": true,
      "lastName": true,
      "email": true,
      "emailGateway": "mailgun",
      "phone": true,
      "phoneGateway": "whatsapp",
      "extraFields": [],
      "showTermsAndConditions": true,
      "showPrivacyNotice": true
    },
    "basicInformation": {
      "age": true,
      "dateOfBirth": true,
      "gender": true,
      "address": true,
      "postalCode": true
    },
    "document": {
      "useGovernmentID": true,
      "usePassport": true,
      "useLicense": true,
      "verifyNames": true,
      "verifyCriminalHistory": true,
      "criminalEndpoints": [],
      "uploadDocumentAllowed": true,
      "scanDocumentAllowed": true,
      "validationMethod": "SCAN_PROMPT",
      "fallbackValidationMethod": "SCAN_PROMPT",
      "compareMinScore": 0.67,
      "maxAttempts": 3
    },
    "liveness": {
      "livenessMinScore": 0.9,
      "searchMode": "FAST",
      "searchMinScore": 0.95,
      "maxAttempts": 3
    }
  },
  "security": {
    "strategy": "blacklist",
    "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",
    "apiTestType": "email",
    "apiTestValue": "[email protected]"
  }
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.verifik.co/v2/project-flows',
  headers: { 
    'Content-Type': 'application/json', 
    'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsIn...a1ldKk8Tt5Kh_o'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Rust

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = reqwest::Client::builder()
        .build()?;

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Content-Type", "application/json".parse()?);
    headers.insert("Authorization", "Bearer eyJhbGciOiJ...GdD1Ww4AFqFqa1ldKk8Tt5Kh_o".parse()?);

    let data = r#"{
    "project": "6842ef5b80add6ddf5aa7fe0",
    "type": "onboarding",
    "status": "active",
    "redirectUrl": "https://debug.verifik.co",
    "onboardingSettings": {
        "steps": {
            "signUpForm": "mandatory",
            "basicInformation": "mandatory",
            "document": "mandatory",
            "liveness": "mandatory",
            "form": "mandatory"
        },
        "signUpForm": {
            "fullName": true,
            "firstName": true,
            "lastName": true,
            "email": true,
            "emailGateway": "mailgun",
            "phone": true,
            "phoneGateway": "whatsapp",
            "extraFields": [],
            "showTermsAndConditions": true,
            "showPrivacyNotice": true
        },
        "basicInformation": {
            "age": true,
            "dateOfBirth": true,
            "gender": true,
            "address": true,
            "postalCode": true
        },
        "document": {
            "useGovernmentID": true,
            "usePassport": true,
            "useLicense": true,
            "verifyNames": true,
            "verifyCriminalHistory": true,
            "criminalEndpoints": [],
            "uploadDocumentAllowed": true,
            "scanDocumentAllowed": true,
            "validationMethod": "SCAN_PROMPT",
            "fallbackValidationMethod": "SCAN_PROMPT",
            "compareMinScore": 0.67,
            "maxAttempts": 3
        },
        "liveness": {
            "livenessMinScore": 0.9,
            "searchMode": "FAST",
            "searchMinScore": 0.95,
            "maxAttempts": 3
        }
    },
    "security": {
        "strategy": "blacklist",
        "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",
        "apiTestType": "email",
        "apiTestValue": "[email protected]"
    }
}"#;

    let json: serde_json::Value = serde_json::from_str(&data)?;

    let request = client.request(reqwest::Method::POST, "https://api.verifik.co/v2/project-flows")
        .headers(headers)
        .json(&json);

    let response = request.send().await?;
    let body = response.text().await?;

    println!("{}", body);

    Ok(())
}

Python

import requests
import json

url = "https://api.verifik.co/v2/project-flows"

payload = json.dumps({
  "project": "6842ef5b80add6ddf5aa7fe0",
  "type": "onboarding",
  "status": "active",
  "redirectUrl": "https://debug.verifik.co",
  "onboardingSettings": {
    "steps": {
      "signUpForm": "mandatory",
      "basicInformation": "mandatory",
      "document": "mandatory",
      "liveness": "mandatory",
      "form": "mandatory"
    },
    "signUpForm": {
      "fullName": True,
      "firstName": True,
      "lastName": True,
      "email": True,
      "emailGateway": "mailgun",
      "phone": True,
      "phoneGateway": "whatsapp",
      "extraFields": [],
      "showTermsAndConditions": True,
      "showPrivacyNotice": True
    },
    "basicInformation": {
      "age": True,
      "dateOfBirth": True,
      "gender": True,
      "address": True,
      "postalCode": True
    },
    "document": {
      "useGovernmentID": True,
      "usePassport": True,
      "useLicense": True,
      "verifyNames": True,
      "verifyCriminalHistory": True,
      "criminalEndpoints": [],
      "uploadDocumentAllowed": True,
      "scanDocumentAllowed": True,
      "validationMethod": "SCAN_PROMPT",
      "fallbackValidationMethod": "SCAN_PROMPT",
      "compareMinScore": 0.67,
      "maxAttempts": 3
    },
    "liveness": {
      "livenessMinScore": 0.9,
      "searchMode": "FAST",
      "searchMinScore": 0.95,
      "maxAttempts": 3
    }
  },
  "security": {
    "strategy": "blacklist",
    "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",
    "apiTestType": "email",
    "apiTestValue": "[email protected]"
  }
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer eyJhbGciOiJIUzI1N...Kk8Tt5Kh_o'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Security settings

Security settings

Response

200

{
  "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
  }
}

400

{
  "error": "Invalid request"
}