Add provider access

Changed on Nov 3, 2026

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.

post/rest/accesses

Request

Base URL
https://api.nrich.qwist.cloud
Auth
HTTP bearer
TypeScript
https://skmtc.dev/qwist/apis/finx-api/docs/rest/accesses/post.ts
A function with typed inputs. Its response is checked against the schema.

Parameters

#/paths/~1rest~1accesses/get/parameters/0 (unresolved $ref)

#/paths/~1catalog/get/parameters/0 (unresolved $ref)

Request body

access_method_idstring UUID required

nrich ID of the provider access method.

Response

Provider access details.

Items required(unresolved $ref)

Changes

Nov 3, 2026398592d93b1f Revision changes
- breaking
  removed from the /// request property oneOf list
- breaking
  the /// request property type changed from no type to string, and format from no format to ISO 4217:2015
- breaking
  added to the /// response property oneOf list for the response status
- breaking
  the // response's property type changed from no type to string for status
- breaking
  the /// response's property type changed from no type to string, and format from no format to ISO 4217:2015 for status
- breaking
  the response's property type changed from no type to object for status
- breaking
  the response's property type changed from no type to string for status
- breaking
  the / response's property type changed from no type to object for status
- breaking
  the / response's property type changed from no type to string for status
- breaking
  the response's property type changed from no type to object for status
- info
  the request property default value EUR was added
- info
  added to the /// request property oneOf list
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property / to the response with the status
- info
  the response's property default value EUR was added for the status
- info
  removed from the /// response property oneOf list for the response status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status

Operation history