SIVO Capital API

Sivo exposes a RESTful API that provides 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 Testing 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, you are ready perform a draw from a debt line. Just follow these steps:

  1. You will need the ID of the debt line that you are drawing from. Get this id from the Sivo dashboard, by navigating to the appropriate debt line.

  1. Create a contact: This is the destination bank account used to send the funds. You may need to do this only once if you always send funds to the same destination account. Use the "Create a Contact" recipe to accomplish this (make sure to use the debt line bank account):
  1. Submit a draw: To transfer funds from your debt line submit a draw using the following recipe. Drawn funds are deposited in your Sivo debt line account.
  1. Send funds to beneficiary: At this point you can send the funds to the contact created on step 2. The next recipe shows how to accomplish this.