Parámetro include
El parámetro include es obligatorio en el endpoint de detalle. Controla qué datos recibe y cuánto paga.
Sintaxis
GET /v4/{jurisdiccion}/entidades/{id}?include=CODIGO1,CODIGO2,CODIGO3
Los códigos se separan por coma, sin espacios. El código mínimo es
CHK-BIN.
El conjunto de códigos aceptado depende de la jurisdicción.
Panamá acepta el catálogo completo de códigos, incluido DAT-ALL.
Ecuador acepta tres:
CHK-BIN,
DAT-CORE y
DAT-ALL.
El catálogo vigente con costos se consulta en vivo con
GET /v5/catalog (gratis) o
previsualizando la llamada con dry_run.
Ejemplos
Verificación rápida
?include=CHK-BIN
Solo confirma existencia. El código más económico del catálogo.
Perfil básico + gobierno
?include=DAT-CORE,DAT-GOV
Datos de registro, contacto, directores y gobierno. Se cobra el cargo base más cada código no redundante.
Due diligence completo
?include=DAT-ALL
Toda la información disponible. Previsualice el cargo exacto con dry_run=true.
Resolución inteligente
Si solicita códigos que comparten niveles, solo se cobra el más amplio.
Por ejemplo, DAT-CORE
ya incluye el nivel core_registro
de CHK-BIN,
así que solicitar ambos solo cobra DAT-CORE.
Códigos no soportados
Si solicita un código que la jurisdicción no reconoce, la respuesta es
400 Bad Request
con la lista de códigos soportados:
$ curl 'https://api.panadata.net/v4/ecuador/entidades/52015398?include=DAT-GOV' \
--header 'Authorization: Bearer pk_su_llave'
{
"error": "unknown product code(s): DAT-GOV",
"jurisdiction": "ecuador",
"supported_includes": ["CHK-BIN", "DAT-CORE", "DAT-ALL"]
}
Use supported_includes
para descubrir el catálogo de cada jurisdicción sin tener que mantenerlo en su lado.
Anterior: ← Primera consulta
Siguiente: Sandbox vs API →