Clarivate Patents API

openapi: 3.2.0
info:
  contact:
    email: Derwent.support@clarivate.com
    name: Derwent API
  description: Derwent APIs provide seamless access to enriched patent data, enabling users to enhance their research capabilities and make faster, more informed decisions.
  termsOfService: https://clarivate.com/legal-center/terms-of-business/product-service-terms/
  title: Intellectual Property (IP) Data Patents API
  version: 1.0.7
servers:
- url: https://api.clarivate.com
security:
- key: []
tags:
- name: Patents
paths:
  /patents/document/abstract/availability:
    post:
      description: Query the availability of abstract journals
      operationId: checkPatentAbstractAvailability
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/document_availability_request_patent'
      responses:
        '200':
          content:
            application/json:
              schema:
                example:
                  available:
                  - pn: US3201444A
                    url: https://docdelivery.derwentinnovation.com/get-file/00631877000165440003967700307006/US3201444(A).pdf
                  unavailable:
                  - JP51021981B
                properties:
                  results:
                    items:
                      properties:
                        available:
                          description: patent with PDFs
                          type: string
                        unavailable:
                          description: patent do not have PDFs
                          type: string
                      required:
                      - available
                      - unavailable
                      type: object
                    type: array
                type: object
          description: Success
        '400':
          content:
            application/json:
              example:
                code: 1200
                error: Invalid request. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Invalid request
        '401':
          content:
            application/json:
              example:
                code: 1100
                error: Insufficient permissions to access this resources. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                code: 10200
                error: Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Forbidden
        '404':
          content:
            application/json:
              example:
                code: 1201
                error: Endpoint not found
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Not found
        '500':
          content:
            application/json:
              example:
                code: 1300
                error: Something went wrong. Please try again, and contact support if error persists.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Internal server error
      summary: Check Abstract availability and get URLS for download
      tags:
      - Patents
  /patents/document/availability:
    post:
      description: Query the availability of patents
      operationId: checkPatentDocumentAvailability
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/document_availability_request_patent'
      responses:
        '200':
          content:
            application/json:
              schema:
                example:
                  available:
                  - pn: US8326177B2
                    url: https://docdelivery.derwentinnovation.com/get-file/00531747006127410038365200136292/US8326177(X601).pdf
                  unavailable:
                  - US99470720B2
                properties:
                  results:
                    items:
                      properties:
                        available:
                          description: patent with PDFs
                          type: string
                        unavailable:
                          description: patent do not have PDFs
                          type: string
                      required:
                      - available
                      - unavailable
                      type: object
                    type: array
                type: object
          description: Success
        '400':
          content:
            application/json:
              example:
                code: 1200
                error: Invalid request. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Invalid request
        '401':
          content:
            application/json:
              example:
                code: 1100
                error: Insufficient permissions to access this resources. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                code: 10200
                error: Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Forbidden
        '404':
          content:
            application/json:
              example:
                code: 1201
                error: Endpoint not found
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Not found
        '500':
          content:
            application/json:
              example:
                code: 1300
                error: Something went wrong. Please try again, and contact support if error persists.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Internal server error
      summary: Check Patent availability and get URLS for download
      tags:
      - Patents
  /patents/document/images/{document_guid}:
    get:
      description: Fetch a list of the images associated with this document, as URLs
      operationId: getPatentImages
      parameters:
      - description: Unique document ID
        in: path
        name: document_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/image_url_list_patent'
          description: Success
        '400':
          content:
            application/json:
              example:
                code: 1200
                error: Invalid request. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Invalid request
        '401':
          content:
            application/json:
              example:
                code: 1100
                error: Insufficient permissions to access this resources. Please contact support if you believe this is an error.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                code: 10200
                error: Insufficient permissions to use attribute values in the resources request. Please contact support if you believe this is an error
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Forbidden
        '404':
          content:
            application/json:
              example:
                code: 1201
                error: Endpoint not found
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Not found
        '500':
          content:
            application/json:
              example:
                code: 1300
                error: Something went wrong. Please try again, and contact support if error persists.
              schema:
                properties:
                  code:
                    description: Application error code
                    type: integer
                  error:
                    description: Error message
                    type: string
                required:
                - code
                - error
                type: object
          description: Internal server error
      summary: API to retrieve images for patents
      tags:
      - Patents
  /patents/document/json:
    post:
      description: Call to fetch one or more full patent documents by GUID, with possibile filters.
      operationId: getPatentDocuments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/records_request_patent'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    description: Page of results
                    items:
                      properties:
                        APPLICATION_DATE:
                          description: 'The date (YYYY-MM-DD) an application was filed. This is not the same as the Publication Date, which is the date the application is finally published.

                            This field is of type date but will be serialized to type string.


                            Flat name: APPLICATION_DATE

                            Hierarchical name: APPLICATION_DATE'
                          example: '2012-11-21'
                          format: date
                          type: string
                        APPLICATION_NUMBER:
                          description: 'A unique number assigned to an application when it is filed. This is not the same as the Publication Number, which is assigned when the application is published. For many authorities, the first four digits of the application number (following the country code) indicate the year the application was filed.

                            This field will be normalized to uppercase.


                            Flat name: APPLICATION_NUMBER

                            Hierarchical name: APPLICATION_NUMBER'
                          example: WO2012EP73219A
                          type: string
                        APPLICATION_NUMBER_ORIGINAL:
                          description: '


                            Flat name: _APPLICATION_NUMBER_ORIGINAL

                            Hierarchical name: APPLICATION_NUMBER_ORIGINAL'
                          type: string
                        APPLICATION_REGISTRATION_OFFICE:
                          description: 'The country / region in which an application was filed.

                            This field will be normalized to uppercase.


                            Flat name: APPLICATION_REGISTRATION_OFFICE

                            Hierarchical name: APPLICATION_REGISTRATION_OFFICE'
                          example: EP
                          type: string
                        ASSIGNEES_CURRENT_US:
                          items:
                            description: 'Entity to which this patent is currently assigned (who owns the patent currently), based on US Reassignment data. For more information see [Assignee Current US](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#assignee-current_us)


                              Flat name: ASSIGNEE_CURRENT_US

                              Hierarchical name: ASSIGNEES_CURRENT_US'
                            example: CONOPCO, INC., D/B/A UNILEVER
                            type: string
                          type: array
                        ASSIGNEES_ORIGINAL:
                          items:
                            description: 'The legal person or entity who owned the patent property right at the time of grant. This may or may not be the inventor and is also known as the applicant by some authorities.


                              Flat name: _ASSIGNEES_ORIGINAL

                              Hierarchical name: ASSIGNEES_ORIGINAL'
                            properties:
                              TYPE:
                                description: 'A single character representing the type of publication. I = Main invention publication;  T = Translation;  R = Reissued patent;  U = Utility Model;  S = Statutory Invention Publication;  P = NTIS Publication;  V = Trial Voluntary Protest Program.


                                  Flat name: ASSIGNEE_ORIGINAL_TYPE

                                  Hierarchical name: ASSIGNEES_ORIGINAL.TYPE'
                                example: P
                                type: string
                            type: object
                          type: array
                        ASSIGNEE_NAMES:
                          items:
                            description: 'The person or entity who owned/owns the patent. See [Optimized Assignee and Ultimate Parent](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/optimized_assignee.htm) on how we determine the owners.

                              This field will be normalized to uppercase.


                              Flat name: ASSIGNEE_NAME

                              Hierarchical name: ASSIGNEE_NAMES'
                            example: GOOGLE INC.
                            type: string
                          type: array
                        AUTHOR_ABSTRACTS:
                          items:
                            description: 'The front page abstracts as written by the author.


                              Flat name: _AUTHOR_ABSTRACTS

                              Hierarchical name: AUTHOR_ABSTRACTS'
                            example: The French author's abstract text in xml
                            properties: {}
                            type: object
                          type: array
                        BACKWARD_CITATION:
                          items:
                            description: '


                              Flat name: _BACKWARD_CITATION

                              Hierarchical name: BACKWARD_CITATION'
                            properties:
                              APPLICATION_DATE:
                                description: '

                                  This field is of type date but will be serialized to type string.


                                  Flat name: _BACKWARD_CITATION.APPLICATION_DATE

                                  Hierarchical name: BACKWARD_CITATION.APPLICATION_DATE'
                                format: date
                                type: string
                              ASSIGNEE:
                                description: '


                                  Flat name: _BACKWARD_CITATION.ASSIGNEE

                                  Hierarchical name: BACKWARD_CITATION.ASSIGNEE'
                                type: string
                              COUNTRY_CODE:
                                description: '


                                  Flat name: _BACKWARD_CITATION.COUNTRY_CODE

                                  Hierarchical name: BACKWARD_CITATION.COUNTRY_CODE'
                                type: string
                              DWPI_INVENTOR_NAMES:
                                description: '


                                  Flat name: _BACKWARD_CITATION.DWPI_INVENTOR_NAMES

                                  Hierarchical name: BACKWARD_CITATION.DWPI_INVENTOR_NAMES'
                                type: string
                              DWPI_TITLE:
                                description: '


                                  Flat name: _BACKWARD_CITATION.DWPI_TITLE

                                  Hierarchical name: BACKWARD_CITATION.DWPI_TITLE'
                                type: string
                              EARLIEST_PRIORITY_DATE:
                                description: '

                                  This field is of type date but will be serialized to type string.


                                  Flat name: _BACKWARD_CITATION.EARLIEST_PRIORITY_DATE

                                  Hierarchical name: BACKWARD_CITATION.EARLIEST_PRIORITY_DATE'
                                format: date
                                type: string
                              KIND_CODE:
                                description: '


                                  Flat name: _BACKWARD_CITATION.KIND_CODE

                                  Hierarchical name: BACKWARD_CITATION.KIND_CODE'
                                type: string
                              MEMBERS:
                                properties:
                                  RELEVANCE_CATEGORY:
                                    description: '


                                      Flat name: _BACKWARD_CITATION.MEMBERS.RELEVANCE_CATEGORY

                                      Hierarchical name: BACKWARD_CITATION.MEMBERS.RELEVANCE_CATEGORY'
                                    type: string
                                type: object
                              PUBLICATION_NUMBER:
                                description: '


                                  Flat name: _BACKWARD_CITATION.PUBLICATION_NUMBER

                                  Hierarchical name: BACKWARD_CITATION.PUBLICATION_NUMBER'
                                type: string
                            type: object
                          type: array
                        CLAIMS:
                          items:
                            description: 'Defines the boundaries of an invention, and therefore lays down what the patent does and does not cover.


                              Flat name: _CLAIMS

                              Hierarchical name: CLAIMS'
                            example: 1. A headgear apparatus I claim , wherein said eye shield member is adjustable with respect to said headband member.
                            properties: {}
                            type: object
                          type: array
                        CORRESPONDENTS:
                          items:
                            description: 'The correspondent acting on behalf of the patent applicant.


                              Flat name: _CORRESPONDENTS

                              Hierarchical name: CORRESPONDENTS'
                            properties: {}
                            type: object
                          type: array
                        CPCS:
                          items:
                            description: 'Cooperative Patent Classifications (CPC) are an extension of the IPC. They are divided into nine sections, A-H and Y presenting an identifier made up of letter and numbers, which in turn are sub-divided into classes, sub-classes, groups and sub-groups.


                              Flat name: _CPCS

                              Hierarchical name: CPCS'
                            properties: {}
                            type: object
                          type: array
                        CPCS_CURRENT:
                          items:
                            description: 'These are the most recent CPC symbols and they overwrite/replace any earlier classifications. They can come from the Front Page or from the EPO (DocDB, through its weekly updates, or MCD quarterly update).  For more information see [CPC symbol](https://www.derwentinnovation.com/tip-innovation/support/help/patent_fields.htm#cpc)

                              This field will be normalized to uppercase.


                              Flat name: CPC_CURRENT

                              Hierarchical name: CPCS_CURRENT'
                            example: G06N001000
                            type: string
                          type: array
                        DEAD_ALIVE_STATUS:
                          description: 'Patent and family status, dead (D) or alive (A) quickly shows you whether a patent or patent family is currently enforceable. Patent status uses a machine-learning algorithm to examine crucial patent data to determine the vitality status of a single patent or a patent family. The factors considered to predict patent status include: expiration date, legal status data, inherited status. If a record does not have an expiration date, filing date, and/or relevant legal status data, its status may be classified as Indeterminate (I). When a true/false is required, indeterminate should be considered as alive. [See the detailed process used to determine the status](https://www.derwentinnovation.com/tip-innovation/support/help/predictive_data/pat_fam_status_doa.htm)

                            This field will be normalized to uppercase.


                            Flat name: DEAD_ALIVE_STATUS

                            Hierarchical name: DEAD_ALIVE_STATUS'
                          example: D
                          type: string
                        DERWENT_BACKWARD_CITATION_COUNT:
                          description: 'Number of patents citing the DWPI family.

                            This field will be normalized to number.


                            Flat name: DERWENT_BACKWARD_CITATION_COUNT

                            Hierarchical name: DERWENT_BACKWARD_CITATION_COUNT'
                          example: 15
                          type: number
                        DERWENT_FORWARD_CITATION_COUNT:
                          description: 'Number of patents cited by at least one member of the DWPI family.

                            This field will be normalized to number.


                            Flat name: DERWENT_FORWARD_CITATION_COUNT

                            Hierarchical name: DERWENT_FORWARD_CITATION_COUNT'
                          example: 17
                          type: number
                        DESCRIPTIONS:
                          items:
                            description: 'Part of a patent application or specification. Discloses the invention as claimed, specifies the technical field to which the invention relates and indicates any prior art the applicant is aware of.


                              Flat name: _DESCRIPTIONS

                              Hierarchical name: DESCRIPTIONS'
                            example: characterised by ingredients other than fatty acid triglycerides
                            properties: {}
                            type: object
                          type: array
                        DESIGNATED_OFFICES:
                          items:
                            description: 'The designated states are the countries/regions in which an invention is protected in addition to the country/region, in which the patent for the invention is filed. Filings under the PCT are identified by filing region XX. Other filing regions are EP (European Patent Office), EA (Eurasian Patent Organization), AP (African Regional IP Organization) or OA (African Intellectual Property Organization).


                              Flat name: _DESIGNATED_OFFICES

                              Hierarchical name: DESIGNATED_OFFICES'
                            properties: {}
                            type: object
                          type: array
                        DOCDB_SIMPLE_FAMILY_ID:
                          description: 'A unique identifier for the simple family (a patent family identified/defined by INPADOC using INPADOC methodology.

                            This field will be normalized to number.


                            Flat name: DOCDB_SIMPLE_FAMILY_ID

                            Hierarchical name: DOCDB_SIMPLE_FAMILY_ID'
                          example: 7843694
                          type: number
                        DPCI_CITED_COUNTS:
                          properties:
                            ACCESSION_NUMBERS_TOTAL:
                              description: 'The number of unique Accession Numbers (showing the number of inventions) from the cited patents from any citation source

                                This field will be normalized to number.


                                Flat name: DPCI_CITED_COUNTS_ACCESSION_NUMBERS_TOTAL

                                Hierarchical name: DPCI_CITED_COUNTS.ACCESSION_NUMBERS_TOTAL'
                              example: 3
                              type: number
                            AUTHORITIES_TOTAL:
                              description: 'The number of unique patenting authorities (country codes) from the cited patents from any citation source. This shows the number of distinct regions where the cited patents are originating from.

                                This field will be normalized to number.


                                Flat name: DPCI_CITED_COUNTS_AUTHORITIES_TOTAL

                                Hierarchical name: DPCI_CITED_COUNTS.AUTHORITIES_TOTAL'
                              example: 3
                              type: number
                            NON_PATENTS_TOTAL:
                              description: 'The number of unique articles from the cited non-patents from any citation source

                                This field will be normalized to number.


                                Flat name: DPCI_CITED_COUNTS_NON_PATENTS_TOTAL

                                Hierarchical name: DPCI_CITED_COUNTS.NON_PATENTS_TOTAL'
                              example: 8
                              type: number
                            PATENTS_TOTAL:
                              description: 'The number of unique patent numbers from the cited patents from any citation source

                                This field will be normalized to number.


                                Flat name: DPCI_CITED_COUNTS_PATENTS_TOTAL

                                Hierarchical name: DPCI_CITED_COUNTS.PATENTS_TOTAL'
                              example: 4
                              type: number
                          type: object
                        DPCI_CITED_NON_PATENTS:
                          items:
                            description: 'Non-patent citation sources including abstracts and articles from scientific and technical literature.


                              Flat name: _DPCI_CITED_NON_PATENTS

                              Hierarchical name: DPCI_CITED_NON_PATENTS'
                            properties:
                              MEMBERS:
                                properties:
                                  FAMILY_MEMBER:
                                    description: 'Patent number of  the family member where the non-patent citation originally populated from.


                                      Flat name: _DPCI_CITED_NON_PATENTS.MEMBERS.FAMILY_MEMBER

                                      Hierarchical name: DPCI_CITED_NON_PATENTS.MEMBERS.FAMILY_MEMBER'
                                    example: US8178699B2
                                    type: string
                                  RELEVANCE_CATEGORY:
                                    description: 'Examiner-applied relevance codes of  the family member where the non-patent citation originally populated from.


                                      Flat name: _DPCI_CITED_NON_PATENTS.MEMBERS.RELEVANCE_CATEGORY

                                      Hierarchical name: DPCI_CITED_NON_PATENTS.MEMBERS.RELEVANCE_CATEGORY'
                                    example: A
                                    type: string
                                  SOURCE:
                                    description: 'Patent source of  the family member where the n

# --- truncated at 32 KB (355 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clarivate/refs/heads/main/openapi/clarivate-patents-api-openapi.yml