AuthorizeAsync

Be advised that this feature requires activation. Please reach out to your Technical Account Manager at Flinks or to [email protected] to have it enabled.

The /AuthorizeAsync endpoint is designed to deliver real-time status updates on the current state of the authentication process.

Complete Workflow

1. /AuthorizeAsync Session Start
   • The first step is to make a request to our /AuthorizeAsync endpoint, informing the Institution, username, password, as well as setting MostRecentCached=false, and Save=true as below.
     
     
     With the credentials being valid, the endpoint will respond with a 202, as well as a RequestId. Make sure to grab this RequestId for the following step.
     
     
2. /AuthorizeAsync Authorization Status Polling
   
   • As shown in the workflow above, after calling /AuthorizeAsync with the RequestId, it can return different statuses. The following snapshot reflects the case where the endpoint returns a 203, which indicates that an MFA step is ready and required the user's engagement.
     
     
     
3. /AuthorizeAsync MFA Response
   
   • With the MFA being valid, the endpoint will respond with a 202.
     
     
     
4. /AuthorizeAsync MFA Status Polling
   • As shown in the workflow above, after calling /AuthorizeAsync with the MFA response, it can return different statuses. The following snapshot reflects the case where the endpoint returns a 200. This indicates that the MFA step was successful, and that the authorization process has been completed. You can now proceed to calling /GetAccountsDetail.