Update a Project Flow

PUT https://api.verifik.co/v2/project-flows/{id}

Method for updating an existing projectFlow. To make the service work, the _id parameter is required, which is generated when a Project Flow is created correctly.

If we want our project to become an active Project Flow, we must change the "status" parameter from "draft" to "active" on both the Project and the Project Flow

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

Query Parameters

Name	Type	Description
id	string	ID of the Project Flow that you want to bring the information.

Body

Name	Type	Description
status	string	Current Status of the project, can be "draft" or "active", only "active" projects can be used.

Body Example

In the body of this service, you can send all the fields generated when creating a Project Flow. The only thing to consider is that the fields we want to modify are the ones that must be included in the body.

{
    "project": "507f1f77bcf86cd799439011",
    "redirectUrl": "https://example.com",
    "status": "active",
    "type": "login",
    "usesWhiteList": false,
    "loginSettings": {
        "email": false,
        "emailGateway": "mailgun",
        "faceLiveness": true,
        "livenessMinScore": 0.65,
        "phone": true,
        "phoneGateway": "both",
        "searchMinScore": 0.85,
        "searchMode": "FAST",
        "showFaceLivenessRecommendation": true
    },
    "security": {
        "apiTestType": "email",
        "apiTestValue": "<test_email>",
        "apiUrl": "<api_endpoint_url>",
        "source": "CSV",
        "strategy": "whitelist"
    },
    "whiteList": [
        {
            "countryCode": "<country_code>",
            "email": "<user_email>",
            "name": "<user_name>",
            "phone": "<phone_number>",
            "project": "507f1f77bcf86cd799439011"
        }
    ]
}

Response

200

{
    "project": "507f1f77bcf86cd799439011",
    "type": "login",
    "status": "active",
    "redirectUrl": "https://example.com",
    "usesWhiteList": false,
    "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": "<api_endpoint_url>",
        "apiTestValue": "<test_email>"
    },
    "whiteList": [
        {
            "project": "507f1f77bcf86cd799439011",
            "name": "<user_name>",
            "email": "<user_email>",
            "countryCode": "<country_code>",
            "phone": "<phone_number>"
        }
    ]
}

400

{
  "error": "Invalid request"
}