https://api.nexscope.ai/ai/designSimilaritySearchEjecutar esta API
Envía una solicitud JSON para ejecutar esta API y recibir los datos de respuesta documentados.
Endpoint
| Método | POST |
| Ruta | https://api.nexscope.ai/ai/designSimilaritySearch |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
imageBase64 | string | opcional | Bytes de imagen Pure Base64, 16–20971520 caracteres; omitir imageUrl. Patrón: ^[A-Za-z0-9+/]+={0,2}$ Longitud mínima: 16 Longitud máxima: 20971520 |
imageUrl | string | opcional | Imagen pública HTTP(S) URL, 8–4096 caracteres; exactamente una fuente de imagen. Formato: uri Patrón: ^https?:// Longitud mínima: 8 Longitud máxima: 4096 |
jurisdictionCodes | array | opcional | Hasta 32 códigos fuente distintos de 2-8 letras; intersecta regiones cuando se suministran ambos. Cantidad máxima de elementos: 32 |
jurisdictionCodes[] | string | obligatorio | Hasta 32 códigos fuente distintos de 2-8 letras; intersecta regiones cuando se suministran ambos. Patrón: ^[A-Za-z]{2,8}$ |
locarnoClasses | array | opcional | Hasta 64 clases distintas de NN-NN Locarno. Cantidad máxima de elementos: 64 |
locarnoClasses[] | string | obligatorio | Hasta 64 clases distintas de NN-NN Locarno. Patrón: ^[0-9]{2}-[0-9]{2}$ |
patentStatus | array | opcional | Uno o dos enteros distintos: 0 inactivo, 1 activo; omitir por ninguna preferencia de estado. Cantidad mínima de elementos: 1 Cantidad máxima de elementos: 2 |
patentStatus[] | integer | obligatorio | Uno o dos enteros distintos: 0 inactivo, 1 activo; omitir por ninguna preferencia de estado. Permitidos: 0, 1 |
regions | array | opcional | Hasta 64 códigos de dos letras diferentes de la región, por ejemplo, EE.UU. o EM; utilizar el EM para la UE. Cantidad máxima de elementos: 64 |
regions[] | string | obligatorio | Hasta 64 códigos de dos letras diferentes de la región, por ejemplo, EE.UU. o EM; utilizar el EM para la UE. Patrón: ^[A-Za-z]{2}$ |
title | string | opcional | Contexto de imagen opcional, 1–4096 caracteres recortados; no una consulta de texto independiente. Longitud mínima: 1 Longitud máxima: 4096 |
topK | integer | opcional | Límite de candidatos, 1–200; por defecto 20. Predeterminado: 20 Mínimo: 1 Máximo: 200 |
topLoc | array | opcional | Hasta 32 prefijos Locarno de dos dígitos distintos; conserve los ceros principales. Cantidad máxima de elementos: 32 |
topLoc[] | string | obligatorio | Hasta 32 prefijos Locarno de dos dígitos distintos; conserve los ceros principales. Patrón: ^[0-9]{2}$ |
Opción 1 de una alternativa — requiere imageUrl
Opción 2 de una alternativa — requiere imageBase64
Respuesta de ejemplo
Estructura de respuesta de la plataforma. code 0 indica éxito o aceptación; data contiene el resultado de negocio.
{
"code": 0,
"cost": "-1",
"data": {
"data": {
"code": "OK",
"data": {
"candidates": [
{
"applicant_addresses": null,
"application_date": "2010-04-13",
"application_number": "001694860",
"design_registration_id": "DSR:euipo_design:001694860-0001",
"designer_names": null,
"estimated_expiration_date": null,
"expiration_date_basis": null,
"holder_names": [
"237302"
],
"image_url": "https://example.com/design-1.png?signature=example%2Bsignature&expires=2000000000",
"images": [
"https://example.com/design-1.png?signature=example%2Bsignature&expires=2000000000",
"https://example.com/design-2.png?signature=second&expires=2000000000"
],
"jurisdiction_iso2": "EM",
"locarno_classes": [
"06.01"
],
"locarno_details": [
{
"code": "06.01",
"label_en": null,
"label_zh": null,
"parent_code": "06"
}
],
"novelty_statement": null,
"primary_identifier": "001694860-0001",
"protected_jurisdictions": [
"EM"
],
"publication_date": null,
"publication_number": null,
"registration_date": null,
"registration_jurisdiction_code": "EU",
"registration_number": "E077151-PC",
"risk_level": "medium",
"similarity": 99.88,
"simple_legal_status": "inactive",
"specification": null,
"title": "E077151-PC",
"title_en": "Chairs [seats]",
"title_language": "unknown",
"tro_cases": []
}
],
"total": 1
},
"message": "success",
"request_id": "req_example"
}
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Campos de respuesta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | obligatorio | 0 significa aceptado o exitoso; no cero es un error de plataforma. |
cost | string | obligatorio | Se pasó milisegundos, nunca créditos; -1 peticiones externas de la web. |
data | any | obligatorio | Valor de Data usado por esta operación de API. |
msg | string | null | obligatorio | Valor de Msg usado por esta operación de API. |
time | string | obligatorio | Hora local del servidor: aaaa-mm-dd HH:mm:ss. |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Epoch milisegundos. |
Opción 1 de cualquier alternativa — requiere data
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.costTime | any | opcional | Valor de Cost time usado por esta operación de API. |
data.costToken | any | opcional | Valor de Cost token usado por esta operación de API. |
data.data | object | obligatorio | Sobre de origen dentro de la carga útil de la puerta de enlace. Ejemplo: {} |
data.data.code | string | obligatorio | El éxito está bien. Los errores incluyen 400 DATA_IMAGE_DOWNLOAD_FAILED (sin sustitución de imágenes), 413 SYSTEM_PAYLOAD_TOO_LARGE (sin compresión automática), 502 SR_QUERY_ERROR y 503 CAPABILITY_BACKEND_UNAVAILABLE (fallo del motor, no cero hits o créditos insuficientes). Preservar código real y solicitar identificadores; no hay reintentos automáticos. Ejemplo: OK |
data.data.data | object | obligatorio | Resultado de la búsqueda; mantenga la cobertura opcional y las advertencias cuando devuelvan. Ejemplo: {} |
data.data.data.candidates | array | obligatorio | Candidatos en orden de retorno; vacío no es libertad para operar. Ejemplo: [{"applicant_addresses":null,"application_date":"2010-04-13","application_number":"001694860","design_registration_id":"DSR:euipo_design:001694860-0001","designer_names":null,"estimated_expiration_date":null,"expiration_date_basis":null,"holder_names":["237302"],"image_url":"https://example.com/design-1.png?signature=example%2Bsignature&expires=2000000000","images":["https://example.com/design-1.png?signature=example%2Bsignature&expires=2000000000","https://example.com/design-2.png?signature=second&expires=2000000000"],"jurisdiction_iso2":"EM","locarno_classes":["06.01"],"locarno_details":[{"code":"06.01","label_en":null,"label_zh":null,"parent_code":"06"}],"novelty_statement":null,"primary_identifier":"001694860-0001","protected_jurisdictions":["EM"],"publication_date":null,"publication_number":null,"registration_date":null,"registration_jurisdiction_code":"EU","registration_number":"E077151-PC","risk_level":"medium","similarity":99.88,"simple_legal_status":"inactive","specification":null,"title":"E077151-PC","title_en":"Chairs [seats]","title_language":"unknown","tro_cases":[]}] |
data.data.data.candidates[] | object | obligatorio | Elemento de data data data candidates. |
data.data.data.candidates[].applicant_addresses | any | opcional | Valor de Applicant addresses usado por esta operación de API. |
data.data.data.candidates[].application_date | any | opcional | Valor de Application date usado por esta operación de API. |
data.data.data.candidates[].application_number | any | opcional | Valor de Application number usado por esta operación de API. |
data.data.data.candidates[].design_registration_id | any | opcional | Valor de Design registration id usado por esta operación de API. |
data.data.data.candidates[].designer_names | any | opcional | Valor de Designer names usado por esta operación de API. |
data.data.data.candidates[].estimated_expiration_date | any | opcional | Valor de Estimated expiration date usado por esta operación de API. |
data.data.data.candidates[].expiration_date_basis | any | opcional | Valor de Expiration date basis usado por esta operación de API. |
data.data.data.candidates[].holder_names | any | opcional | Valor de Holder names usado por esta operación de API. |
data.data.data.candidates[].image_url | any | opcional | Valor de Image url usado por esta operación de API. |
data.data.data.candidates[].images | any | opcional | Valor de Images usado por esta operación de API. |
data.data.data.candidates[].jurisdiction_iso2 | any | opcional | Valor de Jurisdiction iso2 usado por esta operación de API. |
data.data.data.candidates[].locarno_classes | any | opcional | Valor de Locarno classes usado por esta operación de API. |
data.data.data.candidates[].locarno_details | any | opcional | Valor de Locarno details usado por esta operación de API. |
data.data.data.candidates[].novelty_statement | any | opcional | Valor de Novelty statement usado por esta operación de API. |
data.data.data.candidates[].primary_identifier | any | opcional | Valor de Primary identifier usado por esta operación de API. |
data.data.data.candidates[].protected_jurisdictions | any | opcional | Valor de Protected jurisdictions usado por esta operación de API. |
data.data.data.candidates[].publication_date | any | opcional | Valor de Publication date usado por esta operación de API. |
data.data.data.candidates[].publication_number | any | opcional | Valor de Publication number usado por esta operación de API. |
data.data.data.candidates[].registration_date | any | opcional | Valor de Registration date usado por esta operación de API. |
data.data.data.candidates[].registration_jurisdiction_code | any | opcional | Valor de Registration jurisdiction code usado por esta operación de API. |
data.data.data.candidates[].registration_number | any | opcional | Valor de Registration number usado por esta operación de API. |
data.data.data.candidates[].risk_level | any | opcional | Valor de Risk level usado por esta operación de API. |
data.data.data.candidates[].similarity | any | opcional | Valor de Similarity usado por esta operación de API. |
data.data.data.candidates[].simple_legal_status | any | opcional | Valor de Simple legal status usado por esta operación de API. |
data.data.data.candidates[].specification | any | opcional | Valor de Specification usado por esta operación de API. |
data.data.data.candidates[].title | any | opcional | Valor de Title usado por esta operación de API. |
data.data.data.candidates[].title_en | any | opcional | Valor de Title en usado por esta operación de API. |
data.data.data.candidates[].title_language | any | opcional | Valor de Title language usado por esta operación de API. |
data.data.data.candidates[].tro_cases | any | opcional | Valor de Tro cases usado por esta operación de API. |
data.data.data.coverage | any | opcional | Valor de Coverage usado por esta operación de API. |
data.data.data.total | any | opcional | Valor de Total usado por esta operación de API. |
data.data.data.warnings | any | opcional | Valor de Warnings usado por esta operación de API. |
data.data.message | any | opcional | Valor de Message usado por esta operación de API. |
data.data.request_id | any | opcional | Valor de Request id usado por esta operación de API. |
data.data.usage | any | opcional | Valor de Usage usado por esta operación de API. |
data.dataSnapshotMonth | any | opcional | Valor de Data snapshot month usado por esta operación de API. |
data.page | any | opcional | Valor de Page usado por esta operación de API. |
data.pageItemCount | any | opcional | Valor de Page item count usado por esta operación de API. |
data.pageSize | any | opcional | Valor de Page size usado por esta operación de API. |
data.requestId | any | opcional | Valor de Request id usado por esta operación de API. |
data.sourceTool | any | opcional | Valor de Source tool usado por esta operación de API. |
data.sourceType | any | opcional | Valor de Source type usado por esta operación de API. |
data.title | any | opcional | Valor de Title usado por esta operación de API. |
data.totalPage | any | opcional | Valor de Total page usado por esta operación de API. |
data.type | any | opcional | Valor de Type usado por esta operación de API. |
data.upstreamRequestId | any | opcional | Valor de Upstream request id usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.costTime | integer | opcional | Tiempo de ejecución comunicado por el proveedor de aguas arriba. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.costTime | null | opcional | Valor de Cost time usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.costToken | integer | opcional | Coste de la señal comunicado por el proveedor de aguas arriba. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.costToken | null | opcional | Valor de Cost token usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].applicant_addresses | array | opcional | Origen del solicitante objetos con nombre y dirección; nunca inferir jurisdicciones de protección. Ejemplo: null |
data.data.data.candidates[].applicant_addresses[] | object | obligatorio | Elemento de data data data candidates[] applicant_addresses. |
data.data.data.candidates[].applicant_addresses[].address | string | opcional | Dirección de la fuente; no pruebas de jurisdicción protegida. Ejemplo: Example address |
data.data.data.candidates[].applicant_addresses[].name | string | opcional | Nombre del solicitante de origen. Ejemplo: Example applicant |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].applicant_addresses | null | opcional | Valor de Applicant addresses usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].application_date | string | opcional | Fecha de aplicación de origen, YYYY-MM-DD. Ejemplo: 2010-04-13 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].application_date | null | opcional | Valor de Application date usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].application_number | string | opcional | Número de solicitud de origen. Ejemplo: 001694860 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].application_number | null | opcional | Valor de Application number usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].design_registration_id | string | opcional | Id. de registro exacto para más detalles; conservar sin cambios. Ejemplo: DSR:euipo_design:001694860-0001 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].design_registration_id | null | opcional | Valor de Design registration id usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].designer_names | array | opcional | Diseñadores de fuentes; falta o nulidad significa desconocido. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].designer_names | null | opcional | Valor de Designer names usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].estimated_expiration_date | string | opcional | Fecha estimada solamente, AAAA-MM-DD; no se ha confirmado la caducidad o nulidad. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].estimated_expiration_date | null | opcional | Valor de Estimated expiration date usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].expiration_date_basis | object | array | string | number | boolean | null | opcional | Fuente JSON de cualquier forma, o nula; nunca inventar una base de estimación. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].expiration_date_basis | null | opcional | Valor de Expiration date basis usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].holder_names | array | opcional | Titulares de fuentes; no resuelva identificadores numéricos a nombres inventados. Ejemplo: ["237302"] |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].holder_names | null | opcional | Valor de Holder names usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].image_url | string | opcional | Completa firma de primera imagen URL; cuando las imágenes existen esto equivale a imágenes[0]. Nunca se tiran los parámetros de la consulta. Ejemplo: https://example.com/design-1.png?signature=example%2Bsignature&expires=2000000000 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].image_url | null | opcional | Valor de Image url usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].images | array | opcional | Como máximo seis URLs de imágenes firmadas completas en orden original; vacía significa que no hay imágenes disponibles. Ejemplo: ["https://example.com/design-1.png?signature=example%2Bsignature&expires=2000000000","https://example.com/design-2.png?signature=second&expires=2000000000"] Cantidad máxima de elementos: 6 |
data.data.data.candidates[].images[] | string | obligatorio | Elemento de data data data candidates[] images. |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].images | null | opcional | Valor de Images usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].jurisdiction_iso2 | string | opcional | Jurisdicción de registro, distinta de las jurisdicciones protegidas. Ejemplo: EM |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].jurisdiction_iso2 | null | opcional | Valor de Jurisdiction iso2 usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].locarno_classes | array | opcional | Preservar códigos de salida como 06.01 o 09-01; las solicitudes todavía requieren NN-NN. Ejemplo: ["06.01"] |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].locarno_classes | null | opcional | Valor de Locarno classes usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].locarno_details | array | opcional | Código fuente, parent_code, label_zh y label_en; las etiquetas que faltan permanecen desconocidas. Ejemplo: [{"code":"06.01","label_en":null,"label_zh":null,"parent_code":"06"}] |
data.data.data.candidates[].locarno_details[] | object | obligatorio | Elemento de data data data candidates[] locarno_details. |
data.data.data.candidates[].locarno_details[].code | string | opcional | Código de clasificación de fuentes no modificado. Ejemplo: 06.01 |
data.data.data.candidates[].locarno_details[].label_en | string | opcional | Fuente Etiqueta inglesa; falta/nulo permanece desconocido. Ejemplo: null |
data.data.data.candidates[].locarno_details[].label_zh | string | opcional | Etiqueta china de origen; falta/nulo permanece desconocido. Ejemplo: null |
data.data.data.candidates[].locarno_details[].parent_code | string | opcional | Clasificación de los padres de origen. Ejemplo: 06 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].locarno_details | null | opcional | Valor de Locarno details usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].novelty_statement | string | opcional | Fuente de la declaración de novedad; retenga el texto original, no una conclusión legal. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].novelty_statement | null | opcional | Valor de Novelty statement usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].primary_identifier | string | opcional | Número de pantalla primario; mantenga los ceros principales. Ejemplo: 001694860-0001 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].primary_identifier | null | opcional | Valor de Primary identifier usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].protected_jurisdictions | array | opcional | HAGUE Estados designados o jurisdicción ordinaria de registro; nulo significa desconocido, nunca llena de regiones. Ejemplo: ["EM"] |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].protected_jurisdictions | null | opcional | Valor de Protected jurisdictions usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].publication_date | string | opcional | Fecha de publicación de la fuente: AAAA-MM-DD. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].publication_date | null | opcional | Valor de Publication date usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].publication_number | string | opcional | Número de publicación de la fuente; falta o nulidad significa desconocido. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].publication_number | null | opcional | Valor de Publication number usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].registration_date | string | opcional | Fecha de registro de la fuente: AAAA-MM-DD. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].registration_date | null | opcional | Valor de Registration date usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].registration_jurisdiction_code | string | opcional | Código de jurisdicción de origen como UE, EMID o USID; no reescribir como ISO-2. Ejemplo: EU |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].registration_jurisdiction_code | null | opcional | Valor de Registration jurisdiction code usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].registration_number | string | opcional | Número de registro de la fuente. Ejemplo: E077151-PC |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].registration_number | null | opcional | Valor de Registration number usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].risk_level | string | opcional | Fuente de riesgo indirecta, separado de la puntuación y la situación legal; no un veredicto de infracción. Ejemplo: medium |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].risk_level | null | opcional | Valor de Risk level usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].similarity | number | opcional | Final 0-100 puntuación, no es una probabilidad. Preservar el orden devuelto; nunca multiplicar por 100 o ordenar de nuevo. Ejemplo: 99.88 Mínimo: 0 Máximo: 100 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].similarity | null | opcional | Valor de Similarity usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].simple_legal_status | string | opcional | Origen de la condición jurídica; no infieren de la similitud. Ejemplo: inactive |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].simple_legal_status | null | opcional | Valor de Simple legal status usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].specification | object | array | string | number | boolean | null | opcional | Fuente JSON de cualquier forma, o nula; preservar la estructura real sin llenar huecos. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].specification | null | opcional | Valor de Specification usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].title | string | opcional | Título fuente, que puede ser un número. Ejemplo: E077151-PC |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].title | null | opcional | Valor de Title usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].title_en | string | opcional | Título original en inglés; no traduzca los valores que faltan. Ejemplo: Chairs [seats] |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].title_en | null | opcional | Valor de Title en usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].title_language | string | opcional | Lenguaje fuente del título; puede ser desconocido. Ejemplo: unknown |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].title_language | null | opcional | Valor de Title language usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].tro_cases | array | opcional | TRO corpus asociaciones actuales; vacío no es confirmación de ningún TRO. Ejemplo: [] |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.candidates[].tro_cases | null | opcional | Valor de Tro cases usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.coverage | object | opcional | Cobertura opcional de la fuente; no inferir la integridad. Ejemplo: {} |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.coverage | null | opcional | Valor de Coverage usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.total | integer | opcional | Conteo de candidatos retornados, no el tamaño del corpus o las unidades de facturación del usuario. Ejemplo: 1 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.total | null | opcional | Valor de Total usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.warnings | array | opcional | Limitaciones de origen opcionales. Ejemplo: [] |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.warnings | null | opcional | Valor de Warnings usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.message | string | opcional | Mensaje de estado de origen. Ejemplo: success |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.message | null | opcional | Valor de Message usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.request_id | string | opcional | Identificador de petición ascendente; mantener separado del requestId. Ejemplo: req_example |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.request_id | null | opcional | Valor de Request id usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.usage | object | opcional | Uso de la cuenta de origen; no débito o saldo del usuario. Ejemplo: {} |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.usage | null | opcional | Valor de Usage usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.dataSnapshotMonth | string | opcional | Mes de instantánea de datos devuelto por el proveedor de aguas arriba. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.dataSnapshotMonth | null | opcional | Valor de Data snapshot month usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.page | integer | opcional | Página actual devuelta por el proveedor de aguas arriba. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.page | null | opcional | Valor de Page usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.pageItemCount | integer | opcional | El artículo cuenta con la página actual devuelta por el proveedor de aguas arriba. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.pageItemCount | null | opcional | Valor de Page item count usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.pageSize | integer | opcional | Tamaño de página devuelto por el proveedor de aguas arriba. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.pageSize | null | opcional | Valor de Page size usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.requestId | string | opcional | Identificador de la solicitud de error de pasarela/servicio; distinto de la anterior request_id. Ejemplo: gateway_example |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.requestId | null | opcional | Valor de Request id usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.sourceTool | string | opcional | Nombre de la herramienta de fuente específica del proveedor. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.sourceTool | null | opcional | Valor de Source tool usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.sourceType | string | opcional | Tipo de plataforma de origen específico para el proveedor. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.sourceType | null | opcional | Valor de Source type usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.title | string | opcional | Título de respuesta específico del proveedor. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.title | null | opcional | Valor de Title usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.totalPage | integer | opcional | El total de páginas devueltas por el proveedor de aguas arriba. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.totalPage | null | opcional | Valor de Total page usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.type | string | opcional | Rendición específica del proveedor o tipo de carga útil. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.type | null | opcional | Valor de Type usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.upstreamRequestId | string | opcional | Identificador de solicitud de origen extraído. Ejemplo: req_example |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.upstreamRequestId | null | opcional | Valor de Upstream request id usado por esta operación de API. |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data | null | obligatorio | Valor de Data usado por esta operación de API. |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta HTTP predeterminada tanto para el éxito como para muchos errores de negocio. Solo el código JSON externo 0 indica éxito o aceptación asíncrona; consulta data para obtener el resultado. |
| 429 | Límite de admisión de ejecuciones; respeta Retry-After cuando esté presente. |
| 503 | La admisión de ejecuciones no está disponible temporalmente; respeta Retry-After cuando esté presente. |
| Opcional | X-Nexscope-Http-Status: semantic asigna estados HTTP a los errores de negocio gestionados por el controlador en las rutas de ejecución y tareas. Los fallos previos a la autenticación, como la ausencia de una clave API (code 11209), pueden seguir devolviendo HTTP 200 antes de esta asignación. Comprueba siempre el código JSON externo; las solicitudes malformadas y los fallos de infraestructura también pueden devolver respuestas HTTP distintas de 200. |
Fuente de datos, vigencia y limitaciones
La fuente, la vigencia, la cobertura, los límites de frecuencia y las notas de estimación no se especifican en esta definición de API salvo que aparezcan en la documentación de campos de solicitud o respuesta anterior. No supongas datos oficiales del mercado ni actualización en tiempo real cuando no estén documentados explícitamente.