Update a Project

PUT https://api.verifik.co/v2/projects/{id}

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

If we want our project to become an active project, we must change the "status" parameter from "draft" to "active".

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Query Parameters

Name
Type
Description

id

string

ID of the Project 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

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

{
  "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>",
    "tabColor": "#B2BDD3",
    "titleColor": "#FFFFFF",
    "txtColor": "#212121"
  },
  "dataProtection": {
    "address": "KR 7 # 33 - 42",
    "address2": null,
    "city": "Bogota",
    "country": "Colombia",
    "email": "[email protected]",
    "name": "Verifik",
    "postalCode": "111631"
  }
}

Response

{
    "status": "completed",
    "data": {
        "__v": 0,
        "_id": "68a743e5...",
        "allowedCountries": ["Colombia"],
        "client": "67054dc...",
        "collectionCode": "fbf8a322...",
        "contactEmail": "[email protected]",
        "createdAt": "2025-08-21T00:00:00.000Z",
        "currentStep": 0,
        "lastStep": 1,
        "name": "Ejemplo Documentacion Verifik",
        "privacyUrl": "<your privacy link>",
        "projectMembers": [],
        "status": "draft",
        "termsAndConditionsUrl": "<your terms and conditions link>",
        "updatedAt": "2025-08-21T00:00:00.000Z",
        "assignedCollection": {
            "__v": 0,
            "_id": "68a743e5...",
            "client": "67054dc6...",
            "code": "fbf8a322...",
            "createdAt": "2025-08-21T00:00:00.000Z",
            "description": "project #68a743e5...",
            "name": "Ejemplo Documentacion Verifik_0LVV",
            "project": "68a743e5...",
            "updatedAt": "2025-08-21T00:00:00.000Z"
        },
        "branding": {
            "bgColor": "#ffffff",
            "borderColor": "#B2BDD3",
            "buttonColor": "#B2BDD3",
            "buttonTxtColor": "#FFFFFF",
            "logo": "<http or base64>",
            "rightBackgroundColor": "white",
            "rightImage": null,
            "rightImagePosition": "center center",
            "secondaryButtonColor": "#B2BDD3",
            "secondaryButtonTextColor": "#FFFFFF",
            "tabColor": "#B2BDD3",
            "titleColor": "#FFFFFF",
            "txtColor": "#212121"
        },
        "dataProtection": {
            "address": "KR 7 # 33 - 42",
            "address2": null,
            "city": "Bogota",
            "country": "Colombia",
            "email": "[email protected]",
            "name": "Verifik",
            "postalCode": "111631"
        }
    }
}

Last updated

Was this helpful?