API Reference

Integration Guide

Proceed with the integration steps below.

📘

Authentication

All calls to the endpoints will require an API Key in the Header provided asX-API-Key: YOUR_API_KEY, which you can get from your dashboard or upon request via email to info@cladfy.com

  1. Copy the API Key from your dashboard.
  2. Use the base URL - https://service.cladfy.com/v1/
  3. Use the /clients/ endpoint to create a new client.
    • This returns an "id"in the response. It is your new client's unique ID
  4. Use the /documents endpoint to
    1. Set up a callback URL in your app.
    2. Upload a client's statement using the /documents endpoint.
      1. This requires the client_idfrom step 3 above
      2. It will append the document to the client belonging to the ID and return a "document_id" and the same "client_id" in the response.
        The upload will trigger an automatic analysis of the statement.
  5. Listen to your callback.
  6. onFailure, check the error code for debugging.
  7. onSuccess, you will receive the analyzed data and the Client's information on your callback url.
  8. Use the client_id to call the additional endpoints to fetch the specific analysis category of your client's analyzed document. (You can call any of these endpoints as many times as you need)
    • Summary,
    • Cashflow,
    • Spending,
    • Gambling,
    • Trends.
    • Affordability Estimate,
    • etc.
  9. Use the client_id to upload additional statements to the same client or re-fetch the analysis