@gov-cy/govcy-express-services

govcy Express Services

⚠️ Warning:
This package is under active development and is not a finished product. It is intended for testing, acceptance, integration, and browser testing purposes only.

No guarantees are provided regarding stability, security, or compliance. Using this package does not imply your product or service will automatically pass any required assessments, audits, or certifications by the Cyprus government or any other authority.

You are responsible for ensuring your own compliance, security, and quality assurance processes.

📝 Description

This project is an Express-based project that dynamically renders online service forms using @gov-cy/govcy-frontend-renderer, handles data input, validations, renders a review page and submits the data via a submission API. It is designed for developers building government services in Cyprus, enabling them to manage user authentication, form submissions, and OpenID authentication workflows in a timely manner.

The project is designed to support the Linear structure as described in the Unified Design System.

The APIs used for submission, temporary save and file uploads are not part of this project. The project has been designed to work together with the DSF Submission plarform and all API calls are based on the DSF Submission Platform APIs. This readme file describes the definition of these APIs if you wish to develop your own for your own government back-end solution. For more details about the DSF Submission Platform contact the DSF team.

Table of contents

• 📝 Description
• ✨ Features
• 📋 Prerequisites
• 🚀 Quick start
• ✅ Best Practices
• 📦 Full installation guide
• 🛠️ Usage
  • 🔑 Authentication Middleware -CY Login Access Policies
  • 🧩 Dynamic services
    • Pages
    • Form vs static pages
    • Update my details pages
    • Multiple things pages (repeating group of inputs)
    • Review page
    • Success page
  • 🛡️ Site eligibility checks
  • 📤 Site submissions
  • ✅ Input validations
  • 🔀 Conditional logic
  • 💾 Temporary save feature
  • 🗃️ Files uploads feature
  • ✨ Custom pages feature
• 🛣️ Routes
• 👨‍💻 Environment variables
• 🔒 Security note
• ❓ Troubleshooting / FAQ
• 🙏 Credits
• 💡 Developer notes
• 📄 License
• 📬 Contact

✨ Features

• Dynamic form rendering from JSON templates
  • Support for textInput, textArea, select, radios, checkboxes, datePicker, dateInput, fileInput elements
  • Support for conditional radios
• Dynamic creation of check your answers page
• OpenID Connect authentication with CY Login
• Middleware-based architecture for better maintainability
• Supports routing for dynamic pages
• Input validation
• CSRF protection
• cyLogin Single Sign-On (SSO) for physical authorized users
• Pre-filling posted values (in the same session)
• Site level API eligibility checks
• API integration with retry logic for form submissions.
• Optional temporary save of in-progress form data via configurable API endpoints
• Optional file uploads via API endpoints

📋 Prerequisites

• Node.js 20+
• npm
• A CY Login client ID and secret
• An API endpoint for form submissions (through cyConnect)

🚀 Quick start

# 1. Install the package
npm install @gov-cy/govcy-express-services

# 2. Generate SSL certificates for local development
openssl req -x509 -newkey rsa:2048 -keyout server.key -out server.cert -days 365 -nodes

# 3. Create a `secrets/.env` file in your project (see below for required variables)

# 4. Add a minimal data config file in /data (see test.json example)

# 5. Create an index.mjs file:

// index.mjs
import initializeGovCyExpressService from '@gov-cy/govcy-express-services';

const service = initializeGovCyExpressService();
service.startServer();

# 6. Start the server
npm start

• Visit https://localhost:44319 in your browser.
• Log in with CY Login and start using your dynamic service!

Tip:
For more details on configuration, environment variables, and advanced features, see the sections below.

📦 Full installation guide

The project acts as an npm package and you need to install it as a dependency in your npm project. Check out the install notes a detailed installation guide.

✅ Best Practices

Before starting your service, please review the Best Practices guide for guidance on:

• Repository structure
• Environment separation (dev / staging / prod)
• Secure CY Login client registration
• Mandatory footer pages (privacy, cookies, accessibility)

🛠️ Usage

Starting the Server

Add in your package.json:

"scripts": {
    "start": "node index.mjs"
}

Then run the server using npm start.

npm start

The server will start on https://localhost:44319 (see NOTES.md for more details on this).

🔑 Authentication Middleware

Authentication is handled via OpenID Connect using CY Login and is configured using environment variables. The middleware ensures users have valid sessions before accessing protected routes.

The CY Login tokens are used to also connect with the various APIs through cyConnect, so make sure to include the correct scope when requesting for a cyLogin client registration.

The CY Login settings are configured in the secrets/.env file.

cyLogin Access Policies

Each service can specify which types of authenticated CY Login profiles are allowed to access it using the site.cyLoginPolicies property in its site configuration.

"cyLoginPolicies": ["naturalPerson", "legalPerson"]

Supported Policies

Policy name	Description	Typical use
naturalPerson	Allows individual users (Cypriot citizens or foreign residents) who have a verified profile in the Civil Registry. Identified by profile_type: "Individual" and a 10-digit identifier starting with 00 (citizen) or 05 (foreigner).	Citizen-facing services, personal applications, etc.
legalPerson	Allows legal entities (companies, partnerships, organisations) with verified profiles in the Registrar of Companies. Identified by profile_type: "Organisation" and a legal_unique_identifier.	Business-facing services, company submissions, etc.

How it works

• Access is granted if any of the listed policies pass.
• If the user’s CY Login profile does not match any of the allowed policies, the request is blocked.

Defaults

If cyLoginPolicies is omitted, the framework defaults to:

"cyLoginPolicies": ["naturalPerson"]

This maintains backward compatibility with existing services that only supported individual (civil registry) users.

Example

Allow both natural and legal persons:

"site": {
  "cyLoginPolicies": ["naturalPerson", "legalPerson"]
}

Restrict access to natural persons only:

"site": {
  "cyLoginPolicies": ["naturalPerson"]
}

Notes

• This configuration applies globally to the service.
• Both requireAuth and cyLoginPolicy middlewares must be present on protected routes (automatically included by the default route setup).

🧩 Dynamic Services

Services are rendered dynamically using JSON templates stored in the /data folder. All the service configuration, pages, routes, and logic is stored in the JSON files. The service will load data/:siteId.json to get the form data when a user visits /:siteId/:pageUrl. Checkout the express-service-shema.json and the example JSON structure of the test.json file for more details.

Here is an example JSON config:

