Waafir
Diese Seite ist eine maschinelle Übersetzung, die noch auf eine menschliche Prüfung wartet. Sie kann Fehler enthalten.

Abgleich

Mit der Abgleichsschnittstelle prüfen Sie, was in Waafir angekommen ist – anhand Ihrer eigenen Caller-IDs statt der von der Plattform vergebenen UUIDs. Sie ist bewusst minimal gehalten – zwei Routen –, bildet aber das operative Rückgrat einer robusten Integration: Jede gesunde tägliche Datenaufnahme endet mit einem Abgleichsaufruf.

Warum per Caller-ID abgleichen

Wenn Sie einen Kredit mit externalId: "L-001" übermitteln, kennt Ihr System die Zeile bereits unter diesem Namen. Die Plattform zu fragen „Haben Sie L-001?“ ist der natürliche nächste Schritt – und weil Sie nicht erst in eine Plattform-UUID übersetzen müssen, kann Ihre Abgleichslogik mit denselben Kennungen arbeiten, die Ihre Buchhaltung verwendet.

Die Plattform garantiert, dass eine externalId innerhalb eines Portfolios unter den aktiven Zeilen eindeutig ist; deshalb ist eine Suche per externalId ein Lesezugriff auf eine einzelne Zeile.

Routen

MethodePfadZweck
GET/api/v1/monitoring/loan/loans/{externalId}?portfolioId=<UUID>Einen einzelnen Kredit per Caller-ID lesen.
GET/api/v1/monitoring/loan/countsZeilensummen pro Entität lesen, optional eingegrenzt nach Portfolio, Datum oder Entität.

GET /api/v1/monitoring/loan/loans/{externalId}

Liest einen einzelnen Kredit anhand der von Ihnen übermittelten externalId. Stornierte (soft-gelöschte) Zeilen sind ausgeschlossen.

Request

ParameterPositionPflichtEinschränkung
externalIdPfadja1–255 Zeichen; in URLs unzulässige Zeichen per Prozentkodierung kodieren.
portfolioIdQueryjaUUID des Portfolios, zu dem der Kredit gehört.

Die portfolioId ist erforderlich, weil eine externalId nicht portfolioübergreifend eindeutig ist – sie ist nur innerhalb eines Portfolios eindeutig.

Response – 200 OK

{
  "loan": {
    "id": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
    "portfolioId": "ddf63d12-1234-5678-9abc-def012345678",
    "borrowerId": "5b6c7d8e-9f0a-1b2c-3d4e-5f6a7b8c9d0e",
    "externalId": "L-001",
    "predecessorLoanId": null,
    "principalAmount": "10000.0000",
    "currencyCode": "USD",
    "interestRateApr": "0.180000",
    "disbursementDate": "2026-01-15",
    "termMonths": 12,
    "repaymentFrequency": "monthly",
    "productType": "Term loan",
    "status": "active",
    "metadata": {},
    "createdAt": "2026-01-15T08:00:00Z",
    "updatedAt": "2026-01-15T08:00:00Z"
  },
  "borrower": {
    "id": "5b6c7d8e-9f0a-1b2c-3d4e-5f6a7b8c9d0e",
    "externalId": "B-001",
    "name": "J***",
    "email": "j***@example.com",
    "phone": "***-***-1234",
    "nationalIdLast4": "1234",
    "countryCode": "KE",
    "dob": "1985-03-20",
    "gender": "female",
    "incomeBand": null,
    "employmentStatus": null
  }
}

Die Response bettet den Kreditnehmer des Kredits mit maskierten PII ein. Das ist die Ansicht im Investorenkontext – dieselbe Maskierung, die auch für den Endpunkt Kreditnehmer per GET gilt. Dank der Maskierung können Sie bestätigen, dass „dieser Kredit dem richtigen Kreditnehmer zugeordnet ist“, ohne PII an das aufrufende System weiterzugeben. Admins, die unmaskierte PII benötigen, nutzen die Schnittstelle für Kreditnehmer per UUID mit ?unmask=true und Erfassung im Audit-Log.

Geldfelder erscheinen mit ihrer vollen gespeicherten Genauigkeit (vier Nachkommastellen für Geldbeträge; sechs für interestRateApr); Ihr Client sollte sie als opake Dezimal-Strings behandeln, statt sie in Gleitkommazahlen umzuwandeln.

Statuscodes

StatusAuslöser
200 OKKredit in Ihrer Organisation gefunden.
400 Bad RequestportfolioId fehlt oder ist fehlerhaft, oder externalId enthält eine fehlerhafte Prozentkodierung.
404 Not FoundKredit existiert im angegebenen Portfolio nicht als aktive Zeile, oder das Portfolio gehört zu einer anderen Organisation.

