Create a Project

POST https://api.verifik.co/v2/projects

A Project is where all the information related to the company or entity that will use the authentication and validation services generated by Verifik is stored. This is done to ensure that your brand is represented correctly when using Verifik's services.

Headers

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

Body

Name	Type	Description
name	string	Name of the project.
allowedCountries	Array<string>	Countries where your project will be used, there must be defined properly otherwise Verifik can't send OTP to this countries.
contactEmail	string	Primary email address of the project owner
privacyUrl	string	Link to your privacy policy
termsAndConditionsUrl	string	Link to your terms and conditions

allowedCountries Values

"Argentina"	"Germany"	"Portugal"
"Australia"	"Guatemala"	"Puerto Rico"
"Austria"	"Honduras"	"Russia"
"Belgium"	"Ireland"	"Spain"
"Brazil"	"Italy"	"Sweden"
"Canada"	"Mexico"	"Switzerland"
"Chile"	"Netherlands"	"Trinidad and Tobago"
"Colombia"	"Nicaragua"	"United Kingdom"
"Costa Rica"	"Norway"	"United States"
"Ecuador"	"Panama"	"Uruguay"
"El Salvador"	"Paraguay"	"Venezuela"
"France"	"Peru"	"Vietnam"
"Yemen"	"Uzbekistan"

Body (Basic Project)

{
    "allowedCountries": [ "Colombia" ],
    "contactEmail": "[email protected]",
    "name": "Example",
    "privacyUrl": "<your privacy link>",
    "termsAndConditionsUrl": "<your terms and conditions link>"
}

We can also create more robust projects where we can add contact information, Terms & Conditions, and emails for legal matters. Additionally, we can configure brand colors and add the company logo. Here is an example of a project body created with all the required information.

Body (Advanced Project)

{
    "allowedCountries": ["Colombia"],
    "contactEmail": "[email protected]",
    "name": "Ejemplo Documentacion Verifik",
    "privacyUrl": "<your privacy link>",
    "termsAndConditionsUrl": "<your terms and conditions link>",
    "branding": {
        "bgColor": "#ffffff",
        "borderColor": "#B2BDD3",
        "logo": "<http or base64>",
        "titleColor": "#FFFFFF",
        "txtColor": "#212121"
    },
    "dataProtection": {
        "address": "KR 7 # 33 - 42",
        "address2": null,
        "city": "Bogota",
        "country": "Colombia",
        "email": "[email protected]",
        "name": "Verifik",
        "postalCode": "111631"
    }
}

Response

200

{
    "data": {
        "__v": 0,
        "_id": "68a73f...",
        "allowedCountries": ["Colombia"],
        "assignedCollection": "68a73f...",
        "client": "67054d...",
        "collectionCode": "e7b228da...",
        "contactEmail": "[email protected]",
        "createdAt": "2025-08-21T00:00:00.000Z",
        "currentStep": 0,
        "lastStep": 1,
        "name": "Example",
        "privacyUrl": "<your privacy link>",
        "projectMembers": [],
        "status": "draft",
        "termsAndConditionsUrl": "<your terms and conditions link>",
        "updatedAt": "2025-08-21T00:00:00.000Z",
        "branding": {
            "bgColor": "#01236D",
            "borderColor": "#B2BDD3",
            "buttonColor": "#B2BDD3",
            "buttonTxtColor": "#FFFFFF",
            "logo": null,
            "rightBackgroundColor": "white",
            "rightImage": null,
            "rightImagePosition": "center center",
            "secondaryButtonColor": "#B2BDD3",
            "secondaryButtonTextColor": "#FFFFFF",
            "tabColor": "#01236D",
            "titleColor": "#FFFFFF",
            "txtColor": "#8091B6"
        }
    }
}

409

{
    "message": "missing name\n. missing contactEmail\n. missing privacyUrl\n. missing termsAndConditionsUrl\n. \"allowedCountries\" is required",
    "code": "MissingParameter"
}

While all the information received in the response is useful for verifying our project, the field that interests us the most is the _id. This will be requested in other endpoints with the name project.

Once our project is created, we can start creating a Project Flow.