{
  "site": {
    "id": "test",
    "cyLoginPolicies": ["naturalPerson"], //<-- Allowed CY Login policies
    "lang": "el",     //<-- Default language
    "languages": [    //<-- Supported languages
      {
        "code": "el",
        "label": "EL",
        "alt": "Ελληνική γλώσσα",
        "href": "?lang=el"
      },
      {
        "code": "en",
        "label": "EN",
        "alt": "English language",
        "href": "?lang=en"
      }
    ],
    "footerLinks": [ //<-- Links on the footer
      {
        "label": {
          "el": "Δήλωση απορρήτου",
          "en": "Privacy statement",
          "tr": "Privacy statement"
        },
        "href": "test/privacy-statement"
      },
      {
        "label": {
          "el": "Cookies",
          "en": "Cookies",
          "tr": "Cookies"
        },
        "href": "test/cookie-policy"
      },
      {
        "label": {
          "el": "Προσβασιμότητα",
          "en": "Accessibility",
          "tr": "Accessibility"
        },
        "href": "test/accessibility-statement"
      }
    ],
    "footerIcons": [ //<-- Icons on the footer
      {
        "target": "_blank",
        "src": {
          "el": "https://cdn.jsdelivr.net/gh/gov-cy/govdesign@main/FundedbyEU_NextGeneration_H53-EL.png",
          "en": "https://cdn.jsdelivr.net/gh/gov-cy/govdesign@main/FundedbyEU_NextGeneration_H53-EN.png",
          "tr": "https://cdn.jsdelivr.net/gh/gov-cy/govdesign@main/FundedbyEU_NextGeneration_H53-EN.png"
        },
        "alt": {
          "el": "Χρηματοδοτείται από την ΕΕ Next Generation EU",
          "en": "Funded by the EU Next Generation EU",
          "tr": "Funded by the EU Next Generation EU"
        },
        "href": {
          "el": "https://europa.eu/",
          "en": "https://europa.eu/",
          "tr": "https://europa.eu/"
        },
        "title": {
          "el": "Μετάβαση στην ιστοσελίδα της ΕΕ",
          "en": "Go to EU website",
          "tr": "Go to EU website"
        }
      },
      {
        "target": "_blank",
        "src": {
          "el": "https://cdn.jsdelivr.net/gh/gov-cy/govdesign@main/CYpros%20to%20aurio%20logo%20eng_H53_EL.png",
          "en": "https://cdn.jsdelivr.net/gh/gov-cy/govdesign@main/CYpros%20to%20aurio%20logo%20eng_H53_EN.png",
          "tr": "https://cdn.jsdelivr.net/gh/gov-cy/govdesign@main/CYpros%20to%20aurio%20logo%20eng_H53_EN.png"
        },
        "alt": {
          "el": "Κύπρος το Αύριο, σχέδιο ανάκαμψης και ανθεντικότητας",
          "en": "Cyprus tomorrow, recovery and resilience plan",
          "tr": "Cyprus tomorrow, recovery and resilience plan"
        },
        "href": {
          "el": "http://www.cyprus-tomorrow.gov.cy/",
          "en": "http://www.cyprus-tomorrow.gov.cy/",
          "tr": "http://www.cyprus-tomorrow.gov.cy/"
        },
        "title": {
          "el": "Μετάβαση στην ιστοσελίδα Κύπρος το Αύριο",
          "en": "Go to Cyprus Tomorrow website",
          "tr": "Go to Cyprus Tomorrow website"
        }
      }
    ],
    "menu": {     //<-- Menu altext
      "el": "Μενού",
      "en": "Menu",
      "tr": "Menu"
    },
    "title": {  //<-- Service title (meta)
      "el": "Υπηρεσία τεστ",
      "en": "Test service",
      "tr": ""
    },
    "headerTitle": {  // <-- The header title settings
      "title": {      //<-- Service title (as it apears in the header)
        "el": "[Το ΟΝΟΜΑ της υπηρεσίας που θα φαίνεται στις φόρμες]",
        "en": "[The NAME of the service as it will appear on forms]",
        "tr": ""
      },
      "href": {       // <-- The relative URL of the header title link (for each language)
          "el":"/service-id",
          "en":"/service-id",
          "tr":"/service-id"
      }
    },
    "reviewPageHeader": {  //<-- OPTIONAL - Review page header. Useful when directing users to the review page from gov.cy start page
      "el": "Υπηρεσία τεστ",
      "en": "Test service",
      "tr": "Test service"
    },
    "successPageHeader": { //<-- OPTIONAL - Success page header
      "el": "Έχουμε λάβει την προσφορά σας",
      "en": "We have received your offer",
      "tr": "We have received your offer"
    },
    "successEmailHeader": { //<-- OPTIONAL - Success email header
      "el": "Έχουμε λάβει την προσφορά σας",
      "en": "We have received your offer",
      "tr": "We have received your offer"
    },
    "description": {  //<-- Service description (meta)
      "el": "[Υποβάλετε αίτηση για ...]",
      "en": "[Submit an application ...]",
      "tr": ""
    },
    "url": "https://gov.cy", //<-- URL in (meta, for example `og:url`)
    "cdn": {                 //<-- CDN URL and integrity
      "dist": "https://cdn.jsdelivr.net/gh/gov-cy/govcy-design-system@3.2.0/dist",
      "cssIntegrity": "sha384-qjx16YXHG+Vq/NVtwU2aDTc7DoLOyaVNuOHrwA3aTrckpM/ycxZoR5dx7ezNJ/Lv",
      "jsIntegrity": "sha384-tqEyCdi3GS4uDXctplAd7ODjiK5fo2Xlqv65e8w/cVvrcBf89tsxXFHXXNiUDyM7"
    },
    "submissionDataVersion": "1",     //<-- Submission data version
    "rendererVersion": "1.16.1",       //<-- govcy-frontend-renderer version
    "designSystemsVersion": "3.2.0",  //<-- govcy-design-system version
    "homeRedirectPage": {               //<-- Home redirect page
      "el": "https://www.gov.cy/service/aitisi-gia-taftotita/",
      "en": "https://www.gov.cy/en/service/issue-an-id-card/",
      "tr": "https://www.gov.cy/en/service/issue-an-id-card/"
    },
    "copyrightText": {                  //<-- Copyright text
      "el": "Κυπριακή Δημοκρατία, 2025",
      "en": "Republic of Cyprus, 2025",
      "tr": "Republic of Cyprus, 2025"
    },
    "submissionAPIEndpoint": {          //<-- Submission API endpoint
      "url": "TEST_SUBMISSION_API_URL",
      "method": "POST",
      "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
      "serviceId": "TEST_SUBMISSION_API_SERVIVE_ID",
      "dsfgtwApiKey": "TEST_SUBMISSION_DSF_GTW_KEY",
      "response": {
        "errorResponse": {
          "102": {
            "error": "user not administrator",
            "page": "/test/user-not-admin"
          },
          "105": {
            "error": "user not registration",
            "page": "/test/user-not-registered"
          }
        }
      }
    },
    "submissionGetAPIEndpoint": {     //<-- Submission GET API endpoint for temporary saving
      "url": "TEST_SUBMISSION_GET_API_URL",
      "method": "GET",
      "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
      "serviceId": "TEST_SUBMISSION_API_SERVIVE_ID",
      "dsfgtwApiKey": "TEST_SUBMISSION_DSF_GTW_KEY"
    },
    "submissionPutAPIEndpoint": {    //<-- Submission PUT API endpoint for temporary saving
      "url": "TEST_SUBMISSION_PUT_API_URL",
      "method": "PUT",
      "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
      "serviceId": "TEST_SUBMISSION_API_SERVIVE_ID",
      "dsfgtwApiKey": "TEST_SUBMISSION_DSF_GTW_KEY"
    },
    "fileUploadAPIEndpoint": {       //<-- File upload API endpoint
      "url": "TEST_UPLOAD_FILE_API_URL",
      "method": "POST",
      "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
      "serviceId": "TEST_SUBMISSION_API_SERVIVE_ID",
      "dsfgtwApiKey": "TEST_SUBMISSION_DSF_GTW_KEY"
    },
    "fileDownloadAPIEndpoint": {     //<-- File download API endpoint
      "url": "TEST_DOWNLOAD_FILE_API_URL",
      "method": "GET",
      "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
      "serviceId": "TEST_SUBMISSION_API_SERVIVE_ID",
      "dsfgtwApiKey": "TEST_SUBMISSION_DSF_GTW_KEY"
    },
    "fileDeleteAPIEndpoint": {     //<-- File delete API endpoint
      "url": "TEST_DELETE_FILE_API_URL",
      "method": "DELETE",
      "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
      "serviceId": "TEST_SUBMISSION_API_SERVIVE_ID",
      "dsfgtwApiKey": "TEST_SUBMISSION_DSF_GTW_KEY"
    },
    "eligibilityAPIEndpoints": [     //<-- Eligibility API endpoints
      {
        "url": "TEST_ELIGIBILITY_2_API_URL",
        "method": "GET",
        "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
        "serviceId": "TEST_SUBMISSION_API_SERVIVE_ID",
        "dsfgtwApiKey": "TEST_SUBMISSION_DSF_GTW_KEY",
        "cashingTimeoutMinutes": "60",
        "params": {},
        "response": {
          "errorResponse": {
            "105": {
              "error": "user not registration",
              "page": "/test/user-not-registered"
            }
          }
        }
      }
    ]
  },
  "pages": [                 //<-- Pages
    {
      "pageData": {            //<-- 1st Page's data (form)
        "url": "index",        // Page URL
        "title": {             // Page title
          "el": "Επιλογή Εγγάφου",
          "en": "Document selection",
          "tr": ""
        },
        "layout": "layouts/govcyBase.njk",  // Page layout
        "mainLayout": "two-third",          // Page main layout
        "nextPage": "data-entry-radios"     // The next page's URL
      },
      "pageTemplate": {         //<-- Page template
        "sections": [           //<-- Page sections
          {
            "name": "main",   //<-- Main section
            "elements": [     //<-- Main section elements
              {
                "element": "form",  // Form element
                "params": {
                  "elements": [     // Elements inside the form
                    {
                      "element": "checkboxes",  // Checkboxes element
                      "params": {               // Checkboxes parameters
                        "id": "certificate_select",
                        "name": "certificate_select",
                        "legend": {
                          "el": "Τι έγγραφα επιθυμείτε να εκδώσετε;",
                          "en": "What documents do you wish to issue?"
                        },
                        "items": [
                          {
                            "value": "birth",
                            "text": {
                              "el": "Πιστοποιητικό γέννησης​",
                              "en": "Birth certificate",
                              "tr": ""
                            },
                            "hint": {
                              "el": "Αν η γέννηση έγινε στην Κύπρο ή στο εξωτερικό και έχει ενημερωθεί το μητρώο του Αρχείου Πληθυσμού ",
                              "en": "For a birth in Cyprus or abroad which Civil Registry is updated with "
                            }
                          },
                          {
                            "value": "permanent_residence",
                            "text": {
                              "el": "Βεβαίωση μόνιμης διαμονής​",
                              "en": "Certificate of permanent residence",
                              "tr": ""
                            },
                            "hint": {
                              "el": "Για όσους είναι εγγεγραμμένοι στον εκλογικό κατάλογο",
                              "en": "For those registered in the electoral list"
                            }
                          },
                          {
                            "value": "student_proof_of_origin",
                            "text": {
                              "el": "Βεβαίωση καταγωγής",
                              "en": "Certificate of origin",
                              "tr": ""
                            },
                            "hint": {
                              "el": "Για αίτηση σε πανεπιστήμια στην Ελλάδα",
                              "en": "To apply to a university in Greece"
                            }
                          }
                        ],
                        "isPageHeading": true,
                        "hint": {
                          "el": "Επιλέξτε ένα ή περισσότερα έγγραφα",
                          "en": "Select one or more documents",
                          "tr": ""
                        }
                      },
                      "validations": [      // Checkboxes validations
                        {
                          "check": "required",
                          "params": {
                            "checkValue": "",
                            "message": {
                              "el": "Επιλέξετε ένα ή περισσότερα έγγραφα",
                              "en": "Select one or more documents",
                              "tr": ""
                            }
                          }
                        }
                      ]
                    },
                    {
                      "element": "button",
                      "params": {
                        "id": "continue",
                        "variant": "primary",
                        "text": {
                          "el": "Συνέχεια",
                          "en": "Continue"
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    },
    {
      "pageData": {             //<-- 2nd Page's data (form)
        "url": "data-entry-radios",
        "title": {
          "el": "Στοιχεία επικοινωνίας ",
          "en": "Contact details",
          "tr": ""
        },
        "layout": "layouts/govcyBase.njk",
        "mainLayout": "two-third",
        "nextPage": "review"
      },
      "pageTemplate": {
        "sections": [
          {
            "name": "beforeMain",
            "elements": [
              {
                "element": "backLink",
                "params": {}
              }
            ]
          },
          {
            "name": "main",
            "elements": [
              {
                "element": "form",
                "params": {
                  "elements": [
                    {
                      "element": "radios",
                      "params": {
                        "id": "mobile_select",
                        "name": "mobile_select",
                        "legend": {
                          "el": "Σε ποιο κινητό μπορούμε να επικοινωνήσουμε μαζί σας;",
                          "en": "What mobile number can we use to contact you?"
                        },
                        "items": [
                          {
                            "value": "mobile",
                            "text": {
                              "el": "Στο [99 123456]",
                              "en": "You can use [99 123456]",
                              "tr": ""
                            }
                          },
                          {
                            "value": "other",
                            "text": {
                              "el": "Θα δώσω άλλο αριθμό",
                              "en": "I will give a different number",
                              "tr": ""
                            },
                            "conditionalElements": [
                              {
                                "element": "fileInput",
                                "params": {
                                  "id": "proof",
                                  "name": "proof",
                                  "label": {
                                    "el": "Αποδεικτικό τηλεφώνου",
                                    "en": "Telephone proof",
                                    "tr": ""
                                  },
                                  "isPageHeading": false,
                                  "hint": {
                                    "el": "PDF, JPG, JPEG, PNG, είναι οι αποδεκτές μορφές",
                                    "en": "PDF, JPG, JPEG, PNG are the acceptable formats",
                                    "tr": ""
                                  }
                                },
                                "validations": [
                                  {
                                    "check": "required",
                                    "params": {
                                      "checkValue": "",
                                      "message": {
                                        "el": "Ανεβάστε τον αποδεικτικό τηλεφώνου",
                                        "en": "Upload the telephone proof",
                                        "tr": ""
                                      }
                                    }
                                  }
                                ]
                              }
                            ]
                          }
                        ],
                        "isPageHeading": true
                      },
                      "validations": [
                        {
                          "check": "required",
                          "params": {
                            "checkValue": "",
                            "message": {
                              "el": "Επιλέξετε αν θέλετε να χρησιμοποιήσετε το τηλέφωνο που φαίνεται εδώ, ή κάποιο άλλο",
                              "en": "Choose if you'd like to use the phone number shown here, or a different one",
                              "tr": ""
                            }
                          }
                        }
                      ]
                    },
                    {
                      "element": "button",
                      "params": {
                        "id": "continue",
                        "variant": "primary",
                        "text": {
                          "el": "Συνέχεια",
                          "en": "Continue"
                        }
                      }
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    },
    {
      "pageData": {         //<-- 3rd Page's data (not a form)
        "url": "user-not-registered",
        "title": {
          "el": "Δεν είστε εγγεγραμμένοι ",
          "en": "You are not an registered",
          "tr": ""
        },
        "layout": "layouts/govcyBase.njk",
        "mainLayout": "two-third"
      },
      "pageTemplate": {
        "sections": [
          {
            "name": "beforeMain",
            "elements": []
          },
          {
            "name": "main",
            "elements": [
              {
                "element": "textElement",
                "params": {
                  "id": "title",
                  "type": "h1",
                  "text": {
                    "el": "Δεν είστε εγγεγραμμένοι",
                    "en": "You are not registered"
                  }
                }
              },
              {
                "element": "htmlElement",
                "params": {
                  "id": "body",
                  "text": {
                    "el": "<p>Για να υποβάλετε σε υπηρεσία αυτή, χρειάζεται να είστε εγγεγραμμένοι στο ΧΥΖ.</p>",
                    "en": "<p>To submit in this service you need to be registered at XYZ.</p>"
                  }
                }
              }
            ]
          }
        ]
      }
    },
    {
      "pageData": {         //<-- 4th Page's data (not a form)
        "url": "user-not-admin",
        "title": {
          "el": "Δεν είστε διαχειριστής ",
          "en": "You are not an administrator",
          "tr": ""
        },
        "layout": "layouts/govcyBase.njk",
        "mainLayout": "two-third"
      },
      "pageTemplate": {
        "sections": [
          {
            "name": "beforeMain",
            "elements": []
          },
          {
            "name": "main",
            "elements": [
              {
                "element": "textElement",
                "params": {
                  "id": "title",
                  "type": "h1",
                  "text": {
                    "el": "Δεν είστε διαχειριστής ",
                    "en": "You are not an administrator"
                  }
                }
              },
              {
                "element": "htmlElement",
                "params": {
                  "id": "body",
                  "text": {
                    "el": "<p>Για να υποβάλετε σε υπηρεσία αυτή, χρειάζεται να είστε διαχειριστής στο ΧΥΖ.</p>",
                    "en": "<p>To submit in this service you need to be an administrator of XYZ.</p>"
                  }
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Here are some details explaining the JSON structure:

• site object: Contains information about the site, including the site ID, language, and footer links. See govcy-frontend-renderer for more details. Some fields that are only specific to the govcy-express-forms project are the following:
  • submissionDataVersion : The submission data version,
  • rendererVersion : The govcy-frontend-renderer version,
  • designSystemsVersion : The govcy-design-system version,
  • homeRedirectPage: An object mapping language codes to URLs. When a user visits the root route (e.g., https://whatever-your-service-is.service.gov.cy/), the system redirects to the URL for the user's language. If the user's language is not found, it falls back to "el" or the first available URL. If not provided, a list of available sites is shown. Example:

  "homeRedirectPage": {
    "el": "https://www.gov.cy/service/aitisi-gia-taftotita/",
    "en": "https://www.gov.cy/en/service/issue-an-id-card/"
  }
  

  • eligibilityAPIEndpoints : An array of API endpoints, to be used for service eligibility. See more on the Eligibility API Endoints section below.
  • submissionAPIEndpoint: The submission API endpoint, to be used for submitting the form. See more on the Submission API Endoint section below.
  • submissionGetAPIEndpoint: The submission get API endpoint, to be used for getting the submission data. See more on the temporary save feature section below.
  • submissionPutAPIEndpoint: The submission put API endpoint, to be used for temporary saving the submission data. See more on the temporary save feature section below.
  • fileUploadAPIEndpoint: The file upload API endpoint, to be used for uploading files. See more on the file upload feature section below.
  • fileDownloadAPIEndpoint: The file download API endpoint, to be used for downloading files. See more on the file upload feature section below.
  • fileDeleteAPIEndpoint: The file delete API endpoint, to be used for deleting files. See more on the file upload feature section below.
• pages array: An array of page objects, each representing a page in the site.
  • pageData object: Contains the metadata to be rendered on the page. See govcy-frontend-renderer for more details
    • nextPage: The URL of the next page to be rendered after the user clicks the continue button.
  • pageTemplate object: Contains the page template to be rendered on the page. See govcy-frontend-renderer for more details
    • elements array: An array of elements to be rendered on the page. See all supported govcy-frontend-renderer elements for more details

A typical service flow that includes pages index, question-1, question-2 under the pages array in the JSON file looks like this:

flowchart LR
    govcy-page --> isAuth{Is User Authenticated?}
    isAuth -- Yes<br><br> Eligibility Check --> index([:siteId/index])
    isAuth -- No --> cyLogin[cyLogin]
    cyLogin -- Eligibility Check --> index
    index --  Eligibility Check<br> Validations<br> Conditionals --> question-1[:siteId/question-1]
    question-1 --  Eligibility Check<br> Validations<br> Conditionals --> question-2[:siteId/question-2]
    question-2 --  Eligibility Check<br> Validations<br> Conditionals --> review[📄:siteId/review <br> <br> Automatically generated]
    review --  Eligibility Check<br> All Validations<br> All Conditionals --> success([✅:siteId/success <br> <br> Automatically generated])

Some pages are generated automatically by the project, such as the review and success pages.

Pages

Pages defined in the JSON file under the pages array, they rendered based on the govcy-frontend-renderer library, and they are served by the /:siteId/:pageUrl route. The pageData.nextPage field is used to determine the next page to render.

Here's an example of a page defined in the JSON file:

{
  "pageData": {
    "url": "index",
    "title": {
      "el": "Your email",
      "en": "Το email σας"
    },
    "layout": "layouts/govcyBase.njk",
    "mainLayout": "two-third",
    "nextPage": "telephone-number",
    "conditions": [
      {
        "expression": "dataLayer['test-service.inputData.somePage.formData.showExtra'] != 'yes'",
        "redirect": "review"
      }
    ]
  },
  "pageTemplate": {
    "sections": [
      {
        "name": "beforeMain",
        "elements": [
          {
            "element": "backLink",
            "params": {}
          }
        ]
      },
      {
        "name": "main",
        "elements": [
          {
            "element": "form",   
            "params": {
              "elements": [
                {
                  "element": "textInput",
                  "params": {
                      "label": {
                          "en": "What is your email?",
                          "el": "Ποιο είναι το email σας?"
                      },
                      "id": "email",
                      "name": "email",
                      "hint": {
                          "en": "We’ll only use this email for this application",
                          "el": "Θα χρησιμοποιήσουμε το email σας μόνο για αυτήν την υπηρεσία"
                      },
                      "type": "email",
                      "isPageHeading": true,
                      "fixedWidth": "50"
                  },
                  "validations": [
                    {
                        "check": "required",
                        "params": {
                        "message": {
                            "en": "Enter your email",
                            "el": "Εισαγάγετε το email σας"
                        }
                        }
                    },
                    {
                        "check": "valid",
                        "params": {
                        "checkValue": "email",
                        "message": {
                            "en": "Your email must be a valid email address",
                            "el": "To emial πρέπει να είναι έχει μορφή email address"
                        }
                        }
                    }
                ]
                },
                {
                  "element": "button",
                  "params": {
                    "id": "continue",
                    "variant": "primary",
                    "text": {
                      "el": "Συνέχεια",
                      "en": "Continue"
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

The above page JSON generates a page that looks like the following screenshot:

The JSON structure is based on the govcy-frontend-renderer's JSON template.

Lets break down the JSON config for this page:

• pageData are the page's meta data, such as the URL, title, layout, mainLayout, and nextPage.
  • pageData.url is the URL of the page, in this case it's :siteId/index
  • pageData.title is the title of the page, in this case it's Your email. This will be used in the review, success pages, the PDF, the email, and the submission platform.
  • pageData.layout is the layout used to render the page. The project only supports the default layout layouts/govcyBase.njk
  • pageData.mainLayout is the layout of the main section of the page, in this case it's two-third. It can be either two-third or max-width,
  • pageData.nextPage is the next page to redirect to when the user clicks the continue button and all validations pass, in this case it will redirect to /:siteId/telephone-number
  • pageData.conditions is the array that defines the conditional logic
• pageTemplate is the page's template, which is a JSON object that contains the sections and elements of the page. Check out the govcy-frontend-renderer's documentation for more details.
  • sections is an array of sections, which is an array of elements. Sections allowed: beforeMain, main, afterMain.
    • elements is an array of elements for the said section. Seem more details on the govcy-frontend-renderer's design elements documentation.

Form vs static pages

• If the pageTemplate includes a form element in the main section and button element, the system will treat it as form and will:
  • Perform the eligibility checks
  • Display the form
  • Collect the form data for the following input elements (more details on the govcy-frontend-renderer's design elements documentation):
    • textInput
    • textArea
    • select
    • radios
    • checkboxes
    • datePicker
    • dateInput
    • fileInput: the file upload feature must be enabled to use this element (see more on the file upload feature section below)
  • Validate the form data (see more on the Input validations section below)
  • Store the form data in the systems data layer
  • Redirect the user to the next page (or review page if the user came from the review page)
• Else if the pageTemplate does not include a form element in the main section, the system will treat it as static content and will:
  • Not perform the eligibility checks
  • Display the static content

When designing form pages, refer to the Unified Design System's question pages pattern.

Error pages Pages that can be used to display messages when eligibility or submission fail are simply static content pages. That is pages that do not include a form element.

Start page The start page should be created in the gov.cy portal and should be defined in the site.homeRedirectPage property in the site config JSON file. All pages within a service are private by default and can only be accessed by authenticated users, so the start page cannot be created in the JSON file.

Notes:

• Check out the govcy-frontend-renderer's design elements for more details on the supported elements and their parameters.
• Check out the input validations section for more details on how to add validations to the JSON file.

Update my details pages

Update my details pages are pages that can integrate the Update My Personal Details service to fetch or update a user’s name, email, mobile number, or correspondence address, without breaking the user journey. The implementation of these pages follow the instructuctions described in the Use ‘Update my personal details’ in Your Service post.

If the scope also includes the email element, the system will also use that email address to send the email to the user on submition.

Update my details - example JSON config

{
  "pageData": {
    "url": "index",     // Page URL
    "layout": "layouts/govcyBase.njk",
    "mainLayout": "two-third",
    "nextPage": "next-page" 
  },
  "updateMyDetails": {
    "APIEndpoint": {    // API endpoint for fetching user details from the Update My Details service
      "url": "CIVIL_REGISTRY_CONTACT_API_URL", // URL
      "method": "GET",                         // HTTP method
      "clientKey": "DSF_API_GTW_CLIENT_ID",    // Client key
      "serviceId": "DSF_API_GTW_SERVICE_ID",   // Service ID
      "dsfgtwApiKey": "DSF_API_GTW_SECRET"     // DSF GTW API key 
    },
    "updateMyDetailsURL": "UPDATE_MY_DETAILS_URL",  // DOMAIN URL for redirecting to the Update My Details service
  "topElements": [                             // Elements to be displayed on the top of the page
      {
        "element": "progressList",
        "params": {
          "id": "steps",
          "current": "4",
          "total": "4",
          "showSteps": true
        }
      }
    ],
    "scope": [                                  // Scope of the form. What elenents to collect
      "fullName",
      "email",
      "mobile",
      "address"
    ],
    "hasBackLink": true                         // Whether the hub page has a back link
  }
}

Lets break down the JSON config for Update my details:

• updateMyDetails are the page's definition for the integration with the Update My Details service.
  • updateMyDetails.APIEndpoint is the API endpoint for fetching user details from the Update My Details service.
  • updateMyDetails.updateMyDetailsURL is the DOMAIN URL for redirecting to the Update My Details service.
  • updateMyDetails.scope is the scope of the form. What elenents to collect. It can be one or more of the following:
    • fullName
    • dob
    • email
    • mobile
    • address
  • updateMyDetails.hasBackLink is a boolean that indicates whether the hub page has a back link.

The above config references the following environment variables that need to be set:

### Update my details
CIVIL_REGISTRY_CONTACT_API_URL=http://localhost:3002/get-update-my-details
DSF_API_GTW_CLIENT_ID=your-DSF-API-gateway-client-id
DSF_API_GTW_SERVICE_ID=your-DSF-API-gateway-service-id
DSF_API_GTW_SECRET=your-DSF-API-gateway-secret

UPDATE_MY_DETAILS_URL=https://update-my-details.staging.service.gov.cy # FOR TESTING

The DSF team has developed an API that performs standard eligibility checks against the Civil Registry. More details at Update-my-details.md

Update my details - users' flow

The update my details behaves like a normal page and it is accessed through the url :siteId/:pageUrl. As a best practice you should set this as your index page and the first one in your pages array. Depending on the user it can have 3 variants:

Variant 1: Manual form for non-eligible users (no access to UMD)

When a user is either:

• Not a Cypriot citizen
• Or Cypriot citizen under 18

The user gets a data entry page.

Variant 2: Eligible users (access to UMD) with existing details

When a user is :

• A Cypriot citizen over 18
• AND has data in Update my Details

The users get a page with the data from UMD and asks if its ok to use those data.

If the user selects:

• YES: the data are stored in the data layer and continues to the next page (or review page depending where the user came from)
• NO: the users are redirected to the Update my details service in seamless mode. When users finish with that, they are redirected back to the page with variant 2 and are asked again if it's ok to use the updated data.

Variant 3: Eligible users (access to UMD) without existing details

When a user is :

• A Cypriot citizen over 18
• AND has no data in Update my Details

The users get a continue button that redirects to the Update my details service in seamless mode.

When users finish with that, they are redirected back to the page with variant 2 and are asked if it's ok to use the updated data.

Update my details - data storage

The form data for a updateMyDetails page is stored as a normal page as an object in the session data layer:

{
  "index": {
    "formData": 
    {
      "fullName": "John Smith",
      "email": "[e-mail]",
      "mobile": "[phone]",
      "address": "123 Some Street\n Nicosia\nCyprus",
    }
  }
}

Notes on Update my details

• There pageData.title is not used. Instead the page title is generated by the system.

Multiple things pages (repeating group of inputs)

Some services need to collect multiple entries of the same structure, for example, academic qualifications, addresses, or dependents. The framework supports this through the multipleThings block in a page config. It uses the same input method of a normal form page, but the user can add more than one entries.

When enabled, the framework automatically generates a hub page when the user visits the:

/:siteId/:pageUrl

This hub page allows users to:

• 📋 View the list of entries (hub page)
• ➕ Add a new entry
• ✏️ Change an existing entry
• ❌ Remove an existing entry
• ✅ Continue when they are finished

Multiple things - example JSON config Here’s how to define a page that collects multiple academic qualifications:

{
  "pageData": {
    "url": "qualifications",    // Page URL
    "title": {                  // Page title of the input pages (add, edit)
      "el": "Ακαδημαϊκά και επαγγελματικά προσόντα",
      "en": "Academic and professional qualifications",
      "tr": ""
    },
    "layout": "layouts/govcyBase.njk",  // Page layout for all pages (add, edit, hub page)
    "mainLayout": "two-third",          // Page main layout for all pages (add, edit, hub page)
    "nextPage": "memberships"           // The next page's URL
  },
  "pageTemplate" : {  // Page template for the input pages (add, edit)
    ...
  },
  "multipleThings": { // Multiple things configuration
    "min": 1,     // the minimum number of entries
    "max": 5,     // the maximum number of entries
    "dedupe": true, // whether to check for duplicates
    "itemTitleTemplate": "{{title | trim}}  - {{year | trim}}", // the title template for each entry
    "listPage": { // the hub page
      "title": { // the hub page title
        "el": "Ακαδημαϊκά προσόντα",
        "en": "Academic details"
      },
      "topElements": [ // the hub page top elements
        {
          "element": "progressList",
          "params": {
            "id": "progress",
            "current": "2",
            "total": "6",
            "showSteps": true
          }
        },
        {
          "element": "textElement",
          "params": {
            "id": "header",
            "type": "h1",
            "text": {
              "el": "Ποια είναι τα προσόντα σας;",
              "en": "What are your qualifications?",
              "tr": ""
            }
          }
        },
        {
          "element": "textElement",
          "params": {
            "id": "instructions",
            "type": "p",
            "text": {
              "el": "Προσθέστε τουλάχιστον ένα τα ακαδημαϊκό ή επαγγελματικό προσόν για να συνεχίσετε. Μπορείτε να προσθέσετε μέχρι 5.",
              "en": "Add at least one academic or professional qualifications to proceed. You can up to 5."
            }
          }
        }
      ],
      "emptyState": { // the hub page empty state
        "en": "No qualifications added yet.",
        "el": "Δεν έχετε προσθέσει ακόμη προσόντα."
      },
      "addButtonText": { // the hub page add button text
        "en": "➕ Add qualifications",
        "el": "➕ Προσθήκη προσόντος"
      },
      "addButtonPlacement": "top", // the hub page add button placement
      "continueButtonText": { // the hub page continue button text
        "en": "Save and continue",
        "el": "Αποθήκευση και συνέχεια"
      },
      "hasBackLink": true // whether the hub page has a back link
    }
  }
}

Lets break down the JSON config for multiple things:

• multipleThings are the page's definition for repeated group of inputs
  • multipleThings.min : The minimum items rule
  • multipleThings.max : The maximum items rule
  • multipleThings.dedupe: When true prevents duplicates, using the itemTitleTemplate template. Optional with default value false
  • multipleThings.itemTitleTemplate: The template (in Nunjucks form) used to display the items' on a list in the hub, review, success pages and email. Also used by the dedupe to compare for duplicates
  • multipleThings.listPage: The definition the list (hub) page that shows the list of items, with the actions (add, edit, delete, continue)
    • multipleThings.listPage.title: The title used in the hub page's meta data
    • multipleThings.listPage.topElements: The elements to be displayed on the top of the page (more details on the govcy-frontend-renderer's design elements documentation):
    • multipleThings.listPage.emptyState: The message displayed when the count of items == 0. Optional, when not defined generic text is shown
    • multipleThings.listPage.addButtonText: The text displayed on the add link. Optional, when not defined generic text is shown
    • multipleThings.listPage.addButtonPlacement: Where to show the add link. Can be top, bottom or both. Optional, default is bottom
    • multipleThings.listPage.continueButtonText: The text displayed on the continue button text. Optional, default is Continue, Συνέχεια
    • multipleThings.listPage.hasBackLink: When true shows the standard back button. Optional, default is `true

Multiple things - How it works With multiple things pages, the system collects multiple set of the same type of data. The set of data are collected by a single page (similar to a normal page). The multiple things consist of 4 type of pages, the hub, add, edit and delete pages

Hub page: When the user navigates through the service at /:siteId/:pageUrl (either coming from review or linear flow), the system shows the hub page. The hub page in general shows the list of entries, add links, continue button and validates the input (see below more details)

Hub page add links: If the user has not reached the maximum number of allowed entries, the system shows add links on the hub page. There is an option for a custom add link text with multipleThings.listPage.addButtonText. There is an option for top, bottom or both placement with multipleThings.listPage.addButtonPlacement

Hub empty state: When no data are yet entered the hub shows an empty state message with an add link. There is an option for a custom empty state

Hub list state: When data exist, they are shown as a list with change and delete links. The list is created based on an the multipleThings.itemTitleTemplate, for example {{institution}} - {{title}} - {{year}}

Hub max state: If the data entries reached the maximum limit, the add links are removed and a max limit reached message is shown.

Hub page continue: on Continue the system continues to the next page defined in the pageData.nextPage. If user came from the review page, it returns to the review.

Hub page validations: The hub page validates the following when the continue button is pressed.

• Minimum entries have been entered. This is based on the multipleThings.min.
• Maximum limit has not been exceeded.. This is based on the multipleThings.max.
• All entries validations pass. This is based on the pageTemplate element validations.

Add pages

• Accessible through the add link or through the /:siteId/:pageUrl/multiple/add route
• User is shown the item page (e.g. academic-details)
• Files' data are stored in a draft until they click Continue
• On Continue, the data and draft is pushed into the list
• Behaves like a normal form page
• On Continue if there are no validation errors, the user is navigated back to the hub and the added data is displayed on the list. If the user’s journey started from the review page, after clicking continue on the hub, it goes back to the review.
• It performs all configured input validations defined PLUS
  • Maximum limit has not been exceeded.
  • Dedupe validation. If defined in the configuration the service checks if there is an identical entry. The check is made based on the item title template

Edit pages

• Accessible through the change link or through the /:siteId/:pageUrl/multiple/edit/:index route
• User selects an existing item from the hub page
• The item page loads pre-filled data
• Behaves like a normal form page
• On Continue if there are no validation errors, the entry is updated and the user is navigated back to the hub and the updated data is displayed on the list. If the user’s journey started from the review page, after clicking continue on the hub, it goes back to the review.
• It performs all configured input validations defined PLUS
• Dedupe validation. If defined in the configuration the service checks if there is an identical entry. The check is made based on the item title template

Delete pages

• Accessible through the remove link or through the /:siteId/:pageUrl/multiple/delete/:index route
• A confirmation page is shown
• On Yes, the item is removed from the list

Review & Success pages

• Each item is displayed in the summary list, grouped under the hub’s title

Multiple things - data storage

Form data for a multipleThings page is stored as an array in the session data layer:

{
  "academic-details": {
    "formData": [
      {
        "title": "BSc Computer Science",
        "academicFile": {
          "fileId": "12345",
          "sha256": "abcdef..."
        }
      },
      {
        "title": "MSc Information Systems",
        "academicFile": {
          "fileId": "67890",
          "sha256": "ghijkl..."
        }
      }
    ]
  }
}

Notes on multiple things

• Each multipleThings page must define its own item page (with fields and validations), used for the add add edit routes.
• The hub page is generated automatically. It uses the multipleThings.listPage for the UI
• Empty state is handled automatically.
• multipleDraft is used internally to store file's data while the user is adding a new item.

Review page

The review page is automatically generated by the project and includes the following sections:

• Summary: A summary of the data from all the pages in the service.
• Change links: A list of links to each page in the service.
• Submit button: A button to submit the form.

Here's an example screenshot of review page

When the user clicks a change link, the user is redirected to the corresponding page in the service. After the user clicks on continue button the user is redirected back to the review page.

When the user clicks the Submit button, all the data gathered from the site's forms within this session are validated based on the validation definition in the JSON file, and if they pass they are submitted to the configured API endpoint.

Success page

The success page is automatically generated by the project, is accessible only when a submission is made successfully, and includes the following sections:

• Success banner: A banner indicating that the form was successfully submitted, with the reference number of the submission.
• PDF Download link: A link to download the PDF of the submission's data in a human-readable format.
• Summary: A summary of the data from all the pages in the service.

Here's an example screenshot of success page

🛡️ Site eligibility checks

The project uses an array of API endpoints to check the eligibility of a service/site. To use this feature, you need to configure the following in your JSON file under the site object:

"eligibilityAPIEndpoints" : [
  {
    "url": "TEST_ELIGIBILITY_1_API_URL",
    "method": "POST", 
    "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
    "serviceId": "TEST_SUBMISSION_API_SERVIVE_ID",
    "cashingTimeoutMinutes": 2,
    "params": {
      "checkFor": "isCitizen,isAdult"
    },
    "response": {
      "errorResponse": {
        "102": {
          "error": "user not administrator",
          "page": "/test/user-not-admin"
        }
      }
    }
  },
  {
    "url": "TEST_ELIGIBILITY_2_API_URL",
    "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
    "serviceId": "TEST_SUBMISSION_API_SERVIVE_ID",
    "cashingTimeoutMinutes": 60,
    "response": {
      "errorResponse": {
        "105": {
          "error": "user not registration",
          "page": "/test/user-not-registered"
        }
      }
    }
  }
]

If no eligibilityAPIEndpoints are configured, the system will not check for service eligibility for the specific site.

Lets break the JSON config down:

• eligibilityAPIEndpoints : An array of API endpoints, to be used for service eligibility.
  • url: The enviromental variable that holds the URL of the API endpoint.
  • method: The HTTP method to use when making the request.
  • clientId: The enviromental variable that holds the client ID to use when making the request.
  • clientSecret: The enviromental variable that holds the client secret to use when making the request.
  • dsfgtwApiKey (optional): To be used only when using APIs through the DSF gateway instead of cyConnect
  • cashingTimeoutMinutes: The number of minutes to cache the response from the API endpoint. If set to 0, the API endpoint will be called every time.
  • params: An object of key-value pairs that will be added to the request body when making the request.
  • response: An object of expected response when succeeded===false, to be used for the system to know which error page to show.

The above config references the following environment variables that need to be set:

TEST_ELIGIBILITY_1_API_URL=http://localhost:3002/check1
TEST_ELIGIBILITY_2_API_URL=http://localhost:3002/check2
TEST_SUBMISSION_API_CLIENT_KEY=12345678901234567890123456789000
TEST_SUBMISSION_API_SERVIVE_ID=123

With the above config, when a user visits a page under the specific site, /:siteId/*, the service sends a request to the configured eligibility API endpoints. If any of the API endpoints returns succeeded: false, the user is redirected to the error page specified in the response object.

The response is cached to the session storage for the specified number of minutes. If the cashingTimeoutMinutes is set to 0, the API endpoint will be called every time.

Here's a flowchart showing how the eligibility checks work:

flowchart LR
    A[🧭 User visits /:siteId/* page] --> B{{❓ Are eligibilityAPIEndpoints configured?}}
    B -- No --> H[✅ Access granted<br>Show page]
    B -- Yes --> D[🔁 Loop through API endpoints]

    D --> D1{{❓ Is cached response still valid?}}
    D1 -- Yes --> D2[🗃️ Use cached result]
    D1 -- No --> E[🔄 Send request with:<br>- Method GET or POST<br>- Auth header<br>- Params or body]

    D2 --> F{{❓ Did cached result<br>have Succeeded: true?}}
    E --> F

    F -- Yes --> G{{❓ More endpoints to check?}}
    G -- Yes --> D
    G -- No --> H

    F -- No --> I[📄 Check ErrorCode<br>in config]
    I --> J{{❓ Is ErrorCode in config?}}
    J -- Yes --> K[❌ Redirect to configured error page]
    J -- No --> L[❌ Show generic error page]

Eligibility API request and response

For each eligibility API endpoint, the project sends a request to the API endpoint. The project uses the CY Connect - OAuth 2.0 (CY Login) authentication policy, so the user's <access_token> is sent in the Authorization header.

Eligibility Request

• HTTP Method:
  • Defined per endpoint in the method property (defaults to GET if not specified).
• URL:
  • Resolved from the url property in your config (from the environment variable).
• Headers:
  • Authorization: Bearer <access_token> (form user's cyLogin access token)
  • client-key: <clientKey> (from config/env)
  • service-id: <serviceId> (from config/env)
  • Accept: text/plain Parameters: The params object in your config is sent as query parameters for GET requests and as the request body for POST requests.

Example GET Request:

GET /check-eligibility?checkFor=isCitizen,isAdult HTTP/1.1
Host: localhost:3002
Authorization: Bearer eyJhbGciOi...
client-key: 12345678901234567890123456789000
service-id: 123
Accept: text/plain

Example POST Request:

POST /check-eligibility HTTP/1.1
Host: localhost:3002
Authorization: Bearer eyJhbGciOi...
client-key: 12345678901234567890123456789000
service-id: 123
Accept: text/plain
Content-Type: application/json

{
  "checkFor": "isCitizen,isAdult"
}

Eligibility Response

The API is expected to return a JSON response with the following structure (see govcyApiRequest.mjs for normalization):

On Success:

HTTP/1.1 200 OK

{
  "Succeeded": true,
  "ErrorCode": 0,
  "ErrorMessage": null,
}

On Failure:

HTTP/1.1 200 OK

{
  "Succeeded": false,
  "ErrorCode": 102,
  "ErrorMessage": "user not administrator"
}

Notes:

• If no eligibilityAPIEndpoints are configured, the system will not check for service eligibility for the specific site.
• The response is normalized to always use PascalCase keys (Succeeded, ErrorCode, etc.), regardless of the backend’s casing.
• If Succeeded is false, the system will look up the ErrorCode in your config to determine which error page to show.
• For standard eligibility checks see:
  • Elegibility with Civil Registry

Caching

• The response from each eligibility endpoint is cached in the session for the number of minutes specified by cashingTimeoutMinutes.
• If cashingTimeoutMinutes is set to 0, the API endpoint will be called every time (no caching).
• If omitted or null, the result is cached indefinitely.

Error Handling

• If the API returns Succeeded: false, the user is redirected to the error page specified in your config for that error code.
• If the API response is invalid or the request fails after retries, a generic error is shown.

References

• Eligibility check logic: See govcyServiceEligibilityHandler.mjs
• API call, normalization and retries: See govcyApiRequest.mjs

📤 Site Submissions

The project uses an API endpoint to submit the form data. The project uses the CY Connect - OAuth 2.0 (CY Login) authentication policy, so the user's <access_token> is sent in the Authorization header.

To use this feature, you need to configure the following in your JSON file under the site object:

"submissionAPIEndpoint": {
  "url": "TEST_SUBMISSION_API_URL",
  "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
  "serviceId": "TEST_SUBMISSION_API_SERVIVE_ID",
  "response": {
    "errorResponse": {
      "102": {
        "error": "user not administrator",
        "page": "/test/user-not-admin"
      },
      "105": {
        "error": "user not registration",
        "page": "/test/user-not-registered"
      }
    }
  }
}

Lets break the JSON config down:

• submissionAPIEndpoint: The submission API endpoint, to be used for submitting the form.
  • url: The enviromental variable that holds the URL of the API endpoint.
  • clientId: The enviromental variable that holds the client ID to use when making the request.
  • clientSecret: The enviromental variable that holds the client secret to use when making the request.
  • dsfgtwApiKey (optional): To be used only when using APIs through the DSF gateway instead of cyConnect
  • response: An object of expected response when Succeeded===false, to be used for the system to know which error page to show.

The above config references the following environment variables that need to be set:

TEST_SUBMISSION_API_URL=http://localhost:3002/success
TEST_SUBMISSION_API_CLIENT_KEY=12345678901234567890123456789000
TEST_SUBMISSION_API_SERVIVE_ID=123

With the above config, when a user submits the review page, the service sends a request to the configured submission API endpoint.

Here's a flowchart showing how the submission work:

flowchart LR
    A[📤 User submits review page] --> B[🔄 Send POST request]

    B --> C{{❓ Did response have Succeeded: true?}}

    C -- Yes --> D[✅ Show success confirmation with reference code]

    C -- No --> E[📄 Check ErrorCode in config]
    E --> F{{❓ Is ErrorCode in config?}}
    F -- Yes --> G[❌ Redirect to configured error page]
    F -- No --> H[❌ Show generic error page]

    B --> I{{❓ Did request fail or return invalid response?}}
    I -- Yes --> H

Submission API Request and Response

Submission Request:

• HTTP Method: POST
• URL: Resolved from the url property in your config (from the environment variable).
• Headers:
  • Authorization: Bearer <access_token> (form user's cyLogin access token)
  • client-key: <clientKey> (from config/env)
  • service-id: <serviceId> (from config/env)
  • Accept: text/plain
• Body: The body contains the prepared submission data, which is a JSON object with all the form data collected from the user across all pages.

Example Request:

POST /submission-endpoint HTTP/1.1
Host: localhost:3002
Authorization: Bearer eyJhbGciOi...
client-key: 12345678901234567890123456789000
service-id: 123
Accept: text/plain
Content-Type: application/json

{
  "submissionUsername": "username",
  "submissionEmail": "[e-mail]",
  "submissionData": "{\"index\":{\"certificate_select\":[\"birth\",\"permanent_residence\"]}}",
  "submissionDataVersion": "1",
  "printFriendlyData": "[{\"pageUrl\":\"index\",\"pageTitle\":{\"el\":\"Επιλογή Εγγάφου\",\"en\":\"Document selection\",\"tr\":\"\"},\"fields\":[{\"id\":\"certificate_select\",\"name\":\"certificate_select\",\"label\":{\"el\":\"Τι έγγραφα επιθυμείτε να εκδώσετε;\",\"en\":\"What documents do you wish to issue?\"},\"value\":[\"birth\",\"permanent_residence\"],\"valueLabel\":[{\"el\":\"Πιστοποιητικό γέννησης​\",\"en\":\"Birth certificate\",\"tr\":\"\"},{\"el\":\"Βεβαίωση μόνιμης διαμονής​\",\"en\":\"Certificate of permanent residence\",\"tr\":\"\"}]}]}]",
  "rendererData": "{\"element\":\"summaryList\",\"params\":{\"items\":[{\"key\":{\"el\":\"Επιλογή Εγγάφου\",\"en\":\"Document selection\",\"tr\":\"\"},\"value\":[{\"element\":\"summaryList\",\"params\":{\"items\":[{\"key\":{\"el\":\"Τι έγγραφα επιθυμείτε να εκδώσετε;\",\"en\":\"What documents do you wish to issue?\"},\"value\":[{\"element\":\"textElement\",\"params\":{\"text\":{\"en\":\"Birth certificate, Certificate of permanent residence\",\"el\":\"Birth certificate, Certificate of permanent residence\",\"tr\":\"Birth certificate, Certificate of permanent residence\"},\"type\":\"span\"}}]}]}}]}]}}",
  "rendererVersion": "1.14.3",
  "designSystemsVersion": "3.2.0",
  "service": "{\"id\":\"test\",\"title\":{\"el\":\"Υπηρεσία τεστ\",\"en\":\"Test service\",\"tr\":\"\"}}"
}

Submission Response

The API is expected to return a JSON response with the following structure (see govcyApiRequest.mjs for normalization):

On Success:

HTTP/1.1 200 OK

{
  "Succeeded": true,
  "ErrorCode": 0,
  "ErrorMessage": null,
  "Data": {
    "referenceValue": "12345678"
  }
}

On Failure:

HTTP/1.1 200 OK

{
  "Succeeded": false,
  "ErrorCode": 102,
  "ErrorMessage": "user not administrator"
}

Notes:

• The response is normalized to always use PascalCase keys (Succeeded, ErrorCode, etc.), regardless of the backend’s casing.
• If Succeeded is false, the system will look up the ErrorCode in your config to determine which error page to show.

Error Handling

• If the API returns Succeeded: false, the user is redirected to the error page specified in your config for that error code.
• If the API response is invalid or the request fails after retries, a generic error is shown.

References

• Request/response logic: See govcyReviewPostHandler.mjs
• API call, normalization and retries: See govcyApiRequest.mjs

Submission Data

The data is collected from the form elements and the data layer and are sent via the submission API in the following format:

{
  "submissionUsername" : "",   // User's username
  "submissionEmail" : "",      // User's email
  "submissionData": "{}",      // Raw data as submitted by the user in each page
  "submissionDataVersion": "",// The submission data version
  "printFriendlyData": "[]",  // Print friendly data
  "rendererData" :"{}",        // Renderer data of the summary list
  "rendererVersion": "",       // The renderer version
  "designSystemsVersion": "", // The design systems version
  "service": "{}"               // Service info
}

Submission Data Sample

Click here for a sample submission data JSON

ℹ️ Note:

When sent to the API, the fields submissionData, rendererData, printFriendlyData, and service are stringified using JSON.stringify().

The sample below shows the structure before stringification for clarity.

{
  "submissionUsername": "username",        // User's username
  "submissionEmail": "[e-mail]",  // User's email
  "submissionDataVersion": "0.1",         // Submission data version
  "submissionData": {                      // Submission raw data. Object, will be stringified
    "index": {                              // Page level
      "id_select": ["id", "arc"],           // field level: checkboxes are ALWAYS arrays (may be []); radios/select/text are strings
      "id_number": "654654",
      "arc_number": "",
      "aka": "232323",
      "evidenceAttachment":                // File attachments contains an object with `fileId` and `sha256`
      {
        "fileId": "1234567891234567890",
        "sha256": "123456789012345678901234567890123456789012345678901234567890123456"
      }        
    },
    "appointment": {
      "diorismos": "monimos",
      "fileno_monimos": "3233",
      "eidikotita_monimos": "1",
      "fileno_sumvasiouxos": "",
      "eidikotita_sumvasiouxos": "",
      "fileno_aoristou": "",
      "eidikotita_aoristou": "",
      "program": "",
      "fileno_orismenou": ""
    },
    "takeover": {
      "date_start_day": "11",
      "date_start_month": "12",
      "date_start_year": "2020",
      "date_on_contract": "date_other",
      "date_contract": "16/04/2025",
      "reason": "24324dssf"
    }, 
    "academic-details": [                   // Multiple things page
      {
        "title": "BSc Computer Science",
        "academicFile": {
          "fileId": "12345",
          "sha256": "abcdef..."
        }
      },
      {
        "title": "MSc Information Systems",
        "academicFile": {
          "fileId": "67890",
          "sha256": "ghijkl..."
        }
      }
    ]
  },
  "submissionDataVersion": "1",           // Submission data version
  "rendererData": {                        // Summary list renderer data ready for rendering . Object, will be stringified
    ...
  },
  "printFriendlyData": [                  // Print friendly data. Object, will be stringified
    ...
  ],
  "rendererVersion": "1.14.1",              // Renderer version
  "designSystemsVersion": "3.1.0",          // Design systems version
  "service": {                                // Service metadata. Object, will be stringified
    "id": "takeover",
    "title": {
      "el": "Βεβαίωση ανάληψης καθηκόντων εκπαιδευτικών",
      "en": "Certificate of teachers takeover"
    }
  }
}

✅ Input Validations

The project includes input validation for the following elements:

• textInput
• textArea
• select
• radios
• checkboxes
• datePicker
• dateInput
• fileInput (only required check)

The validation rules for each element are defined in the "validations array for each element. The project support the following validations:

• valid: Checks the value against the specified rule's checkValue. Available rules:
  • noSpecialChars: Consists only of letters, numbers and some other characters
  • numeric: Numeri input
  • numDecimal: Numeric decimal input
  • currency: Currency input (numeric with 2 decimal places)
  • alpha: Alphabetic input
  • alphaNum: Alphanumeric input
  • name: Name input
  • tel: Telephone input
  • mobile: Mobile input
  • telCY: Cyprus telephone input
  • mobileCY: Cyprus mobile input
  • iban: IBAN input
  • email: Email input
  • date: Date input (DD/MM/YYYY)
  • dateISO: ISO date input YYYY-M-D
  • dateDMY: European/Common Format date input D/M/YYYY
  • maxCurrentYear: Maximum current year input
• required: Checks if the value is not null, undefined, or an empty string (after trimming).
• length: Checks if the value has a maximum length passed in the checkValue parameter.
• regCheck: Checks if the value matches the specified regular expression passed in the checkValue parameter.
• minValue: Checks if the value is greater than or equal to the specified minimum value passed in the checkValue parameter.
• maxValue: Checks if the value is less than or equal to the specified maximum value passed in the checkValue parameter.
• minValueDate: Checks if the value is greater than or equal to the specified minimum date passed in the checkValue parameter.
• maxValueDate: Checks if the value is less than or equal to the specified maximum date passed in the checkValue parameter.
• minLength: Checks if the value has a minimum length passed in the checkValue parameter.

Example:

"validations": [
    {
        "check": "required",
        "params": {
        "message": {
            "en": "Enter your IBAN",
            "el": "Εισαγάγετε το IBAN σας"
        }
        }
    },
    {
        "check": "valid",
        "params": {
        "checkValue": "iban",
        "message": {
            "en": "IBAN must be a valιd iban, for example",
            "el": "To ΙΒΑΝ πρέπει να είναι έχει μορφή iban"
        }
        }
    }
]

🔀 Conditional logic

The project supports conditional logic on pages. Conditional logic is evaluated using a custom govcyExpressions.mjs module, which executes expressions in a safe and scoped context using new Function. Only safe data access through the dataLayer is allowed. The system uses expressions and session data from the service's data layer to decide if a page will be shown or not.

The conditional logic is defined in the pageData.conditions array for each page. The project calculates the pageData.conditions[i].expression expression at run time and if the condition is true, the current page is ignored and the user is redirected to the pageData.conditions[i].redirect url. The pages whose conditions are true:

• are skiped from normal flow and user is redirected to the pageData.conditions[i].redirect url
• the pages are ignored from:
  • the review page summary list, success page summary list and email
  • when validating all inputs when posting the review page (before submission)
  • the data submitted via the API

The following diagram shows the logic that runs on every request to a page. If any condition evaluates to true, the page is skipped and the user is redirected.

flowchart LR
    A[⬅️ User navigates to /:siteId/:pageUrl] --> B{{Does pageData.conditions exist?}}
    B -- No --> C[✅ Render the page]
    B -- Yes --> D[🔁 Loop through conditions]

    D --> E{{Evaluate condition.expression}}
    E -- returns true --> F[➡️ Redirect to condition.redirect]
    E -- returns false --> G{{More conditions?}}

    G -- Yes --> D
    G -- No --> C[✅ Render the page]

How to define conditional logic

Each page in your JSON config can optionally include a conditions array inside the pageData object. The conditions array is an array of objects that define the conditions to evaluate and the corresponding redirect URL. For example the following JSON config:

"conditions": [
  {
    "expression": "dataLayer['my-service.inputData.step1.formData.showExtra'] == 'no'",
    "redirect": "review"
  }
]

Here is the same example as part of the page config:

{
  "pageData": {
    "url": "page-1",
    "title": {
      "el": "Σελίδα 1",
      "en": "Page 1",
      "tr": ""
    },
    "layout": "layouts/govcyBase.njk",
    "mainLayout": "two-third",
    "conditions": [     //---- conditionals start here
      {
        "expression": "dataLayer['my-service.inputData.step1.formData.showExtra'] == 'no'",
        "redirect": "review"
      }
    ],                  //---- conditionals end here
    "nextPage": "page-2"
  },
  "pageTemplate": {
    "sections": [
    ...
    ...
  }
}

When the condition evaluates to true, the page is skipped and the user is redirected to the given redirect URL and are excluded from the service. Note that:

• Multiple conditions are checked in order (first match wins)
• Conditions can be chained across pages (redirect triggers another check)

Expressions

Expressions are written using JavaScript syntax and are evaluated at runtime in a sandboxed environment. You can use:

• comparison operators (==, ===, !=, <, >, etc.)
• logical operators (&&, ||, !)
• string methods (.includes(), .toLowerCase())
• safety fallbacks using || or optional chaining ?..

🔐 Only the dataLayer variable is available inside the expression scope, all other variables or globals (like window, document, etc.) are blocked for safety.

Some supported examples:

dataLayer['site.inputData.page.formData.agree'] === 'yes'
(dataLayer['site.inputData.page.formData.age'] || 0) >= 18
String(dataLayer['site.inputData.page.formData.status'] || '').toLowerCase().includes('inactive')

Expressions should not:

• Try to access external or global variables (they are not available).
• Attempt to execute unsafe operations like fetch(), eval(), alert(), etc.

Expressions are parsed using new Function() inside a restricted evaluator (govcyExpressions.mjs), and errors are caught and logged without crashing the application. If an expression returns true, the corresponding redirect is triggered.

Data used in the expressions with the dataLayer

The expressions can only access dataLayer values. The data layer is basically a read-only object that contains the data stored within a session, things like values inputed by the user or results from eligibility checks. It's scoped per site and follows a strict structure. Note that you can only use the dataLayer array to access data for the current site.

To use data layer values, use the special dataLayer[] array. For example dataLayer['conditional-test-service.inputData.index.formData.showExtra'] will get the value stored in the data store for:

• conditional-test-service refers to the site with that siteID
  • inputData is a reserved word for the data inputed by the user for that site
    • indexrefers to the page with that URL
      • formData is a reserved word for the form data (already inputed data by the user) for that page
        • showExtrarefers to a input component with that name

The dataLayer typically contains keys such as:

• inputData: All data submitted by the user through forms
• eligibilityResults: Cached results from service eligibility API checks

Example structure for a service with ID my-service:

dataLayer = {
  'my-service.inputData.index.formData.fullName': 'John Smith',
  'my-service.inputData.index.formData.age': '34',
  'my-service.inputData.contact-details.formData.telephone': '[phone]',
  'my-service.inputData.contact-details.formData.email': '[e-mail]',
  "my-service.inputData.what-do-you-want.formData.certificate-select": [
    "birth",
    "permanent_residence"
  ],
  'my-service.inputData.want-to-apply.formData.option-radio': 'yes',
  'my-service.eligibilityResults.check1.succeeded': true,
  'my-service.eligibilityResults.check2.ErrorCode': 0
}

If any part of the key path is missing (e.g., the page hasn’t been visited yet or a form field was left empty), the expression will safely return undefined and will not throw an error. This behavior is by design, so that conditional logic expressions can fail silently and fallback gracefully.

For this reason, it's strongly recommended to use fallback values using ||, like:

String(dataLayer['my-site.inputData.index.formData.status'] || '').toLowerCase()

Best practice note

Developers should ensure expressions are resilient to missing or undefined values in the data layer. Since invalid paths like dataLayer['x.y.z'] will return undefined and will not throw errors, use fallbacks such as || '' or wrappers like String(...).toLowerCase() to avoid unexpected behavior. Silent false positives are possible if expressions do not guard against undefined values.

Bad Example:

dataLayer['site.inputData.page.formData.status'].toLowerCase().includes('inactive')

This will throw an error if status is undefined.

Good Example:

String(dataLayer['site.inputData.page.formData.status'] || '').toLowerCase().includes('inactive')

This ensures the expression works even if the field is missing or undefined.

Examples of conditional logic configuration

See below some examples how to use the conditional logic for pages.

1. Simple example:

"conditions": [
  {
    "expression": "dataLayer['conditional-test-service.inputData.index.formData.showExtra'] == 'no'",
    "redirect": "next-page"
  }
]

Explanation:

• dataLayer['conditional-test-service.inputData.index.formData.showExtra']: gets the value stored in the data store for:
  • site with siteID conditional-test-service
  • input data for that site
  • page with URL index
  • form data (already inputed data by the user) for that page
  • field with name showExtra
• == 'no': checks if the value is equal to 'no'

2. Expression example using JS string functions:

"conditions": [
  {
    "expression": "dataLayer['conditional-test-service.inputData.index.formData.showExtra'] == 'no' && String(dataLayer['conditional-test-service.inputData.details.formData.info'] || '').toLowerCase().includes('hide')",
    "redirect": "next-page"
  }
]

Explanation:

• String(dataLayer['...'] || ''): ensures it's always a string, even if the value is undefined or null.
• toLowerCase(): converts the string to lowercase.
• includes('hide'): checks if the string contains the substring 'hide'.

3. Multiple conditions example:

"conditions": [
  {
    "expression": "String(dataLayer['conditional-test-service.inputData.index.formData.showExtra'] || '').toLowerCase().includes('no')",
    "redirect": "next-page"
  },
  {
    "expression": "String(dataLayer['conditional-test-service.inputData.details.formData.info'] || '').toLowerCase().includes('hide')",
    "redirect": "review"
  }
]

Explanation:

• Multiple conditions are checked in order (first match wins)
• String(dataLayer['...'] || ''): ensures it's always a string, even if the value is undefined or null.
• toLowerCase(): converts the string to lowercase.
• includes('hide'): checks if the string contains the substring 'hide'.

4.Example with select input that can have either string or array value:

"conditions": [
  {
    "expression": "[].concat(dataLayer['conditional-test-service.inputData.index.formData.certificate_select'] || []).includes('birth')",
    "redirect": "next-page"
  }
]

Explanation:

• dataLayer['...']: accesses the field from the session data.
• || []: ensures it's always an array, even if the value is undefined or null.
• [].concat(...): safely flattens a string or array into an array.
• .includes('value1'): checks if the value is selected.

💾 Temporary save feature

The temporary save feature allows user progress to be stored in an external API and automatically reloaded on the next visit.
This is useful for long forms or cases where users may leave and return later.

How to enable and configure temporary save

To use this feature, configure the config JSON file. In your service’s site object, add both a submissionGetAPIEndpoint and submissionPutAPIEndpoint entry:

"submissionGetAPIEndpoint": {
  "url": "TEST_SUBMISSION_GET_API_URL",
  "method": "GET",
  "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
  "serviceId": "TEST_SUBMISSION_API_SERVICE_ID"
},
"submissionPutAPIEndpoint": {
  "url": "TEST_SUBMISSION_PUT_API_URL",
  "method": "PUT",
  "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
  "serviceId": "TEST_SUBMISSION_API_SERVICE_ID"
}

These values should point to environment variables that hold your real endpoint URLs and credentials.

In your secrets/.env file (and staging/production configs), define the variables referenced above:

TEST_SUBMISSION_GET_API_URL=https://example.com/api/submissionData
TEST_SUBMISSION_PUT_API_URL=https://example.com/api/submissionData
TEST_SUBMISSION_API_CLIENT_KEY=12345678901234567890123456789000
TEST_SUBMISSION_API_SERVICE_ID=123

How temporary save works

• On first page load for a site, using the submissionGetAPIEndpoint the system will:
  • Call the GET endpoint to retrieve any saved submission.
  • If found, populate the session’s inputData so fields are pre-filled.
  • If not found, call the PUT endpoint to create a new temporary record.
• On every form POST, after successful validation:
  • The submissionPutAPIEndpoint will fire-and-forget a PUT request to update the saved submission with the latest form data.
  • The payload includes all required submission fields with submissionData JSON-stringified.

submissionGetAPIEndpoint GET API Request and Response

This API is used to retrieve the saved submission data.

Request:

• HTTP Method: GET
• URL: Resolved from the url property in your config (from the environment variable).
• Headers:
  • Authorization: Bearer <access_token> (form user's cyLogin access token)
  • client-key: <clientKey> (from config/env)
  • service-id: <serviceId> (from config/env)
  • Accept: text/plain
• Body: The body contains the and either:
  • an a null which means no data was found for the user
  • a JSON object with all the form data collected from the user across all pages in previous sessions.

Example Request:

GET /temp-save-get-endpoint?status=0 HTTP/1.1
Host: localhost:3002
Authorization: Bearer eyJhbGciOi...
client-key: 12345678901234567890123456789000
service-id: 123
Accept: text/plain
Content-Type: application/json

Response:

The API is expected to return a JSON response with the following structure:

When temporary submission data are found:

HTTP/1.1 200 OK

{
    "Succeeded": true,
    "ErrorCode": 0,
    "ErrorMessage": null,
    "Data": {
        "submissionData": "{\"index\":{\"formData\":{\"certificate_select\":[\"birth\",\"permanent_residence\"]}},\"data-entry-radios\":{\"formData\":{\"mobile_select\":\"other\",\"mobileTxt\":\"[phone]\"}}}",
        "referenceValue": "0000000924107836"
    }
}

NOTE: The Data object contains the submissionData and referenceValue fields. The referenceValue is a unique identifier for the submission. It is used to identify the submission in the submissionPutAPIEndpoint and fileDownloadAPIEndpoint API requests.

When temporary submission data are NOT found:

HTTP/1.1 404 Not Found

{
    "Succeeded": true,
    "ErrorCode": 0,
    "ErrorMessage": null,
    "Data": null
}

When temporary submission retreival fails:

HTTP/1.1 200 OK

{
    "Succeeded": false,
    "ErrorCode": 401,
    "ErrorMessage": "Not authorized",
    "Data": null
}

submissionPutAPIEndpoint PUT API Request and Response

This API is used to temporary save the submission data.

Request:

• HTTP Method: PUT
• URL: Resolved from the url property in your config (from the environment variable).
• Headers:
  • Authorization: Bearer <access_token> (form user's cyLogin access token)
  • client-key: <clientKey> (from config/env)
  • service-id: <serviceId> (from config/env)
  • Accept: text/plain
• Body: The body contains the a JSON object with all the form data collected from the user across all pages.

Example Request:

PUT /temp-save-endpoint HTTP/1.1
Host: localhost:3002
Authorization: Bearer eyJhbGciOi...
client-key: 12345678901234567890123456789000
service-id: 123
Accept: text/plain
Content-Type: application/json

{
  "submissionData" : "{\"index\":{\"formData\":{\"certificate_select\":[\"birth\",\"permanent_residence\"]}},\"data-entry-radios\":{\"formData\":{\"mobile_select\":\"other\",\"mobileTxt\":\"[phone]\"}}}"
}

Response:

The API is expected to return a JSON response with the following structure:

On success:

HTTP/1.1 200 OK

{
    "Succeeded": true,
    "ErrorCode": 0,
    "ErrorMessage": null,
    "Data": {
        "submissionData": "{\"index\":{\"formData\":{\"certificate_select\":[\"birth\",\"permanent_residence\"]}},\"data-entry-radios\":{\"formData\":{\"mobile_select\":\"other\",\"mobileTxt\":\"[phone]\"}}}",
        "referenceValue": "0000000924107836"
    }
}

On failure:

HTTP/1.1 401 Unauthorized

{
    "Succeeded": false,
    "ErrorCode": 401,
    "ErrorMessage": "Not authorized",
    "Data": null
}

Notes:

• The response is normalized to always use PascalCase keys (Succeeded, ErrorCode, etc.), regardless of the backend’s casing.

Temporary save backward compatibility

If these endpoints are not defined in the service JSON, the temporary save/load logic is skipped entirely. Existing services will continue to work without modification.

🗃️ Files uploads feature

The Files uploads feature allows user progress to upload, remove and download files. The files will be stored in an external API and automatically reloaded on the next visit.

Pre-requisites for the files uploads feature

The 💾 Temporary save feature must be enabled for the file uploads feature to work.

How to enable and configure file uploads

To use this feature, configure the config JSON file. In your service’s site object, add a fileUploadAPIEndpoint, fileDownloadAPIEndpointand fileDeleteAPIEndpoint entry:

"fileUploadAPIEndpoint": {
  "url": "TEST_UPLOAD_FILE_API_URL",
  "method": "POST",
  "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
  "serviceId": "TEST_SUBMISSION_API_SERVIVE_ID"
},
"fileDownloadAPIEndpoint": {
  "url": "TEST_DOWNLOAD_FILE_API_URL",
  "method": "GET",
  "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
  "serviceId": "TEST_SUBMISSION_API_SERVIVE_ID"
},
"fileDeleteAPIEndpoint": {
  "url": "TEST_DELETE_FILE_API_URL",
  "method": "DELETE",
  "clientKey": "TEST_SUBMISSION_API_CLIENT_KEY",
  "serviceId": "TEST_SUBMISSION_API_SERVIVE_ID"
}

These values should point to environment variables that hold your real endpoint URLs and credentials.

In your secrets/.env file (and staging/production configs), define the variables referenced above:

TEST_UPLOAD_FILE_API_URL=https://example.com/api/fileUpload
TEST_DOWNLOAD_FILE_API_URL=https://example.com/api/fileDownload
TEST_SUBMISSION_API_CLIENT_KEY=12345678901234567890123456789000
TEST_SUBMISSION_API_SERVICE_ID=123

How to define the file input field in the JSON config

The files input field is defined under the pages[i].pageTemplate.sections["main"].elements[0].elements array. Basically it must exist in the page template of a page inside a form.

The element type for files input is fileInput (see it's definition in govcy-frontend-renderer)

Here is a sample code section of a page definition with a file input field:

{
  "pageData": {
    "url": "data-entry-file",
    "title": {
      "el": "Λογαριασμός κινήσεως",
      "en": "Utility bill"
    },
    "layout": "layouts/govcyBase.njk",
    "mainLayout": "two-third",
    "nextPage": "data-entry-all"
  },
  "pageTemplate": {
    "sections": [
      {
        "name": "beforeMain",
        "elements": [
          {
            "element": "backLink",
            "params": {}
          }
        ]
      },
      {
        "name": "main",
        "elements": [
          {
            "element": "form",
            "params": {
              "elements": [
                {
                  "element": "fileInput", //<-- this is the file input
                  "params": {
                    "id": "utility",
                    "name": "utility",
                    "label": {
                      "el": "Λογαριασμός κινήσεως",
                      "en": "Utility bill"
                    },
                    "isPageHeading": true,
                    "hint": {
                      "el": "PDF, JPG, JPEG, PNG, είναι οι αποδεκτές μορφές",
                      "en": "PDF, JPG, JPEG, PNG are the acceptable formats"
                    }
                  },
                  "validations": [ //<-- this is the file input validations
                    {
                      "check": "required",
                      "params": {
                        "checkValue": "",
                        "message": {
                          "el": "Ανεβάστε τον λογαριασμό κινήσεως",
                          "en": "Upload the utility bill"
                        }
                      }
                    }
                  ]
                },
                {
                  "element": "button",
                  "params": {
                    "id": "continue",
                    "variant": "primary",
                    "text": {
                      "el": "Συνέχεια",
                      "en": "Continue"
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

How file uploads works

• On a form page with an upload input field:
  • On first load: the page displays the fileInput field to choose a file.
  • On choosing a file: the file is uploaded to the fileUploadAPIEndpoint endpoint.
    • The fileUploadAPIEndpoint validates the input for allowed file types and file size. On validation error an error message is displayed. The following validations are performed:
      • The fileInput element is defined in the JSON config
      • API endpoints and environment variables are defined
      • The page is not skiped because of conditional logic
      • The file is not empty
      • The file size must be less than 4MB
      • The file type must be one of the following: pdf, jpg, jpeg, png
    • If fileUploadAPIEndpoint returns an success, the file is uploaded temporarilly and the fileView element is displayed, with links to View or Delete the file. The file infomation are store in the data layer of the page.
• On a form page after upload:
  • The fileView element is displayed with links to View or Delete the file.
• When clinking view:
  • The file is downloaded using the fileDownloadAPIEndpoint and opened in a new tab.
• When clinking delete:
  • A confimation page is displayed asking the user to confirm the deletion. If the user confirms (clicks Yes):
    • The file is deleted using the fileDeleteAPIEndpoint
    • The file is deleted from the data layer and the fileView element is removed from the page.
    • If the same file is used on another page (with the same fileId and sha256), they are also removed from the data layer
• On the review page after upload:
  • The element is displayed with a link to View file. A Change link is also displayed for the whole page.
• On the success page and email after upload:
  • The element is displayed with links a marking File uploaded.

fileUploadAPIEndpoint POST API Request and Response

This API is used to temporarily store the file uploaded by the user. The API connects the file with a temporary saved submission, for the specific user and service. It does not create a connection with the actual field on the specific page, that is done by the submissionPutAPIEndpoint API.

Request:

• HTTP Method: POST
• URL: Resolved from the url property in your config (from the environment variable) concatenated with /:tag which defines the type of the file (for example passport). For example https://example.com/api/fileUpload/:tag
• Headers:
  • Authorization: Bearer <access_token> (form user's cyLogin access token)
  • client-key: <clientKey> (from config/env)
  • service-id: <serviceId> (from config/env)
  • Accept: application/json
  • Content-Type: multipart/form-data (typically automatically set when using FormData in the browser)
• Body (multipart/form-data): The body the actual file to be uploaded (PDF, JPEG, etc.)

Example Request:

curl --location 'https://example.gov.cy/api/v1/files/upload/passport' \
--header 'client-key: 12345678901234567890123456789000' \
--header 'service-id: 123' \
--header 'Authorization: Bearer eyJhbGciOi...' \
--form 'file=@"/path/to/file.pdf"'

Response:

The API is expected to return a JSON response with the following structure:

On success:

HTTP/1.1 200 OK

{
    "ErrorCode": 0,
    "ErrorMessage": null,
    "Data": {
        "fileId": "6899adac8864bf90a90047c3",
        "fileName": "passport.pdf",
        "contentType": "application/pdf",
        "fileSize": 4721123,
        "sha256": "8adb79e0e782280dad8beb227333a21796b8e01d019ab1e84cfea89a523b0e7d",
        "description": "passport.pdf",
        "tag": "passport"
    },
    "Succeeded": true
}

On failure:

HTTP/1.1 400

{
  "ErrorCode": 400,
  "ErrorMessage": "SUBMISSION_REQUIRED",
  "Data": null,
  "Succeeded": false
}

fileDownloadAPIEndpoint GET API Request and Response

This API is used to download the file uploaded by the user. It returns the file data in Base64.

Request:

• HTTP Method: GET
• URL: Resolved from the url property in your config (from the environment variable) concatenated with /:refernceValue/:fileid/:sha256. For example https://example.com/api/fileDownload/1234567890/123456789123456/12345678901234567890123:
  • referenceValue is the referenceValue of the file current temporary saved instance (see more 💾 Temporary save feature).
  • fileid is the fileId of the file uploaded by the user.
  • sha256 is the sha256 of the file uploaded by the user.
• Headers:
  • Authorization: Bearer <access_token> (form user's cyLogin access token)
  • client-key: <clientKey> (from config/env)
  • service-id: <serviceId> (from config/env)
  • Accept: text/plain

Example Request:

GET fileDownload/1234567890/123456789123456/12345678901234567890123 HTTP/1.1
Host: localhost:3002
Authorization: Bearer eyJhbGciOi...
client-key: 12345678901234567890123456789000
service-id: 123
Accept: text/plain
Content-Type: application/json

Response:

The API is expected to return a JSON response with the following structure:

When file is found:

HTTP/1.1 200 OK

{
  "ErrorCode": 0,
  "ErrorMessage": null,
  "Data": {
    "fileId": "123456789123456",
    "fileName": "passport.pdf",
    "contentType": "application/pdf",
    "fileSize": 1872,
    "sha256": "12345678901234567890123456789012345678901234567890123456789012345",
    "base64": "JVBERi0xLjMKJZOMi54gUm....
",
    "description": null,
    "uid": null,
    "tag": "Passport"
  },
  "Succeeded": true
}

When file is NOT found:

HTTP/1.1 404 Not Found

{
    "ErrorCode": 404,
    "ErrorMessage": "File not found",
    "InformationMessage": null,
    "Data": null,
    "Succeeded": false
}

fileDeleteAPIEndpoint DELETE API Request and Response

This API is used to delete the file uploaded by the user. It returns the file data in Base64.

⚠️ Important note:
If the same file (same fileId and sha256) is used for other fields in the same application for the same service and the same user, when deleted it will be removed from all instances in the data layer. A warning will appear in the user's delete confirmation page to warn the users in such cases.

Request:

• HTTP Method: DELETE
• URL: Resolved from the url property in your config (from the environment variable) concatenated with /:fileid/:sha256. For example https://example.com/api/fileDelete/123456789123456/12345678901234567890123:
  • fileid is the fileId of the file uploaded by the user.
  • sha256 is the sha256 of the file uploaded by the user.
• Headers:
  • Authorization: Bearer <access_token> (form user's cyLogin access token)
  • client-key: <clientKey> (from config/env)
  • service-id: <serviceId> (from config/env)
  • Accept: text/plain

Example Request:

DELETE fileDelete/123456789123456/12345678901234567890123 HTTP/1.1
Host: localhost:3002
Authorization: Bearer eyJhbGciOi...
client-key: 12345678901234567890123456789000
service-id: 123
Accept: text/plain
Content-Type: application/json

Response:

The API is expected to return a JSON response with the following structure:

When file is found and deleted:

HTTP/1.1 200 OK

{
  "ErrorCode": 0,
  "ErrorMessage": null,
  "Succeeded": true
}

When file is NOT found:

HTTP/1.1 404 Not Found

{
    "ErrorCode": 404,
    "ErrorMessage": "File not found",
    "InformationMessage": null,
    "Data": null,
    "Succeeded": false
}

File uploads in the data layer

The system uses the fileId and sha256 to identify the file uploaded by the user. The file information are stored in the data layer in the following format:

{
  "fileId": "1234567891234567890",
  "sha256": "123456789012345678901234567890123456789012345678901234567890123456"
}

File uploads when submitted

When the user submits the service through the submission API endpoint, the system will use the fileId and sha256 to identify the file uploaded by the user. The actuall file is already uploaded via the fileUploadAPIEndpoint.

To help back-end systems recognize the field as a file, the field's element name is concatenated with Attachment. For example, if for the field passport, the data will be submitted as follows:

{
  "passportAttachment": {
    "fileId": "1234567891234567890",
    "sha256": "123456789012345678901234567890123456789012345678901234567890123456"
  }
}

File uploads backward compatibility

If these endpoints are not defined in the service JSON, the file upload logic is skipped entirely. Existing services will continue to work without modification.

✨ Custom pages feature

The Custom pages feature allows developers to add service-specific custom pages that exist outside the standard Express Services JSON configuration.

These pages can collect data, display conditional content, and inject custom sections into the review and email stages of the service flow.

What do custom pages get out of the framework

With the custom pages feature, developers can define pages and routes on an express service. On these pages the following apply out of the box:

• Login requirement
• User policy requirement
• Any service eligibility checks
• Csrf protection on POST
• Generic error page on errors

The developers can also choose to:

• store values in the session to be submitted via the submission API
• define where and what the users sees in the review page
• define errors regarding the custom page in the review page
• define what the user receives the email

What the framework expects from custom pages

• Every custom page must be defined at startup using defineCustomPages(app, siteId, pageUrl, ...).
• Custom pages are not automatically discovered, they must be registered explicitly.
• Each page must specify on start up:
  • pageTitle: multilingual object for display in review and email
  • insertAfterPageUrl: the page after which this custom page will appear
  • summaryElements, errors, and email are managed dynamically in session
    • NOTE: Usually a default required error must be defined on start up. This will ensure that the when the users try to submit in the “Check your answers” review page, they get an error message to complete an action.
  • extraProps extra property stored in the session to be used by the developers as they wish
• During runtime, developers are responsible for setting:
  • data: data to include in submission, using the setCustomPageData function
  • summaryElements: what appears in the “Check your answers” review page, using the setCustomPageSummaryElements function
  • email: array of dsf-email-templates components for the submission confirmation email, using the setCustomPageEmail
  • errors: errors that appear in the “Check your answers” review page. Developers can use the addCustomPageError function to add an error, or the clearCustomPageErrors to clear the errors

Available methods

Method	Purpose
defineCustomPages(store, siteId, pageUrl, pageTitle, insertAfterSummary, insertAfterPageUrl, errors, summaryElements, summaryHtml, extraProps)	Registers a custom page definition in app. Must be called once at startup.
getCustomPageDefinition(store, siteId, pageUrl)	Retrieves the custom page definition for a given siteId and pageUrl
resetCustomPages(configStore, store, siteId)	Resets per-session data from the global definitions.
setCustomPageData(store, siteId, pageUrl, dataObject)	Sets or replaces the data object used during submission.
setCustomPageSummaryElements(store, siteId, pageUrl, summaryElements)	Sets what appears in the review page summary.
clearCustomPageErrors(store, siteId, pageUrl)	Clears validation errors.
addCustomPageError(store, siteId, pageUrl, errorId, errorTextObject)	Adds a validation error.
setCustomPageEmail(store, siteId, pageUrl, arrayOfEmailObjects)	Defines email sections for the confirmation email using dsf-email-templates components.
setCustomPageProperty(store, siteId, pageUrl, property, value, isDefinition = false)	Sets a custom property on a given custom page definition or instance
getCustomPageProperty(store, siteId, pageUrl, property, isDefinition = false)	Gets a custom property from a given custom page definition or instance.

Example

Below is a practical example of a custom Declarations page added to an existing service.

import initializeGovCyExpressService from '@gov-cy/govcy-express-services';
import {
    defineCustomPages, resetCustomPages,
    clearCustomPageErrors, addCustomPageError,
    setCustomPageData, setCustomPageSummaryElements,
    setCustomPageEmail, getCustomPageProperty, setCustomPageProperty
} from '@gov-cy/govcy-express-services/customPages';

// Initialize the service
const service = initializeGovCyExpressService({
    beforeMount({ siteRoute, app }) {

        // ==========================================================
        // 1️⃣ DEFINE GLOBAL CUSTOM PAGE CONFIGS (once per app)
        // ==========================================================
        defineCustomPages(
            app, // <-- using app as store (global config)
            "cso", // siteId
            "/cso/custom", // pageUrl
            { en: "My custom section", el: "Προσαρμοσμένη ενότητα" }, // pageTitle
            "qualifications",     // insertAfterPageUrl
            [                         // errors
                {
                    id: "custom-error",
                    text: {
                        en: "This is a custom error custom",
                        el: "Αυτή ειναι ενα προσαρμοσμένη σφαλμα custom",
                    }
                }
            ],
            [     // summaryElements  
                {
                    key:
                    {
                        en: "Extra value",
                        el: "Πρόσθετη τιμή"
                    },
                    value: []
                }
            ],
            false,
            { // other custom properties if needed like nextPage or initial data
                nextPage: "/cso/memberships", // custom property nextPage. Not needed by Express but useful for the custom logic
                data : // custom initial data. Useful when you need the data model to be standard or pre-populated
                { 
                    something: "",
                }  
             }
        );

        // ==========================================================
        // 2️⃣ MIDDLEWARE: SET UP SESSION DATA FROM GLOBAL DEFINITIONS
        // ==========================================================
        app.use((req, res, next) => {
            // Initialize session data for custom pages
            req.session.siteData ??= {};
            req.session.siteData["cso"] ??= {};

            // Reset session copies if missing (first visit)
            if (!req.session.siteData["cso"].customPages) {
                resetCustomPages(app, req.session, "cso"); // 🔁 deep copy from app to session
                req.session.save((err) => {
                    if (err) console.error("⚠️ Error initializing customPages:", err);
                });
            }

            next();
        });

        // ==========================================================
        // 3️⃣ CUSTOM ROUTES (still per-user)
        // ==========================================================

        // GET `/cso/custom`
        siteRoute("cso", "get", "/cso/custom", (req, res) => {

            // Render the custom page using the session data
            // It is important for POST to add the csrfToken and to pass on the route query parameter
            res.send(`<form action="/cso/custom${(req.query.route === "review")?"?route=review":""}" method="post">
                 custom for ${req.params.siteId}
                 <input type="hidden" name="_csrf" value="${req.csrfToken()}">
                <button type="submit">Submit custom page</button>
            </form>`);

        });

        // POST `/cso/custom`
        siteRoute("cso", "post", "/cso/custom", (req, res) => {

            // Update custom page `data` dynamically`
            setCustomPageData(req.session, "cso", "/cso/custom", {
                something: "123",
            });

            // Update `summary elements` dynamically (example)
            setCustomPageSummaryElements(req.session, "cso", "/cso/custom",
                [
                    {
                        key: {
                            en: "Extra value",
                            el: "Πρόσθετη τιμή"
                        },
                        value: [
                            {
                                element: "textElement",
                                params: {
                                    text: {
                                        en: "123 Changed",
                                        el: "123 Αλλάχθηκε"
                                    },
                                    type: "span",
                                    showNewLine: true,
                                }
                            }
                        ]
                    }
                ]);

            // Update the custom page `email` 
            setCustomPageEmail(req.session, "cso", "/cso/custom", [
                {
                    component: "bodyKeyValue",
                    params: {
                        type: "ul",
                        items: [
                            { key: "Extra value", value: "123" },
                            { key: "Priority level", value: "High" },
                        ],
                    },
                }
            ]);

            // clear any previous errors
            clearCustomPageErrors(req.session, "cso", "/cso/custom");

            // Add a custom error
            // addCustomPageError(req.session, "cso", "/cso/custom", {
            //     id: "custom-error",
            //     text: {
            //         en: "This is a custom error custom",
            //         el: "Αυτή ειναι ενα προσαρμοσμένη σφαλμα custom",
            //     }
            // });

            //if route is review, redirect to review page else go to nextPage property
            if (req.query.route === "review") {
                res.redirect("/cso/review");
                return;
            } else {
                //example of using custom property nextPage
                res.redirect(getCustomPageProperty(req.session, "cso", "/cso/custom", "nextPage", false));
                return;
            }
        });


        // ==========================================================
    },
});


// Start the server
service.startServer();

🛣️ Routes

The project uses express.js to serve the following routes:

Service routes:

• /:siteId: Requires cyLogin authentication for authorized individual users. Redirects to /:siteId/index.
• /:siteId/:pageUrl: Requires cyLogin authentication for authorized individual users. Based on /data/:siteId.json, Renders the specified page template. Validates page and saves data to session. If validation fails, errors are displayed with links to the inputs.
• /:siteId/review: Requires cyLogin authentication for authorized individual users. Renders the check your answers page template. Validates all pages in the service and submits the data to the configured API endpoint. If validation fails, errors are displayed with links to the relevant pages.
• /:siteId/success: Requires cyLogin authentication for authorized individual users. Renders latest successful submission.
• /:siteId/:pageUrl/view-file/:elementName: Requires cyLogin authentication for authorized individual users. Renders the specified file in a new tab.
• /:siteId/:pageUrl/delete-file/:elementName: Requires cyLogin authentication for authorized individual users. Renders the delete confirmation page and handles the file delete.

Authentication routes:

• /signin-oidc: CY Login authentication endpoint.
• /login: Redirect to CY Login login page.
• /logout: CY Login logout endpoint.

API routes:

• /apis/:siteId/:pageUrl/upload: Uploads a file. Used from the client side JS.

👨‍💻 Environment variables

The environment variables are defined in:

• Secret environment variables: These are secret variables and MUSR NOT be saved in version control. The are saved locally in the secrets/.env file and they control the server configuration, authentication, integrations, and development behavior. These variables vary depending on the environment and are defined through the deployment prosses for staging and production.
• Non secret environment variables: These are non secret enviromentat variables and can be saved in version control. These are stored in the root folder of the project:
  • .env.development for local development
  • .env.staging for staging
  • .env.production for production

Secret environment variables

The following secret environment variables are used to configure the server (note the values below are examples, you need to replace them with your own values):

# 🔐 Session
SESSION_SECRET=12345678901234567890123456789012345678901234567890
# Secret used to sign session cookies. Use a long, random string in production.

# 🌐 Server
PORT=44319
# The port the Express server runs on.

NODE_ENV=development
# Set to 'development', 'staging', or 'production'. Enables optimizations and logging behavior.

DEBUG=true
# Set to false in production to disable debug logging.

ALLOW_SELF_SIGNED_CERTIFICATES=false
# Allow self-signed SSL certs (e.g. for local development). Set to false in production.

# -----------------------------------------------
#### CY Login environment variables
# The following environment variables are used to configure CY Login authentication:
CYLOGIN_ISSUER_URL=https://aztest.cyprus.gov.cy/cylogin/core/.well-known/openid-configuration
# The OIDC issuer URL for discovery.

CYLOGIN_CLIENT_ID=your-CYLOGIN-client-id
CYLOGIN_CLIENT_SECRET=your-CYLOGIN-client-secret
# Your client credentials provided by CY Login.

CYLOGIN_SCOPE=openid cegg_profile your.scope
# Scopes requested from CY Login. 'openid' is required. Add additional scopes as needed.

CYLOGIN_REDIRECT_URI=https://localhost:44319/signin-oidc
# Redirect URI registered with CY Login. Must match exactly.

CYLOGIN_CODE_CHALLENGE_METHOD=S256
# Use S256 for PKCE challenge method.

CYLOGIN_POST_LOGOUR_REIDRECT_URI=https://localhost:44319/
# Where to redirect users after logout.

# -----------------------------------------------
#### DSF API Gateway environment variables
# The following environment variables are used to configure the DSF API Gateway. The DSF API Gateway is used to send notifications to the NotificationEngine API.
DSF_API_GTW_CLIENT_ID=your-DSF-API-gateway-client-id
DSF_API_GTW_SECRET=your-DSF-API-gateway-secret
DSF_API_GTW_SERVICE_ID=your-DSF-API-gateway-service-id
# DSF Gateway credentials and registered service ID.

DSF_API_GTW_NOTIFICATION_API_URL=https://127.0.0.1/api/v1/NotificationEngine/simple-message
# URL for the NotificationEngine API.

#-----------------------------------------------
#### Service API environmental variables
# The following environment variables are used to configure the services (they are referenced in the JSON config file):
# Submission endpoint (test service)
TEST_SUBMISSION_API_URL=http://localhost:3002/submission
TEST_SUBMISSION_API_CLIENT_KEY=12345678901234567890123456789000
TEST_SUBMISSION_API_SERVIVE_ID=123
TEST_SUBMISSION_DSF_GTW_KEY=12345678901234567890123456789000

# Optional Temporary Save GET and PUT endpoints (test service)
TEST_SUBMISSION_GET_API_URL=http://localhost:3002/getTempSubmission
TEST_SUBMISSION_PUT_API_URL=http://localhost:3002/save

# Optional File Upload and download endpoints (test service)
TEST_FILE_UPLOAD_API_URL=http://localhost:3002/fileUpload
TEST_FILE_DOWNLOAD_API_URL=http://localhost:3002/fileDownload
TEST_FILE_DELETE_API_URL=http://localhost:3002/fileDelete

# Eligibility checks (optional test APIs)
TEST_ELIGIBILITY_1_API_URL=http://localhost:3002/eligibility1
TEST_ELIGIBILITY_2_API_URL=http://localhost:3002/eligibility2

# Update my details
CIVIL_REGISTRY_CONTACT_API_URL=http://localhost:3002/get-update-my-details
UPDATE_MY_DETAILS_URL=https://update-my-details.staging.service.gov.cy

Non secret environment variables

The following non-secret environment variables are used to configure the server defined in .env.development for local development, .env.staging for staging, and .env.production for production:

#### Matomo web analytics environment variables
MATOMO_SITE_ID=51
MATOMO_URL=//wp.matomo.dits.dmrid.gov.cy

🔒 Security note

• Always set a strong, random SESSION_SECRET in your secrets/.env file. Never commit secrets or credentials to version control.
• Add .gitignore & .npmignore: Ensure no real secrets/.env, server.key, or other sensitive files are published.
• In production, ensure cookies are set with secure, httpOnly, and sameSite attributes to protect against common web vulnerabilities.
• Make sure your server is running behind HTTPS in production.
• Regularly rotate secrets and credentials, and restrict access to your secrets/.env and configuration files.
• Validate user input to prevent injection attacks.
• Review and update your dependencies regularly to address security vulnerabilities.

Tip: This project enables CSRF protection and secure session cookies by default, but it is your responsibility to keep secrets and environment variables safe in production.

❓ Troubleshooting / FAQ

SSL certificate errors on local development

• Problem: Browser shows a warning or refuses to connect to https://localhost:44319.
• Solution: Make sure you have generated self-signed certificates as described in the installation guide. You may need to trust the certificate in your browser or OS.

Session not persisting / users logged out unexpectedly

• Problem: Users are logged out or session data is lost between requests.
• Solution: Ensure your SESSION_SECRET is set in secrets/.env and is long and random. If running behind a proxy (like nginx), set trust proxy in your Express app.

CY Login authentication not working

• Problem: Users cannot log in or are redirected incorrectly.
• Solution: Double-check your CY Login client ID, secret, scope and redirect URIs in secrets/.env. Make sure your app is accessible at the correct URL and port.

API requests fail with 401/403 errors

• Problem: Eligibility or submission API calls fail with authorization errors.
• Solution: Ensure the user's access token is being sent in the Authorization header. Check that your API endpoint and credentials are correct. Check that the CY Login you have configured has the correct scope that the API endpoint requires.

Changes to JSON config not reflected

• Problem: Updates to your /data/:siteId.json file don’t show up in the app.
• Solution: Restart the server after making changes to config files, as they are loaded at startup. If the problem persists, check your JSON file syntax and ensure it is valid. Also check if the definition of the elements is as defined in the govcy-frontend-renderer library.

Environment variables not loading

• Problem: The app fails to start or cannot find required configuration values.
• Solution: Make sure your secrets/.env file exists in the project root and is formatted correctly. Restart the server after making changes to .env.

Port already in use

• Problem: The server fails to start with an error like EADDRINUSE: address already in use.
• Solution: Another process is using the same port. Either stop the other process or change the PORT value in your secrets/.env file.

Cannot connect to CY Login or API endpoints

• Problem: The app cannot reach CY Login or your API endpoints.
• Solution: Check your network connection, firewall settings, and that the URLs in your secrets/.env are correct and accessible from your environment.

🙏 Credits

• Cyprus Government Digital Services Factory (DSF) [e-mail]
• Cyprus Connecting Digital Services Team [e-mail]

💡 Developer notes

For local develoment checke the developer notes document.

📄 License

This project is released under the MIT License.

📬Contact

If you have any questions or feedback, please feel free to reach out to us at [e-mail]