HomeGuidesAPI Reference
Log In
API Reference

Start provider synchronization

post
https://api.finx-s.qwist.cloud/rest/accesses//syncs

In order for the finX API to have up-to-date transaction and account information, it needs to query the bank servers, a process which is called synchronization. With this call you can create a new synchronization to fetch updated data from the provider. If the confidential parts of the provider credentials have not been given when creating the access they have to be send with this request. If the save_secrets flag is set to true the credentials are stored in the finX backend, so that subsequent synchronizations can be triggered without providing the credentials again.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

finX ID of the provider access.

Body Params
credentials

Credentials used for authentication with the financial service provider.

boolean

Indicates whether the confidential parts of the credentials should be saved for future access synchronization operations. If set to false previously saved secrets are discarded at the end of the synchronization.

boolean
Defaults to false

Indicates whether the configured notification events are triggered at the end of the synchronization process.

url

The URI to which the user is redirected at the end of a redirect based authentication flow. The state that has been specified in the request will be attached as a query parameter to the URI.

string
length between 1 and 1024

An arbitrary string to maintain state between this request and the callback, e.g. it might contain a session ID from your application. The value should also contain a random component, which your application checks to prevent cross-site request forgery.

scope
array of strings
Defaults to TRANSACTIONS

Defines the scope of the synchronization.

  • "ACCOUNTS": Only fetch basic account data (e.g. holder name, IBAN etc.). Add new provider accounts to previously synced accesses.
  • "TRANSACTIONS": Fetch transaction and account data.
scope
boolean
Defaults to true

Indicates whether the last selected authentication method should be re-used for this synchronization. This minimizes the amount of challenges that have to be solved in the course of the synchronization operation.

boolean
Defaults to true

Indicates whether the last selected authentication medium should be re-used for this synchronization. This minimizes the amount of challenges that have to be solved in the course of the synchronization operation.

string

The IP address of the end-user for whom the synchronization is triggered. This might be required by the provider. It is advised to provide this value whenever possible.

integer

Defines the number of days of transaction history that is requested from the financial provider.

Responses

Updated about 7 hours ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 7 hours ago