FAQ

Web Services

I need help to create my own application.

Two example tools have been developed to help you create your own applications. One tool is based on the Java platform and the second on the PHP platform. Both show how to extract the Europass XML from a PDF, parse it and store it in a database.

Java Example Sample Europass tool based on the Java platform

PHP Example Sample Europass tool based on the PHP platform

Was this answer helpful?
Let us know how we did

What is the Europass statistics API?

The Europass statistics API is part of the public set of Europass web services.

The Statistics API allows users to query Europass statistical data for

  • Europass Online Editors generated documents;
  • Visits of Europass portal and EWA Editors (combined);
  • Europass portal document downloads.

dating back to 2005.

Visit the Europass online statistical tool.

It is HTTP-based and can return results in JSON or CSV format.

Was this answer helpful?
Let us know how we did

Is the schema version I use compatible with the Europass web services?

Check out the Europass Compatibility matrix.

Was this answer helpful?
Let us know how we did

Can I try out the Remote upload service?

Try this Live example

Was this answer helpful?
Let us know how we did

Which Europass schema versions can be remotely uploaded to the Europass editor?

The Remote upload service is compatible with all Europass XML versions, from v1.0 up to v3.0.x. See the Compatibility Matrix for further details.

Was this answer helpful?
Let us know how we did

Which method is used for the Europass remote upload service?

To remotely upload a document to the Europass editors, send a POST request to

https://europass.cedefop.europa.eu/editors/remote-upload

providing a valid Europass XML in a parameter called europass-xml.

Was this answer helpful?
Let us know how we did

What does the Remote upload web service do?

Users of an external system can have their data uploaded remotely to the Europass online editors, without having to create a Europass document from scratch. This is achieved by means of an XML request sent by the external system to the Europass editor.

All or some of the editor fields are pre-populated with existing data from the external system's database, and the users can then edit and download their CV/ESP or LP via the Europass editor in any of the available formats.

Was this answer helpful?
Let us know how we did

What services are provided by the Europass REST API?

Check out the Services currently provided by the Europass REST API.

Was this answer helpful?
Let us know how we did

Need help with the Europass REST API?

Check out these REST API examples in Javascript, PHP, and Java.

Was this answer helpful?
Let us know how we did

Where can I find the Europass REST API documentation?

REST API Reference

Was this answer helpful?
Let us know how we did

Which method is used for Europass REST API web services?

Currently, all REST API services/endpoints require to POST a HTTP request.

Was this answer helpful?
Let us know how we did

Does the API require authentication?

The API does not require any kind of authentication, but given that the services involve personal data (e.g. in the Curriculum vitae), all requests must be made over secure HTTP (HTTPS). Requests made on plain HTTP will be forbidden with an HTTP 403 Forbidden Status response.

Was this answer helpful?
Let us know how we did

What does the Europass REST API do?

The Europass REST API mostly provides a set of conversion services which allow external systems to send a Europass XML or JSON document and get back a Europass document of a different file format such as PDF+XML.

In addition, it provides two utility methods, one to extract the XML attachment from a Europass PDF+XML document and another one to upgrade an older Europass XML (i.e. XML versions <= 2.0) to the latest version.

Was this answer helpful?
Let us know how we did

What file formats are supported by the Europass web services?

Supported file formats are: Europass XML, Adobe PDF + Europass XML attachment, Europass JSON, Microsoft Word 97-2003, OpenDocument v2 Text, HTML, HR-XML, Adobe PDF with HR-XML attachment.

Was this answer helpful?
Let us know how we did

Where can I find more information about the Europass web services?

REST API Summary: Information on Europass REST API

REST API Reference: Extensive documentation and examples for each REST API service

REST API Examples: Examples for the Europass REST API

Remote Upload: Alternative web service to take advantage of Europass online editor

Statistics API: Web service to take advantage of statistics gathered from Europass CVs

Was this answer helpful?
Let us know how we did

What is the purpose of the Europass web services?

These services offer conversion methods between various file formats supported by Europass. We encourage the integration with systems and environments that maintain a repository of personal data such as:

  • job matching services (e.g. job portals, employment services);
  • promotion services (e.g. career guidance, human resource management);
  • profile maintaining services (e.g. blog publishing tools, social networking sites).
Was this answer helpful?
Let us know how we did

What kind of web services are provided by Europass?

Europass provides two types of web services: a API REST, and a method to populate the online editors with data coming from a remote system, which we simply call Remote upload.

Was this answer helpful?
Let us know how we did

Data Model

Does Europass supports JSON?

JSON in general (regardless of any specific versions) is not supported by the Europass online editors, so it is not possible to either upload or download a JSON document to/from the editors.

Was this answer helpful?
Let us know how we did

Where can I find the Europass JSON schema documentation?

Currently there is no extra documentation for the JSON schema but it is relatively straightforward to understand it by studying the Europass XML schema documentation, v3.3.0 [PDF], since most concepts there apply in the case of the JSON schema as well.

Was this answer helpful?
Let us know how we did

