Docs

Developers/api

REST API

The LoanPilot HTTP API — upload statements and read credit decisions programmatically.

5 sections

REST API

Base URL: https://api.ippo.one/v1. Authenticate with a Bearer token — an API key for servers, or a per-user login token for mobile apps. Everything is scoped to your team, exactly like the app.

curl https://api.ippo.one/v1/me \
  -H "Authorization: Bearer $LOANPILOT_API_KEY"

Endpoints

MethodPathDescription
GET/v1/meThe user + team the key belongs to
GET/v1/analysesList analyses (limit, offset, status, decision)
POST/v1/analysesUpload a statement (multipart) and start an analysis
POST/v1/analyses/combineCombine 2–6 statements for one account into a single analysis
GET/v1/analyses/{id}One analysis; ?include_result=true for the full report
GET/v1/productsThe team's loan products (credit policies)
POST/v1/credit-checksPull a credit-bureau report (billable; {name, mobile, consent})
POST/v1/credit-checks/uploadUpload a credit report (free, no enquiry) — standalone bureau-only check
GET/v1/credit-checksList saved credit checks
GET/v1/credit-checks/{id}One credit check + full bureau report
POST/v1/customersCreate a customer (idempotent on PAN); {pan, name, mobile, email?}
GET/v1/customersList/search customers (q, limit, offset)
GET/v1/customers/catalogThe KYC vocabulary (employment types, loan purposes, business categories, …)
GET/v1/customers/{id}One customer's full profile incl. timeline, signals, profile, businesses, portfolio + profile_intelligence (uuid or ref)
PATCH/v1/customers/{id}Update name, mobile, email, notes or status
POST/v1/customers/{id}/attachAttach an analysis / credit check / AA consent to the timeline
GET / PUT/v1/customers/{id}/profileRead / upsert the borrower's KYC profile (partial; null clears a field)
GET / POST/v1/customers/{id}/businessesList / add the borrower's businesses (name required, category from the catalog)
PATCH / DELETE/v1/customers/{id}/businesses/{businessId}Update / delete one business

See Customers for the PAN-keyed borrower profiles — KYC, businesses and a deterministic profile score (PAN is always returned masked).

Create an analysis

POST /v1/analyses is multipart/form-data:

FieldNotes
filethe statement PDF (required)
product_idthe loan product to score under (optional)
applicant_name, applicant_mobile, bureau_consentto also pull the bureau (requires entitlement + consent)
bureau_filea free credit report to attach (optional) — see below
inputsJSON object of anchors: requested_amount, collateral_value, gst_turnover, down_payment
curl -X POST https://api.ippo.one/v1/analyses \
  -H "Authorization: Bearer $LOANPILOT_API_KEY" \
  -F "file=@statement.pdf" \
  -F 'inputs={"requested_amount":500000,"collateral_value":700000}'

Returns { "id": "...", "ref": "APP-000123", "status": "queued" }. Poll GET /v1/analyses/{id} until status is completed, then read result.

Attach a credit report (free)

Add a bureau_file part to POST /v1/analyses (or POST /v1/analyses/combine) to fold a free credit-bureau report into the analysis. It accepts an Experian / Equifax / CRIF report as JSON or TXT — the bureau is auto-detected and parsed with no entitlement and no enquiry cost. One bureau per analysis: an uploaded report takes precedence over applicant_name + applicant_mobile. A file that isn't a recognised report is rejected with 422.

curl -X POST https://api.ippo.one/v1/analyses \
  -H "Authorization: Bearer $LOANPILOT_API_KEY" \
  -F "file=@statement.pdf" \
  -F "bureau_file=@experian-report.json"

Upload a credit report on its own (free)

POST /v1/credit-checks/upload is multipart/form-data with a single bureau_file part — a standalone bureau-only check, with no bank statement. It is free: no entitlement, no bureau policy flag and no paid enquiry. The bureau is auto-detected; the response carries the full normalized report and its rich extra block (identity, income, employment, addresses, reason codes, secured/unsecured, enquiry summary, trends, per-loan detail). A file that isn't a recognised Experian/Equifax/CRIF report is rejected with 422.

curl -X POST https://api.ippo.one/v1/credit-checks/upload \
  -H "Authorization: Bearer $LOANPILOT_API_KEY" \
  -F "bureau_file=@crif-report.json"

Unlike POST /v1/credit-checks (which pulls a fresh report by name + mobile and is billable), the upload path reuses a report you already hold and never fires a paid enquiry.

Errors & limits

Errors are JSON with a message (and code where relevant) and the right HTTP status (401 bad key, 404 not found, 429 rate-limited, 422 rejected file). Uploads and bureau pulls are rate-limited per user.

Prefer the SDK or MCP server over raw HTTP where you can.