https://api.nexscope.ai/ai/designRegistrationDetailsRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/ai/designRegistrationDetails |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
designRegistrationIds | array | optional | 1β200 unique exact registration IDs, each 1β128 trimmed characters; excludes primaryIdentifier and jurisdictionIso2. Minimum items: 1 Maximum items: 200 |
designRegistrationIds[] | string | required | 1β200 unique exact registration IDs, each 1β128 trimmed characters; excludes primaryIdentifier and jurisdictionIso2. Pattern: ^\S(?:[^\r\n]*\S)?$ Minimum length: 1 Maximum length: 128 |
jurisdictionIso2 | string | optional | Optional two-letter jurisdiction, only with primaryIdentifier; use EM for EU. Pattern: ^[A-Za-z]{2}$ |
primaryIdentifier | string | optional | Exact primary number, 1β128 trimmed characters; preserve leading zeros. Excludes designRegistrationIds. Pattern: ^\S(?:[^\r\n]*\S)?$ Minimum length: 1 Maximum length: 128 |
One of option 1 β requires designRegistrationIds
One of option 2 β requires primaryIdentifier
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"data": {
"code": "OK",
"data": {
"items": [
{
"as_of_date": "2026-10-09",
"design_registration_id": "DSR:wipo_hague:EMID.001431738-0001",
"designer_names": [
"Example designer"
],
"has_readable_image": 1,
"holder_names": [
"Example holder"
],
"image_count": 5,
"primary_identifier": "001431738",
"simple_legal_status": "inactive",
"title_en": "Bottles"
}
],
"returned": 1
},
"request_id": "example-request"
}
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Response fields
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
data | any | required | Data value used by this API operation. |
msg | string | null | required | Msg value used by this API operation. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds. |
Any of option 1 β requires data
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.costTime | any | optional | Cost time value used by this API operation. |
data.costToken | any | optional | Cost token value used by this API operation. |
data.data | object | required | Source envelope retained within the gateway payload. Example: {} |
data.data.code | string | required | Success is OK. DATA_DESIGN_NOT_FOUND (404) means no source detail found, not absence of rights. Preserve actual source/configuration errors and request identifiers; do not retry, split or change lookup mode automatically. Authentication, credits and permission failures remain distinct. Example: OK |
data.data.data | object | required | Registration details result. Example: {} |
data.data.data.asset | any | optional | Asset value used by this API operation. |
data.data.data.asset_code | any | optional | Asset code value used by this API operation. |
data.data.data.execution | any | optional | Execution value used by this API operation. |
data.data.data.items | array | required | All returned registration records in source order; no infringement conclusion. Example: [{"as_of_date":"2026-10-09","design_registration_id":"DSR:wipo_hague:EMID.001431738-0001","designer_names":["Example designer"],"has_readable_image":1,"holder_names":["Example holder"],"image_count":5,"primary_identifier":"001431738","simple_legal_status":"inactive","title_en":"Bottles"}] |
data.data.data.items[] | object | required | Item in data data data items. |
data.data.data.items[].application_date | any | optional | Application date value used by this API operation. |
data.data.data.items[].application_number | any | optional | Application number value used by this API operation. |
data.data.data.items[].as_of_date | any | optional | As of date value used by this API operation. |
data.data.data.items[].classification_count | any | optional | Classification count value used by this API operation. |
data.data.data.items[].coverage_level | any | optional | Coverage level value used by this API operation. |
data.data.data.items[].data_quality_level | any | optional | Data quality level value used by this API operation. |
data.data.data.items[].data_version | any | optional | Data version value used by this API operation. |
data.data.data.items[].design_registration_id | any | optional | Design registration id value used by this API operation. |
data.data.data.items[].designer_names | any | optional | Designer names value used by this API operation. |
data.data.data.items[].has_readable_image | any | optional | Has readable image value used by this API operation. |
data.data.data.items[].holder_names | any | optional | Holder names value used by this API operation. |
data.data.data.items[].image_count | any | optional | Image count value used by this API operation. |
data.data.data.items[].jurisdiction_iso2 | any | optional | Jurisdiction iso2 value used by this API operation. |
data.data.data.items[].locarno_classes | any | optional | Locarno classes value used by this API operation. |
data.data.data.items[].party_count | any | optional | Party count value used by this API operation. |
data.data.data.items[].primary_identifier | any | optional | Primary identifier value used by this API operation. |
data.data.data.items[].publication_date | any | optional | Publication date value used by this API operation. |
data.data.data.items[].publication_number | any | optional | Publication number value used by this API operation. |
data.data.data.items[].raw_status | any | optional | Raw status value used by this API operation. |
data.data.data.items[].registration_date | any | optional | Registration date value used by this API operation. |
data.data.data.items[].registration_jurisdiction | any | optional | Registration jurisdiction value used by this API operation. |
data.data.data.items[].registration_jurisdiction_code | any | optional | Registration jurisdiction code value used by this API operation. |
data.data.data.items[].registration_number | any | optional | Registration number value used by this API operation. |
data.data.data.items[].right_type | any | optional | Right type value used by this API operation. |
data.data.data.items[].simple_legal_status | any | optional | Simple legal status value used by this API operation. |
data.data.data.items[].text_count | any | optional | Text count value used by this API operation. |
data.data.data.items[].title | any | optional | Title value used by this API operation. |
data.data.data.items[].title_en | any | optional | Title en value used by this API operation. |
data.data.data.items[].title_en_source | any | optional | Title en source value used by this API operation. |
data.data.data.items[].title_language | any | optional | Title language value used by this API operation. |
data.data.data.returned | any | optional | Returned value used by this API operation. |
data.data.message | any | optional | Message value used by this API operation. |
data.data.request_id | any | optional | Request id value used by this API operation. |
data.data.usage | any | optional | Usage value used by this API operation. |
data.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.page | any | optional | Page value used by this API operation. |
data.pageItemCount | any | optional | Page item count value used by this API operation. |
data.pageSize | any | optional | Page size value used by this API operation. |
data.requestId | any | optional | Request id value used by this API operation. |
data.sourceTool | any | optional | Source tool value used by this API operation. |
data.sourceType | any | optional | Source type value used by this API operation. |
data.title | any | optional | Title value used by this API operation. |
data.totalPage | any | optional | Total page value used by this API operation. |
data.type | any | optional | Type value used by this API operation. |
data.upstreamRequestId | any | optional | Upstream request id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | null | optional | Cost time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costToken | integer | optional | Token cost reported by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.costToken | null | optional | Cost token value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.asset | string | optional | Source asset identifier. Example: asset.design_profile |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.asset | null | optional | Asset value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.asset_code | string | optional | Source asset code. Example: asset_ipr_design_profile |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.asset_code | null | optional | Asset code value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.execution | object | optional | Optional source execution metadata. Example: {} |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.execution | null | optional | Execution value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].application_date | string | optional | Application date, YYYY-MM-DD. Example: 2020-01-01 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].application_date | null | optional | Application date value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].application_number | string | optional | Source application number; preserve leading zeros. Example: example-application |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].application_number | null | optional | Application number value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].as_of_date | string | optional | Source confirmation date, not necessarily today. Example: 2026-10-09 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].as_of_date | null | optional | As of date value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].classification_count | integer | optional | Source fact count; missing values remain unknown. Example: 1 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].classification_count | null | optional | Classification count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].coverage_level | string | optional | Source coverage level; no completeness guarantee. Example: detail_ready |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].coverage_level | null | optional | Coverage level value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].data_quality_level | string | optional | Source data quality level; absent means unknown. Example: usable |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].data_quality_level | null | optional | Data quality level value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].data_version | string | optional | Source data version. Example: example-version |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].data_version | null | optional | Data version value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].design_registration_id | string | optional | Exact registration ID. Example: DSR:wipo_hague:EMID.001431738-0001 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].design_registration_id | null | optional | Design registration id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].designer_names | array | optional | Source designers, when known. Example: ["Example designer"] |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].designer_names | null | optional | Designer names value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].has_readable_image | integer | optional | Source media hint; not an image URL. Example: 1 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].has_readable_image | null | optional | Has readable image value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].holder_names | array | optional | Source holders, when known. Example: ["Example holder"] |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].holder_names | null | optional | Holder names value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].image_count | integer | optional | Source image count; do not construct download links. Example: 5 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].image_count | null | optional | Image count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].jurisdiction_iso2 | string | optional | Two-letter jurisdiction; EM represents the EU. Example: EM |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].jurisdiction_iso2 | null | optional | Jurisdiction iso2 value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].locarno_classes | array | optional | Source Locarno classes; preserve leading zeros. Example: ["09-01"] |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].locarno_classes | null | optional | Locarno classes value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].party_count | integer | optional | Source fact count; missing values remain unknown. Example: 1 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].party_count | null | optional | Party count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].primary_identifier | string | optional | Primary number; preserve leading zeros. Example: 001431738 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].primary_identifier | null | optional | Primary identifier value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].publication_date | string | optional | Publication date, YYYY-MM-DD. Example: 2020-03-01 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].publication_date | null | optional | Publication date value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].publication_number | string | optional | Source publication number. Example: example-publication |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].publication_number | null | optional | Publication number value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].raw_status | string | optional | Unmapped original source status. Example: DEL |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].raw_status | null | optional | Raw status value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].registration_date | string | optional | Registration date, YYYY-MM-DD. Example: 2020-02-01 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].registration_date | null | optional | Registration date value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].registration_jurisdiction | string | optional | Original source jurisdiction value. Example: EM |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].registration_jurisdiction | null | optional | Registration jurisdiction value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].registration_jurisdiction_code | string | optional | Original source jurisdiction code. Example: EMID |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].registration_jurisdiction_code | null | optional | Registration jurisdiction code value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].registration_number | string | optional | Source registration number, not a constructed registration ID. Example: example-registration |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].registration_number | null | optional | Registration number value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].right_type | string | optional | Source right type. Example: registered_design |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].right_type | null | optional | Right type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].simple_legal_status | string | optional | Source legal status; do not infer missing values. Example: inactive |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].simple_legal_status | null | optional | Simple legal status value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].text_count | integer | optional | Source fact count; missing values remain unknown. Example: 1 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].text_count | null | optional | Text count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].title | string | optional | Original source title. Example: Bottles |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].title | null | optional | Title value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].title_en | string | optional | Source English title; do not translate independently. Example: Bottles |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].title_en | null | optional | Title en value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].title_en_source | string | optional | Provenance of the English title. Example: source |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].title_en_source | null | optional | Title en source value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].title_language | string | optional | Source title language; may be unknown. Example: unknown |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.items[].title_language | null | optional | Title language value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.returned | integer | optional | Number of returned records, not dataset size. Example: 1 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.returned | null | optional | Returned value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.message | string | optional | Source status message. Example: success |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.message | null | optional | Message value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.request_id | string | optional | Source request identifier. Example: example-request |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.request_id | null | optional | Request id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.data.usage | object | optional | Raw source usage, not user billing or balance. Example: {} |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.data.usage | null | optional | Usage value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | null | optional | Data snapshot month value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.page | null | optional | Page value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pageItemCount | null | optional | Page item count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pageSize | null | optional | Page size value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.requestId | string | optional | Gateway/service error request identifier, distinct from upstream request_id. Example: gateway_example |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.requestId | null | optional | Request id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceTool | null | optional | Source tool value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | null | optional | Source type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.title | string | optional | Provider-specific response title. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.title | null | optional | Title value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPage | null | optional | Total page value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.type | string | optional | Provider-specific render or payload type. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.type | null | optional | Type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.upstreamRequestId | string | optional | Extracted upstream request identifier. Example: req_example |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.upstreamRequestId | null | optional | Upstream request id value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.