Create a project (Crear un proyecto)

Endpoint

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

Un Proyecto es donde se almacena toda la información relacionada con la empresa o entidad que utilizará los servicios de autenticación y validación generados por Verifik. Esto se hace para garantizar que tu marca esté correctamente representada al usar los servicios de Verifik.

Headers

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

Parameters

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"
  ]
}

También podemos crear proyectos más robustos, donde se puede agregar información de contacto, Términos y Condiciones, y correos electrónicos para asuntos legales. Además, es posible configurar colores de marca y agregar el logotipo de la empresa. A continuación, se muestra un ejemplo de un cuerpo de proyecto creado con toda la información requerida.

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"
}

Si bien toda la información recibida en la respuesta es útil para verificar nuestro proyecto, el campo que más nos interesa es _id. Este será solicitado en otros endpoints bajo el nombre project.

Una vez que nuestro proyecto esté creado, podemos comenzar a crear un Project Flow.