Enlightly
Tillbaka till startsidan

API Dokumentation

Integrera kreditupplysningar direkt i ert system med Enlightly API

Kom igång snabbt
Följ dessa steg för att börja använda Enlightly API
1

Skapa ett konto

Registrera dig och välj en prisplan som passar ert behov.

2

Hämta din API-nyckel

Gå till dashboarden och kopiera din API-nyckel.

3

Gör ditt första API-anrop

Använd exemplen nedan för att komma igång.

Autentisering
Alla anrop till API:et kräver en giltig API-nyckel

Inkludera din API-nyckel i Authorization-headern för alla anrop:

Authorization: Bearer ek_live_xxxxxxxxxxxx

Endpoints

POST/api/v1/lookup
Initierar en kreditupplysning. Skickar en BankID-förfrågan till kunden.

Request Body

{
  "personnummer": "199001011234",
  "purpose": "Kreditprövning för abonnemang",
  "webhook_url": "https://example.com/webhook" // Optional
}

Parametrar

personnummer
required

Kundens personnummer i formatet YYYYMMDDXXXX

purpose
required

Syfte med upplysningen (visas för kunden i BankID)

webhook_url
optional

URL dit resultatet skickas när kunden godkänt

GET/api/v1/lookup/:id
Hämtar status och resultat för en specifik upplysning.
{
  "lookup_id": "lkp_abc123def456",
  "status": "completed",
  "report": {
    "risk_score": "low",
    "total_debt": 45000,
    "active_cases": 2,
    "closed_cases": 1,
    "has_enforcement": false,
    "agencies": ["Intrum", "Lowell"],
    "generated_at": "2024-01-15T14:32:00Z"
  }
}
Webhooks
Ta emot realtidsuppdateringar när en kund godkänner eller nekar en förfrågan

Om du anger en webhook_url vid anropet, skickar vi en POST-förfrågan med resultatet när kunden svarat.

Webhook Payload

{
  "event": "lookup.completed",
  "lookup_id": "lkp_abc123def456",
  "timestamp": "2024-01-15T14:32:00Z",
  "report": {
    "risk_score": "low",
    "total_debt": 45000,
    // ... full report data
  }
}
Rate Limits
Starter100 anrop/minut
Growth500 anrop/minut
EnterpriseObegränsat
SDKs
Officiella bibliotek för enklare integration

Node.js

npm install @enlightly/sdk

Python

pip install enlightly

PHP

composer require enlightly/sdk