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 [email protected]
Base URL
All endpoints will be appended to this URL https://service.cladfy.com/v1/
Integrate in a few minutes
Copy the API Key from your dashboard.
Use the base URL - https://service.cladfy.com/v1/
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
Use the /documents endpoint to Upload a client's statement: - POST
This requires the client_idfrom step 3 above
This will append the document to the client belonging to the ID
It will also return an "id" This is your new document's unique ID
This upload action will trigger an automatic analysis of the statement.
Use the /documents/:id/status endpoint to get the document's analysis status: - GET
This requires the id, Document ID returned from step 4 above
onFailure, check the error code for debugging.
onSuccess, you can now fetch the analyzed data and the Client's information.
Use the /analysis_results to fetch all the analysis results: - GET
This requires the id, Client ID returned from step 3 above
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.
This requires the id, Client ID returned from step 3 above
Use the /clients/:id/download_report to Download a PDF version of the analysis report: - GET
Repeat.
Go to step 3 to create more clients.
Or go to step 4 to upload additional statements to the same client.
Or go to Step 8 / Step 9 to fetch the analysed data belonging to specific clients.
