Clarivate IP Cases 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 IP Cases API
  version: 1.0.7
servers:
- url: https://api.clarivate.com
security:
- key: []
tags:
- name: IP Cases
paths:
  /caselaw/document/availability:
    post:
      description: Query the availability and update date of documents
      operationId: checkCaselawDocumentAvailability
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/document_availability_request_caselaw'
      responses:
        '200':
          content:
            application/json:
              schema:
                example:
                  result_count: 6
                  results:
                    '2706413':
                      availability: valid
                      last_updated: '2023-06-15 04:48:10.244000000'
                    '10043066':
                      availability: deleted
                      last_updated: '2023-03-22 23:05:32.841943000'
                    '10157664':
                      availability: deleted
                      last_updated: '2023-04-26 23:14:36.608294000'
                    '10282480':
                      availability: deleted
                      last_updated: '2023-04-20 23:05:59.493840000'
                    '11021977':
                      availability: valid
                      last_updated: '2023-06-21 15:08:19.928657000'
                    '9999999999':
                      availability: invalid
                properties:
                  result_count:
                    description: Total number of results
                    type: number
                  results:
                    description: Page of results
                    items:
                      properties:
                        GUID:
                          description: GUID
                          example: '2706413'
                          type: string
                        availability:
                          enum:
                          - deleted
                          - invalid
                          - valid
                          example: valid
                          type: string
                        last_updated:
                          description: Date of last update
                          example: '2023-06-15'
                          format: date
                          type: string
                      required:
                      - GUID
                      - availability
                      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: Caselaw document availability check
      tags:
      - IP Cases
  /caselaw/document/json:
    post:
      description: Call to fetch one or more full caselaw documents by GUID, with possibile filters.
      operationId: getCaselawDocuments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/records_request_caselaw'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  result:
                    description: Page of results
                    items:
                      properties:
                        BINDER:
                          properties:
                            AREA:
                              description: 'Represents the legal area where the case takes place as defined by Darts-ip (i.e. countries grouped together under harmonized legal provisions).


                                Flat name: AREA

                                Hierarchical name: BINDER.AREA'
                              example: JAPAN
                              type: string
                            CASE_DOMAINS:
                              items:
                                description: 'The IP right types that the case pertains to. Possible values are: copyright, design_model, domain_name, patent, trademark, unfair_competition or other


                                  Flat name: CASE_DOMAIN

                                  Hierarchical name: BINDER.CASE_DOMAINS'
                                example: '["PATENT", "DOMAIN_NAME", "TRADEMARK"]'
                                type: string
                              type: array
                            CASE_NAME:
                              description: 'The name of the Binder, about 4% of our Binders have a case name.


                                Flat name: CASE_NAME

                                Hierarchical name: BINDER.CASE_NAME'
                              example: EX PARTE SAGHEER AHMAD
                              type: string
                            CASE_REFERENCES:
                              items:
                                description: 'The docket references for this specific case.


                                  Flat name: _BINDER.CASE_REFERENCES

                                  Hierarchical name: BINDER.CASE_REFERENCES'
                                example: 81 O 25/99", "6 U 179/99
                                type: string
                              type: array
                            CASE_RESOLUTION:
                              description: 'The outcome of the case according to the information collected. Possible values are: claimant wins, defendant wins, split win, settled, withdrawn or unknown (null value).


                                Flat name: CASE_RESOLUTION

                                Hierarchical name: BINDER.CASE_RESOLUTION'
                              example: SETTLED
                              type: string
                            CASE_STAGE:
                              description: 'The current stage of the case according to the information collected


                                Flat name: CASE_STAGE

                                Hierarchical name: BINDER.CASE_STAGE'
                              example: HEARING
                              type: string
                            CASE_STATUS:
                              description: 'The current status of an IP Case. Possible values are open, closed or inactive.


                                Flat name: CASE_STATUS

                                Hierarchical name: BINDER.CASE_STATUS'
                              example: CLOSED
                              type: string
                            CLOSED:
                              description: 'Whether the binder has been closed. (US Only)


                                Flat name: CLOSED

                                Hierarchical name: BINDER.CLOSED'
                              example: false
                              type: boolean
                            DOCKETS:
                              properties:
                                COURT:
                                  properties:
                                    AREA:
                                      description: 'The legal area this court is part of.


                                        Flat name: DOCKET_COURT_AREA

                                        Hierarchical name: BINDER.DOCKETS.COURT.AREA'
                                      example: EUROPE
                                      type: string
                                    COURT_COUNTRY:
                                      description: 'A two-character WIPO ST.3 code representing the country or the international organization the court is part of.


                                        Flat name: DOCKET_COURT_COUNTRY

                                        Hierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY'
                                      example: RU
                                      type: string
                                    COURT_COUNTRY_DERIVED:
                                      properties:
                                        COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2:
                                          description: 'A two-character code mapping from the court country code to the countries belonging to the court country code


                                            Flat name: DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2

                                            Hierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_ISO_3166_ALPHA2'
                                          example: AD
                                          type: string
                                        COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3:
                                          description: 'A three-character code mapping from the court country code to the countries belonging to the court country code


                                            Flat name: DOCKET_COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3

                                            Hierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_ISO_3166_ALPHA3'
                                          example: AND
                                          type: string
                                        COURT_COUNTRY_DERIVED_TEXT:
                                          description: 'The country name mapping from the court country code to the countries belonging to the country code


                                            Flat name: DOCKET_COURT_COUNTRY_DERIVED_TEXT

                                            Hierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_DERIVED.COURT_COUNTRY_DERIVED_TEXT'
                                          example: ALBANIA
                                          type: string
                                      type: object
                                    COURT_COUNTRY_TEXT:
                                      description: 'The country or the international organization the court is part of.


                                        Flat name: DOCKET_COURT_COUNTRY_TEXT

                                        Hierarchical name: BINDER.DOCKETS.COURT.COURT_COUNTRY_TEXT'
                                      example: AFRICAN INTELLECTUAL PROPERTY ORGANIZATION
                                      type: string
                                    NAME:
                                      description: 'The English name of the Court.


                                        Flat name: DOCKET_COURT_NAME

                                        Hierarchical name: BINDER.DOCKETS.COURT.NAME'
                                      example: FEDERAL SERVICE FOR IP - WIPO
                                      type: string
                                    PATH:
                                      description: 'Information about the Court in which this Docket was handled.


                                        Flat name: DOCKET_COURT_PATH

                                        Hierarchical name: BINDER.DOCKETS.COURT.PATH'
                                      example: COMMONW. OF INDEP. STATES/RUSSIAN FEDERATION/FEDERAL SERVICE FOR IP - WIPO
                                      type: string
                                    TYPES:
                                      items:
                                        description: 'Domain Types such as wethere a document is Administrative, Judical, or Arbitration.


                                          Flat name: _BINDER.DOCKETS.COURT.TYPES

                                          Hierarchical name: BINDER.DOCKETS.COURT.TYPES'
                                        example: ADMINISTRATIVE
                                        type: string
                                      type: array
                                  type: object
                                DOCUMENTS:
                                  properties:
                                    CITABLE:
                                      description: 'Whether the decision has a reporter citation.


                                        Flat name: DOCUMENT_CITABLE

                                        Hierarchical name: BINDER.DOCKETS.DOCUMENTS.CITABLE'
                                      example: false
                                      type: boolean
                                    CITATION_REFERENCE:
                                      description: 'An unique internal reference in the format ''darts-000-000-A''.


                                        Flat name: DOCUMENT_CITATION_REFERENCE

                                        Hierarchical name: BINDER.DOCKETS.DOCUMENTS.CITATION_REFERENCE'
                                      example: '"DARTS-998-200-L",'
                                      type: string
                                    CLAIM_CONSTRUCTIONS:
                                      properties:
                                        AGREED:
                                          description: 'Whether both the plaintiff(s) and defendant(s) agreed with the definition put forward by the judge.


                                            Flat name: CLAIM_CONSTRUCTION_AGREED

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.AGREED'
                                          example: false
                                          type: boolean
                                        DEFINITION:
                                          description: 'The definition that was given for the term in this decision.


                                            Flat name: CLAIM_CONSTRUCTION_DEFINITION

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.DEFINITION'
                                          example: NICHT GLEICHZEITIG
                                          type: string
                                        MEANS_PLUS_FUNCTION:
                                          description: 'Whether the term was considered as describing a function the technology performs, rather than the structure of the technology.(US Only)


                                            Flat name: CLAIM_CONSTRUCTION_MEANS_PLUS_FUNCTION

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.MEANS_PLUS_FUNCTION'
                                          example: NOT_DISCUSSED
                                          type: string
                                        NOT_NECESSARY:
                                          description: 'Whether the judge deemed a definition of the term to unnecessary for a variety of reasons.


                                            Flat name: CLAIM_CONSTRUCTION_NOT_NECESSARY

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.NOT_NECESSARY'
                                          example: false
                                          type: boolean
                                        TERM:
                                          description: 'The term for which a definition or interpretation was given by the judge in this decision.


                                            Flat name: CLAIM_CONSTRUCTION_TERM

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.CLAIM_CONSTRUCTIONS.TERM'
                                          example: ASYNCHROM
                                          type: string
                                      type: object
                                    DAMAGES:
                                      properties:
                                        AMOUNT:
                                          description: 'The amount of damages that needs to be paid.


                                            Flat name: DAMAGE_AMOUNT

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.AMOUNT'
                                          example: 137240
                                          type: number
                                        CALCULATION_METHOD:
                                          description: 'How the damages have been calculated.


                                            Flat name: DAMAGE_CALCULATION_METHOD

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CALCULATION_METHOD'
                                          example: LOSS_OF_PROFITS
                                          type: string
                                        CURRENCY:
                                          description: 'A 3-character ISO currency code for the main currency of the damage.


                                            Flat name: DAMAGE_CURRENCY

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENCY'
                                          example: EUR
                                          type: string
                                        CURRENT_CNY_EQUIVALENT:
                                          description: 'The amount converted to Chinese Yuan.


                                            Flat name: DAMAGE_CURRENT_CNY_EQUIVALENT

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_CNY_EQUIVALENT'
                                          example: 1454475
                                          type: number
                                        CURRENT_EUR_EQUIVALENT:
                                          description: 'The amount converted to Euro.


                                            Flat name: DAMAGE_CURRENT_EUR_EQUIVALENT

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_EUR_EQUIVALENT'
                                          example: 186335
                                          type: number
                                        CURRENT_USD_EQUIVALENT:
                                          description: 'The amount converted to US Dollars.


                                            Flat name: DAMAGE_CURRENT_USD_EQUIVALENT

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.CURRENT_USD_EQUIVALENT'
                                          example: 224108
                                          type: number
                                        NATURE:
                                          description: 'The nature of the damages mentioned in the decision document.


                                            Flat name: DAMAGE_NATURE

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.NATURE'
                                          example: INFRINGEMENT
                                          type: string
                                        TYPES:
                                          properties:
                                            LATER:
                                              description: 'Indicates that damages have been assigned, but the amount has not been specified in this decision.


                                                Flat name: DAMAGE_LATER

                                                Hierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.LATER'
                                              example: false
                                              type: boolean
                                            PARTIAL:
                                              description: 'Indicates whether the damage amount is potentially incomplete and might be amended in a future decision.


                                                Flat name: DAMAGE_PARTIAL

                                                Hierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.PARTIAL'
                                              example: false
                                              type: boolean
                                            REQUESTED:
                                              description: 'Indicates that the damage was requested by the plaintiff, but not necessarily granted.


                                                Flat name: DAMAGE_REQUESTED

                                                Hierarchical name: BINDER.DOCKETS.DOCUMENTS.DAMAGES.TYPES.REQUESTED'
                                              example: false
                                              type: boolean
                                          type: object
                                      type: object
                                    DECLARATORY:
                                      description: 'Whether the decision addresses a motion for declaratory judgment(US Only).


                                        Flat name: DOCUMENT_DECLARATORY

                                        Hierarchical name: BINDER.DOCKETS.DOCUMENTS.DECLARATORY'
                                      example: false
                                      type: boolean
                                    DEFAULT_JUDGEMENT:
                                      description: 'Whether the decision is granting a default judgment (US Only).


                                        Flat name: DOCUMENT_DEFAULT_JUDGEMENT

                                        Hierarchical name: BINDER.DOCKETS.DOCUMENTS.DEFAULT_JUDGEMENT'
                                      example: false
                                      type: boolean
                                    DOCUMENT_DATE:
                                      description: 'Judgment Date: The date of this Document.

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


                                        Flat name: DOCUMENT_DATE

                                        Hierarchical name: BINDER.DOCKETS.DOCUMENTS.DOCUMENT_DATE'
                                      example: '2021-10-04'
                                      format: date
                                      type: string
                                    DOCUMENT_TYPE:
                                      description: 'The type of the document. Possible values are: decisions_and_orders, prelude, process_procedure_information, settlement_information, briefs_and_memorandums, motions, evidence and conclusions_of_advocate_generale


                                        Flat name: DOCUMENT_TYPE

                                        Hierarchical name: BINDER.DOCKETS.DOCUMENTS.DOCUMENT_TYPE'
                                      example: DECISIONS_AND_ORDERS
                                      type: string
                                    LEVEL:
                                      description: 'The level of the document. Possible values are first_instance, appeal, judicial_review and preliminary_ruling


                                        Flat name: DOCUMENT_LEVEL

                                        Hierarchical name: BINDER.DOCKETS.DOCUMENTS.LEVEL'
                                      example: FIRST_INSTANCE
                                      type: string
                                    POINT_OF_LAWS:
                                      properties:
                                        CONFIDENCE_LEVEL:
                                          description: 'Whether the point of law was suggested by AI or was manually encoded.


                                            Flat name: POINT_OF_LAW_CONFIDENCE_LEVEL

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.CONFIDENCE_LEVEL'
                                          example: CONFIDENT
                                          type: string
                                        NAME:
                                          description: 'The name of this Point of Law.


                                            Flat name: POINT_OF_LAW_NAME

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.NAME'
                                          example: BETWEEN GOODS IN DIFFERENT CLASSES
                                          type: string
                                        OUTCOMES:
                                          properties:
                                            NEGATIVE:
                                              description: 'The name of the negative outcome (if applicable).


                                                Flat name: POINT_OF_LAW_OUTCOME_NEGATIVE

                                                Hierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.NEGATIVE'
                                              example: DIFFERENT
                                              type: string
                                            OUTCOME:
                                              description: 'The outcome either positive, negative or both for this Point of Law.


                                                Flat name: POINT_OF_LAW_OUTCOME

                                                Hierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.OUTCOME'
                                              example: NEGATIVE
                                              type: string
                                            POSITIVE:
                                              description: 'The name of the positive outcome (if applicable).


                                                Flat name: POINT_OF_LAW_OUTCOME_POSITIVE

                                                Hierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.OUTCOMES.POSITIVE'
                                              example: DIFFERENT
                                              type: string
                                          type: object
                                        PARENT_PATH:
                                          description: 'The parent of this Point of Law in the Point of Law tree.


                                            Flat name: POINT_OF_LAW_PARENT_PATH

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.PARENT_PATH'
                                          example: CONFLICT BETWEEN TRADE MARKS/LIKELIHOOD OF CONFUSION (IDENTICAL/SIMILAR TRADE MARKS FOR IDENTICAL/SIMILAR GOODS OR SERVICES)/SIMILARITY BETWEEN THE GOODS/SERVICES/BETWEEN GOODS IN DIFFERENT CLASSES
                                          type: string
                                        PREFIX:
                                          description: 'The parent of this Point of Law in the Point of Law tree.


                                            Flat name: POINT_OF_LAW_PREFIX

                                            Hierarchical name: BINDER.DOCKETS.DOCUMENTS.POINT_OF_LAWS.PREFIX'
                                          example: EUR-06.2.2.4
                                          type: string
                                      type: object
                                    PRODUCT_COMPARISONS:
                                      properties:
                                        PRODUCT_A:
                                          properties:
                                            DESCRIPTION:
                                              description: 'Description of the first product.


                                                Flat name: PRODUCT_COMPARISON_PRODUCT_A_DESCRIPTION

                                                Hierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_A.DESCRIPTION'
                                              example: DEBIT CARD SERVICES; PROCESSING OF PAYMENTS IN RELATION TO CHARGE CARDS; PROCESSING PAYMENTS MADE BY CHARGE CARDS; CHEQUE GUARANTEE CARD PROCESSING; ISSUING OF CREDIT AND DEBIT CARDS; FINANCIAL TRANSACTIONS; ELECTRONIC FUNDS TRANSFER; PAYMENT SETTLEMENT, BANKING OPERATIONS; BANKS (BANKING); BANKING; FINANCIAL CONSULTANCY; CREDIT CONSULTANCY; BUDGET ACCOUNT SERVICES; BANK ACCOUNT AND SAVINGS ACCOUNT SERVICES; FINANCIAL SERVICES IN THE FIELD OF BANK CARDS; BANK ACCOUNT INFORMATION SERVICES; PROVIDING OF BANKING SERVICES; MONEY TRANSFER SERVICES BY ELECTRONIC MEANS; ELECTRONIC FUND TRANSFER FOR OTHERS; PROVIDING MULTIPLE PAYMENT OPTIONS BY MEANS OF CUSTOMER-OPERATED ELECTRONIC TERMINALS AVAILABLE ON-SITE IN RETAIL STORES
                                              type: string
                                            NICE_CLASSES:
                                              description: 'The Nice Classes of the first product.


                                                Flat name: PRODUCT_COMPARISON_PRODUCT_A_NICE_CLASS

                                                Hierarchical name: BINDER.DOCKETS.DOCUMENTS.PRODUCT_COMPARISONS.PRODUCT_A.NICE_CLASSES'
                                              example: 36.","36.13","36.41
                                              type: string
                                          type: object
                   

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