Integration Guide

Proceed with the integration steps below.

📘

Info

Authentication

• All calls to the endpoints will require an API Key in the Header
• It should be provided asX-API-Key: YOUR_API_KEY, which you can get from your dashboard or upon request via email to [e-mail]

Base URL

• All endpoints will be appended to this URL https://service.cladfy.com/v1/

Integrate in a few minutes

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: - POST
   • This returns an "id"in the response. This is your new client's unique ID
4. Use the /documents endpoint to Upload a client's statement: - POST
   1. This requires the client_idfrom step 3 above
   2. This will append the document to the client belonging to the ID
   3. It will also return an "id" This is your new document's unique ID
   4. This upload action will trigger an automatic analysis of the statement.
5. Use the /documents/:id/status endpoint to get the document's analysis status: - GET
   1. This requires the id, Document ID returned from step 4 above
6. onFailure, check the error code for debugging.
7. onSuccess, you can now fetch the analyzed data and the Client's information.
8. Use the /analysis_results to fetch all the analysis results: - GET
   1. This requires the id, Client ID returned from step 3 above
9. Or call the additional endpoints to fetch the specific analysis categories of your client's analyzed document(s). (You can call any of these endpoints as many times as you need): - GET
   • Summary,
   • Cashflow,
   • Spending,
   • Gambling,
   • Trends.
   • Affordability Estimate,
   • etc.
   1. This requires the id, Client ID returned from step 3 above
10. Use the /clients/:id/download_report to Download a PDF version of the analysis report: - GET
11. Repeat.
    1. Go to step 3 to create more clients.
    2. Or go to step 4 to upload additional statements to the same client.
    3. Or go to Step 8 / Step 9 to fetch the analysed data belonging to specific clients.