Core Services and authentication

On this page

Managing customer data effectively is crucial for any business with customer-facing operations. The Core Services APIs let you build your own application on top of Lendsqr and handle customer-related tasks programmatically within the Lendsqr ecosystem.

These APIs let you create, retrieve, update, and delete customer information, so your customer data stays accurate, current, and organized. You can manage customer profiles alongside the rest of the lending cycle: loans, direct debits, cards, and wallets, all within the same ecosystem.

Authorization and token management

To call any Core Services endpoint other than Auth, you need two things:

  • Bearer Token: your app’s API key, generated from Developer > Apps in your admin console.
  • x-access-token header: a token retrieved from the Auth endpoint. Provide valid credentials (email and password) in the request body, and the response includes this token, which must be sent as the x-access-token header on every subsequent Core Services request.

Steps to obtain your tokens

  1. Create an account on the Lendsqr admin console, or use an existing one.
  2. Add a team member to your organization using a dedicated email address; this member will manage API interactions. See How to add a team member.
  3. That team member logs in to the admin console, expands Developer in the sidebar, selects Apps, creates an app, and retrieves its API key. This is your Bearer Token.
  4. Using that same team member’s email and password, call the Auth endpoint. The response includes the x-access-token, which you include in the header of every Core Services request.

Important: once a team member’s credentials have been used to authenticate an API call through the Auth endpoint, those credentials are no longer valid for logging in to the admin console. Manage credentials carefully, and consider using a team member dedicated to API access rather than someone who also needs console access.

Questions about Core Services access? Email [email protected].

Was this page helpful?