Introducción
callback_url donde recibirás el resultado final una vez completado el análisis en segundo plano.
Para integrar correctamente el scoring, debes distinguir entre dos dimensiones:
| Dimensión | Opciones disponibles | Endpoint / Campo Clave |
|---|---|---|
| Producto | Electricidad vs Gas | /creditcheck o /creditcheck_gas |
| Tipo de Persona | Física vs Jurídica | Campo tipo_persona y tipo de ID |
⚖️ Selecciona tu Escenario
⚡ Escenarios de Electricidad
Utiliza el endpoint /creditcheck. Se integra con SIPS Electricidad para recuperar consumos históricos si no se proporciona el CAE.
👤 Particular / Autónomo (Persona Física)
Para NIF/NIE. Es obligatorio indicar tipo_persona: "Física".
🔴 Obligatorios
company_name(Nombre completo)identificador(NIF/NIE)tipo_identificador(NIF)tipo_persona("Física")autonomo(true/false)postal_codetownaddressprovincecups(CUPS Electricidad)callback_url
🟢 Aceptados (Opcionales)
cae(Consumo estimado)tarifa_json(Datos fallback)referencia_externa
POST /creditcheck
{
"company_name": "Juan Pérez García",
"identificador": "12345678Z",
"tipo_identificador": "NIF",
"tipo_persona": "Física",
"autonomo": false,
"postal_code": "28001",
"town": "Madrid",
"address": "Calle Alcalá 1",
"province": "Madrid",
"cups": "ES0021000005451399XXXX",
"callback_url": "https://tu-api.com/callback"
}
🏢 Empresa / Sociedad (Persona Jurídica)
Para CIFs. Se recomienda usar "tipo_identificador": "NIF" para asegurar compatibilidad con validadores internos.
🔴 Obligatorios
company_name(Razón Social)identificador(CIF)tipo_identificador("NIF")tipo_persona("Jurídica")autonomo(false)postal_codecups(CUPS Electricidad)callback_url
🟢 Aceptados (Opcionales)
town,address,provincereferencia_externa
POST /creditcheck
{
"company_name": "IMAGINA ENERGIA S.L.",
"identificador": "B12345678",
"tipo_identificador": "NIF",
"tipo_persona": "Jurídica",
"autonomo": false,
"postal_code": "08001",
"town": "Barcelona",
"address": "Calle Diagonal 100",
"province": "Barcelona",
"cups": "ES0021000005451399XXXX",
"callback_url": "https://tu-api.com/callback"
}
🔥 Escenarios de Gas
Utiliza el endpoint /creditcheck_gas. Permite el paso opcional del cae (Consumo Anual Estimado) para scoring directo sin depender de SIPS.
👤 Particular (Persona Física)
Para NIF/NIE. Es obligatorio indicar tipo_persona: "Física".
🔴 Obligatorios
company_name(Nombre completo)identificador(NIF/NIE)tipo_identificador(NIF)tipo_persona("Física")autonomo(true/false)postal_codetownaddressprovincecups(CUPS Gas)callback_url
🟢 Aceptados (Opcionales)
cae(Consumo estimado - Recomendado)tarifa_json(ej: RL.2)referencia_externa
POST /creditcheck_gas
{
"company_name": "María García",
"identificador": "87654321X",
"tipo_identificador": "NIF",
"tipo_persona": "Física",
"autonomo": false,
"postal_code": "46001",
"town": "Valencia",
"address": "Plaza del Ayuntamiento 5",
"province": "Valencia",
"cups": "ES0231101733548006XXXX",
"cae": 3500.0,
"callback_url": "https://tu-api.com/callback"
}
🏢 Empresa (Persona Jurídica)
Para CIFs. Se recomienda usar "tipo_identificador": "NIF" para asegurar compatibilidad con validadores internos.
🔴 Obligatorios
company_name(Razón Social)identificador(CIF)tipo_identificador("NIF")tipo_persona("Jurídica")autonomo(false)postal_codecups(CUPS Gas)callback_url
🟢 Aceptados (Opcionales)
town,address,provincecae(Consumo estimado)tarifa_jsonreferencia_externa
POST /creditcheck_gas
{
"company_name": "INDUSTRIA GAS S.A.",
"identificador": "A98765432",
"tipo_identificador": "NIF",
"tipo_persona": "Jurídica",
"autonomo": false,
"postal_code": "48001",
"town": "Bilbao",
"address": "Gran Vía 12",
"province": "Vizcaya",
"cups": "ES0231101733548006XXXX",
"tarifa_json": {"nombre": "RL.3"},
"callback_url": "https://tu-api.com/callback"
}
📍 Referencia de Provincias
El campo province acepta tanto el nombre de la provincia como su ID numérico. A
continuación se listan los nombres aceptados:
⚙️ Flujo Técnico
Solicitud (202 Accepted)
Envías el JSON. Recibes un request_id.
Procesamiento en Background
Consultamos SIPS, verificamos Experian y aplicamos reglas de negocio.
Callback
Enviamos el resultado final (ACEPTADO/DENEGADO/REVISION MANUAL) a tu callback_url.
Estructura del Resultado (Callback)
POST https://tu-api.com/callback
{
"request_id": 1542,
"result_operation": "ACEPTADO",
"referencia_externa": "SOLICITUD-99",
"credit_result": {
"raw": {
"code": "1008",
"sips": {
"CUPS": "ES0021000005451399XXXX",
"ConsumoAnualKwh": 106724.70
}
}
},
"_callback_signature": {
"version": "v1",
"signature": "F9qDjHkLt5lO_JjiPvbP7...",
"timestamp": "1772552356"
}
}
v