HomeGuidesAPI Reference
Log In
API Reference

Add provider access

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.

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

The embed query parameter allows it to add additional information to the response. The format for the parameter value is a comma separated list of field names (that is optionally surrounded by parentheses). Currently supported fields to be embedded are "provider" and "access_method".

Body Params
string
required

finX ID of the provider access method.

credentials

Credentials used for authentication with the financial service provider.

consent
object
Headers
string

Setting the Accept-Language to one of the available languages will return results in this language.

Responses

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