API de consultas

Autenticación

Manda tu API key en el header x-api-key en cada petición. Creas y administras tus keys desde API y MCP en el dashboard.

x-api-key: TU_API_KEY

Entornos

Hay dos entornos y cada uno tiene su propio host. El entorno de la key debe coincidir con el host en ambos sentidos: una key de sandbox solo funciona en el host con prefijo sandbox. y una key de producción solo en el host pelón. Si no coinciden, la petición responde 401.

Toda cuenta empieza únicamente con keys de sandbox. Para consultar en producción, cada servicio debe certificarse desde Certificación en el dashboard: envías las evidencias de tu proceso y las revisamos para liberarlo. Una key sin certificación nunca llega al buró real, aunque apunte a producción.

Flujo de una consulta

Una consulta se completa en varios pasos. El consultado autoriza con un NIP: un solo código que el buró pide dos veces, una para ingresarlo y otra para confirmarlo.

Valores de nipPhase: CREATE_ACCOUNT → VALIDATE → VALIDATE_2 → "" (vacío al terminar). Valores de estado: EN_PROGRESO, COMPLETADA, ERROR.

Endpoints

Crear una consulta

Inicia una consulta. El body lleva el tipo de reporte, el canal por el que se entrega el NIP y los datos del consultado.

Parámetros

{
  "tipo": "ORDINARIO",
  "canal": "SMS",
  "sujeto": {
    "primerNombre": "JUAN",
    "segundoNombre": "",
    "apellidoPaterno": "PEREZ",
    "apellidoMaterno": "LOPEZ",
    "rfc": "PXLJ850101H12",
    "calleNumero": "AV REFORMA 123",
    "cp": "06600",
    "celular": "5555555555",
    "correo": "juan@example.com",
    "fechaNacimiento": "1985-01-01"
  }
}

Ejemplo rápido

Coloca tu API key en el header x-api-key y agrega el header Content-Type: application/json para enviar el body como JSON.

curl -X POST https://sandbox.dashboard.consultasnonstop.com/v1/consultas \
  -H "x-api-key: TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tipo": "ORDINARIO",
    "canal": "SMS",
    "sujeto": {
      "primerNombre": "JUAN",
      "segundoNombre": "",
      "apellidoPaterno": "PEREZ",
      "apellidoMaterno": "LOPEZ",
      "rfc": "PXLJ850101H12",
      "calleNumero": "AV REFORMA 123",
      "cp": "06600",
      "celular": "5555555555",
      "correo": "juan@example.com",
      "fechaNacimiento": "1985-01-01"
    }
  }'

Respuesta

{
  "id": "6a7f1c2e9b3d4a5f6e7d8c90",
  "tipo": "ORDINARIO",
  "estado": "EN_PROGRESO",
  "nipPhase": "CREATE_ACCOUNT",
  "reporteId": "",
  "errorMensaje": "",
  "creadoEn": "2026-07-07T18:00:00Z"
}

Enviar el NIP

Envía el NIP al consultado por el canal que elegiste al crear la consulta. No lleva body. nipPhase pasa a VALIDATE.

curl -X POST https://sandbox.dashboard.consultasnonstop.com/v1/consultas/CONSULTA_ID/nip/send \
  -H "x-api-key: TU_API_KEY"

Validar y confirmar el NIP

Valida el código. Llámalo dos veces con el mismo NIP: la primera pasa a VALIDATE_2, la segunda cierra el ciclo y deja la consulta en COMPLETADA con su reporteId. No es un segundo código distinto: es el mismo, como cuando el buró te pide "ingresa nuevamente tu NIP".

curl -X POST https://sandbox.dashboard.consultasnonstop.com/v1/consultas/CONSULTA_ID/nip/validate \
  -H "x-api-key: TU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "nip": "123456" }'

Respuesta

