Platform Data APIs

On this page

Beyond identity, decisioning, and direct debit, the Developer APIs also expose your own operational data: customer records, loan data, transactions, and account/wallet information you can pull into your own systems.

Data for lenders

Lenders and their customers generate data that’s useful outside the Lendsqr ecosystem too: for example, using new customer information to drive drip marketing, or loan data to send customized repayment reminders. These endpoints let you pull that data for your own customers, transactions, and audit activity.

Common parameters

  • Getting individual records: some endpoints let you fetch a single record instead of a full list, for example /data/users/:id.
  • Pagination: every data endpoint supports pagination, with a default page size of 100.
  • Filtering: some data endpoints support filtering; available filters are documented per endpoint.
  • Process time: some data endpoints aren’t real-time and are populated by batch processing. Where that applies, the response includes a process time showing when the data set was generated.

Start with the Get Options endpoint to see which data sources are available for your organization, then pull the ones relevant to you.

Operational services

These endpoints give you and your integrators programmatic access to your account, profile, and wallet information, and let you monitor API health directly rather than relying only on the admin console.

  • Get Pricing: returns the current pricing for API services. Pricing can vary between lenders based on commercial negotiations and volume commitments.
  • Get Wallet: returns your organization’s wallet information. See How pricing and billing works and Understanding your wallet transactions.
  • Get API Audit Logs: returns audit logs for API calls made on your profile.
  • Get Status Check: returns the current operational status of the underlying systems, so you can troubleshoot and stay informed if something’s degraded.

Questions about a specific data endpoint? Email [email protected].

Was this page helpful?