Understanding the API

The original version of this API started as a direct replacement of our SOAP API. This means that most endpoints didn't start with full http verb capability: i.e. adding a loan cannot be done via baseurl\loan\ POST method. Does that mean that you can't add a loan? It does not, we have a very handy endpoint that handles most inputs into the system - an artifact from the SOAP API and the standard way to import data via the GUI.

📘

XML IMPORT is the most important endpoint to know

This endpoint is able to add many data sets including:

• Contacts (borrowers)
• Loans
• Transactions

Find the full spec here: xml import spec

The endpoint: nls/xml-import

XML and JSON payloads

We are in the process of updating all our endpoints to accept and send both XML and JSON payloads. However we are prioritizing adding endpoints vs supporting JSON for data structure/payload.

Constant improvements

We are frequently updating the API, please head over to the Changelog to see the latest changes. Although we try to limit breaking changes, they may happen from time to time.

Technology

The API is written according to the Open API spec and comes with Swagger-based documentation with version dependent docs.

Authentication

Tokens are created using the Oauth 2.0 spec.

🚧

Each active token/connection is tied to a Seat License

For customers on a per-user plan, each token and active connection is the equivalent of a NLS user on the native app. For more details, contact Support .

📘

Tokens expire in 5 minutes

Each token is set to expire in 5 minutes following best practices for OAuth2.

Use the refresh tokens when building your app to keep the authentication valid.

Dependencies

Each API version is tied to an NLS version. Please go to Version Dependencies for the rest of the NLS version requirements.

Required Setup

If you are setting up NLS from scratch, please note there is setup required before using some endpoints. For example, to add a loan, you must have a loan template.

Setup checklist

1. Credentials and endpoints
2. Setup Dependencies