{
  "id": "6a7f1c2e9b3d4a5f6e7d8c90",
  "tipo": "ORDINARIO",
  "estado": "EN_PROGRESO",
  "nipPhase": "VALIDATE_2",
  "reporteId": "",
  "errorMensaje": "",
  "creadoEn": "2026-07-07T18:00:00Z"
}

Descargar el reporte

Devuelve el PDF del reporte de buró (application/pdf). Solo cuando estado es COMPLETADA; si todavía no lo está responde 409 no_disponible.

curl https://sandbox.dashboard.consultasnonstop.com/v1/consultas/CONSULTA_ID/reporte \
  -H "x-api-key: TU_API_KEY" \
  -o reporte.pdf

Consultar el estado

Devuelve el estado guardado de la consulta más la fase del NIP en vivo. Es solo lectura: no finaliza la consulta ni descuenta saldo.

curl https://sandbox.dashboard.consultasnonstop.com/v1/consultas/CONSULTA_ID \
  -H "x-api-key: TU_API_KEY"

{
  "id": "6a7f1c2e9b3d4a5f6e7d8c90",
  "tipo": "ORDINARIO",
  "estado": "EN_PROGRESO",
  "nipPhase": "CREATE_ACCOUNT",
  "reporteId": "",
  "errorMensaje": "",
  "creadoEn": "2026-07-07T18:00:00Z"
}

Consultar el saldo

Saldo de consultas disponible por tipo de reporte. El saldo lo alimentan las consultas incluidas en tu plan cada ciclo y los paquetes adicionales que compres.

curl https://sandbox.dashboard.consultasnonstop.com/v1/saldos \
  -H "x-api-key: TU_API_KEY"

{ "ordinario": 12, "especial": 3 }

Catálogo de paquetes

Paquetes de consultas vigentes por tipo. precio viene en centavos MXN: 49900 son $499.00.

curl https://sandbox.dashboard.consultasnonstop.com/v1/paquetes \
  -H "x-api-key: TU_API_KEY"

{
  "ordinario": [
    {
      "id": "6a7f1c2e9b3d4a5f6e7d8c92",
      "tipoReporte": "ORDINARIO",
      "cantidad": 10,
      "precio": 49900,
      "vigenteDesde": "2026-01-01T00:00:00Z"
    }
  ],
  "especial": [
    {
      "id": "6a7f1c2e9b3d4a5f6e7d8c93",
      "tipoReporte": "ESPECIAL",
      "cantidad": 5,
      "precio": 129900,
      "vigenteDesde": "2026-01-01T00:00:00Z"
    }
  ]
}

La API es de consulta: no hay endpoint REST para comprar paquetes. Recargas tu saldo desde Planes y paquetes en el dashboard, o con la herramienta comprar_paquete del servidor MCP.

Formato de errores

Los errores de la aplicación usan un envelope con type (estable, para programar contra él) y message (legible, para mostrar).

{
  "error": {
    "type": "saldo_insuficiente",
    "message": "No tienes saldo de este tipo de reporte."
  }
}

Autenticación (401)

Los errores de la capa de API key usan un envelope distinto: message más code, sin el objeto error.

{
  "message": "api key environment does not match host",
  "code": "UNAUTHORIZED"
}

Responden 401:

Errores de la aplicación

Sandbox

En sandbox no se consulta al buró real: los datos son sintéticos y el flujo completo corre igual. Usa una key de sandbox contra el host https://sandbox.dashboard.consultasnonstop.com y el NIP de prueba 123456, el mismo código dos veces (ingresar y confirmar).

Casos de prueba

Caso A — Ordinario por SMS (camino feliz)

Caso B — Especial por correo

Igual que el Caso A pero con tipo: ESPECIAL y canal: EMAIL. Recuerda que correo y fechaNacimiento son obligatorios en este caso; si faltan, responde 400 campos_invalidos.

Caso C — Errores esperados

Nota: si el consultado de prueba ya existe en el sandbox (la misma identidad repetida), el escenario puede completar la consulta sin pedir el NIP interactivo. Usa un RFC nuevo para forzar el flujo completo del NIP.