Modular API

​

Authentication

Authorization: Bearer <token>

​

Base URLs

​

Webhooks

{
  "url": "https://example.com/webhooks/skor",
  "secret": "your-shared-secret"
}

svix-id: msg_...
svix-timestamp: 1787138793
svix-signature: v1,...

npm install svix

import { Webhook } from "svix";

function verifySkorWebhook(rawBody, headers, secret) {
  const webhook = new Webhook(secret, { format: "raw" });
  return webhook.verify(rawBody, headers);
}

import express from "express";
import { Webhook } from "svix";

app.post(
  "/webhooks/skor",
  express.raw({ type: "application/json" }),
  (req, res) => {
    try {
      const webhook = new Webhook(process.env.SKOR_WEBHOOK_SECRET, {
        format: "raw",
      });
      const event = webhook.verify(req.body, req.headers);

      // Process the verified event.
      console.log(event);
      return res.sendStatus(200);
    } catch {
      return res.status(400).json({ error: "Invalid webhook signature" });
    }
  }
);

• Tenant lifecycle events — TENANT_CREATED, TENANT_UPDATED, TENANT_DELETED, TENANT_ONBOARDING_COMPLETED
• Application updates — APPLICATION_UPDATED
• Document analysis completion — DOCUMENT_ANALYSIS_DATA
• Cl@ve processing success — CLAVE_SUCCESS
• KYC verification result — KYC_VERIFICATION_DATA
• Forensic analysis completion — FORENSIC_ANALYSIS_DATA
• Financial analysis result — FINANCIAL_ANALYSIS_SUCCESS, FINANCIAL_ANALYSIS_FAILURE

​

Retries and redelivery

• List Undelivered Events returns events that are still retrying (pending) or whose retries all failed (failed). An event leaves this list as soon as it is delivered.
• Redeliver Event sends one of those events again right away.

​

Tenant management

​

Guarantors

• The tenant must be a flatmate in that application, not a guarantor.
• A guarantor cannot have guarantors: someone with guarantors in the application cannot become a guarantor in it.

​

Applications

• Get Application — see the application, its participants, and its feedback (feedback is null when none has been saved).
• Update Application — rename the application.
• Add Participants — add people. New people get an invite email.
• Update Participant — change a participant’s name or guarantor flag. The email cannot be changed.
• Remove Participant — remove a participant. The lead cannot be removed.
• Delete Application — delete the application. It is unlinked from all properties and no longer appears in any endpoint. An application that has been awarded a property cannot be deleted (409).

​

Application feedback

• Save feedback with Save Application Feedback (PUT /applications/{applicationId}/feedback). Provide documents (up to 50 strings, max 255 characters each) and/or message (max 2000 characters). Omitted fields keep their existing values. Send explicit documents: [] or message: "" to clear that field. An empty request is rejected with 400.
• Saving feedback sets status to OPEN and resolved_at to null.
• Mark feedback done with Resolve Application Feedback (PATCH /applications/{applicationId}/feedback/resolve). It takes no request body, preserves documents and message, and sets status to RESOLVED with resolved_at and updated_at timestamps.
• Resolving already resolved feedback succeeds without changing timestamps or sending another webhook.
• 404 means the application is inaccessible or no feedback exists. 409 means the feedback changed during resolve — retry the resolve.
• Feedback saved before statuses were introduced reads as OPEN with resolved_at: null.
• Saving or first resolving feedback sends an APPLICATION_UPDATED webhook. Fetch the application to read the updated feedback object.

​

Landlord report session

curl "https://api.skortorent.com/api/v1/landlords/token" \
  -H "Authorization: Bearer $SKOR_ACCESS_TOKEN"

curl "https://dev-api.skortorent.com/api/v1/landlords/token" \
  -H "Authorization: Bearer $SKOR_ACCESS_TOKEN"

<div id="skor-container"></div>

const session = sdk.startProfileSession({
  token, // from your server
  containerId: "skor-container",
  propertyId: "YOUR_PROPERTY_ID", // required
  applicationId: "YOUR_APPLICATION_ID", // required
  height: "700px", // optional
});

​

Document upload and download

• Upload documents for a tenant using the Documents API.
• Trigger document analysis automatically after successful upload.
• Receive webhook events when document analysis is completed.
• Download documents retrieved from Cl@ve.

​

Identity verification

​

Financial scoring

• Connect a bank: send the tenant through the bank connection flow with Initiate Bank.
• Upload a bank statement: send a PDF statement (max 8 MB, at least 3 months, showing the account holder name) with Upload Bank Statement. It goes through the same processing as a statement uploaded in the SKOR platform.

​

Forensic analysis

​

End-to-end flow