Overview

What is the Decision API?

The decision api enable you the ability to gain a full report for a customer financial data with insights and aggregated parameters on his financial situation

🚧

At least one Connection must be ACTIVE/COMPLETED

The customer must have at least one ACTIVE/COMPLETED connection first before attempting to create a decision. Please see the connection docs.

How does it work?

The decision api contains 2 requests - Create Decision and Get Decision.

The Create Decision API will generate a job id for the decision, and will start the process of calculating the insights and report for the customer.

You will need to poll (query) the Get Decision API with this job id until the job will have "status": "DONE", if the job returns "status": "RUNNING" you will need to continue polling.

Once you will get "status": "DONE" you can get the decision parameters.

This process usually takes about 5-20 seconds depends on the size of the user data

📘

Job id meaning

The job id is an id for the calculation of the decision once the decision is created, if a customer connects another connection after the job id was generated, the get decision api won't regard the newly created connection and will consider older data only.

Decision Parameters

Please see the api reference for the list of parameters and explanation for them