---
title: "Start provider synchronization"
method: POST
path: "/rest/accesses/{access-id}/syncs"
tags: ["Synchronizations"]
---

# Start provider synchronization

`POST /rest/accesses/{access-id}/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.

## Parameters

- `#/paths/~1rest~1accesses~1%7Baccess-id%7D/get/parameters/0` — unresolved $ref

## Request body

- object
  - `credentials` Credentials — unresolved $ref
  - `save_secrets` 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.
  - `disable_notifications` boolean — Indicates whether the [configured notification](/#tag/Notifications) events are triggered at the end of the synchronization process.
  - `redirect_uri` string, 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.
  - `state` State — unresolved $ref
  - `scope` string[] — 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.
  - `reuse_auth_method` boolean — 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.
  - `reuse_auth_medium` boolean — 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.
  - `psu_ip` string, IP — 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.
  - `period` integer — Defines the number of days of transaction history that is requested from the financial provider.

## Response `201`

Synchronization status.

- object — A handle to refer to a synchronization operation with a financial provider. In the course of the execution of the synchronization updated data (e.g. transaction statement, balance) will be fetched from the provider.
  - `id` Schema, required — unresolved $ref
  - `status` Status, required — unresolved $ref
  - `state` string — The `state` that was being provided in the request when creating the synchronization.
  - `challenge` Schema — unresolved $ref
  - `error` object — Error detailing why the background operation failed.
    - `code` Code — unresolved $ref
    - `name` string — Error summary.
    - `message` string — Error message as provided by the financial provider.
    - `description` string — Human readable description of the error.
    - `group` Group — unresolved $ref
  - `created_at` EndedAt, required — unresolved $ref
  - `started_at` EndedAt — unresolved $ref
  - `ended_at` EndedAt — unresolved $ref
  - `redirect_uri` string, url — The URL where users will be redirected after completing their interaction with the Widget.

## Other responses

- `400` — unresolved $ref
- `401` — unresolved $ref

---

[API](https://skmtc.net/qwist/apis/finx-api.md) · [All operations](https://skmtc.net/qwist/apis/finx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/qwist/finx-api/revisions/b75f5c1aa39e/schema)