Desarrolladores

Documentación de la API de CredoRisk.

El cliente solicita un informe a través de su API. Su backend llama a la API de CredoRisk, que genera el informe estandarizado y lo devuelve en JSON/PDF.

Inicio rápido

Integración

Conecte CredoRisk a su backend en pocos días

La API está diseñada para uso servidor a servidor: autenticación por clave, endpoints estables, respuestas JSON normalizadas. Sus equipos de negocio conservan el mismo formato CredoRisk que en la interfaz web — sin exponer los proveedores de origen al cliente final.

Claves API creadas y revocables en el espacio de cliente
Flujo Francia recomendado: search → france/{siren} → uuid → PDF
Internacional: país + identificador oficial
Errores documentados (401, 402, 422…) y timeouts recomendados

Crear una cuenta de desarrollador

Inicio rápido — Francia (recomendado)

Flujo de API de informe estándar: misma lógica que la interfaz web de CredoRisk. Guarde el uuid devuelto.

# 1) Buscar en Francia por nombre (0 crédito)
curl -sS -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/standard/search?q=airbus"
# -> leer results.resultats[].siren

# 2) Generar informe de Francia (1 crédito)
curl -sS -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/standard/france/383474814"
# -> guardar report.uuid

# 3) Lectura completa (0 crédito)
curl -sS -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/standard/report/550e8400-e29b-41d4-a716-446655440000"

# 4) PDF (0 crédito)
curl -sS -H "Authorization: Bearer <api_key>" \
  -o report.pdf \
  "https://credorisk.com/api/v1/standard/report/550e8400-e29b-41d4-a716-446655440000/pdf"
      

Para un SIRET de 14 dígitos, use los primeros 9 dígitos como SIREN. Timeout recomendado: 60-90 s.

API de informe estándar API clásica (heredada) Precios de API

Autenticación

Cada solicitud se firma con una API key de CredoRisk (cabecera Authorization: Bearer o X-API-Key). El cliente nunca ve el proveedor de origen.

Authorization: Bearer <CREDORISK_API_KEY>
o
X-API-Key: <CREDORISK_API_KEY>
          

Precios de API

La API es gratuita. La facturación se basa en los informes generados, con descuentos por volumen.

Ver precios de informes

Formato de informe CredoRisk

Respuesta estandarizada: company, decision, sections.directors, sections.financials, sections.signals. Contrato estable e independiente del proveedor de origen.

Trazabilidad completa

Todas las llamadas API se registran. Los informes estándar se almacenan por uuid; la API clásica usa report_id.

Flujo recomendado

Francia — API de informe estándar

Buscar por nombre, generar por SIREN, guardar UUID, recuperar y descargar PDF.

1) Búsqueda

GET /standard/search?q=... - leer results.resultats[] y SIREN.

2) Generación

GET /standard/france/{siren} - obtener report.uuid.

3) Recuperación

GET /standard/report/{uuid} - campos credorisk + raw.

4) PDF

GET /standard/report/{uuid}/pdf - descarga sin crédito adicional.

Informe estándar

Puntos finales /standard/*

GET /api/v1/standard/search?q=...

Buscar en Francia por nombre de empresa. Respuesta: results.resultats (lista de empresas).

GET /api/v1/standard/france/{siren}

Generar o devolver un informe completo de Francia desde caché. Respuesta: report.uuid, cached.

GET /api/v1/standard/report/{uuid}

Recuperación con credorisk, raw, source_type.

GET /api/v1/standard/{country}/{identifier}

Informe internacional (fuera de Francia).

Heredado

API clásica (heredada)

Para Francia, priorice la API de informe estándar anterior.

POST /api/v1/companies/search

Buscar empresas por país + criterios.

curl -X POST -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{"countries":"FR","name":"LA REDOUTE","city":"ROUBAIX"}' \
  "https://credorisk.com/api/v1/companies/search"

GET /api/v1/companies/{providerCompanyId}/report

Generar (o devolver desde caché) un informe CredoRisk.

curl -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/companies/FR30612897/report?country=FR&language=en"

GET /api/v1/reports/{reportId}

Recuperar un informe almacenado por identificador.

curl -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/reports/1284"

GET /api/v1/account/credits

Devuelve saldo restante y uso mensual de API.

curl -H "Authorization: Bearer <api_key>" \
  "https://credorisk.com/api/v1/account/credits"

Ejemplo de respuesta de informe (formato CredoRisk)

{
  "report_id": 1284,
  "credits_cost": 1,
  "source": "live",
  "report": {
    "company": {
      "name": "EXEMPLE SA",
      "country": "FR",
      "status": "Active",
      "reg_no": "123456789",
      "vat_no": "FR00123456789",
      "address": {
        "street": "10 RUE EXEMPLE",
        "city": "PARIS",
        "postcode": "75001",
        "region": "ILE-DE-FRANCE"
      }
    },
    "decision": {
      "score": 72,
      "risk_band": "B",
      "credit_limit": {
        "value": 50000,
        "currency": "EUR"
      },
      "days_beyond_terms": 8
    },
    "sections": {
      "directors": [],
      "financials": [],
      "signals": []
    }
  }
}
      

Principales códigos de error

401 — API key ausente o no válida
402 — Créditos insuficientes para generar un informe en vivo
403 — Cuenta no verificada
404 — Informe no encontrado
422 — Parámetros no válidos
429 — Cuota mensual de API alcanzada
500 — Error interno
503 — Servicio de búsqueda/datos no configurado

¿Listo para probar la API?

Cree una cuenta, genere una API key de CredoRisk e integre rápidamente la generación de informes en su flujo de clientes.

Crear cuenta Ver precios