Sivo exposes a RESTful API that exposes the capabilities needed to take advantage of its debt-as-a-service functionality. The APIs are designed to follow modern standards and best practices to make it as easy as possible to adopt and integrate with your application. You can use standard HTTP verbs (POST to create, GET to retrieve, etc.) in your requests and expect standard HTTP response codes in the responses (2xx for success, 4xx for request errors, and 5xx for other errors).

Sivo offers a sandbox mode for development and test purposes (see the Testing section for details and best practices).

The best way to get started is to log into the Sivo application to retrieve your client id and refresh token from the Integrations > API page. Next, you can write code to obtain an access token from Sivo👇

After obtaining an access token, there are 3 API endpoints that you can use to send reporting data to Sivo:

  1. Create a Borrower (can be either a consumer or a business)
  2. Create a Loan
  3. Create Disbursements and Payments

The recipes below provide sample code to help you get started with these tasks.

Continue to read topics in our documentation to learn about Sivo API concepts and features. Go to the Recipes section (menu at the top) to find common integration scenarios and examples of how Sivo APIs can be used to implement them.