Skip to content
WorkspaceDarkLight
Contents

API reference

Credit Reporting

Report from the ledger. Open the product

GET/v1/credit-reportingOpen ↗

Describes this API: what it takes and what it returns.

POST/v1/credit-reporting/historyKey

Body
{reference, terms, events, arrangements?, asAt, grace?}

POST/v1/credit-reporting/submissionKey

Body
{month, accounts: [{reference, terms, events, arrangements}], previous?}

POST/v1/credit-reporting/defaultKey

Body
{terms, events, asAt, s6qNotice, s21dNotice, statuteBarred, hardshipRequest, threshold?}

POST/v1/credit-reporting/prepareKey

The month’s contribution as it would be sent, its SHA-256, and the check before a person at the lender approves it

Body
{month, accounts: [{reference, terms, events, arrangements}], previous?, tier?, body?}

POST/v1/credit-reporting/obligationsKey

The lender’s filings replayed from its own events: each one’s step, due day, overdue flag and approval, and its enquiry log

Body
{config: {id, compliance, creditReporting}, events, asAt, defaults?}