API-referens

curl -X POST https://credit.tic.io/api/v1/check \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "personalNumber": "YYYYMMDDNNNN",
    "deliveryMethod": "sms",
    "mobilePhoneNumber": "+46XXXXXXXXX",
    "webhookUrl": "https://your-app.com/webhook"
  }'

const response = await fetch('https://credit.tic.io/api/v1/check', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    personalNumber: 'YYYYMMDDNNNN',
    deliveryMethod: 'sms',
    mobilePhoneNumber: '+46XXXXXXXXX',
    webhookUrl: 'https://your-app.com/webhook'
  })
});

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("X-Api-Key", "YOUR_API_KEY");

var response = await http.PostAsJsonAsync(
    "https://credit.tic.io/api/v1/check",
    new {
        personalNumber = "YYYYMMDDNNNN",
        deliveryMethod = "sms",
        mobilePhoneNumber = "+46XXXXXXXXX",
        webhookUrl = "https://your-app.com/webhook"
    });

curl -X POST https://credit.tic.io/api/v1/check \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "personalNumber": "YYYYMMDDNNNN",
    "deliveryMethod": "sms",
    "mobilePhoneNumber": "+46XXXXXXXXX",
    "sections": { "relationships": false, "properties": false }
  }'

curl -X POST https://credit.tic.io/api/v1/check \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "personalNumber": "YYYYMMDDNNNN",
    "deliveryMethod": "letter"
  }'

Response — SMS-godkännande (första gången)

{
  "creditCheckId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Requested",
  "deliveredVia": "sms",
  "hostedUrl": "/your-slug/check/550e8400-...",
  "expiresAt": "2026-04-15T12:30:00Z",
  "sections": { "relationships": true, "income": true, "properties": true, "debts": true }
}

Response — SMS-notifiering (bekräftat nummer)

{
  "creditCheckId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Completed",
  "deliveredVia": "sms",
  "notificationOnly": true,
  "completedAt": "2026-04-15T12:00:05Z"
}

Response — Letter-flöde (Kivra)

{
  "creditCheckId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Completed",
  "deliveredVia": "kivra",
  "completedAt": "2026-04-15T12:00:05Z"
}

Response — Letter-flöde (fysiskt brev)

När mottagaren saknar Kivra-brevlåda byts deliveredVia till "mail":

{
  "creditCheckId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Completed",
  "deliveredVia": "mail",
  "completedAt": "2026-04-15T12:00:05Z"
}

Fält

Felkoder

Response — Slutförd

{
  "creditCheckId": "550e8400-...",
  "status": "Completed",
  "personalNumber": "YYYYMMDDNNNN",
  "givenName": "Anna",
  "surname": "Andersson",
  "creditScore": 85,
  "requestedAt": "2026-04-15T12:00:00Z",
  "completedAt": "2026-04-15T12:02:30Z",
  "ipRisk": {
    "level": "low",
    "consentIp": {
      "ipAddress": "83.68.240.137",
      "countryCode": "SE",
      "countryName": "Sweden",
      "usageType": "Fixed Line ISP",
      "confidenceScore": 0,
      "isTor": false,
      "isWhitelisted": false,
      "totalReports": 0
    },
    "deviceIp": null
  },
  "report": {
    "creditScore": 85,
    "person": { ... },
    "ban": null,
    "addresses": [ ... ],
    "folkbokforing": { ... },
    "deregistration": null,
    "relationships": [ ... ],
    "debtSummary": { ... },
    "income": [ ... ],
    "properties": [ ... ],
    "companyRoles": [ ... ],
    "enskildFirma": null,
    "creditChecks": [ ... ]
  }
}

ipRisk innehåller IP-risken för (a) IP:n som gav samtycke / startade integrationen och (b) IP:n där BankID-appen faktiskt slutförde autentiseringen. Skiljer sig vid QR-flöden där laptop och telefon är på olika nätverk. level är "low" · "moderate" · "high" eller null när ingen publik IP kunde kontrolleras. Credit agerar inte på signalen — applicera er egen policy.

Fält i report

Se vår OpenAPI-spec på /openapi/v1/swagger.json för fullständigt schema med alla nestade fält.

Response — Ej slutförd

{
  "error": "Credit check is not completed"
}

curl -H "X-Api-Key: YOUR_API_KEY" \
  https://credit.tic.io/api/v1/check/550e8400-.../pdf \
  -o report.pdf

Response

Content-Type: application/pdf

Binär PDF-fil med den fullständiga kreditupplysningen.

Response

{
  "total": 142,
  "page": 1,
  "pageSize": 50,
  "items": [
    {
      "creditCheckId": "550e8400-...",
      "status": "Completed",
      "personalNumber": "YYYYMMDDNNNN",
      "givenName": "Anna",
      "surname": "Andersson",
      "creditScore": 85,
      "requestedAt": "2026-04-15T12:00:00Z",
      "completedAt": "2026-04-15T12:02:30Z",
      "ipRiskLevel": "low"
    }
  ]
}

ipRiskLevel är en aggregerad signal: "low" · "moderate" · "high" · null. Hämta hela ipRisk-objektet (per-IP-detaljer) via GET /api/v1/check/{guid}.

Response — Avbruten

{
  "creditCheckId": "550e8400-...",
  "status": "Expired",
  "cancelledAt": "2026-04-15T12:05:00Z"
}

Response — Felaktigt tillstånd

{
  "error": "Credit check cannot be cancelled in status 'Completed'"
}