This is the initial beta release of the Documents API. It is numbered 0.7 to signify it as the evolution of functionality first introduced in the deprecated IDS API.

The Documents API is currently in beta. New features or changes may be introduced with short or no notice.

Changes from IDS API

• The Documents API is accessed through the /documents/ URL path instead of /ids/. Subsequent URL inputs have not changed. More details are in the specification.
• Several field names have changed in the return object. Full details about the new return object are in the specification. The fields that have been renamed are;
  • applicationNumber -> application_number
  • applicationDate -> application_date
  • countryCode -> country_code
  • inventor -> inventors
  • abstract -> patent_body
  • currentOwner -> current_owner
  • kindCode -> kind_code
  • ipType -> ip_type
  • applicationNumber -> application_number
  • ipcrClassification group renamed to ipcr_classification and the child elements have been renamed as follows;
    • classCode -> class_code
    • subClassCode -> sub_class_code
    • mainGroup -> main_group
    • subGroup -> sub_group
  • innographyLink -> innography_link
  • innography_id -> ipid
• client_id is required as a query parameter, ex. /documents/case/I-000000000999?client_id=fip

This release of the Documents API should function identically to the latest release of the IDS API. New features will be added to the Documents API and may not be implemented on the IDS API.