Sivo provides 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👇
Our Yield API covers all of the available features for Sivo yield accounts including creation, deposits and fund transfers. Sivo yield accounts are offered in USD (USDC coming soon!). Join a growing list of companies earning up to 8% APY to fund cashback and interest bearing accounts for their users or to extend their cash runway.
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.
To create a yield account using the Web application, do the next steps:
Login at app.sivo.com and go to Yield > Account and click on Create Yield Account
Set a name to the yield account:
Finally choose an option :
Now you have created a new Yield Account:
Once that the yield account is created the next step is to transfer the funds , to do this you require the account details from your new account, use the next recipe to get your bank accounts:
The bank account labeled as Yield should contains all the details to transfer the funds, example:
Note: The KYB process verification should be pass other wise the bank account won't be returned.
Once a yield period is completed you should be able to execute a withdraw from the yield account, to do this execute the next steps:
Get the contact Id to withdraw the fund, you have two options ,create a contact with the bank account information or use an existing contact, use the Contact Management API for more references:
- Create a new contact:
- Use an existing contact:
Pick the contact and get the contact ID need it to execute the withdraw.
- Execute the withdraw to the contact selected: