What is the endpoint for [P028]License?

The [P028]License endpoint is GET https://connect.patsnap.com/advanced-patent-data/license-data.

Where can I find the OpenAPI schema for [P028]License?

The OpenAPI schema is available at /openapi.json#/paths/~1advanced-patent-data~1license-data/get. You can also browse the full specification at /openapi.json.

[P028]License

Q: What data can [P028]License return?

[P028]License Receive license data by patent_id or patent_number. This includes license contract number, licensor, licensee, license type, and license effective date. See the Response Schema and Success Response Example on this page for the full structure.

get

https://connect.patsnap.com/advanced-patent-data/license-data

Try in Sandbox

Receive license data by patent_id or patent_number. This includes license contract number, licensor, licensee, license type, and license effective date.

The API supports batch requests with a maximum of 100 patents, and more patent id or patent number are separated with English comma. Batch requests are deducted from traffic/costs, and will be deducted multiple times based on the number of successful results returned.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`patent_id`	`string`	`8fa96acb-a3f1-4d79-b6cd-499ce3badd44`	patent_id
`patent_number`	`string`	`US11234954B2`	patent_number

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`array`	-	response data
`pn`	`string`	`US11205304B2`	patent number
`patent_id`	`string`	`718ead9c-4f3c-4674-8f5a-24e126827269`	patent id
`patent_license_data`	`array`	`Please check the form: PatentLicenseData`	patent license data
`country`	`string`	`US`	Authority code
`licensees`	`array`	`Please check the form: PersonBaseDoc`	licensees
`lang`	`string`	`EN`	Language
`name`	`string`	`EMC IP HOLDING COMPANY LLC`	name
`sequence`	`integer<int32>`	`1`	sequence
`licensors`	`array`	`Please check the form: PersonBaseDoc`	licensors
`license_type`	`array`	`[ "Exclusive" ]`	License type
`effective_date`	`integer<int64>`	`20100915`	License effective date
`contract_number`	`string`	`2010370000340`	License contract number, only some jurisdictions have this field, such as CN
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": [
    {
      "pn": "US11205304B2",
      "patent_id": "718ead9c-4f3c-4674-8f5a-24e126827269",
      "patent_license_data": [
        {
          "country": "US",
          "licensees": [
            {
              "lang": "EN",
              "name": "EMC IP HOLDING COMPANY LLC",
              "sequence": 1
            }
          ],
          "licensors": [
            {
              "lang": "EN",
              "name": "EMC IP HOLDING COMPANY LLC",
              "sequence": 1
            }
          ],
          "license_type": [
            "Exclusive"
          ],
          "effective_date": 20100915,
          "contract_number": "2010370000340"
        }
      ]
    }
  ],
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	Quota exceeds the limit!
`67200003`	Access token expired or authentication error!
`67200004`	No permission or API package quota has exceeded the limit!
`67200005`	Insufficient balance, call failed!
`67200006`	This client has expired and call failed!

HTTP Status Codes

Status Code	Description
`0`	Success
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found