Which is the current JSON schema version?

The latest Europass JSON Schema, v3.3.0 follows the XML Schema versioning scheme.

JSON in general (regardless of any specific versions) is not supported by the Europass Online Editors, so it is not possible to either upload or download a JSON document to/from the editors.

Was this answer helpful?
Let us know how we did

Where can I find previous JSON versions?

Visit the JSON Archive.

Was this answer helpful?
Let us know how we did

Where can I find previous XML versions?

Browse section XML Archive.

Was this answer helpful?
Let us know how we did

Where can I find the Europass XML schema documentation?

Download the Europass XML schema documentation, v3.3.0.

Was this answer helpful?
Let us know how we did

How to deal with lack of XML version compatibility?

In case you are stuck with an older Europass XML version and you cannot adjust your application soon so as to use the latest one, you can also try to use one of the following XSL transformations which take an old Europass XML as the source document and convert it to a newer version.

If XSL is not your thing, you can use the XML upgrade REST service instead. An advantage of this approach over the XSL transformations is that it doesn't require more than one steps, even if you are upgrading from a Europass XML prior to version 2.0.

In any case, these XSLTs should only be used as a temporary workaround and it is strongly advised to natively upgrade your system to use the latest Europass XML version as soon as possible.

Was this answer helpful?
Let us know how we did

How to deal with older XML schema versions?

The new CV/LP online editor is backward compatible, meaning that it is possible to upload an XML or PDF+XML document that is based on an older Europass XML Schema (e.g. v2.0, v1.2, etc. - see XML archive below). In this case, the editor will automatically convert the uploaded document to the latest XML version so that it can be further edited and downloaded as per normal.

Important: this feature is not available in the Europass REST API but you can pretty much achieve the same functionality by manually converting the older version to the latest one using either one of the available XSLTs or the XML Upgrade REST service.

You can also consult the Europass Compatibility matrix for further details.

Was this answer helpful?
Let us know how we did

Which is the current XML schema version?

The latest Europass XML schema is v3.3.0. This version is currently supported by the following Europass services:

Was this answer helpful?
Let us know how we did

Are there separate schemas for the different Europass documents?

No. There there are no separate, individual schemas per document type. All Europass documents (CV, ESP, LP) are based on one common XML schema  explicitly designed from the ground up as a generic and reusable model to describe a learner's information, irrespectively of any implementation details.

As a result, the Europass documents can be used interchangeably, meaning that it is possible to produce an LP starting from a CV (or an ESP) and vice versa.

Was this answer helpful?
Let us know how we did

How is the XML schema used in practice for interoperability?

The XML Schema is used to describe the information contained in the Curriculum Vitae (CV), Language Passport (LP) and European Skills Passport (ESP). Individuals woo use the Europass online editors to create a CV, LP or ESP can save it in Europass XML format or PDF format with the XML attached.

Both formats (XML and JSON) can be imported to the Europass online editors at a later stage for editing, or to any other system that understands the Europass XML, thus enabling interoperability.

Was this answer helpful?
Let us know how we did

Which schema to use?

The JSON schema is not currently included in the documents generated by the online editors but is supported by the Europass REST API, as a lightweight alternative to XML. XML too is supported by the REST API. It is up to you and depending on your application's requirements to decide which format to use.

Was this answer helpful?
Let us know how we did

How does Europass promote interoperability?

Europass promotes interoperability by defining a specific data model and vocabulary to express the information contained in Europass documents. This data model is realised using an XML schema as well as a JSON schema which:

  • describes the constraints on the structure and on the contents of Europass documents;
  • establishes the preferred data interchange format between Europass and other software systems and applications.
Was this answer helpful?
Let us know how we did

General

Which interoperable options are available?

  • Upload a Europass CV

Allows users to create a profile on your platform starting from an existing Europass CV. By uploading a Europass CV, common fields can be automatically populated with the corresponding personal data.

  • Export in Europass Format

Allows users to export personal data already entered in your IT system. Using our web services, this option enables your clients to produce a graphically formatted Europass CV directly from your platform.

Was this answer helpful?
Let us know how we did

How much does it cost?

Integrating your system with Europass entails no financial cost. Our options are based on widely-used, open standards. We also provide extensive resources, documentation and technical support.

  • XML
  • Java
  • JSON
  • REST
  • Web services
  • Javascript
  • iText
  • Apache & Mysql
Was this answer helpful?
Let us know how we did

Why should you become interoperable with Europass?

  • Added value for your end-users, eliminating the need to fill in the same information repeatedly on different platforms.
  • Increased attractiveness for your organisation, providing compatibility with a widely recognised European service.
Was this answer helpful?
Let us know how we did

Who can become interoperable with Europass?

Any organisation that maintains a CV database or manages an IT system where end-users fill in a profile or an application form is a natural candidate for liaising with Europass:

  • public employment services;
  • recruitment agencies;
  • career guidance offices;
  • job portals;
  • HR services.
Was this answer helpful?
Let us know how we did