Add attachments to your application
When requesting a new EUTM application, sometimes you may need to add some attachments to your application: logo of the trade mark, some additional documentation to support your application, etc.
To link these documents to your application, you need to use a document-repository API in combination with the EUTM Filing API.
We are going to see the steps needed to add attachments to the application.
Step 1: Upload the document
Before creating the application, we need the documents to be available to link them to the application. We are going to use a document-repository API to upload the documents to a temporary storage space where a unique identifier is given to each file.
Endpoint: POST /document-repository/documents
curl --location --request POST 'https://api-sandbox.euipo.europa.eu/document-repository/documents' \
--header 'X-IBM-Client-Id: {{client_id}}' \
--header 'X-IBM-Client-Secret: {{client_secret}}' \
--header 'Authorization: Bearer {{authorization_token}}‘\
--form 'file=@"{{file_name}} "'
Among other properties, the response will include the unique identifier we will use to link the uploaded file to the application.
{
"identifier": "0ec45c1e-62c5-4983-8a58-847abdb4116f",
"createdBy": "balagjo01",
"creationDate": "2022-08-11T13:09:16.483+0000",
"fileName": "pikolinos_logo.jpg",
"fileSize": 5895,
"mimeType": "image/jpeg",
"imageProperties": {
"width": 170,
"height": 37,
"widthDpi": 96,
"heightDpi": 96,
"progressive": false,
"bitsPerPixel": 24,
"colorTypeDescription": "RGB"
}
}Step 2: Including the file in the application
In this step, we will use the unique identifier provided by the document-repository API in the EUTM application request to link the uploaded file to the application.
Endpoint: POST /eutm-filing/applications
Request body:
{
...
"firstLanguage": "en",
"secondLanguage": "es",
"personalReference": "PersonalReference001",
"markNature": "INDIVIDUAL",
"representation": {
"image": "0ec45c1e-62c5-4983-8a58-847abdb4116f",
"markFeature": "FIGURATIVE"
},
...
}If the document in question is in an unacceptable format or does not comply with the technical requirements for attachments, the server will send a ‘bad request’ response. The response will indicate what the error is.
{
"type": "/problems/invalid-file-format",
"title": "Invalid file format",
"detail": "Format OTHER of document with identifier '37a4eb6a-9562-4797-9b23-fd59755ba63f' not allowed. Expected formats: [JPEG]",
"status": 400,
"instance": "/applications"
}NOTE: the server may expect different file formats depending on the document type (e.g. logo – jpeg; markNatureRegulationDocument – pdf).
Add or import new Applicants and Representatives
When filing a new EUTM application, you can face two different scenarios:
- you have already participated in a procedure at the EUIPO (existing applicant scenario); or
- you can be a newcomer to the EUIPO services (new applicant scenario).
i) Existing applicant scenario
If the data of the applicant in the new filing application is already in the system because they have been involved in a previous procedure, the PersonIdentifier (ID number) assigned to the applicant can be used instead of including all applicant’s information.
Endpoint: POST /eutm-filing/applications
{
...
"applicants": [
{
"personIdentifier": "1516"
}
],
…
}The response will include the applicant information including the PersonIdentifier because the applicant is already in the system.
{
...
"applicants": [
{
"type": "APPLICANT_BUSINESS",
"personIdentifier": "1516",
"correspondenceRecipient": true,
"identifier": "4c867e20-943b-4c4f-af3b-b75bb7779683",
"legalName": "Applicants Holding Ltd",
"legalForm": "LTD",
"countryOfIncorporation": "DE",
"address": {
"street": "Vestergade 36",
"city": "Aarhus",
"postalCode": "8000",
"country": "DK"
},
"phone": "+45 222 333 666",
"email": applicants.holding@domain.com
}
],
...
}NOTE: equivalent scenario also exists for existing representatives.
ii) New applicant scenario
If it is the first time the user has interacted with the EUIPO, the EUIPO does not have any previous information about the applicant. Therefore, all requisite information about the applicant must be included in the application request. Below we can see an example of an ‘Applicant business’ type request.
Endpoint: POST /eutm-filing/applications
{
...
"applicants": [
{
"type": "APPLICANT_BUSINESS",
"legalName": "Applicants Holding Ltd",
"legalForm": "LTD",
"countryOfIncorporation": "DE",
"address": {
"street": "Vestergade 36",
"city": "Aarhus",
"postalCode": "8000",
"country": "DK"
},
"phone": "+45 222 333 666",
"email": applicants.holding@domain.com
}
],
...
}The system will return a response containing the submitted data and some extra information. The response will not contain a PersonIdentifier property. Please, do not confuse the identifier with the personIdentifier. The PersonIdentifier will be generated and available once the submission is processed.
{
...
"applicants": [
{
"type": "APPLICANT_BUSINESS",
"correspondenceRecipient": true,
"identifier": "4c867e20-943b-4c4f-af3b-b75bb7779683",
"legalName": "Applicants Holding Ltd",
"legalForm": "LTD",
"countryOfIncorporation": "DE",
"address": {
"street": "Vestergade 36",
"city": "Aarhus",
"postalCode": "8000",
"country": "DK"
},
"phone": "+45 222 333 666",
"email": applicants.holding@domain.com
}
],
...
}The addition of a new person to the database requires some validations. There are two type of validation rules, blocking and non-blocking. For non-blocking validations, those rules that are not adhered to will be included in the response as warnings.
{
...
"warnings": [
{
"type": "/problems/application-warned-applicant",
"title": "Applicant with warnings",
"detail": "In the applicant, the legal form [CO] does not match one of the valid values for the provided incorporation country [DE]",
"errorCode": "legal_form_not_match"
}
]
}When blocking rules are not adhered to, the response will return 400 status code and the relevant information about the validation errors. Example below:
{
"type": "/problems/application-invalid-applicant",
"title": "In an applicant, the name is mandatory",
"detail": "Invalid applicant",
"status": 400,
"instance": "/applications"
}NOTE: equivalent scenario also exists for new representatives.
Provide classification in first and second language
When we are performing an application of an EUTM we have two different options for providing goods and services classification. In this guide we are going to explore both possible paths.
Providing classification in first language
The most common scenario will be providing goods and services in the first language. In the example down below we can see the request body for this action. Please be aware that for clarity reasons, only the relevant properties are included.
{
"firstLanguage": "en",
"secondLanguage": "es",
…
"goodsAndServices": [
{
"classNumber": 8,
"terms": [
"Tableware [knives, forks and spoons]"
]
},
{
"classNumber": 21,
"terms": [
"Aluminium cookware"
]
}
],
…
}By default, unless otherwise indicated, the terms are considered to correspond to the language specified in the "firstLanguage" property. So in this case, it is not necessary to specify the language for each of the items under "goodsAndServices" property.
The response we may expect will be like this:
{
"firstLanguage": "en",
"secondLanguage": "es",
…
"goodsAndServices": [
{
"language": "en",
"classNumber": 8,
"terms": [
"Tableware [knives, forks and spoons]", "Tableware [knives, forks and spoons]"
]
},
{
"language": "en",
"classNumber": 21,
"terms": [
"Aluminium cookware"
]
}
]
…
"trackInformation": {
"track": "FASTTRACK"
},
…
}In this case, if terms used belong to Harmonised Database (HDB) and rest of conditions are met the application track will be set as "fast track".
Providing classification in first and second language
The other possible scenario is providing goods and services in both, first and second language. In case we want to provide classification terms in both languages the request body will require the following structure.
{
"firstLanguage": "en",
"secondLanguage": "es",
…
"goodsAndServices": [
{
"language": "en",
"classNumber": 8,
"terms": [
"Tableware [knives, forks and spoons]", "Tableware [knives, forks and spoons]"
]
},
{
"language": "en",
"classNumber": 21,
"terms": [
"Aluminium cookware"
]
},
{
"language": "es",
"classNumber": 8,
"terms": [
"Cubiertos [cuchillos, tenedores y cucharas]"
]
},
{
"language": "es",
"classNumber": 21,
"terms": [
"Artículos de cocina de aluminio"
]
}
]
…
}In this scenario each item will contain its language code. Also, it is important to be sure we are providing translated version for each item. For instance, if we are providing two classifications there will be four items, two for first language and two for second language.
This is an example of the response:
{
"firstLanguage": "en",
"secondLanguage": "es",
…
"goodsAndServices": [
{
"language": "en",
"classNumber": 8,
"terms": [
"Tableware [knives, forks and spoons]", "Tableware [knives, forks and spoons]"
]
},
{
"language": "en",
"classNumber": 21,
"terms": [
"Aluminium cookware"
]
},
{
"language": "es",
"classNumber": 8,
"terms": [
"Cubiertos [cuchillos, tenedores y cucharas]"
]
},
{
"language": "es",
"classNumber": 21,
"terms": [
"Artículos de cocina de aluminio"
]
}
]
…
,
"trackInformation": {
"track": "REGULAR",
"fastTrackIncompatibilities": [
"TRANSLATIONS_PROVIDED_BY_USER"
]
},
…
}Take into account that providing terms in both languages will make the application non eligible for "fast track", and it will set as "regular track". This information can be checked under "trackInformation" property.
Limits on goods and services classification
Good and Services classification terms can only be provided in first and second language. Otherwise, the service will return a error code. Code below shows an example of error response.
{
"type": "/problems/goods-and-services-language-invalid",
"title": "Goods and Services language is not matching application's first or second language",
"detail": "Goods and Service can be only provided for the application's first or second language",
"status": 400,
"instance": "/applications"
}Add or import a registered trade mark as new claim or import it
When filing a new EUTM application, you can make various types of claim based on earlier registrations. You can add a claim to the request either by:
- providing some basic information; or
- by importing the data using the ST.13 application number of a trade mark.
i) Adding a new claim with some basic information
The Add a claim operation is available for these claim types:
- Priority
- Seniority
- International registration transformation
- Exhibition priority
Here is an example for a "Priority" claim.
Endpoint: /eutm-filing/applications
{
...
"priorities": [
{
"countryCode": "ES",
"applicationNumber": "M0004354",
"applicationDate": "2021-05-18"
}
],
...
}The requisite information will differ depending on the type of the claim.
The response will include the provided information with an identifier.
{
...
"priorities": [
{
"identifier": "e2aac082-f03f-4e7b-ad7f-d846a0a4b18c",
"countryCode": "ES",
"applicationNumber": "M0004354",
"applicationDate": "2022-05-18"
}
],
...
}ii) Importing registered trade mark as a claim using St13 identifier
The Importing a claim operation is only available for:
- Priority
- Seniority
- International registration transformation
Below we can see an example of a priority claim introduced by importing a registered trade mark into an EUTM application.
{
...
"priorities": [
{
"st13ApplicationNumber": "DE503020221067064"
}
],
...
}Note: the ST.13 application number and other trade mark information is retrieved from TMview.
The response will include the information about the imported trade mark.
{
...
"priorities": [
{
"identifier": "2e6d65d4-255d-486f-af40-59d409276f88",
"countryCode": "DE",
"applicationNumber": "3020221067064",
"applicationDate": "2022-04-27",
"st13ApplicationNumber": "DE503020221067064"
}
],
...
}Validations
Adding a new claim (whether by providing information or by importing the trade mark data) implies the execution of some validation rules. If there is a blocking rule that is not adhered to, the server will send a ‘bad request’ response. The response will indicate what the error is.
Here is an error response example.
{
"type": "/problems/claim-invalid-period",
"title": "Claim date not in acceptable period",
"detail": "Application date Sun Mar 14 00:00:00 CET 2021 cannot be older than 6 months",
"status": 400,
"instance": "/applications",
"date": "2021-03-14T00:00:00",
"period": "P6M"
}Errors
The EUTM Filing API will send an error message if anything goes wrong with your API calls. When an error occurs, it triggers the message. Every error message includes:
- an HTTP status code;
- the error type;
- a brief explanation of the error.
This documentation provides additional explanation of the possible errors and guidance on how to avoid them.
When you use any API, keep in mind that errors and exceptions (e.g., server connection problems or outages) are rare, but they do happen. To make sure that your integration is as reliable as it can be, you should always watch out for errors and exceptions.
If your API call returns an error, log the call in as much detail as you can. If you need to contact support, we recommend including the complete request you’re trying to make, the error code, and the response you’re receiving. This will mean they can help you as quickly as possible.
Problem format
We display API errors in human-readable messages in JSON format.
{
"type": "/problems/application-not-editable",
"title": "Application not editable",
"detail": "Only applications with status 'DRAFT' can be modified. Current status is 'PAID'",
"status": 400
}
Problem Glossary
This is a list of the known possible issues with the EUTM Filing API.
| Type | Description |
|---|---|
| General | |
| application-representation-text-contains-invalid-character | If representation text contains invalid characters |
| application-representation-text-field-max-size-exceeded | If representation text exceeds the size limit |
| *colour-representation-colour-list-required | If the colour list has not been provided in the colour representation field |
| *colour-representation-invalid-format | If there are colours with the wrong format in the colour representation field |
| application-invalid-personal-reference | If personal reference does not match expected format |
| goods-and-services-language-invalid | If the language used in the goods and services classification is not the first or second language |
| application-unsupported-payment-method | If unsupported payment method is found in payment preferences |
| application-second-language-not-allowed | If the second language is not one of the five official EUIPO languages (DE, EN, ES, FR, IT) |
| application-second-language-same-as-first | If the second language has the same value as the first language |
| application-correspondence-language-inapplicable | If the chosen correspondence language is the second language but the first language is one of the five official EUIPO languages |
| application-signatures-max-number-exceeded | If the number of signatures exceeds the number of applicants |
| application-incomplete | If any of the mandatory fields of the application have not been filled in |
| application-not-editable | If client tries to update the application when its status is not DRAFT |
| application-status-error | If client tries to do something that is not compatible with the current status of the application |
| Attachments | |
| application-attachment-not-found | If the document referred to as attachment cannot be found |
| invalid-maximum-size | If attached document size exceeds the size limit |
| invalid-file-format | If attached document format is not on the list of allowed formats |
| invalid-filename-length | If attached document filename length exceeds the maximum allowed |
| invalid-image-color-model | If attached document colour model is not allowed |
| invalid-image-dimensions | If attached document dimensions exceeds the maximum allowed |
| invalid-image-maximum-dpi | If attached document DPI exceeds the maximum allowed |
| invalid-image-progressive | If attached document uses progressive image format |
| invalid-audio-channels | If attached document exceeds the maximum channel limit or is below the minimum channel limit |
| invalid-audio-sampling-size | If attached document exceeds the maximum sampling size limit or is below the minimum sampling size limit |
| invalid-video-bit-rate | If attached document exceeds the maximum bit rate or is below the minimum bit rate or has not defined the bit rate |
| invalid-video-frame-rate | If attached document exceeds the maximum frame rate or is below the minimum frame rate or has not defined the video frame rate |
| invalid-video-frame-size | If attached document exceeds the maximum resolution allowed or is below the minimum resolution allowed or has not defined the resolution |
| Applicants | |
| application-invalid-applicant | If applicant information does not fulfil defined constraints |
| application-imported-applicant-cannot-be-updated | If client tries to update an applicant added using its person identifier |
| application-duplicated-person | If another applicant with same person identifier is already in applicants collection |
| application-invalid-correspondence-recipient | If applicant is not from EEA, has been set as correspondence recipient and there is already another applicant in applicants collection that belongs to EEA. |
| Representatives | |
| application-invalid-representative | If representative information does not fulfil defined constraints |
| application-imported-representative-cannot-be-updated | If client tries to update a representative added using its person identifier |
| application-duplicated-person | If another representative with same person identifier is already in representatives collection |
| representative-not-valid | If imported representative is in a non-valid status |
| application-nature-economic-connection-not-specified | If representative type is EMPLOYEE and nature of economic connection was not specified |
| application-reference-document-not-specified | If representative type is EMPLOYEE, the requisite evidence of this type of economic connection has not been specified |
| Priorities | |
| application-claim-not-found | If trade mark used as for priority claim is not found |
| application-duplicated-claim | If another priority with same st13ApplicationNumber is already in the application |
| claim-invalid-period | If trade mark application date is in the future or older than 6 months |
| *claim-incomplete | If any of the mandatory fields for the priority claim have not been filled in. |
| Seniorities | |
| application-claim-not-found | If trade mark used for seniority claim is not found |
| claim-invalid-import-status | Seniority status is not valid for import |
| application-duplicated-claim | If another seniority with same st13ApplicationNumber is already in the application |
| claim-invalid-period |
|
| *claim-incomplete | If any of the mandatory fields for the seniority claim have not been filled in |
| claim-invalid-registration-number | If registration number is not valid the country of the trade mark |
| claim-invalid-country-office-code | If the seniority claim has a WIPO country code |
| IR Transformations | |
| application-claim-not-found | If international registration is not found |
| claim-invalid-period | If international registration date of registration is in the future |
| *claim-incomplete | If any of the mandatory fields for the IR transformation request have not been filled in. |