cURL

curl https://app.waafir.io/api/v1/monitoring/loan/loans/L-001?portfolioId=ddf63d12-1234-5678-9abc-def012345678 \
  -H "Authorization: Bearer $WAAFIR_PAT"

GET /api/v1/monitoring/loan/counts

Liest Zeilenzahlen pro Entität, optional eingegrenzt nach Portfolio, nach Datum oder auf eine einzelne Entität. Soft-gelöschte Zeilen sind ausgeschlossen.

Request

ParameterPositionPflichtEinschränkung
portfolioIdQueryneinUUID; grenzt auf ein einzelnes Portfolio ein. Weglassen für eine organisationsweite Gesamtsicht.
dateQueryneinYYYY-MM-DD; wenn angegeben, enthält die Response pro Entität einen onDate-Zähler.
entityQueryneinEiner der Werte borrowers, loans, scheduled_repayments, actual_payments, collateral, collateral_valuations (ohne Beachtung der Groß-/Kleinschreibung). Wenn angegeben, wird nur diese Entität zurückgegeben.

Response – 200 OK

Standard-Gesamtsicht, alle sechs Entitäten:

{
  "counts": {
    "borrowers": { "total": 1200 },
    "loans": { "total": 3450 },
    "scheduled_repayments": { "total": 41400 },
    "actual_payments": { "total": 32118 },
    "collateral": { "total": 600 },
    "collateral_valuations": { "total": 1840 }
  },
  "date": null,
  "portfolioId": null
}

Mit ?date=2026-05-22 erhält jede Entität einen onDate-Zähler für die am angegebenen Datum angelegten Zeilen:

{
  "counts": {
    "borrowers": { "total": 1200, "onDate": 0 },
    "loans": { "total": 3450, "onDate": 12 },
    "scheduled_repayments": { "total": 41400, "onDate": 144 },
    "actual_payments": { "total": 32118, "onDate": 1207 },
    "collateral": { "total": 600, "onDate": 0 },
    "collateral_valuations": { "total": 1840, "onDate": 0 }
  },
  "date": "2026-05-22",
  "portfolioId": null
}

Mit ?entity=loans erscheint nur der Eintrag loans.

Statuscodes

StatusAuslöser
200 OKAbfrage geparst; Zähler zurückgegeben.
400 Bad RequestFehlerhafte portfolioId, date oder entity.

Eine portfolioId, die nicht existiert oder zu einer anderen Organisation gehört, liefert kein 404, sondern 200 mit durchgehend Nullen. Das ist beabsichtigt – die Zählschnittstelle liest Ihre eigenen Daten, und ein unbekanntes Portfolio ist funktional nicht von einem Portfolio ohne Zeilen zu unterscheiden.

cURL

# Full daily reconciliation for one portfolio:
curl "https://app.waafir.io/api/v1/monitoring/loan/counts?portfolioId=ddf63d12-1234-5678-9abc-def012345678&date=2026-05-22" \
  -H "Authorization: Bearer $WAAFIR_PAT"

Ein typischer täglicher Abgleich

Wenn Sie die heutigen Übermittlungen abgeschlossen haben, sieht der kanonische Abgleichsablauf so aus:

  1. Rufen Sie GET /counts?date=<today> mit Ihrem Portfolio auf. Vergleichen Sie den onDate-Zähler jeder Entität mit dem, was Sie heute übermittelt haben. Stimmen die Zähler mit Ihren Übermittlungen überein, ist Ihr Batch sauber angekommen.
  2. Suchen Sie bei Abweichungen die konkreten Zeilen mit GET /loans/{externalId}. Die Abfragen sind günstig – jeweils ein einzelner Index-Scan – und liefern den kanonischen Zeilenzustand einschließlich der von der Plattform vergebenen UUID, mit der Sie weiter nachforschen können.
  3. Für Untersuchungen auf Zeilenebene sind die Einzeldatensatz-GET-Endpunkte und der Endpunkt für seitenweise abgerufene Fehler bei asynchronen Importen die Schnittstellen, die Fehlerdetails pro Zeile liefern.

Die Abgleichsschnittstelle ist bewusst schreibgeschützt und kostengünstig – sie ist der Herzschlag der Integration, keine Ladeschnittstelle. Rufen Sie sie ein- oder zweimal pro Tag und Portfolio auf; es gibt kein eigenes Rate Limit für sie, aber bitte fragen Sie sie nicht in einer engen Schleife ab.