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.

Implementation

Headers

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

Body

Name	Type	Description
name	string	Name of the project.
allowedCountries	String	Countries where your project will be used, there must be defined properly otherwise Verifik can't send OTP to this countries.

"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 of America"
"Ecuador"	"Panama"	"Uruguay"
"El Salvador"	"Paraguay"	"Venezuela"
"France"	"Peru"

Body with minimal data

{
  "name": "Example",
  "allowedCountries": [
    "Colombia"
  ]
}

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 with full data

{
  "branding": {
    "bgColor": "#ffffff",
    "borderColor": "#B2BDD3",
    "txtColor": "#212121",
    "titleColor": "#FFFFFF",
    "logo": "<https://cdn.verifik.co/projects/Inmobu-ValidaciónDeIdentidad_1702305468459-image.jpeg>"
  },
  "allowedCountries": [
    "Colombia"
  ],
  "name": "Ejemplo Documentacion Verifik",
  "contactEmail": "[e-mail]",
  "privacyUrl": "<https://docs.verifik.co/docs/terminos-condiciones/ftxz1gulcjg3y-manual-de-politicas-de-privacidad-y-procedimientos-para-la-proteccion-tratamiento-de-datos-personales-y-atencion-de-solicitudes-consultas-y-reclamos>",
  "termsAndConditionsUrl": "<https://docs.verifik.co/docs/terminos-condiciones/04z7dktljn54j-terminos-y-condiciones-del-uso-de-los-servicios-del-aplicativo-verifik>",
  "dataProtection": {
    "name": "Verifik",
    "email": "[e-mail]",
    "address": "KR 7 # 33 - 42",
    "address2": null,
    "city": "Bogota",
    "country": "Colombia",
    "postalCode": "111631"
  }
}

Response

200

{
  "data": {
    "branding": {
      "bgColor": "#01236D",
      "borderColor": "#B2BDD3",
      "txtColor": "#8091B6",
      "titleColor": "#FFFFFF",
      "logo": null
    },
    "status": "draft",
    "currentStep": 0,
    "lastStep": 1,
    "allowedCountries": [
      "Colombia"
    ],
    "_id": "65772f3b427932d45a3811f9", // Required field in other services
    "name": "Ejemplo",
    "client": "64404b1f9856cc8cebd762e7",
    "updatedAt": "2023-12-11T15:48:11.640Z",
    "createdAt": "2023-12-11T15:48:11.640Z",
    "__v": 0
  }
}

409

{
    "code": "MissingParameter",
    "message": "missing name\n"
}

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.