Skip to main content
GET
Obtener un item de verificación por ID

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

El ID único del item de verificación

Query Parameters

with_citations
boolean
default:false

Solo aplica a items de tipo acta. Si es true, la respuesta incluye citations.url: una URL firmada al artifact de coordenadas de ese documento. Ver Coordenadas de citas.

Response

Item de verificación obtenido exitosamente

id
number
item_status
string
item_order
number
item_type
string
item_value
object

Estructura depende de item_type. Ver guía en /guia-devs/respuestas-por-tipo-de-item.

Además de los campos propios del tipo, incluye una llave cp_<prompt_id> por cada extracción personalizada con resultado para ese ítem, donde prompt_id es el identificador editable de la extracción. Ver Extracciones personalizadas.

Ese prefijo solo aplica a tipos de documento estándar. Un ítem de un tipo de ítem personalizado (item_type con prefijo cit_) nunca lleva llaves cp_: sus resultados viven en pipeline, con la forma del schema CustomItemTypeItemValue. Ver Tipos de ítem personalizados.

item_error
string | null

Campo opcional que indica errores públicos relacionados con el procesamiento del ítem. Su valor depende del item_type que produjo el error.

Comunes a ítems documentales

  • password_protected_pdf: el PDF está protegido con contraseña y no puede procesarse.
  • get_input_file_info_failed: falló la obtención de información del archivo de entrada.

Específicos de doc_splitter (ver guía para el listado completo)

  • unsupported_file_type: el archivo no es un PDF.
  • unknown_custom_item_type / misconfigured_custom_item_type: allowed_item_types o client_item_type referencia un tipo personalizado (cit_*) que no existe o no está listo.
  • no_splits_returned: el análisis no identificó ningún documento en el PDF.
  • pdf_slice_failed: no se pudo leer o recortar el PDF (archivo corrupto o error de descarga del original).
  • pdf_slice_upload_failed: se recortaron los sub-PDFs pero falló la subida de al menos uno.
  • doc_splitter_request_failed: falló la llamada al servicio de análisis (OCR o AI). Reintentar suele resolverlo.

Específicos de doc_validation

  • invalid_document_type: el documento no corresponde al client_item_type esperado.
  • ruleset_validation_failed: al menos una regla del ruleset no se cumplió.

Trata este campo como un string opaco: además de los códigos anteriores puede llegar con otros valores para ítems específicos (por ejemplo prevalidation_failed en csf_mx) o, en errores inesperados, con un mensaje libre en inglés.

item_internal_status
string | null
item_options
object | null
item_ui_options
object | null
validation_result
object | null
user_event_completed_at
string | null
user_event_name
string | null
user_event_reason
string | null
tag
string | null
item_scope
string | null
original_file_url
string | null
citations
object

Presente solo cuando se llamó con ?with_citations=true y el item es de tipo acta. Contiene la URL firmada (CloudFront) al artifact de coordenadas en S3. Ver Coordenadas de citas.