Smart Access Project Flow

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

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Property	Type	Description
project	ObjectId	(Required) Reference to the associated Project
type	String	(Required) Flow type - Must be: "login"
collectionCode	String	Collection identifier for the project flow
identityUrl	String	URL for identity verification endpoint
redirectUrl	String	URL to redirect users after completion
status	String	Current status: "draft", "active", or "paused"
systemForm	ObjectId	Reference to the Form model for system forms
webhook	ObjectId	Reference to the Webhook model
webhookUrl	String	External webhook URL for notifications
loginSettings	Object	Sub-document containing settings pertaining to the login options
systemSettings	Object	Sub-document containing system settings for this flow

loginSettings Sub-document

Property	Type	Description
email	Boolean	Whether email login is enabled
emailGateway	String	Email gateway: "mailgun" or "none"
faceLiveness	Boolean	Whether face liveness detection is enabled
livenessMinScore	Number	Minimum liveness score (0.51-0.9)
phone	Boolean	Whether phone login is enabled
phoneGateway	String	Phone gateway: "sms", "whatsapp", "both", or "none"
searchMinScore	Number	Minimum search score (0.7-0.95)
searchMode	String	Search mode: "FAST" or "ACCURATE"
showFaceLivenessRecommendation	Boolean	Whether to show liveness recommendations
steps	Array	Array of login flow steps

security Sub-document

Property	Type	Description
apiTestType	String	Type of API test: "email" or "phone"
apiTestValue	String	Test value for API verification
apiUrl	String	Security API endpoint URL
source	String	Security source: "API", "CSV", or "NONE"
strategy	String	Security strategy: "whitelist", or "none"

More information on security can be found here:

Security Settings

Request

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 '{
        "identityUrl": "https://identity.verifik.co/verify",
        "project": "507f1f77bcf86cd799439012",
        "redirectUrl": "https://app.verifik.co/onboarding/success",
        "status": "active",
        "systemForm": "507f1f77bcf86cd799439022",
        "type": "login",
        "webhook": "507f1f77bcf86cd799439013",
        "webhookUrl": "https://api.client.com/webhooks/verifik",
        "loginSettings": {
            "email": true,
            "emailGateway": "mailgun",
            "faceLiveness": true,
            "livenessMinScore": 0.75,
            "phone": true,
            "phoneGateway": "both",
            "searchMinScore": 0.85,
            "searchMode": "ACCURATE",
            "showFaceLivenessRecommendation": true,
            "steps": ["email", "phone", "liveness"]
        },
        "security": {
            "apiTestType": "email",
            "apiTestValue": "[email protected]",
            "apiUrl": "https://security.client.com/api/verify",
            "source": "API",
            "strategy": "whitelist"
        }
    }'

Node.js

const axios = require('axios');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.verifik.co/v2/project-flows',
  headers: { 
    'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsIn...a1ldKk8Tt5Kh_o',
    'Content-Type': 'application/json', 
  },
  data: {
      "collectionCode": "ONBOARD_2024",
      "identityUrl": "https://identity.verifik.co/verify",
      "project": "507f1f77bcf86cd799439012",
      "redirectUrl": "https://app.verifik.co/onboarding/success",
      "status": "active",
      "systemForm": "507f1f77bcf86cd799439022",
      "type": "login",
      "webhook": "507f1f77bcf86cd799439013",
      "webhookUrl": "https://api.client.com/webhooks/verifik",
      "loginSettings": {
          "email": true,
          "emailGateway": "mailgun",
          "faceLiveness": true,
          "livenessMinScore": 0.75,
          "phone": true,
          "phoneGateway": "both",
          "searchMinScore": 0.85,
          "searchMode": "ACCURATE",
          "showFaceLivenessRecommendation": true,
          "steps": ["email", "phone", "liveness"]
      },
      "security": {
          "apiTestType": "email",
          "apiTestValue": "[email protected]",
          "apiUrl": "https://security.client.com/api/verify",
          "source": "API",
          "strategy": "whitelist"
      }
  }
};

axios.request(config)
    .then((response) => response.data)
    .catch((error) => 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#"{
        "collectionCode": "ONBOARD_2024",
        "identityUrl": "https://identity.verifik.co/verify",
        "project": "507f1f77bcf86cd799439012",
        "redirectUrl": "https://app.verifik.co/onboarding/success",
        "status": "active",
        "systemForm": "507f1f77bcf86cd799439022",
        "type": "login",
        "webhook": "507f1f77bcf86cd799439013",
        "webhookUrl": "https://api.client.com/webhooks/verifik",
        "loginSettings": {
            "email": true,
            "emailGateway": "mailgun",
            "faceLiveness": true,
            "livenessMinScore": 0.75,
            "phone": true,
            "phoneGateway": "both",
            "searchMinScore": 0.85,
            "searchMode": "ACCURATE",
            "showFaceLivenessRecommendation": true,
            "steps": ["email", "phone", "liveness"]
        },
        "security": {
            "apiTestType": "email",
            "apiTestValue": "[email protected]",
            "apiUrl": "https://security.client.com/api/verify",
            "source": "API",
            "strategy": "whitelist"
        }
    }"#;

    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(
    {
        "collectionCode": "ONBOARD_2024",
        "identityUrl": "https://identity.verifik.co/verify",
        "project": "507f1f77bcf86cd799439012",
        "redirectUrl": "https://app.verifik.co/onboarding/success",
        "status": "active",
        "systemForm": "507f1f77bcf86cd799439022",
        "type": "login",
        "webhook": "507f1f77bcf86cd799439013",
        "webhookUrl": "https://api.client.com/webhooks/verifik",
        "loginSettings": {
            "email": true,
            "emailGateway": "mailgun",
            "faceLiveness": true,
            "livenessMinScore": 0.75,
            "phone": true,
            "phoneGateway": "both",
            "searchMinScore": 0.85,
            "searchMode": "ACCURATE",
            "showFaceLivenessRecommendation": true,
            "steps": ["email", "phone", "liveness"],
        },
        "security": {
            "apiTestType": "email",
            "apiTestValue": "[email protected]",
            "apiUrl": "https://security.client.com/api/verify",
            "source": "API",
            "strategy": "whitelist",
        },
    }
)

headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer eyJhbGciOiJIUzI1N...Kk8Tt5Kh_o",
}

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

print(response.text)

Response

200

{
    "__v": 0,
    "_id": "67996c2606c23de3bc785a23",
    "allowedCountries": [],
    "client": "67054dc629a00e8b1ce73c51",
    "createdAt": "2025-01-28T23:45:42.007Z",
    "linkSettings": null,
    "onboardingSettings": null,
    "project": "67054e609e2c794b78e02af8",
    "redirectUrl": "https://verifik.co",
    "status": "active",
    "type": "login",
    "updatedAt": "2025-06-26T21:40:25.053Z",
    "version": 1,
    "webhook": "68a63328cba3c7dac2896950",
    "loginSettings": {
        "email": true,
        "emailGateway": "mailgun",
        "faceLiveness": true,
        "livenessMinScore": 0.65,
        "phone": true,
        "phoneGateway": "both",
        "searchMinScore": 0.85,
        "searchMode": "FAST",
        "showFaceLivenessRecommendation": true,
        "steps": []
    },
    "security": {
        "_id": "67996c6d06c23de3bc785a30",
        "apiTestType": "email",
        "source": "CSV",
        "strategy": "whitelist",
    }
}

400

{
  "error": "Invalid request"
}

Create a Project Flow