Consumer API
>
API Reference
>
v0
>
Account Aggregation
>
Details
openapi: 3.0.0
info:
version: '0.0'
title: User Details
servers:
- url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0'
variables:
API_ENVIRONMENT:
default: digital.garden-fi.com
description: FI specific hostname
tags:
- name: Account Aggregation
paths:
'/users/{userId}/fetch':
put:
tags:
- Account Aggregation
description: Start fetching transactions for a user
security:
- OpenID_Connect:
- openid
parameters:
- $ref: '#/components/parameters/userId'
responses:
'200':
description: Fetch Task was created
content:
application/json:
schema:
type: object
description: The task id of the current fetch process.
required:
- taskId
properties:
taskId:
type: string
'400':
description: Bad request - The user is not fullly authenticated.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden. The user does not have the required permissions.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
securitySchemes:
OpenID_Connect:
type: openIdConnect
description: OpenID Connect - Discovery endpoint will be institution specific
openIdConnectUrl: >-
https://digital.garden-fi.com/a/consumer/api/v0/oidc/.well-known/openid-configuration
parameters:
userId:
in: path
name: userId
description: ID of the desired user
required: true
schema:
type: string
schemas:
Error:
type: object
required:
- errorCode
properties:
errorCode:
type: integer
description: Brief description of the failure.
messages:
type: string
description: Message along with the error code
Have a Question?
Have a how-to question? Seeing a weird error? Get help on
StackOverflow.
Register for the Digital Toolkit Meetup
where we answer technical Q&A from the audience.