WorkspaceDarkLight
Contents

API reference

Portal

One account. A clear view. Open the product

GET/v1/portalOpen ↗

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

POST/v1/portal/accountKey

The borrower’s view of their account, from the ledger

Body
{brands, asAt, terms, events}

POST/v1/portal/renderKey

A message, rendered, or why not

Body
{template, variables}

POST/v1/portal/may-contactKey

Body
{purpose, channel, offersSmallAmountCredit, requestedByConsumer, recipient, recentSends, frequencyCap, journeyOver, onDay}