The Blackswan partner-facing HTTP API for customers, loans, repayments, and credit decisions.Documentation Index
Fetch the complete documentation index at: https://docs.lms.bsa.ai/llms.txt
Use this file to discover all available pages before exploring further.
What this API gives you
Customers
Create and manage customer (borrower) records, including activation
and closure.
Loans
Origination in a single call —
POST /v1/loans submits, approves,
and disburses. Reversals available for operational rollbacks.Repayments
Record repayments, waivers, refunds, and adjustments against
active loans.
Credit Scoring
Look up a customer’s credit grade and limit, or boost their limit
with a financial statement PDF.
Design choices worth knowing
String IDs
String IDs
Every resource ID is exposed as a string. Pass them back exactly as
you received them — never reformat or parse.
ISO-8601 dates
ISO-8601 dates
All dates on the wire are
YYYY-MM-DD.Bearer-token auth
Bearer-token auth
Every endpoint requires a JWT in the
Authorization header. See
Authentication.Errors as structured codes
Errors as structured codes
Failures return a stable error code (
not_found,
invalid_argument, unauthenticated, …) plus a message. See
Errors.Address resources by partner externalId
Address resources by partner externalId
Customers, loans, and credit-scoring lookups all accept a
partner-supplied
externalId alongside the LMS numeric id. You can:- Look up customers by externalId:
GET /v1/customers?externalId=XorGET /v1/customers/external/{externalId} - Filter a customer’s loans:
GET /v1/loans?customerExternalId=X - Post repayments by the loan’s externalId:
POST /v1/loans/external/{loan_external_id}/repayments - Score a customer by externalId:
GET /v1/credit-scorecard/{externalId}