---
title: "Add provider access"
method: POST
path: "/rest/accesses"
tags: ["Accesses"]
---

# Add provider access

`POST /rest/accesses`

Attach a new provider access to the user's account. If the provider uses an authentication flow where customer credentials have to be presented, use the information from the catalog to identify available input fields. All mandatory (`is_optional=false`) public (`is_secret=false`) fields have to be provided when creating an access. All credentials that are sent with the request are securely stored in the finX backend.

## Parameters

- `#/paths/~1rest~1accesses/get/parameters/0` — unresolved $ref
- `#/paths/~1catalog/get/parameters/0` — unresolved $ref

## Request body

- object
  - `access_method_id` string, UUID, required — finX ID of the provider access method.
  - `credentials` union — Credentials used for authentication with the financial service provider.
    - object — Pairs of key/value-items as specified in the access-method of the service provider's catalog entry.
    - object
      - `type` 'encrypted'
      - `value` string — Pairs of key/value-items as specified in the access-method of the service provider's catalog entry encrypted with JSON web encryption.
  - `consent` object — Configuration of the PSD2 consents. Is ignored for non-PSD2 accesses.
    - `recurring` boolean, required — Indicates whether the consent is for an ongoing use-case
    - `period` integer, required — Specify the period in days for which the consent is valid. Ignored if recurring is set to false.
    - `scopes` string[], required — Defines the requested consent scopes. The actual scopes granted are determined on a best-effort basis and may differ from the requested configuration depending on the capabilities and policies of the bank.
    - `accounts` Items[], required — unresolved $ref

## Response `201`

Provider access details.

- Items — unresolved $ref

## 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)