Retrieve a project flow

GET - https://api.verifik.co/v2/project-flows/{ID}

With this service, you can bring all projectflow that you have created or if you only want one, you can specify the ID of the project and the endpoint will return only the selected project.

Headers

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

Query Parameters

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

Response

200

{
            "_id": "6345d7b174d77f4dae45e5d7",
            "loginSettings": {
                "steps": [],
                "searchMode": "FAST"
            },
            "onboardingSettings": {
                "steps": {
                    "signUpForm": "mandatory",
                    "basicInformation": "mandatory",
                    "document": "mandatory",
                    "liveness": "mandatory",
                    "form": "mandatory"
                },
                "signUpForm": {
                    "emailGateway": "none",
                    "phoneGateway": "none",
                    "extraFields": []
                },
                "basicInformation": {
                    "fullName": true,
                    "age": true,
                    "gender": true,
                    "address": true,
                    "postalCode": true,
                    "legalDocument": true
                },
                "document": {
                    "uploadDocumentAllowed": true,
                    "scanDocumentAllowed": true,
                    "validationMethod": "SCAN_PROMPT",
                    "fallbackValidationMethod": "SCAN_PROMPT",
                    "compareMinScore": 0.67,
                    "maxAttempts": 3
                },
                "liveness": {
                    "searchMode": "FAST",
                    "maxAttempts": 3
                },
                "documentValidation": {
                    "includeOCR": true,
                    "includeGovernmentVerification": false,
                    "useGovermentID": true,
                    "useBasicLiveness": true,
                    "useProLiveness": false,
                    "verifyCriminalHistory": true,
                    "useGovernmentID": true
                },
                "countriesAllowed": []
            },
            "userFeatures": [],
            "type": "onboarding",
            "status": "draft",
            "version": 1,
            "allowedCountries": [
                "Colombia"
            ],
            "usesWhiteList": false,
            "deleted": false,
            "project": "6345d7b174d77f4dae45e5d6",
            "client": "623b6317fe5fd1774be9f566",
            "updatedAt": "2022-10-11T21:05:55.964Z",
            "createdAt": "2022-10-11T20:53:05.052Z",
            "__v": 0,
            "email": true,
            "phone": true,
            "phoneGateway": "whatsapp"
        }

400

{
  "error": "Invalid request"
}