GET /v1/dgii/document:search

Búsqueda de contribuyentes DGII por nombre, nombre comercial, actividad económica o prefijo de documento.

Parámetros de consulta

Param	Requerido	Tipo	Default	Descripción
q	Sí	string	—	Texto a buscar (mínimo 3 caracteres)
field	Sí	enum	—	name · trade_name · economic_activity · document
type	No	enum	—	Filtro por tipo: rnc o cedula
limit	No	integer	25	Máximo de resultados (1–100)

Headers requeridos

Header	Descripción
x-api-key	API key sandbox/producción

Respuestas

200 — Resultados

{
  "items": [
    {
      "rnc": "130862346",
      "name": "DIRECCIÓN GENERAL DE IMPUESTOS INTERNOS",
      "trade_name": "DGII",
      "economic_activity": "ADMINISTRACIÓN PÚBLICA EN GENERAL",
      "status": "ACTIVO"
    }
  ],
  "count": 1,
  "partial": false
}

Campos de respuesta

Campo	Tipo	Descripción
items	array	Registros que coinciden con la búsqueda
count	integer	Número de resultados en esta respuesta
partial	boolean	true si se alcanzó el límite y existen más resultados

400 — Parámetros inválidos

{
  "type": "https://api.erply.pro/errors/validation-error",
  "title": "Bad Request",
  "status": 400,
  "detail": "Query 'q' must be at least 3 characters."
}

Ejemplos

Búsqueda por nombre

curl -s "https://api.erply.pro/v1/dgii/document:search?q=ERPLY&field=name&limit=5" \
  -H "x-api-key: $ERPLYPRO_API_KEY"

Búsqueda por actividad económica

curl -s "https://api.erply.pro/v1/dgii/document:search?q=ADMINISTRACION&field=economic_activity&limit=10" \
  -H "x-api-key: $ERPLYPRO_API_KEY"

Búsqueda por prefijo de documento

curl -s "https://api.erply.pro/v1/dgii/document:search?q=13086&field=document" \
  -H "x-api-key: $ERPLYPRO_API_KEY"

Ejemplos de código

Ver ejemplos multi-lenguaje (Python, JavaScript, C#, PHP, Go) y la colección Postman.

Notas

• La búsqueda normaliza el texto automáticamente (mayúsculas, sin acentos).
• El campo partial indica si hay más resultados disponibles (refine la búsqueda para obtener resultados más precisos).
• La búsqueda por name usa un índice GSI dedicado; trade_name y economic_activity usan scan parcial con filtro — rendimiento aceptable hasta ~50 ms para queries comunes.