{ "openapi": "3.0.2", "info": { "x-audience": "external-public", "x-api-id": "f7bee785-ecb0-4a7c-a018-644cbff1208c", "version": "1.0.0", "title": "Design Filing", "x-ibm-name": "design-filing", "x-pathalias": "design-filing", "description": "API to create Design applications\n", "contact": { "name": "API Platform Team", "url": "https://dev.euipo.europa.eu", "email": "apiplatform@euipo.europa.eu" }, "termsOfService": "https://euipo.europa.eu/tunnel-web/secure/webdav/guest/document_library/contentPdfs/law_and_practice/decisions_president/EX-22-05_en_annex_I_version_2_en.pdf", "x-ip-domain": [ "Industrial Design" ], "x-service-type": [ "Application Management", "Payment" ], "x-content-type": [ "Bibliographic data", "Classification", "Payment related data" ], "x-product-page-url": "https://dev.euipo.europa.eu/product/design-filing_100", "x-ibm-summary": "" }, "servers": [ { "url": "https://api.euipo.europa.eu/design-filing" } ], "x-ibm-configuration": { "testable": true, "enforced": true, "cors": { "enabled": true }, "phase": "realized", "type": "rest", "oauth-servers": { "Oauth2AuthorizationCode": { "authorizationCode": { "tokenUrls": [ "https://euipo.europa.eu/cas-server-webapp/oidc/accessToken" ], "authorizationUrls": [ "https://euipo.europa.eu/cas-server-webapp/oidc/authorize" ], "refreshUrls": [ "https://euipo.europa.eu/cas-server-webapp/oidc/accessToken" ] } } } }, "tags": [ { "name": "Application" }, { "name": "Payment" }, { "name": "Designer" }, { "name": "Exhibition" } ], "paths": { "/applications": { "post": { "operationId": "createApplication", "summary": "Creates a new application\n", "description": "Validates or submits an application depending on the value of `Application-Validation-Only` header.\n\nIf no headers provided, creation and submission of application will be performed by default.\n\n### Validation of application\nWhen `Application-Validation-Only` header has value `true`, the server executes the validation on the application data, calculates the amount of fees to be charged and the assigned track.\nWhen header has value `false` or it is not specified, the server submits the application.\n\nPost-conditions:\n - Result of validations execution, fee and track calculation is returned.\n\n### Creation and submission of application\nWhen `Application-Validation-Only` header has value `false` or it is not specified, the server executes validations and submits the application.\n\nPreconditions:\n- All mandatory information of application is included.\n- Information included complies with the business rules of an application.\n\nPost-conditions:\n- Application is created and submitted.\n", "tags": [ "Application" ], "security": [ { "ClientID": [], "Oauth2AuthorizationCode": [ "design-filing.application.write" ] } ], "parameters": [ { "in": "header", "name": "Application-Validation-Only", "description": "This header denotes that submitted application is intended for validation only", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "description": "Application information", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationSubmission" }, "examples": { "Create and submit an application": { "$ref": "#/components/examples/CreateAndSubmitAnApplication" } } } } }, "responses": { "200": { "description": "Application validated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationValidationResult" }, "examples": { "Application_validated": { "$ref": "#/components/examples/ApplicationValidationResult" } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "201": { "description": "Application submitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application" }, "examples": { "Application created and submitted": { "$ref": "#/components/examples/SubmittedApplication" } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "429": { "$ref": "#/components/responses/RateLimitError" }, "default": { "$ref": "#/components/responses/DefaultError" } } } }, "/applications/{applicationId}/receipt": { "head": { "operationId": "checkReceipt", "summary": "Checks the existence of an application receipt", "description": "Checks the existence of an application receipt", "tags": [ "Payment" ], "security": [ { "ClientID": [], "Oauth2AuthorizationCode": [ "design-filing.application.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/applicationId" } ], "responses": { "200": { "description": "The receipt for this application exists", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "404": { "description": "The receipt for this application is not yet generated", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "/problems/not-found-error", "title": "Resource not found", "detail": "Application with identifier d9ef7d49-f96e-4c09-adab-ee11b3f09cee not found", "status": 404 } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "429": { "$ref": "#/components/responses/RateLimitError" }, "default": { "$ref": "#/components/responses/DefaultError" } } }, "get": { "operationId": "getReceipt", "summary": "Retrieves application receipt", "description": "Returns application receipt", "tags": [ "Payment" ], "security": [ { "ClientID": [], "Oauth2AuthorizationCode": [ "design-filing.application.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/applicationId" } ], "responses": { "200": { "description": "The requested document", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "404": { "description": "The receipt for this application is not yet generated", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "/problems/not-found-error", "title": "Resource not found", "detail": "Application with identifier d9ef7d49-f96e-4c09-adab-ee11b3f09cee not found", "status": 404 } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "429": { "$ref": "#/components/responses/RateLimitError" }, "default": { "$ref": "#/components/responses/DefaultError" } } } }, "/designers": { "get": { "operationId": "searchDesigners", "summary": "Search for designers", "description": "Search for designers that match the criteria below", "tags": [ "Designer" ], "security": [ { "ClientID": [], "Oauth2AuthorizationCode": [ "design-filing.application.read" ] } ], "parameters": [ { "$ref": "#/components/parameters/DesignerName" } ], "responses": { "200": { "description": "The designers that match the criteria", "content": { "application/json": { "schema": { "type": "object", "properties": { "designers": { "type": "array", "items": { "$ref": "#/components/schemas/DesignerSearchResult" } } } }, "examples": { "List of designers": { "$ref": "#/components/examples/DesignerList" } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "429": { "$ref": "#/components/responses/RateLimitError" }, "default": { "$ref": "#/components/responses/DefaultError" } } } }, "/exhibitions": { "get": { "operationId": "searchExhibitions", "summary": "Search for exhibitions", "description": "Search for exhibitions", "tags": [ "Exhibition" ], "security": [ { "ClientID": [], "Oauth2AuthorizationCode": [ "design-filing.application.read" ] } ], "responses": { "200": { "description": "The exhibitions", "content": { "application/json": { "schema": { "type": "object", "properties": { "exhibitions": { "type": "array", "items": { "$ref": "#/components/schemas/Exhibition" }, "description": "List of exhibition events" } } }, "examples": { "List of exhibitions": { "$ref": "#/components/examples/ExhibitionList" } } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "429": { "$ref": "#/components/responses/RateLimitError" }, "default": { "$ref": "#/components/responses/DefaultError" } } } } }, "components": { "securitySchemes": { "ClientID": { "type": "apiKey", "in": "header", "name": "X-IBM-Client-Id" }, "Oauth2AuthorizationCode": { "type": "oauth2", "description": "- **Authorization Code Flow:** This flow involves the identification of the final user.\n", "flows": { "authorizationCode": { "authorizationUrl": "https://euipo.europa.eu/cas-server-webapp/oidc/authorize", "tokenUrl": "https://euipo.europa.eu/cas-server-webapp/oidc/accessToken", "refreshUrl": "https://euipo.europa.eu/cas-server-webapp/oidc/accessToken", "scopes": { "design-filing.application.read": "Grants read access to design applications", "design-filing.application.write": "Grants write access to design applications" } } }, "x-ibm-oauth-provider": "production-oauth" } }, "headers": { "X-RateLimit-Limit": { "schema": { "type": "integer" }, "description": "The maximum number of requests you're permitted to make per time period." }, "X-RateLimit-Remaining": { "schema": { "type": "integer" }, "description": "The number of requests remaining in the current rate limit window." }, "X-RateLimit-Reset": { "schema": { "type": "integer" }, "description": "The relative time in seconds until the current rate-limit window resets.\n" }, "Retry-After": { "schema": { "type": "integer" }, "description": "The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached." } }, "responses": { "BadRequestError": { "description": "Bad request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "/problems/input-validation-error", "title": "Input validation error", "status": 400 } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "UnauthorizedError": { "x-summary": "Unauthorized", "description": "Client request has not been completed because it lacks valid authentication credentials for the requested resource", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "/problems/unauthorized", "title": "The request lacks valid authentication credentials for this resource", "detail": "Full authentication is required to access this resource", "status": 401 } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "RateLimitError": { "description": "Rate Limit Exceeded", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "/problems/too-many-requests", "title": "Too Many Requests", "detail": "Rate Limit exceeded", "status": 429 } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } }, "DefaultError": { "x-summary": "Unexpected error", "description": "Error occurred - see status code and problem object for more information.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "/problems/general-error", "title": "General error", "status": 500 } } }, "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } } } }, "schemas": { "ApplicationExcerpt": { "type": "object", "properties": { "identifier": { "$ref": "#/components/schemas/ApplicationIdentifier" }, "reference": { "$ref": "#/components/schemas/Reference" }, "applicationNumber": { "$ref": "#/components/schemas/ApplicationNumber" }, "personalReference": { "$ref": "#/components/schemas/PersonalReference" }, "firstLanguage": { "$ref": "#/components/schemas/EUOfficialLanguage" }, "secondLanguage": { "$ref": "#/components/schemas/EUIPOOfficialLanguage" }, "correspondenceInSecondLanguageIndicator": { "type": "boolean", "default": false, "description": "If flagged, all correspondence for this application will be in the 2nd\nlanguage. Correspondence in second language is possible only if first\nlanguage is not one of the five EUIPO official ones.\n" }, "signatures": { "$ref": "#/components/schemas/SignatureList" }, "paymentPreferences": { "$ref": "#/components/schemas/PaymentPreferences" }, "payment": { "$ref": "#/components/schemas/Payment" }, "fees": { "$ref": "#/components/schemas/FeeList" }, "submissionDate": { "type": "string", "format": "date-time", "readOnly": true, "description": "Date in which the application was submitted to the Office" }, "status": { "$ref": "#/components/schemas/Status" }, "createdBy": { "$ref": "#/components/schemas/Username" }, "creationDate": { "type": "string", "format": "date-time", "readOnly": true, "description": "Date in which the application was created" }, "updateDate": { "type": "string", "format": "date-time", "readOnly": true, "description": "Date in which the application was updated" }, "trackInformation": { "$ref": "#/components/schemas/TrackInformation" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationResult" }, "readOnly": true, "description": "List of warnings on the application data that server may return when application is validated\n" }, "clientId": { "$ref": "#/components/schemas/ClientId" }, "errorDetails": { "type": "string", "readOnly": true } } }, "ApplicationSubmission": { "allOf": [ { "$ref": "#/components/schemas/ApplicationExcerpt" }, { "type": "object", "properties": { "designs": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/DesignUpdate" } ], "required": [ "views", "productIndications" ] } }, "applicants": { "$ref": "#/components/schemas/ApplicantListNew" }, "representatives": { "$ref": "#/components/schemas/RepresentativeListNew" } } } ], "required": [ "designs", "applicants", "firstLanguage", "signatures", "paymentPreferences" ] }, "Application": { "allOf": [ { "$ref": "#/components/schemas/ApplicationExcerpt" }, { "type": "object", "properties": { "designs": { "type": "array", "items": { "$ref": "#/components/schemas/Design" }, "minItems": 1, "maxItems": 100, "description": "List of designs included in the application" }, "applicants": { "$ref": "#/components/schemas/ApplicantList" }, "representatives": { "$ref": "#/components/schemas/RepresentativeList" } } } ], "required": [ "identifier", "reference", "firstLanguage", "fees", "status", "createdBy", "creationDate", "updateDate", "trackInformation" ] }, "DesignerReference": { "type": "object", "properties": { "designerIdentifier": { "type": "string", "description": "Public identifier of the designer" } }, "required": [ "designerIdentifier" ] }, "Designer": { "type": "object", "properties": { "identifier": { "type": "string", "format": "uuid", "readOnly": true, "description": "Identifier of the designer in the context of the application" }, "designerIdentifier": { "type": "string", "readOnly": true, "description": "Public identifier of the designer" }, "name": { "type": "string", "maxLength": 100, "description": "The designer's full name (first name and surnames)" } }, "required": [ "identifier", "name" ] }, "DesignerSearchResult": { "type": "object", "properties": { "designerIdentifier": { "type": "string", "readOnly": true, "description": "Public identifier of the designer" }, "name": { "type": "string", "maxLength": 100, "description": "The designer's full name (first name and surnames)" } }, "required": [ "designerIdentifier", "name" ] }, "DesignExcerpt": { "type": "object", "description": "Design common properties", "properties": { "identifier": { "type": "string", "format": "uuid", "readOnly": true, "description": "Identifier of the design in the context of the application" }, "personalReference": { "$ref": "#/components/schemas/PersonalReference" }, "views": { "type": "array", "items": { "type": "string" }, "description": "Views to represent the design\n\nYou can upload up to 7 protected images and additionally up to 3 unprotected images.\n\nThe unprotected images: can be considered filed and therefore form part of a priority claim in a subsequent application; may serve to explain the design, which may assist the examiner in the assessment of the protected images\nThe order of the protected views does not have any effect on the design protection. However, the first view is usually the one shown in a list of search results. (see eSearch and DesignView).\n\nSupported file type is JPG\n\nThe attachment must meet some technical requirements as explained at \n[Technical requirements for attachments to electronic filing and communication](https://www.euipo.europa.eu/en/the-office/help-centre/technical-information/faq-attachments) \nunder **\"Registered Community design e filing\"** section.\n", "minItems": 1, "maxItems": 10, "example": [ "ee45ddd5-5ab2-4f45-a484-88573c5e94b9", "377a6867-35c3-4294-bb88-67ef177dd1ac" ] }, "model": { "type": "string", "format": "uuid", "description": "3D Model attached to the design for additional information and as a source for the static images (views).\n\nSupported file types are OBJ, STL and X3D\n\nThe attachment must meet some technical requirements as explained at \n[Technical requirements for attachments to electronic filing and communication](https://www.euipo.europa.eu/en/the-office/help-centre/technical-information/faq-attachments) \nunder **\"Registered Community design e filing\"** section.\n" }, "description": { "type": "string", "description": "Explanation or details related to the design to help understanding the design concept.", "maxLength": 100 }, "productIndications": { "type": "array", "items": { "$ref": "#/components/schemas/ProductIndication" }, "description": "An application for a Design must indicate the products in which the design is intended to be incorporated or\nto which it is intended to be applied. The indication of products must be worded in such a way as to indicate \nclearly the nature of the products and to enable each product to be classified in only one class of the \nLocarno Classification, preferably using the terms appearing in the list of products set out therein, or in \nDesignClass.\n", "externalDocs": { "description": "More information on Product Indications", "url": "https://euipo.europa.eu/designclass/" } }, "claimPriorityLaterIndicator": { "type": "boolean", "default": false, "description": "If `true`, you indicate that you want to claim priority at a later date (this can be done up to one month after the application date)\n\nThis property and `priorities` property are mutually auto-exclusive\n" }, "exhibitionPriorities": { "type": "array", "items": { "$ref": "#/components/schemas/ExhibitionPriority" }, "description": "The effect of exhibition priority is that the date on which the design was displayed at an officially \nrecognised exhibition is deemed to be the date of filing of the application for an RCD for the purposes of \nArticles 5, 6, 7 and 22, Article 25(1)(d) and Article 50(1) CDR (Article 43 CDR).\n\nThe applicant can claim exhibition priority within 6 months of the first display. Evidence of the display \nmust be filed (Article 44(1) and (2) CDR).\n\nExhibition priority cannot extend the 6-month Convention priority period (Article 44(3) CDR).\n\nOnly a very small number of exhibitions, in particular world exhibitions, fall under this provision.\n", "externalDocs": { "description": "For more information, visit the Bureau International des Expositions (BIE).", "url": "https://www.bie-paris.org/site/en" } }, "claimExhibitionPriorityLaterIndicator": { "type": "boolean", "default": false, "description": "If `true`, you indicate that exhibition priority will be claim at a later date (this can be done up to one month after the application date)\n\nThis property and `exhibitionPriorities` property are mutually auto-exclusive\n" }, "claimWipoDasIndicator": { "type": "boolean", "default": true, "description": "If `true`, you indicate that you want to use the WIPO DAS system to exchange priority documents for this Community design.", "externalDocs": { "description": "For more information, visit WIPO Digital Access Service (WIPO DAS) page.", "url": "https://www.wipo.int/das/en/" } }, "wipoDasCode": { "type": "string", "readOnly": true, "description": "Code generated to register this design in WIPO DAS system as a priority document to be used future applications", "externalDocs": { "description": "For more information, visit WIPO Digital Access Service (WIPO DAS) page.", "url": "https://www.wipo.int/das/en/" } }, "designerWaiverIndicator": { "type": "boolean", "default": false, "description": "If `true`, it indicates that the designer(s) has/have waived the right to be cited\n\nThis property and `designers` property are mutually auto-exclusive\n" }, "publicationDefermentIndicator": { "type": "boolean", "default": false, "description": "If `true`, the Publication will be delayed for up to 30 months. The design will therefore be kept confidential until you are ready to disclose it. \nShould you choose not to publish the RCD at all, the registration will lapse after the 30-month deferment period.\n" }, "publicationAfterDefermentPeriodIndicator": { "type": "boolean", "default": false, "description": "If `true`: \n- The Publication Fee will be charged together with the Deferment Fee when submitting this application. \nThe Publication Fee will not be refunded if you finally decide not to publish. \n- The Office will proceed with the publication of the design(s) at the end of the deferment period, \nunless the design(s) is (are) surrendered or published earlier.\n" }, "fees": { "allOf": [ { "$ref": "#/components/schemas/FeeList" } ], "description": "Fees that will be charged once the application is submitted for this design.\n" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationResult" }, "readOnly": true, "description": "List of warnings on the design data that server may return when design is validated\n" } } }, "DesignUpdate": { "allOf": [ { "$ref": "#/components/schemas/DesignExcerpt" }, { "type": "object", "properties": { "priorities": { "$ref": "#/components/schemas/PriorityListUpdate" }, "designers": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/DesignerReference" }, { "$ref": "#/components/schemas/Designer" } ] }, "description": "List of persons that should appear as designers of the design.\n\nYou can reference designers whose name already appears in EUIPO's database using their designer identifier\nor if the designer does not appear in EUIPO's database, add a new designer providing the designer's full name\n" } } } ] }, "Design": { "allOf": [ { "$ref": "#/components/schemas/DesignExcerpt" }, { "type": "object", "properties": { "priorities": { "allOf": [ { "$ref": "#/components/schemas/PriorityList" } ], "description": "List of priorities" }, "designers": { "type": "array", "items": { "$ref": "#/components/schemas/Designer" }, "description": "List of persons that should appear as designers of the design." } } } ], "required": [ "identifier", "fees" ] }, "ProductIndication": { "type": "object", "description": "Product indications", "properties": { "classNumber": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 32 }, "subClassNumber": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 99 }, "terms": { "type": "array", "items": { "type": "string" }, "minItems": 1 } }, "required": [ "classNumber", "subClassNumber", "terms" ] }, "ApplicantList": { "type": "array", "items": { "$ref": "#/components/schemas/Applicant" }, "minItems": 1, "description": "List of persons that apply for the registration of the design" }, "ApplicantListNew": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicantNew" }, "minItems": 1, "description": "List of persons that apply for the registration of the design.\n\nIf the user is an applicant and she is not included in the list, she is automatically added as the first element.\n" }, "Applicant": { "oneOf": [ { "$ref": "#/components/schemas/ApplicantBusiness" }, { "$ref": "#/components/schemas/ApplicantIndividual" } ], "discriminator": { "propertyName": "type", "mapping": { "APPLICANT_BUSINESS": "#/components/schemas/ApplicantBusiness", "APPLICANT_INDIVIDUAL": "#/components/schemas/ApplicantIndividual" } } }, "ApplicantNew": { "oneOf": [ { "$ref": "#/components/schemas/ApplicantBusiness" }, { "$ref": "#/components/schemas/ApplicantIndividual" }, { "$ref": "#/components/schemas/ApplicantReference" } ], "discriminator": { "propertyName": "type", "mapping": { "APPLICANT_BUSINESS": "#/components/schemas/ApplicantBusiness", "APPLICANT_INDIVIDUAL": "#/components/schemas/ApplicantIndividual", "REFERENCE": "#/components/schemas/ApplicantReference" } } }, "ApplicantExcerpt": { "type": "object", "properties": { "identifier": { "type": "string", "format": "uuid", "readOnly": true, "description": "Unique identifier of this applicant in the current application" }, "personIdentifier": { "type": "string", "readOnly": true, "description": "Unique identifier given by EUIPO to persons that intervened in\nprocedures before the Office\n" }, "type": { "allOf": [ { "$ref": "#/components/schemas/ApplicantType" } ], "description": "Applicant type" }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Legal address" }, "correspondenceAddress": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Correspondence address in case it's different from legal address.\nIf applicant domicile belongs to EEA(European Economic Area), then correspondence country must belong to EEA.\nIf applicant domicile is out of EEA, correspondence country list will be out of EEA.\n" }, "phone": { "type": "string", "description": "Phone number including area code. e.g.: +358400123456", "example": 358400123456 }, "email": { "type": "string", "format": "email", "description": "E-mail address" }, "userToLink": { "type": "string", "readOnly": true, "example": "johndoe", "description": "Website user to which the new applicant must be linked. The application is automatically linked to \nthe creator either the applicant or the representative depending on the user kind.\n" }, "correspondenceRecipient": { "type": "boolean", "default": false, "description": "If `true`, the applicant is selected as the correspondence recipients for all the communications \nfrom the Office related to this application.\n\nThe first applicant is always considered the correspondence recipient by default.\n" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationResult" }, "readOnly": true, "description": "List of warnings on the applicant data that server may return when applicant is added to the application\n" } }, "required": [ "identifier", "type" ] }, "ApplicantBusiness": { "allOf": [ { "$ref": "#/components/schemas/ApplicantBusinessPatch" } ], "required": [ "identifier", "type", "legalName", "countryOfIncorporation", "address", "sectorOfActivity", "companySize" ] }, "ApplicantBusinessPatch": { "allOf": [ { "$ref": "#/components/schemas/ApplicantExcerpt" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "APPLICANT_BUSINESS" ], "description": "Applicant type" }, "legalName": { "type": "string", "maxLength": 350, "description": "Name of the company" }, "legalForm": { "type": "string", "maxLength": 250, "description": "Legal form used by the company. It may differ per country." }, "legalFormDocument": { "type": "string", "format": "uuid", "description": "Document certifying the legal form of the company" }, "nationalIdentification": { "type": "string", "maxLength": 20, "description": "Company’s national identification" }, "countryOfIncorporation": { "allOf": [ { "$ref": "#/components/schemas/Country" } ], "description": "Nationality of the company" }, "stateOfIncorporation": { "type": "string", "format": "iso-3166-2", "description": "State, District, or Territory of incorporation (For US applicants)" }, "sectorOfActivity": { "type": "string", "enum": [ "NA", "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U" ], "description": "Company's Sector of activity:\n- A. Agriculture, forestry and fishing\n- B. Mining and quarrying\n- C. Manufacturing\n- D. Electricity, gas, steam and air conditioning supply\n- E. Water supply; sewerage; waste management and remediation\nactivities\n- F. Construction\n- G. Wholesale and retail trade; repair of motor vehicles and\nmotorcycles\n- H. Transporting and storage\n- I. Accommodation and food service activities\n- J. Information and communication\n- K. Financial and insurance activities\n- L. Real estate activities\n- M. Professional, scientific and technical activities\n- N. Administrative and support service activities\n- O. Public administration and defence; compulsory social security\n- P. Education\n- Q. Human health and social work activities\n- R. Arts, entertainment and recreation\n- S. Other services activities\n- T. Activities of households as employers; undifferentiated goods-\nand services-producing activities of households for own use\n- U. Activities of extraterritorial organisations and bodies\n\n*This information about your legal entity will be collected to produce statistics, enabling the Office \nto optimise its operations. In particular, processing it aims to ensure advanced customer-centric \nservices are provided, which are set out in strategic driver 2 of the EUIPO Strategic Plan 2025. \nThis information will not be made publicly available.*\n" }, "companySize": { "type": "string", "enum": [ "Micro", "Small", "Medium", "Large" ], "description": "Size of the company\n\n *This information about your legal entity will be collected to produce statistics, enabling the Office \nto optimise its operations. In particular, processing it aims to ensure advanced customer-centric \nservices are provided, which are set out in strategic driver 2 of the EUIPO Strategic Plan 2025. \nThis information will not be made publicly available.*\n" } } } ] }, "ApplicantIndividual": { "allOf": [ { "$ref": "#/components/schemas/ApplicantIndividualPatch" } ], "required": [ "identifier", "type", "firstName", "surname", "nationality", "address" ] }, "ApplicantIndividualPatch": { "allOf": [ { "$ref": "#/components/schemas/ApplicantExcerpt" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "APPLICANT_INDIVIDUAL" ], "description": "Applicant type" }, "firstName": { "type": "string", "maxLength": 260, "description": "First name of the natural person" }, "surname": { "type": "string", "maxLength": 260, "description": "Surname of the natural person" }, "nationality": { "allOf": [ { "$ref": "#/components/schemas/Country" } ], "description": "Nationality of the natural person" } } } ] }, "ApplicantReference": { "type": "object", "properties": { "identifier": { "type": "string", "format": "uuid", "readOnly": true, "description": "Unique identifier of this applicant in the current application" }, "type": { "type": "string", "enum": [ "REFERENCE" ], "description": "Applicant type" }, "personIdentifier": { "type": "string", "description": "Unique identifier given by EUIPO to persons that intervened in procedures before the Office\n" } }, "required": [ "identifier", "personIdentifier", "type" ] }, "ApplicantType": { "type": "string", "enum": [ "APPLICANT_BUSINESS", "APPLICANT_INDIVIDUAL", "REFERENCE" ] }, "RepresentativeList": { "type": "array", "items": { "$ref": "#/components/schemas/Representative" }, "maxItems": 1, "description": "List of persons that represent the applicants" }, "RepresentativeListNew": { "type": "array", "items": { "$ref": "#/components/schemas/RepresentativeNew" }, "maxItems": 1, "description": "List of persons that represent the applicants\n\nIf the user is a representative and she is not included in the list, she is automatically added as the first element.\n" }, "Representative": { "oneOf": [ { "$ref": "#/components/schemas/RepresentativeEmployee" }, { "$ref": "#/components/schemas/RepresentativeLegalAssociation" }, { "$ref": "#/components/schemas/RepresentativeLegalProfessional" }, { "$ref": "#/components/schemas/RepresentativeEUIPOProfessional" } ], "discriminator": { "propertyName": "type", "mapping": { "REPRESENTATIVE_EMPLOYEE": "#/components/schemas/RepresentativeEmployee", "REPRESENTATIVE_LEGAL_ASSOCIATION": "#/components/schemas/RepresentativeLegalAssociation", "REPRESENTATIVE_LEGAL_PROFESSIONAL": "#/components/schemas/RepresentativeLegalProfessional", "REPRESENTATIVE_EUIPO_PROFESSIONAL": "#/components/schemas/RepresentativeEUIPOProfessional" } } }, "RepresentativeNew": { "oneOf": [ { "$ref": "#/components/schemas/RepresentativeEmployee" }, { "$ref": "#/components/schemas/RepresentativeLegalAssociation" }, { "$ref": "#/components/schemas/RepresentativeLegalProfessional" }, { "$ref": "#/components/schemas/RepresentativeEUIPOProfessional" }, { "$ref": "#/components/schemas/RepresentativeReference" } ], "discriminator": { "propertyName": "type", "mapping": { "REPRESENTATIVE_EMPLOYEE": "#/components/schemas/RepresentativeEmployee", "REPRESENTATIVE_LEGAL_ASSOCIATION": "#/components/schemas/RepresentativeLegalAssociation", "REPRESENTATIVE_LEGAL_PROFESSIONAL": "#/components/schemas/RepresentativeLegalProfessional", "REPRESENTATIVE_EUIPO_PROFESSIONAL": "#/components/schemas/RepresentativeEUIPOProfessional", "REFERENCE": "#/components/schemas/RepresentativeReference" } } }, "RepresentativeExcerpt": { "description": "Representative common properties", "type": "object", "properties": { "identifier": { "type": "string", "format": "uuid", "readOnly": true, "description": "Unique identifier of this representative in the current application" }, "personIdentifier": { "type": "string", "readOnly": true, "description": "Unique identifier given by EUIPO to persons that intervened in procedures before the Office\n" }, "type": { "allOf": [ { "$ref": "#/components/schemas/RepresentativeType" } ], "description": "Representative type" }, "address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Representative legal address" }, "correspondenceAddress": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Correspondence address in case it's different from legal address.\n" }, "phone": { "type": "string", "description": "Phone number including area code" }, "email": { "type": "string", "format": "email", "description": "E-mail address" }, "userToLink": { "type": "string", "readOnly": true, "example": "johndoe", "description": "Website user to which the new applicant must be linked. The application is automatically linked to \nthe creator either the applicant or the representative depending on the user kind.\n" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationResult" }, "readOnly": true, "description": "List of warnings on the representative data that server may return when representative is added to the application\n" } }, "required": [ "identifier", "type" ] }, "RepresentativeEmployee": { "allOf": [ { "$ref": "#/components/schemas/RepresentativeEmployeePatch" } ], "required": [ "identifier", "type", "firstName", "surname", "nationality", "economicConnections", "email" ] }, "RepresentativeEmployeePatch": { "description": "Employee representative", "allOf": [ { "$ref": "#/components/schemas/RepresentativeExcerpt" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "REPRESENTATIVE_EMPLOYEE" ], "description": "Representative type" }, "firstName": { "type": "string", "maxLength": 260, "description": "First name of the employee" }, "surname": { "type": "string", "maxLength": 260, "description": "Surname of the employee" }, "nationality": { "allOf": [ { "$ref": "#/components/schemas/Country" } ], "description": "Nationality of the employee" }, "economicConnections": { "type": "array", "items": { "$ref": "#/components/schemas/EconomicConnection" } } } } ] }, "EconomicConnection": { "type": "object", "properties": { "personIdentifier": { "type": "string" }, "employerName": { "type": "string" }, "mainEmployer": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/EconomicConnectionType" }, "natureOfEconomicConnection": { "type": "string", "description": "Type of economic connection between the applicant and the employee representative\n\nRequired when type is `OTHER`\n" }, "proofOfEconomicConnectionDocument": { "type": "string", "format": "uuid", "description": "Proof of economic connection\n\nSupported file types are JPEG and PDF.\n\nRequired when type is different from `EMPLOYEE_REPRESENTATIVE_WORKS_DIRECTLY_FOR_THE_APPLICANT`\n" }, "authorisationDocument": { "type": "string", "format": "uuid", "description": "Employees acting on behalf of natural or legal persons must file a signed authorisation for insertion in the files\n\nSupported file types are JPEG and PDF.\n" } }, "required": [ "type", "authorisationDocument" ] }, "EconomicConnectionType": { "type": "string", "enum": [ "EMPLOYEE_REPRESENTATIVE_WORKS_DIRECTLY_FOR_THE_APPLICANT", "EMPLOYEE_REPRESENTATIVE_WORKS_FOR_A_SUBSIDIARY_OF_THE_APPLICANT", "EMPLOYEE_REPRESENTATIVE_WORKS_FOR_A_BRANCH_OF_THE_APPLICANT", "EMPLOYEE_REPRESENTATIVE_WORKS_FOR_A_PARENT_COMPANY_OF_THE_APPLICANT", "OTHER" ], "description": "Economic connection between the applicant and the employee representative" }, "RepresentativeLegalAssociation": { "allOf": [ { "$ref": "#/components/schemas/RepresentativeLegalAssociationPatch" } ], "required": [ "identifier", "type", "associationName", "address", "email", "countryOfRegistration", "members" ] }, "RepresentativeLegalAssociationPatch": { "description": "Representative association", "allOf": [ { "$ref": "#/components/schemas/RepresentativeExcerpt" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "REPRESENTATIVE_LEGAL_ASSOCIATION" ], "description": "Applicant type" }, "associationName": { "type": "string", "maxLength": 260, "description": "Name of the association" }, "countryOfRegistration": { "allOf": [ { "$ref": "#/components/schemas/Country" } ], "description": "Nationality of the association" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/RepresentativeReference" }, "minItems": 2, "description": "Members of the Association" } } } ] }, "RepresentativeLegalProfessional": { "description": "Legal practitioner representative", "allOf": [ { "$ref": "#/components/schemas/RepresentativeExcerpt" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "REPRESENTATIVE_LEGAL_PROFESSIONAL" ], "description": "Representative type" }, "firstName": { "type": "string", "maxLength": 260, "description": "First name of the legal practitioner" }, "surname": { "type": "string", "maxLength": 260, "description": "Surname of the legal practitioner" }, "nationality": { "allOf": [ { "$ref": "#/components/schemas/Country" } ], "description": "Nationality of the legal practitioner" }, "officialCollegeId": { "type": "string", "maxLength": 260, "description": "ID of the Official college" }, "officialCollegeCountry": { "allOf": [ { "$ref": "#/components/schemas/Country" } ], "description": "Country where official college is seated" } } } ], "required": [ "identifier", "type", "firstName", "surname", "nationality", "address" ] }, "RepresentativeEUIPOProfessional": { "allOf": [ { "$ref": "#/components/schemas/RepresentativeEUIPOProfessionalPatch" } ], "required": [ "identifier", "type", "firstName", "surname", "nationality", "address", "email" ] }, "RepresentativeEUIPOProfessionalPatch": { "description": "Professional design representative before the EUIPO", "allOf": [ { "$ref": "#/components/schemas/RepresentativeExcerpt" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "REPRESENTATIVE_EUIPO_PROFESSIONAL" ], "description": "Representative type" }, "firstName": { "type": "string", "maxLength": 260, "description": "First name of the representative" }, "surname": { "type": "string", "maxLength": 260, "description": "Surname of the representative" }, "nationality": { "allOf": [ { "$ref": "#/components/schemas/Country" } ], "description": "Nationality of the representative" } } } ] }, "RepresentativeReference": { "type": "object", "properties": { "identifier": { "type": "string", "format": "uuid", "readOnly": true }, "type": { "type": "string", "enum": [ "REFERENCE" ], "description": "Representative type" }, "personIdentifier": { "type": "string", "description": "Unique identifier given by EUIPO to persons that intervened in\nprocedures before the Office\n", "example": "1045" }, "comment": { "type": "string", "description": "Comment" }, "userToLink": { "type": "string", "readOnly": true, "example": "johndoe" } }, "required": [ "personIdentifier", "type" ], "description": "Reference to a representative already registered at EUIPO in previous\nproceedings\n" }, "RepresentativeType": { "type": "string", "enum": [ "REPRESENTATIVE_EMPLOYEE", "REPRESENTATIVE_LEGAL_ASSOCIATION", "REPRESENTATIVE_LEGAL_PROFESSIONAL", "REPRESENTATIVE_EUIPO_PROFESSIONAL", "REFERENCE" ], "description": "Representative type" }, "ValidationResult": { "type": "object", "properties": { "type": { "type": "string", "format": "uri-reference", "description": "A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.\n", "default": "about:blank", "example": "/some/uri-reference" }, "title": { "type": "string", "description": "A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.\n", "example": "some title for the error situation" }, "detail": { "type": "string", "description": "A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.\n", "example": "some description for the error situation" } }, "additionalProperties": true }, "Address": { "type": "object", "properties": { "street": { "type": "string", "maxLength": 500, "description": "Street and Number of Address" }, "city": { "type": "string", "maxLength": 100, "description": "City of Address" }, "postalCode": { "type": "string", "pattern": "[a-zA-Z0-9]{1,10}", "maxLength": 10, "description": "Postal Code of Address" }, "state": { "type": "string", "format": "iso-3166-2", "description": "State or County where the applicant is allocated in case country is\nUS (Unites States), GB (Great Britain), IN (India), CA (Canada), BR\n(Brazil), MX (Mexico), AU (Australia), or IE (Ireland)\n" }, "country": { "allOf": [ { "$ref": "#/components/schemas/Country" } ], "description": "Country of Address" }, "formattedAddress": { "type": "string", "readOnly": true, "description": "Postal address whose format may vary depending on the country" } }, "required": [ "street", "city", "country" ], "description": "Address information" }, "SignatureList": { "type": "array", "items": { "$ref": "#/components/schemas/Signature" }, "minItems": 1, "description": "Persons signing the application. Max. number of signatures allowed in an\napplication are up to number of applicants.\n" }, "Signature": { "type": "object", "properties": { "firstName": { "type": "string", "maxLength": 250, "description": "First name of the person signing the application" }, "lastName": { "type": "string", "maxLength": 250, "description": "Last name of the person signing the application" }, "capacity": { "$ref": "#/components/schemas/Capacity" } }, "required": [ "firstName", "lastName", "capacity" ] }, "Capacity": { "type": "string", "enum": [ "APPLICANT", "EMPLOYEE_REPRESENTATIVE", "LEGAL_PRACTITIONER", "PROFESSIONAL_PRACTITIONER" ] }, "Payment": { "description": "Payment information", "type": "object", "properties": { "identifier": { "type": "string", "readOnly": true, "description": "Unique identifier of the payment", "example": "23CG7RC7" }, "paymentDate": { "type": "string", "format": "date-time", "readOnly": true, "description": "Payment date" } }, "readOnly": true, "required": [ "identifier", "paymentDate" ] }, "PaymentPreferences": { "type": "object", "description": "Payment preferences of the applicant", "properties": { "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" }, "account": { "$ref": "#/components/schemas/Account" } }, "required": [ "paymentMethod" ] }, "Account": { "type": "object", "description": "EUIPO current account. It must be specified when selected\n`CURRENT_ACCOUNT` as payment method.\n", "properties": { "identifier": { "type": "string", "description": "EUIPO current account identifier" }, "debitType": { "$ref": "#/components/schemas/DebitType" } }, "externalDocs": { "description": "For more information, visit the \"Current account\" FAQ page.\n", "url": "https://www.euipo.europa.eu/en/the-office/help-centre/user-area/faq-current-account" } }, "DebitType": { "type": "string", "enum": [ "DEBIT_NOW", "DEBIT_LATER" ], "description": "Type of debit for payments by current account" }, "Priority": { "type": "object", "properties": { "identifier": { "type": "string", "format": "uuid", "readOnly": true, "description": "Unique identifier of this claim in the current application" }, "country": { "allOf": [ { "$ref": "#/components/schemas/ExtendedCountry" } ], "description": "Country of first filing" }, "applicationNumber": { "type": "string", "description": "Filing number given by the Office of first filing" }, "applicationDate": { "type": "string", "format": "date", "description": "Filing date in which the design to be claimed was filed" }, "copyFirstFilingDocument": { "type": "string", "format": "uuid", "description": "Copy of first filing\n\nSupported file types are JPEG and PDF.\n" }, "translationFirstFilingDocument": { "type": "string", "format": "uuid", "description": "The first filing must be translated into the first or second language specified in your application \n(only if the certificate is not in an official EU language).\n\nSupported file types are JPEG and PDF.\n" }, "transferAssignmentDocument": { "type": "string", "format": "uuid", "description": "Document that proofs the transfer of the design. \n\nThe content of the attachment will not be checked nor examined by the examiner. The attachment will only \nserve for recording purposes\n\nSupported file types are JPEG and PDF.\n" }, "st13ApplicationNumber": { "type": "string", "description": "ST13 Application Number" }, "wipoDasCode": { "type": "string", "description": "wipo code" } }, "required": [ "identifier", "country", "applicationDate", "applicationNumber" ] }, "PriorityDASCodeReference": { "description": "Claim a previous registered Design using WIPO DAS system to retrieve documentation from the first filing Office.", "properties": { "identifier": { "type": "string", "format": "uuid", "readOnly": true, "description": "Unique identifier of this claim in the current application" }, "country": { "allOf": [ { "$ref": "#/components/schemas/ExtendedCountry" } ], "description": "Country of first filing" }, "applicationDate": { "type": "string", "format": "date", "description": "The priority filing date" }, "applicationNumber": { "type": "string", "description": "Filing number given by the Office of first filing" }, "wipoDasCode": { "type": "string", "description": "Code provided by WIPO DAS to the first filing Office when the priority document was registered" } }, "required": [ "identifier", "country", "applicationDate", "applicationNumber", "wipoDasCode" ] }, "PrioritySt13Reference": { "description": "Import Priority from TMView database using its ST13 Application number", "type": "object", "properties": { "st13ApplicationNumber": { "type": "string", "description": "WIPO ST.13 Application Number" } }, "required": [ "st13ApplicationNumber" ] }, "PriorityListUpdate": { "description": "Priority may be claimed of one or more previous design applications, namely a national (or Benelux) application \nfiled in or for a State party to the Paris Convention, a member of the WTO, a State for which the Commission has \nconfirmed reciprocity, or an EU design application.\n\nThe ‘convention priority’ right is a right limited in time, which is triggered by the first regular filing of a \ndesign. A regular national application is sufficient to establish the date on which the application was filed in\nthe country concerned, whatever the subsequent fate may be of the application (Article 4(3) of the Paris Convention). \n\nIt may be claimed during the 6 months following the first filing.\n\nPriority claims must be filed together with the EU design application or in a separate communication filed on \nthe same date as the Design application.\n", "externalDocs": { "description": "Further details on the principles and formalities of ‘convention priority’ claims can be found in the Guidelines, \nPart B, Examination, Section 2, Formalities, paragraph 11, (Convention) Priority.\n", "url": "https://euipo.europa.eu/tunnel-web/secure/webdav/guest/document_library/contentPdfs/law_and_practice/trade_marks_practice_manual/WP_2_2017/Part-B/02-part_b_examination_section_2_formalities/part_b_examination_section_2_formalities_en.pdf" }, "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/PriorityDASCodeReference" }, { "$ref": "#/components/schemas/PrioritySt13Reference" }, { "$ref": "#/components/schemas/Priority" } ] } }, "PriorityList": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/PriorityDASCodeReference" }, { "$ref": "#/components/schemas/Priority" } ] } }, "ExhibitionPriority": { "type": "object", "description": "Only a very small number of exhibitions, in particular world exhibitions, fall under this provision. More information in: https://www.bie-paris.org/site/en\n", "properties": { "identifier": { "type": "string", "readOnly": true, "description": "Unique identifier of this claim in the current application" }, "code": { "type": "string", "example": "exhibition.doha" }, "name": { "type": "string", "description": "Name of exhibition in which the design was exhibited", "example": "Expo 2023 Doha" }, "firstDisplayDate": { "type": "string", "format": "date", "description": "Date of first disclosure. Acceptable period is within the last six months.\n\nIf not provided, the server will take `exhibitionDate` as `firstDisplayDate`\n", "example": "2023-10-02" }, "country": { "allOf": [ { "$ref": "#/components/schemas/Country" } ], "example": "QA" }, "cityName": { "type": "string", "description": "Name of the city at which exhibition was celebrated", "example": "Doha" }, "exhibitionDate": { "type": "string", "format": "date", "description": "Date of exhibition", "example": "2023-10-02" }, "exhibitionDocument": { "type": "string", "format": "uuid", "description": "The exhibition document at the moment of filing or afterwards. \n\nSupported file types are JPEG and PDF.\n" }, "exhibitionTranslationDocument": { "type": "string", "format": "uuid", "description": "The exhibition document must be translated into the first or second language specified in your application (only if\nthe certificate is not in an official EU language).\n\nSupported file types are JPEG and PDF.\n" } }, "required": [ "identifier", "code" ] }, "EUOfficialLanguage": { "type": "string", "description": "The language that you want to use for your application. This can be any of 23 EU languages.", "enum": [ "bg", "cs", "da", "de", "el", "en", "es", "et", "fi", "fr", "hr", "hu", "it", "lt", "lv", "mt", "nl", "pl", "pt", "ro", "sk", "sl", "sv" ] }, "EUIPOOfficialLanguage": { "type": "string", "description": "Second language from one of the five official EUIPO languages. The second language must be different from the first language.", "enum": [ "de", "en", "es", "fr", "it" ] }, "Country": { "type": "string", "format": "iso-3166", "example": "ES" }, "WIPOST3Country": { "type": "string", "enum": [ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AP", "AR", "AT", "AU", "AW", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BX", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "EM", "EP", "ER", "ES", "ET", "FI", "FJ", "FK", "FO", "FR", "GA", "GB", "GC", "GD", "GE", "GG", "GH", "GI", "GL", "GM", "GN", "GQ", "GR", "GS", "GT", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "IB", "ID", "IE", "IL", "IM", "IN", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MK", "ML", "MM", "MN", "MO", "MP", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NZ", "OA", "OM", "PA", "PE", "PG", "PH", "PK", "PL", "PT", "PW", "PY", "QA", "QZ", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TG", "TH", "TJ", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VN", "VU", "WO", "WS", "XN", "YE", "ZA", "ZM", "ZW" ], "example": "ES" }, "WIPOFormerST3Country": { "type": "string", "enum": [ "CS", "DL", "DD", "SU", "YD", "YU" ], "example": "YU" }, "ExtendedCountry": { "oneOf": [ { "$ref": "#/components/schemas/WIPOST3Country" }, { "$ref": "#/components/schemas/WIPOFormerST3Country" } ] }, "Status": { "type": "string", "enum": [ "DRAFT", "PAID", "READY", "INTEGRATED", "ERROR" ], "readOnly": true, "description": "Status of the application:\n\n- DRAFT. Application created\n- PAID. Application submitted and paid\n- READY. Submitted application ready to be processed\n- INTEGRATED. Submitted application processed\n- ERROR. Submitted application could not be processed due to an error\n" }, "PaymentMethod": { "type": "string", "description": "Method of Payment for the application", "enum": [ "CREDIT_CARD", "CURRENT_ACCOUNT", "BANK_TRANSFER" ] }, "FeeList": { "type": "array", "items": { "$ref": "#/components/schemas/Fee" }, "readOnly": true, "description": "Fees that will be charged once the application is submitted.\n", "externalDocs": { "description": "For more information, visit the \"Fees and payments\" page.", "url": "https://www.euipo.europa.eu/en/designs/before-applying/fees-payments" } }, "Fee": { "type": "object", "properties": { "identifier": { "type": "string", "description": "Fee code", "example": "D-001" }, "amount": { "type": "number", "format": "double", "description": "Total amount to be charged in Euros(€)" }, "details": { "$ref": "#/components/schemas/FeeDetail" } }, "required": [ "identifier", "amount", "details" ] }, "FeeDetail": { "description": "Details of the items charged", "type": "object", "properties": { "concept": { "type": "string", "description": "Short description of the item related with the charge" }, "quantity": { "type": "integer", "format": "int32", "description": "Units charged" }, "amount": { "type": "number", "format": "double", "description": "Amount to be charged per unit in Euros(€)" } }, "required": [ "concept", "quantity", "amount" ] }, "ApplicationValidationResult": { "type": "object", "properties": { "designs": { "type": "array", "items": { "$ref": "#/components/schemas/Design" } }, "fees": { "$ref": "#/components/schemas/FeeList" }, "trackInformation": { "$ref": "#/components/schemas/TrackInformation" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationResult" }, "description": "List of errors on the application data that server may return when application is validated\n" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationResult" }, "description": "List of warnings on the application data that server may return when application is validated\n" } }, "required": [ "designs", "fees", "trackInformation" ] }, "TrackInformation": { "type": "object", "properties": { "track": { "allOf": [ { "$ref": "#/components/schemas/Track" } ], "description": "Track assigned to the application" }, "fastTrackIncompatibilities": { "type": "array", "items": { "$ref": "#/components/schemas/FastTrackIncompatibility" }, "description": "List of issues found that don't allow FAST track." } }, "readOnly": true, "required": [ "track" ], "description": "Information about the track assigned to the application and the possible issues for FAST track." }, "Track": { "type": "string", "enum": [ "REGULAR", "FASTTRACK" ] }, "FastTrackIncompatibility": { "type": "string", "enum": [ "NON_HARMONIZED_TERMS", "EXHIBITION_PRIORITY_CLAIM", "NEW_CLAIM_WITHOUT_ATTACHMENT", "NON_IMMEDIATE_PAYMENT", "NEW_REPRESENTATIVE", "NON_EEA_APPLICANT" ], "description": "Issue type that does not allow to assign FAST track to the application" }, "ApplicationIdentifier": { "type": "string", "format": "uuid", "description": "Identifier of the application", "readOnly": true }, "Username": { "type": "string", "readOnly": true, "example": "johndoe", "description": "The user who created the application" }, "ClientId": { "type": "string", "example": "test_client", "description": "Identifier of the Consumer of the API", "readOnly": true }, "Reference": { "type": "string", "example": "EEFEM202200999000198", "description": "Reference of the application i.e. 'EEFEM202200999000198'", "readOnly": true }, "ApplicationNumber": { "type": "string", "example": "018692868", "readOnly": true, "description": "Public identifier of the design application" }, "PersonalReference": { "type": "string", "maxLength": 30, "pattern": "[a-zA-Z0-9._\\\\-\\\\/\\\\\\\\]{1,30}", "example": "PersonalReference001", "description": "Value that the user may indicate for his own reference. It should consist of up to 30 alphanumeric characters, using the Roman alphabet: a-z, A-Z, 0-9 and/or the special characters: .-_/\\\\. Spaces not allowed" }, "Exhibition": { "type": "object", "properties": { "code": { "type": "string", "description": "Code given to the exhibition" }, "name": { "type": "string", "description": "Name of the exhibition" }, "exhibitionDate": { "type": "string", "format": "date", "description": "Date of the exhibition" }, "city": { "type": "string", "description": "Name of the city where the exhibition takes place" }, "country": { "allOf": [ { "$ref": "#/components/schemas/WIPOST3Country" } ], "description": "Country where the exhibition takes place" } } }, "Problem": { "type": "object", "properties": { "type": { "type": "string", "format": "uri-reference", "description": "A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.\n", "default": "about:blank", "example": "/some/uri-reference" }, "title": { "type": "string", "description": "A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.\n", "example": "some title for the error situation" }, "status": { "type": "integer", "format": "int32", "description": "The HTTP status code generated by the origin server for this occurrence of the problem.\n", "minimum": 100, "maximum": 600 }, "detail": { "type": "string", "description": "A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.\n", "example": "some description for the error situation" }, "instance": { "type": "string", "format": "uri-reference", "description": "A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.\n", "example": "/some/uri-reference#specific-occurrence-context" } }, "additionalProperties": false } }, "parameters": { "applicationId": { "in": "path", "name": "applicationId", "schema": { "$ref": "#/components/schemas/ApplicationIdentifier" }, "required": true }, "DesignerName": { "in": "query", "name": "designerName", "schema": { "type": "string", "maxLength": 100, "description": "The designer's full name (first name and surnames)" }, "required": true } }, "examples": { "CreateAndSubmitAnApplication": { "description": "Application providing designs, views and full details of applicant and representative.", "value": { "firstLanguage": "en", "secondLanguage": "es", "personalReference": "PersonalReference001", "designs": [ { "views": [ "123", "456" ], "designers": [ { "name": "Walt Disney" } ], "productIndications": [ { "classNumber": 21, "subClassNumber": 0, "terms": [ "Games, toys, tents and sports goods" ] } ], "description": "Donald Duck", "claimWipoDasIndicator": true } ], "applicants": [ { "type": "APPLICANT_BUSINESS", "legalName": "Owner 12345", "legalForm": "CO", "countryOfIncorporation": "GR", "address": { "street": "Address of owner 12345", "city": "Athens", "postalCode": "12345", "country": "GR" }, "correspondenceAddress": { "formattedAddress": "Correspondence address of owner 12345" }, "phone": "+45 222 333 666", "email": "applicants.holding@domain.com" } ], "representatives": [ { "type": "REPRESENTATIVE_EMPLOYEE", "firstName": "Firstname 67890", "surname": "Representative 67890", "nationality": "DE", "address": { "street": "Address of representative 67890", "city": "Bremen", "postalCode": "28203", "country": "DE" }, "correspondenceAddress": { "formattedAddress": "Correspondence address of repr 67890", "country": "DE" }, "phone": "+45 222 333 666", "email": "representatives.holding@domain.com" } ], "paymentPreferences": { "paymentMethod": "CURRENT_ACCOUNT", "account": { "identifier": "123456789", "debitType": "DEBIT_NOW" } }, "signatures": [ { "firstName": "John", "lastName": "Doe", "capacity": "APPLICANT" } ] } }, "SubmittedApplication": { "description": "The created Application", "value": { "identifier": "df3a8761-83bd-4a3a-98bd-b4d05ca29148", "reference": "EEFEM202000000000022", "applicationNumber": "018692868", "firstLanguage": "en", "secondLanguage": "es", "personalReference": "PersonalReference001", "designs": [ { "identifier": "fab51762-5b8e-4b9a-8b53-60517bcc57fa", "views": [ "123", "456" ], "designers": [ { "identifier": "abc12345-6d7e-8f9a-0g11-121314hij57k", "name": "Walt Disney" } ], "productIndications": [ { "classNumber": 21, "subClassNumber": 0, "terms": [ "Games, toys, tents and sports goods" ] } ], "description": "Donald Duck", "claimWipoDasIndicator": true, "wipoDasCode": "F8H1", "fees": [ { "identifier": "D-001", "amount": "230.0", "details": { "concept": "REGISTRATION_FEE", "quantity": 1, "amount": "230.0" } }, { "identifier": "D-011", "amount": "120.0", "details": { "concept": "PUBLICATION_FEE", "quantity": 1, "amount": "120.0" } } ] } ], "applicants": [ { "type": "APPLICANT_BUSINESS", "legalName": "Owner 12345", "legalForm": "CO", "countryOfIncorporation": "GR", "address": { "street": "Address of owner 12345", "city": "Athens", "postalCode": "12345", "country": "GR" }, "correspondenceAddress": { "formattedAddress": "Correspondence address of owner 12345" }, "phone": "+45 222 333 666", "email": "applicants.holding@domain.com" } ], "representatives": [ { "type": "REPRESENTATIVE_EMPLOYEE", "firstName": "Firstname 67890", "surname": "Representative 67890", "nationality": "DE", "address": { "street": "Address of representative 67890", "city": "Bremen", "postalCode": "28203", "country": "DE" }, "correspondenceAddress": { "formattedAddress": "Correspondence address of repr 67890", "country": "DE" }, "phone": "+45 222 333 666", "email": "representatives.holding@domain.com" } ], "signatures": [ { "firstName": "John", "lastName": "Doe", "capacity": "APPLICANT" } ], "paymentPreferences": { "paymentMethod": "CURRENT_ACCOUNT", "account": { "identifier": "123456789", "debitType": "DEBIT_NOW" } }, "payment": { "identifier": "A270WYV", "paymentDate": "2020-11-13T17:35:28Z" }, "fees": [ { "identifier": "D-001", "amount": "230.00", "details": { "concept": "REGISTRATION_FEE", "quantity": 1, "amount": "230.00" } }, { "identifier": "D-011", "amount": "120.00", "details": { "concept": "PUBLICATION_FEE", "quantity": 1, "amount": "120.00" } } ], "trackInformation": { "track": "FASTTRACK" }, "submissionDate": "2020-11-13T17:34:28Z", "status": "INTEGRATED", "createdBy": "johndoe02", "creationDate": "2020-11-13T17:32:28Z", "updateDate": "2020-11-13T17:34:28Z" } }, "ApplicationValidationResult": { "description": "", "value": { "designs": [ { "identifier": "04c12ce2-298c-4c7a-97fa-8de17fb47913", "fees": [ { "identifier": "D-001", "amount": "230.00", "details": { "concept": "REGISTRATION_FEE", "quantity": 1, "amount": "230.00" } }, { "identifier": "D-011", "amount": "120.00", "details": { "concept": "PUBLICATION_FEE", "quantity": 1, "amount": "120.00" } } ], "claimWipoDasIndicator": true, "wipoDasCode": "A80E", "exhibitionPriorities": [ { "identifier": "b00deb78-8057-4b47-bfb8-60fa6ea39621", "name": "A", "firstDisplayDate": "2023-06-02" } ] } ], "fees": [ { "identifier": "D-001", "amount": "230.00", "details": { "concept": "REGISTRATION_FEE", "quantity": 1, "amount": "230.00" } }, { "identifier": "D-011", "amount": "120.00", "details": { "concept": "PUBLICATION_FEE", "quantity": 1, "amount": "120.00" } } ], "trackInformation": { "track": "REGULAR", "fastTrackIncompatibilities": [ "EXHIBITION_PRIORITY_CLAIM", "NON_IMMEDIATE_PAYMENT" ] }, "errors": [ { "type": "/problems/application-incomplete", "title": "Some mandatory information is missing", "detail": "Design with identifier '04c12ce2-298c-4c7a-97fa-8de17fb47913' should include at least one view" }, { "type": "/problems/application-incomplete", "title": "Some mandatory information is missing", "detail": "Design with identifier '04c12ce2-298c-4c7a-97fa-8de17fb47913' should include at least one product indication" }, { "type": "/problems/application-incomplete", "title": "Some mandatory information is missing", "detail": "Application should include at least one signature" } ], "warnings": [ { "type": "/problems/application-missing-person", "title": "Missing person", "detail": "Application representatives do not contain the main user" } ] } }, "DesignerList": { "value": { "designers": [ { "name": "John Doe", "designerIdentifier": 235786 }, { "name": "John Wick", "designerIdentifier": 72563 } ] } }, "ExhibitionList": { "value": { "exhibitions": [ { "code": "exhibition.doha", "name": "Expo 2023 Doha", "city": "Doha", "exhibitionDate": "2023-10-02T00:00:00.000Z", "country": "QA" }, { "code": "exhibition.floriade", "name": "Floriade Expo 2022 Amsterdam - Almere", "city": "Amsterdam", "exhibitionDate": "2022-04-14T00:00:00.000Z", "country": "NL" }, { "code": "exhibition.yanqing", "name": "Expo 2019 Beijing", "city": "Yanqing", "exhibitionDate": "2019-04-29T00:00:00.000Z", "country": "CN" } ] } } } }, "x-ibm-endpoints": [ { "url": "https://api.euipo.europa.eu/design-filing" } ] }