openapi: 3.0.3 info: title: Fiskil's core platform APIs description: Handles a number of open Data fetching related tasks version: 1.1.10 servers: - url: http://localhost:8080 - url: https://api.fiskil.com - url: https://staging.api.fiskil.com paths: /_internal/clients/{id}: get: tags: - clients summary: Get client config for internal usage front-door description: Returns transaction refresh rate limits for a client. Unauthenticated since not sensitive but only for internal usage. operationId: front-door#Get client config for internal usage parameters: - name: id in: path description: the client config ID (teamID) required: true schema: type: string description: the client config ID (teamID) example: Et omnis perferendis quas enim. example: Quia rem dolorem est. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/GetClientConfigForInternalUsageResponseBody' example: transaction_refresh_enabled: false transaction_refresh_max_per_window: 1 transaction_refresh_min_interval: 10800 "404": description: 'not_found: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /_internal/trigger-sync/{arrangement_id}: post: tags: - admin summary: Trigger sync for consent front-door description: Manually trigger sync for consent operationId: front-door#Trigger sync for consent parameters: - name: arrangement_id in: path description: The CDR arrangement id. required: true schema: type: string description: The CDR arrangement id. example: Mollitia dolorum laudantium non consequatur quae. example: Amet enim consequuntur. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TriggerSyncForConsentRequestBody' example: permissions: - Ullam voluptatum ut quasi odio cumque suscipit. - Inventore quisquam doloremque. - Omnis cumque explicabo et quaerat. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/CreateCustomAuthResponseBody' example: message: Ut vero. "404": description: 'consent_not_found: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "500": description: 'internal_server_error: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /_pubsub/internal/trigger/{event}: post: tags: - pubsub summary: Receive internal pubsub events pubsub description: Receive internal pubsub push events operationId: pubsub#Receive internal pubsub events parameters: - name: event in: path required: true schema: type: string example: Deserunt adipisci. example: Voluptas quia commodi ut perspiciatis quaerat voluptatem. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReceivePubsubEventsPayload3' example: deliveryAttempt: 4127053103149300756 message: attributes: Numquam voluptatem voluptatibus.: Magni enim consequatur. data: Dolorum delectus optio aperiam amet nisi maiores. messageId: Blanditiis quisquam aliquam. publishTime: Nihil in. subscription: Ut dignissimos. responses: "204": description: No Content response. security: [] /_pubsub/trigger/{event}: post: tags: - pubsub summary: Receive webhook pubsub events pubsub description: Receive pubsub push events and trigger webhooks operationId: pubsub#Receive webhook pubsub events parameters: - name: event in: path required: true schema: type: string example: Ratione et. example: Quod dolore dolorum consequatur ea. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReceivePubsubEventsPayload2' example: deliveryAttempt: 6086021032003427635 message: attributes: Sit quia.: Aliquid eos in maiores fugit sunt. data: Nulla id dolore ipsum ea. messageId: Nemo in doloremque doloremque quia perspiciatis harum. publishTime: Facere voluptas sed dolores voluptatem ut asperiores. subscription: Harum ut delectus. responses: "204": description: No Content response. security: [] /access/{arrangement_id}: get: tags: - access summary: Fetch an access token front-door description: Gets an access token. operationId: front-door#Fetch an access token parameters: - name: arrangement_id in: path description: The CDR arrangement id. required: true schema: type: string description: The CDR arrangement id. example: Magnam qui dolorum ad quia. example: Id quam earum dolor beatae quo sint. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/FetchAnAccessTokenResponseBody' example: client_id: Non odit temporibus omnis labore. client_mtls_secret_location: Temporibus ut et error voluptatem est sapiente. expires_at: 8422800809614578702 institution_base_url: https://resource.cdr-api.bankaust.com.au institution_id: Veniam beatae. token: Ut officiis quos. "400": description: 'upstream_4xx_error: Bad Request response.' content: application/json: schema: $ref: '#/components/schemas/FetchAccessTokenError' example: client_id: Laudantium consectetur nobis quam sed quo. institution_id: Dignissimos tempore qui assumenda omnis iste. message: Placeat et quaerat quod. name: Commodi voluptates aut. "410": description: 'inactive_consent: Gone response.' content: application/json: schema: $ref: '#/components/schemas/FetchAccessTokenError' example: client_id: Occaecati omnis perferendis dolorum magnam. institution_id: Dignissimos id repellat quae velit. message: Non ipsam consequuntur. name: Consequuntur hic natus et molestias. "500": description: 'internal_server_error: Internal Server Error response.' content: application/json: schema: $ref: '#/components/schemas/FetchAccessTokenError' example: client_id: Harum ut aut numquam. institution_id: Incidunt culpa rerum. message: Rem voluptas doloribus sit. name: Quo at. security: - Token_header_Authorization: [] /admin/arrangements/{arrangement_id}: delete: tags: - consent summary: Admin revoke an arrangement front-door description: Allows Fiskil admin to revoke an arrangement operationId: front-door#Admin revoke an arrangement parameters: - name: arrangement_id in: path description: Arrangement ID. required: true schema: type: string description: Arrangement ID. example: Iusto dolores aut nobis unde. example: Qui alias aut. responses: "204": description: No Content response. security: - Token_header_Authorization: [] /analytics/cdr-errors: get: tags: - analytics summary: Get CDR errors front-door description: Get a list of cdr errors from today operationId: front-door#Get CDR errors parameters: - name: from in: query description: Start date allowEmptyValue: true schema: type: string description: Start date example: Eveniet reprehenderit quia illum omnis sit et. example: Ea in sit ut magnam odio. - name: to in: query description: End date allowEmptyValue: true schema: type: string description: End date example: Reiciendis aut et impedit voluptates. example: Illo rerum atque dicta. responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/CDRError' example: - clientId: Voluptates rem cumque in. endUserId: Voluptate nam architecto minus tenetur. institutionId: Non enim quo. req: Labore velit. reqBody: In rerum aut ex veniam. res: Ratione qui deserunt. resBody: Aspernatur libero. time: Facilis eligendi. - clientId: Voluptates rem cumque in. endUserId: Voluptate nam architecto minus tenetur. institutionId: Non enim quo. req: Labore velit. reqBody: In rerum aut ex veniam. res: Ratione qui deserunt. resBody: Aspernatur libero. time: Facilis eligendi. - clientId: Voluptates rem cumque in. endUserId: Voluptate nam architecto minus tenetur. institutionId: Non enim quo. req: Labore velit. reqBody: In rerum aut ex veniam. res: Ratione qui deserunt. resBody: Aspernatur libero. time: Facilis eligendi. example: - clientId: Voluptates rem cumque in. endUserId: Voluptate nam architecto minus tenetur. institutionId: Non enim quo. req: Labore velit. reqBody: In rerum aut ex veniam. res: Ratione qui deserunt. resBody: Aspernatur libero. time: Facilis eligendi. - clientId: Voluptates rem cumque in. endUserId: Voluptate nam architecto minus tenetur. institutionId: Non enim quo. req: Labore velit. reqBody: In rerum aut ex veniam. res: Ratione qui deserunt. resBody: Aspernatur libero. time: Facilis eligendi. - clientId: Voluptates rem cumque in. endUserId: Voluptate nam architecto minus tenetur. institutionId: Non enim quo. req: Labore velit. reqBody: In rerum aut ex veniam. res: Ratione qui deserunt. resBody: Aspernatur libero. time: Facilis eligendi. - clientId: Voluptates rem cumque in. endUserId: Voluptate nam architecto minus tenetur. institutionId: Non enim quo. req: Labore velit. reqBody: In rerum aut ex veniam. res: Ratione qui deserunt. resBody: Aspernatur libero. time: Facilis eligendi. security: - Token_header_Authorization: [] /arrangements/revoke: post: tags: - consent summary: Revoke arrangement front-door description: Allows a dh to revoke an arrangement operationId: front-door#Revoke arrangement parameters: - name: Authorization in: header description: Auth token allowEmptyValue: true required: true schema: type: string description: Auth token example: "Bearer \U000498C9" pattern: ^Bearer [^ ]+$ example: "Bearer \U000864AB" requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RevokeArrangementRequestBody' example: cdr_arrangement_id: Fugit est molestiae veritatis libero et. cdr_arrangement_jwt: Quo occaecati praesentium culpa. responses: "204": description: No Content response. "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /auth/session: post: tags: - auth - public - v1 - v2 - v3 summary: Create auth session front-door description: Create an auth session before auth process. operationId: front-door#Create auth session requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAuthSessionRequestBody' example: arrangement_id: 94549a73-a554-4b76-b824-d96898829751 cancel_uri: https://acme.com/cancel end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB institution_id: "10" redirect_uri: https://acme.com/success responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/AddAuthSessionInConsoleResponseBody' example: auth_url: auth-session.com/redirect-url expires_at: 1213467 id: 5qcql2s0bn9qfh1m5qd1sl4gth session_id: ea564d-56012s4-6ds4564 "400": description: 'invalid_arrangement_id: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "404": description: 'end_user_not_found: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /auth/session/{id}: get: tags: - auth summary: Fetch auth session details front-door description: Gets auth session details by the session id. operationId: front-door#Fetch auth session details parameters: - name: mode in: query description: The mode of the session allowEmptyValue: true schema: type: string description: The mode of the session default: standalone example: standalone enum: - embedded - standalone example: standalone - name: id in: path description: The session id (state) required: true schema: type: string description: The session id (state) example: Qui doloribus est reprehenderit qui suscipit. example: Sit distinctio tempore minus excepturi nisi error. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Fiskilauthsession' example: arrangement_id: 94549a73-a554-4b76-b824-d96898829751 arrangement_id_expiration_date: "2022-02-18T01:57:59Z" auth_url: auth.fiskil.com?session_id=ea564d-56012s4-6ds4564 cancel_uri: https://acme.com/cancel client_id: 5qcql2s0bn9qfh1m5qd1sl4gth created_at: "2022-02-18T01:57:59Z" end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB events: - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED expires_at: "2022-02-18T01:57:59Z" institution_id: "10" is_terminal: true missing_abn: true missing_email: true redirect_uri: https://acme.com/success session_id: ea564d-56012s4-6ds4564 "404": description: 'session_not_found: Session not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "410": description: 'session_expired: Session expired' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /auth/session/{id}/timeout: put: tags: - auth summary: Timeout auth session front-door description: Manually times out auth session by the session id. operationId: front-door#Timeout auth session parameters: - name: id in: path description: The session id required: true schema: type: string description: The session id example: Aut alias qui provident. example: Similique sequi voluptas dolore aut et rerum. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Fiskilauthsession' example: arrangement_id: 94549a73-a554-4b76-b824-d96898829751 arrangement_id_expiration_date: "2022-02-18T01:57:59Z" auth_url: auth.fiskil.com?session_id=ea564d-56012s4-6ds4564 cancel_uri: https://acme.com/cancel client_id: 5qcql2s0bn9qfh1m5qd1sl4gth created_at: "2022-02-18T01:57:59Z" end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB events: - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED expires_at: "2022-02-18T01:57:59Z" institution_id: "10" is_terminal: false missing_abn: true missing_email: true redirect_uri: https://acme.com/success session_id: ea564d-56012s4-6ds4564 "404": description: 'session_not_found: Session not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /cdr/data-holders/{product_id}/{industry}: get: tags: - data-holders summary: List data holders front-door description: List CDR Data Holders operationId: front-door#List data holders parameters: - name: product_id in: path required: true schema: type: string example: Necessitatibus nihil magnam itaque voluptates dolor. example: Ad nihil ut architecto. - name: industry in: path required: true schema: type: string example: Et mollitia. example: Quisquam velit est alias reprehenderit voluptatibus atque. responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Dataholder' example: - brand_id: Blanditiis tempore rem ipsam. brand_name: Est nihil dolor qui id. endpoint_details: Voluptatum dolorum ipsam minima.: Id omnis omnis omnis. logo_uri: Fuga unde ipsam voluptates. - brand_id: Blanditiis tempore rem ipsam. brand_name: Est nihil dolor qui id. endpoint_details: Voluptatum dolorum ipsam minima.: Id omnis omnis omnis. logo_uri: Fuga unde ipsam voluptates. example: - brand_id: Blanditiis tempore rem ipsam. brand_name: Est nihil dolor qui id. endpoint_details: Voluptatum dolorum ipsam minima.: Id omnis omnis omnis. logo_uri: Fuga unde ipsam voluptates. - brand_id: Blanditiis tempore rem ipsam. brand_name: Est nihil dolor qui id. endpoint_details: Voluptatum dolorum ipsam minima.: Id omnis omnis omnis. logo_uri: Fuga unde ipsam voluptates. security: - Token_header_Authorization: [] /certificates: get: tags: - certificates summary: List CDR certificates front-door description: List CDR Certificates operationId: front-door#List CDR certificates parameters: - name: limit in: query description: Number of records to return in response allowEmptyValue: true schema: type: integer description: Number of records to return in response example: 4076876881108835770 format: int64 example: 2411385343866761447 - name: offset in: query description: Defines start point of query to fetch records allowEmptyValue: true schema: type: integer description: Defines start point of query to fetch records example: 9075300577457182390 format: int64 example: 6300865750967686944 responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Certificate' example: - brand_id: 7a1a0eb6-1711-ec11-a83f-000d3a8842e1 brand_name: Fiskil name: Genie product_id: 4b9f604f-fe02-ed11-a830-000d3a8830d6 redirect_uri: - auth.fiskil.com/callback - brand_id: 7a1a0eb6-1711-ec11-a83f-000d3a8842e1 brand_name: Fiskil name: Genie product_id: 4b9f604f-fe02-ed11-a830-000d3a8830d6 redirect_uri: - auth.fiskil.com/callback - brand_id: 7a1a0eb6-1711-ec11-a83f-000d3a8842e1 brand_name: Fiskil name: Genie product_id: 4b9f604f-fe02-ed11-a830-000d3a8830d6 redirect_uri: - auth.fiskil.com/callback - brand_id: 7a1a0eb6-1711-ec11-a83f-000d3a8842e1 brand_name: Fiskil name: Genie product_id: 4b9f604f-fe02-ed11-a830-000d3a8830d6 redirect_uri: - auth.fiskil.com/callback example: - brand_id: 7a1a0eb6-1711-ec11-a83f-000d3a8842e1 brand_name: Fiskil name: Genie product_id: 4b9f604f-fe02-ed11-a830-000d3a8830d6 redirect_uri: - auth.fiskil.com/callback - brand_id: 7a1a0eb6-1711-ec11-a83f-000d3a8842e1 brand_name: Fiskil name: Genie product_id: 4b9f604f-fe02-ed11-a830-000d3a8830d6 redirect_uri: - auth.fiskil.com/callback security: - Token_header_Authorization: [] post: tags: - certificates summary: Create a CDR certificate front-door description: Creates a cdr certificate. operationId: front-door#Create a CDR certificate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateACDRCertificateRequestBody' example: brand_id: 7a1a0eb6-1711-ec11-a83f-000d3a8842e1 brand_name: Fiskil mtls_cert: Molestiae at dolorum impedit amet reiciendis. mtls_key: Dolorem blanditiis vero eaque. name: Genie product_id: 4b9f604f-fe02-ed11-a830-000d3a8830d6 redirect_uris: - auth.fiskil.com/callback responses: "200": description: OK response. content: application/json: schema: type: string example: Enim vel officiis. example: At ut minus optio. security: - Token_header_Authorization: [] /clients: get: tags: - clients summary: Get a client front-door description: Returns the current client config operationId: front-door#Get a client responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Fiskilclient' example: access_level: In itaque debitis voluptates esse illo. id: Aspernatur possimus omnis. name: Ratione a voluptates nisi. product_id: Rerum numquam quidem aut non. send_email: false security: - Token_header_Authorization: [] put: tags: - clients summary: Update a client front-door description: Update a client operationId: front-door#Update a client requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAClientRequestBody' example: send_email: true responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/CreateCustomAuthResponseBody' example: message: Harum magni. security: - Token_header_Authorization: [] /clients/{id}/grant-activation: post: tags: - clients summary: Grant live access front-door description: Grants a team live access to the configured data API client certificate operationId: front-door#Grant live access parameters: - name: id in: path description: the client config ID required: true schema: type: string description: the client config ID example: Temporibus recusandae et. example: Ut eaque. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Fiskilclient' example: access_level: Sed id. id: Maiores eum aliquam. name: In cum. product_id: Blanditiis labore dolorum non nihil est. send_email: false security: - Token_header_Authorization: [] /clients/{id}/liveapplication-approve: post: tags: - clients summary: Approve client live access application front-door description: Approves an application for live access by the client as fiskil:admin operationId: front-door#Approve client live access application parameters: - name: id in: path description: the client config ID (teamID) required: true schema: type: string description: the client config ID (teamID) example: Animi asperiores suscipit nisi tempora reprehenderit. example: Aut quo voluptatum molestiae quae ipsam. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Fiskilclient' example: access_level: Autem neque. id: Voluptatum adipisci. name: Veritatis quisquam exercitationem molestias perferendis. product_id: In neque nam et necessitatibus. send_email: true security: - Token_header_Authorization: [] /clients/{id}/revoke-activation: post: tags: - clients summary: Revoke live access front-door description: Revokes a team's live access, preventing new consents operationId: front-door#Revoke live access parameters: - name: id in: path description: the client config ID required: true schema: type: string description: the client config ID example: Et soluta est repellat ex voluptas. example: Sed corrupti ullam mollitia dolores. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Fiskilclient' example: access_level: Repellat aliquam sunt dolore. id: Velit nobis dolorum quod qui rerum magni. name: Non repellat sunt et sunt. product_id: Dolorum dolorem. send_email: true security: - Token_header_Authorization: [] /clients/activationrequest: post: tags: - clients summary: Request client live access front-door description: Requests activation of live access for team's client config. operationId: front-door#Request client live access responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Fiskilclient' example: access_level: Quidem molestiae architecto voluptates. id: Sunt in error. name: Est consequuntur. product_id: Illo provident cumque ad sequi quis voluptatum. send_email: true security: - Token_header_Authorization: [] /clients/invoicepaid-notify: post: tags: - webhooks summary: Notify client of Stripe payment front-door description: Webhook callback from Stripe to notify client of successful payment operationId: front-door#Notify client of Stripe payment responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/NotifyClientOfStripePaymentOKResponseBody' example: status: Quod similique rerum aut sunt et. "400": description: Bad Request response. content: application/json: schema: $ref: '#/components/schemas/NotifyClientOfStripePaymentOKResponseBody' example: status: Qui voluptas maxime rem voluptas. "401": description: Unauthorized response. content: application/json: schema: $ref: '#/components/schemas/NotifyClientOfStripePaymentOKResponseBody' example: status: Voluptate eos illum officia. security: [] /clients/liveapplication-complete: post: tags: - clients summary: Complete client live access application front-door description: Completes client live access activation application after purchase. operationId: front-door#Complete client live access application responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Fiskilclient' example: access_level: Cupiditate consectetur. id: Omnis et cupiditate. name: Doloremque quas. product_id: Iure vel praesentium sint. send_email: false "400": description: Bad Request response. content: application/json: schema: $ref: '#/components/schemas/Fiskilclient' example: access_level: Recusandae impedit. id: Facere quo autem nam maxime. name: Qui eius autem quia. product_id: Non perspiciatis id aspernatur fugit mollitia. send_email: false security: - Token_header_Authorization: [] /clients/liveapplication-submit: post: tags: - clients summary: Submit client live access application front-door description: Submits live access activation application for review. operationId: front-door#Submit client live access application responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Fiskilclient' example: access_level: Voluptatem et eaque. id: Perspiciatis blanditiis sint omnis nihil ut non. name: Error est voluptatibus rerum fugiat aut. product_id: Est delectus exercitationem molestiae laborum. send_email: false security: - Token_header_Authorization: [] /consent: get: tags: - consent - public - v1 - v2 summary: List consents front-door description: List consents belonging to a client. operationId: front-door#List consents parameters: - name: end_user_id in: query description: The ID of the end user to list consents for allowEmptyValue: true schema: type: string description: The ID of the end user to list consents for example: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB example: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB - name: active in: query description: Filter to include only active or inactive (i.e. revoked or expired) consents allowEmptyValue: true schema: type: boolean description: Filter to include only active or inactive (i.e. revoked or expired) consents example: true example: true - name: expires_before in: query description: Optional RFC3339 timestamp. Only consents expiring before this time are returned. allowEmptyValue: true schema: type: string description: Optional RFC3339 timestamp. Only consents expiring before this time are returned. example: "2025-05-01T00:00:00Z" example: "2025-05-01T00:00:00Z" responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Consent' example: - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked example: - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked security: - Token_header_Authorization: [] /consent/{arrangement_id}: delete: tags: - consent - public - v1 - v2 - v3 summary: Revoke consent front-door description: Allows a client to revoke a consent operationId: front-door#Revoke consent parameters: - name: arrangement_id in: path description: CDR arrangement ID as returned by the list consents API. required: true schema: type: string description: CDR arrangement ID as returned by the list consents API. example: 94549a73-a554-4b76-b824-d96898829751 example: 94549a73-a554-4b76-b824-d96898829751 responses: "204": description: No Content response. security: - Token_header_Authorization: [] /consent/authorise: post: tags: - consent summary: Authorize front-door description: Begin the process of creating a consent. operationId: front-door#Authorize requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AuthoriseRequest' example: auth_session_id: Dolorem ea. cancel_uri: https://www.powerpal.net/ cdr_arrangement_id: Accusamus cupiditate soluta. client_id: Nostrum fugiat et aut iste. consent_period_string: 3 months end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB institution_id: "85" redirect_uri: https://www.powerpal.net/cancel scope: - Enim eligendi odit dolore voluptatem. - Praesentium et eaque nobis iusto ipsum optio. - Occaecati et soluta dolores. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Authorise' example: location: Quia eum optio ut sint. session_id: Dolore provident rerum. "400": description: 'missing_abn: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "401": description: 'invalid_enduser: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /consent/authorise/callback: get: tags: - consent summary: Authorize callback front-door description: Complete the consent process. operationId: front-door#Authorize callback parameters: - name: response in: query description: The JARM encoded authorization response. It should be passed via query string but if not, it may be passed by fragment allowEmptyValue: true schema: type: string description: The JARM encoded authorization response. It should be passed via query string but if not, it may be passed by fragment example: Omnis alias ipsum ut in illum eum. example: Recusandae voluptatem. - name: cdr_error in: query allowEmptyValue: true schema: type: string example: Exercitationem iure officia vitae animi illo facilis. example: Ad rem qui voluptatum ea ipsa quod. - name: error_description in: query allowEmptyValue: true schema: type: string example: Repellendus quae. example: Pariatur consequatur iste ea dolor tempora. - name: error_uri in: query allowEmptyValue: true schema: type: string example: Alias qui modi molestiae. example: Quod fugiat. responses: "200": description: OK response. content: text/html: schema: type: string example: Doloribus expedita iusto quia dicta molestias. example: Error culpa et. "307": description: Temporary Redirect response. headers: Location: description: Redirect URL schema: type: string description: Redirect URL example: Aut cum laudantium tenetur magnam quas enim. example: Nisi rerum voluptatum nostrum ullam ab. content: application/json: schema: $ref: '#/components/schemas/AuthorizeCallbackTemporaryRedirectResponseBody' example: response_mode: Et earum sed. response_page: Nulla voluptatem saepe. security: [] /consent/dashboard: get: tags: - consent summary: List consents by an email front-door description: List consents belonging to a client by an email operationId: front-door#List consents by an email responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Consent' example: - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked example: - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked security: - Token_header_Authorization: [] /consent/dashboard/{arrangement_id}: delete: tags: - consent summary: Revoke consent for dashboard front-door description: Allows a client to revoke a consent for dashboard operationId: front-door#Revoke consent for dashboard parameters: - name: arrangement_id in: path description: CDR arrangement ID. required: true schema: type: string description: CDR arrangement ID. example: Praesentium praesentium. example: Minima et repellat repudiandae. responses: "204": description: No Content response. "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] get: tags: - consent summary: Get consent details by consent id front-door description: Get consent details by consent id operationId: front-door#Get consent details by consent id parameters: - name: arrangement_id in: path required: true schema: type: string example: Non dolores voluptatem facere et nisi. example: Fugiat eaque officia tempora omnis ipsa. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Consent' example: account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked "404": description: 'consent_not_found: Consent not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /consent/deny: post: tags: - consent summary: Deny front-door description: User denied the consent operationId: front-door#Deny requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DenyAuthorisationRequest' example: end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB session_id: "85" responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/DenyAuthorisationResult' example: cancel_uri: https://www.adrapp.net/error=access_denied&error_id=err_acde070d-8c4c-4f0d-9d8a-162843c10333&error_type=CONSENT_ENDUSER_DENIED&error_description=End-user denied consent during consent creation inside third-party data-holder application. End-user needs to create new consent.&error_uri=https://data.docs.fiskil.dev/errors#CONSENT_ENDUSER_DENIED "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /contact/careers: post: tags: - website summary: Submit career application front-door description: Submit an application for a career at Fiskil operationId: front-door#Submit career application requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SubmitCareerApplicationRequestBody' example: cover_letter_link: Necessitatibus rerum ut magni. email: 7@d.WoX name: Nesciunt veniam laboriosam velit. phone: +2 8930090443 resume_link: Temporibus ipsam. website: Quis est. responses: "200": description: OK response. content: application/json: schema: type: string example: Amet harum asperiores nobis quis. example: Consectetur occaecati expedita voluptas odit est. security: [] /custom-auth: get: tags: - custom-auth summary: Get custom auth for client front-door description: Finds custom auth by client id operationId: front-door#Get custom auth for client parameters: - name: client_id in: query description: Client ID allowEmptyValue: true required: true schema: type: string description: Client ID example: Facilis eum commodi earum voluptate tempora et. example: Autem quod possimus. - name: session_id in: query description: Session ID allowEmptyValue: true schema: type: string description: Session ID example: Repudiandae possimus aut dolor provident voluptatem necessitatibus. example: Id maxime nostrum asperiores fugiat officiis. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Customauth' example: access_level: Corporis soluta et quisquam ipsam voluptatum vitae. additional_use_cases: - Ut quibusdam quidem quasi hic eos. - Blanditiis quis voluptates non asperiores. - Maxime mollitia optio nam. app_name: Labore aut eligendi ipsa itaque aliquid ut. button_border_radius: 2887867733300303731 button_color: Adipisci iste velit et quisquam. button_text_color: Veritatis laudantium culpa dicta. client_id: Enim quia est voluptatem neque. client_type: Quisquam iusto ut eos. consent_period: 3737751712712269019 consent_period_string: Aperiam laborum enim eaque eum autem. consumer_type: Neque aspernatur ducimus vel aut. created_at: Quis rerum ut cum. customer_authorization: Sed qui perferendis quibusdam. data_minimisation: Consectetur fugit voluptas ut doloribus. end_user: abn: Est nihil et facilis. business_name: Aliquid sapiente consequuntur qui a necessitatibus nisi. history_fetch_period_in_month: 328879226851826251 industry: Quasi tempore. institution_mode: Architecto quas magni ratione. logo: Dolor ut dolore esse quia. main_primary: Sint ullam. main_secondary: Id nesciunt fugit voluptatibus. notification_email: Dolor neque ut officia eum. policy_uri: A sed consectetur qui exercitationem eum. providers: Illum aut. sandbox_enabled: false scope: - Qui repellendus eius tempore. - Eos nisi sit quas. service_usage_disclosure: Optio modi nostrum et quaerat molestiae. show_cdr_footer: false supporting_parties: - Blanditiis corrupti excepturi quae accusantium dicta. - Ipsa odit est. - Molestias nesciunt. - At perspiciatis. updated_at: Neque minima. use_cases: - Maxime voluptatem. - Minus sed quia. withdraw_consent: Consequuntur nihil accusantium incidunt. "404": description: 'end_user_not_found: end users not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] post: tags: - custom-auth summary: Create custom auth front-door description: Creates a custom auth operationId: front-door#Create custom auth requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCustomAuthRequestBody' example: additional_use_cases: - Non blanditiis. - Facere et sapiente eos. - Temporibus commodi quia magnam ex at. - Repellendus nisi et tempore. app_name: Molestiae autem. button_border_radius: 8671105365268785204 button_color: Aut ab nihil est quam ex. button_text_color: Voluptatem facere aut tenetur sint assumenda quo. consent_period: 5942756855643320161 consent_period_string: 1 month consumer_type: Aliquid sapiente laboriosam. customer_authorization: Qui error illum mollitia eius sapiente et. data_minimisation: Consequuntur molestiae sapiente dolores doloribus nemo. history_fetch_period_in_month: 5665207231512593851 industry: Quibusdam expedita. main_primary: Ea magni dolore aut tenetur numquam. main_secondary: Rerum impedit et. notification_email: Consequatur nulla ducimus consectetur quo cupiditate. policy_uri: Sit quod magni. providers: Qui non commodi perferendis ut. scope: - Ipsam hic excepturi tenetur cupiditate sit sint. - Ipsa ea explicabo facere. - In ipsa dolores tenetur ipsa non facilis. service_usage_disclosure: Enim in nihil eum. show_cdr_footer: true supporting_parties: - Et recusandae repudiandae. - Tenetur distinctio quas modi adipisci ipsa. - Tenetur dolores perferendis enim. use_cases: - Explicabo accusantium dolorum sit aut velit dolore. - Itaque beatae. withdraw_consent: Ut sapiente fugiat fugit odio. responses: "201": description: Created response. content: application/json: schema: $ref: '#/components/schemas/CreateCustomAuthResponseBody' example: message: Ad molestiae quasi sint. security: - Token_header_Authorization: [] put: tags: - custom-auth summary: Update custom auth for client front-door description: Update custom auth for client operationId: front-door#Update custom auth for client requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateCustomAuthForClientRequestBody' example: additional_use_cases: - Est modi qui. - Quos incidunt. app_name: Fuga quo. button_border_radius: 7779407539451463139 button_color: Nisi dolor porro sunt rem. button_text_color: Eligendi vitae magnam et. consent_period: 8343202748651233414 consent_period_string: Once-off consumer_type: Id incidunt est autem odio. customer_authorization: Perspiciatis autem in. data_minimisation: Veniam et quidem tempore est. history_fetch_period_in_month: 951896638283411038 industry: Excepturi provident. institution_mode: Rerum voluptas omnis in. logo: Itaque et ea dolorem dolor accusantium. main_primary: Illo cum. main_secondary: Harum consequatur. notification_email: Vitae error quibusdam qui. policy_uri: Non beatae unde. providers: Repellendus eligendi tempore non corrupti eos ab. sandbox_enabled: false scope: - Totam aut modi omnis rerum occaecati. - Optio maiores sit hic error. - Reprehenderit aut deleniti. service_usage_disclosure: Nulla quam earum molestiae quas ea. show_cdr_footer: true supporting_parties: - Odio voluptatem iusto vel quae. - Id ab quia non blanditiis accusamus itaque. use_cases: - Quam quia. - Voluptate tempora. - Saepe cum. - Dolorum et repudiandae. withdraw_consent: Soluta laborum maxime est porro explicabo ipsa. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/CreateCustomAuthResponseBody' example: message: Et aut. "404": description: 'custom_auth_not_found: Custom Auth not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /custom-auth/logo/upload: post: tags: - custom-auth summary: Upload custom auth logo front-door description: Upload custom auth logo to GCS operationId: front-door#Upload custom auth logo parameters: - name: Content-Type in: header description: Content-Type header, must define value for multipart boundary. allowEmptyValue: true schema: type: string description: Content-Type header, must define value for multipart boundary. example: Maiores doloremque tempore nihil ut fuga. example: Blanditiis hic ut minima et at pariatur. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Uploadedimageresponse' example: image_name: Sapiente voluptas eos ipsum ex. "400": description: 'invalid_multipart_request: Error returned when the request body is not a valid multipart content.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "404": description: 'custom_auth_not_found: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "500": description: 'internal_error: Fault while processing upload.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /customer-onboarding: get: tags: - clients summary: Fetch customer onboarding details front-door description: Finds the current value of the customer onboarding data operationId: front-door#Fetch customer onboarding details responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Fiskilcustomeronboarding' example: customer_connection_commercial: true customer_connection_news: true customer_industry: Aut non eos incidunt asperiores. customer_intention: Voluptatem beatae tempora autem non. customer_interests: - Occaecati in ea. - Voluptas rerum illum ut eaque distinctio non. - Ut alias in perspiciatis rerum. customer_service: Suscipit labore eos qui aspernatur. customer_service_providing: Accusamus veritatis temporibus aperiam beatae voluptatibus. customer_users_scale: Cum quasi minus dolor et et cupiditate. id: Voluptas quas sit. security: - Token_header_Authorization: [] post: tags: - clients summary: Create a customer onboarding front-door description: Creates a customer onboarding resource, when customers describe their use case operationId: front-door#Create a customer onboarding requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateACustomerOnboardingRequestBody' example: customer_connection_commercial: true customer_connection_news: false customer_industry: Quia consequatur. customer_intention: Earum numquam numquam. customer_interests: - Similique consequatur nostrum. - Dolores quod. - Velit quia natus dolorum. customer_service: Vel nihil omnis aspernatur in quo minus. customer_service_providing: Nihil et in voluptatum hic veritatis ratione. customer_users_scale: Est iusto sapiente voluptates. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/CreateACustomerOnboardingResponseBody' example: id: Saepe enim esse modi cum impedit quis. security: - Token_header_Authorization: [] /dcr: get: tags: - dcr summary: List DCR registrations front-door description: Lists all dcr registrations for a product operationId: front-door#List DCR registrations parameters: - name: product_id in: query description: The CDR product id to register. allowEmptyValue: true required: true schema: type: string description: The CDR product id to register. example: Voluptas qui praesentium deleniti culpa sit totam. example: Ratione maxime nemo. responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Dcrentry' example: - brand_id: Excepturi aut ducimus ut est corrupti. brand_name: Eius eveniet quaerat rerum cumque voluptatem. institution_brand_id: Incidunt quia eum repellendus. institution_client_id: Praesentium vero et. institution_icon_url: Vel et autem. institution_id: Excepturi rerum qui eius. institution_industry: Consequuntur consequatur reiciendis delectus accusantium. institution_logo_url: Eligendi numquam debitis. institution_name: Dolorum cumque vel. product_id: Dolores modi. product_name: Aut perferendis accusamus. redirect_uris: - Debitis animi tenetur. - Aspernatur ea ab consequatur. - Vitae et ut aliquid fugiat. - Vel nisi explicabo vero. - brand_id: Excepturi aut ducimus ut est corrupti. brand_name: Eius eveniet quaerat rerum cumque voluptatem. institution_brand_id: Incidunt quia eum repellendus. institution_client_id: Praesentium vero et. institution_icon_url: Vel et autem. institution_id: Excepturi rerum qui eius. institution_industry: Consequuntur consequatur reiciendis delectus accusantium. institution_logo_url: Eligendi numquam debitis. institution_name: Dolorum cumque vel. product_id: Dolores modi. product_name: Aut perferendis accusamus. redirect_uris: - Debitis animi tenetur. - Aspernatur ea ab consequatur. - Vitae et ut aliquid fugiat. - Vel nisi explicabo vero. - brand_id: Excepturi aut ducimus ut est corrupti. brand_name: Eius eveniet quaerat rerum cumque voluptatem. institution_brand_id: Incidunt quia eum repellendus. institution_client_id: Praesentium vero et. institution_icon_url: Vel et autem. institution_id: Excepturi rerum qui eius. institution_industry: Consequuntur consequatur reiciendis delectus accusantium. institution_logo_url: Eligendi numquam debitis. institution_name: Dolorum cumque vel. product_id: Dolores modi. product_name: Aut perferendis accusamus. redirect_uris: - Debitis animi tenetur. - Aspernatur ea ab consequatur. - Vitae et ut aliquid fugiat. - Vel nisi explicabo vero. - brand_id: Excepturi aut ducimus ut est corrupti. brand_name: Eius eveniet quaerat rerum cumque voluptatem. institution_brand_id: Incidunt quia eum repellendus. institution_client_id: Praesentium vero et. institution_icon_url: Vel et autem. institution_id: Excepturi rerum qui eius. institution_industry: Consequuntur consequatur reiciendis delectus accusantium. institution_logo_url: Eligendi numquam debitis. institution_name: Dolorum cumque vel. product_id: Dolores modi. product_name: Aut perferendis accusamus. redirect_uris: - Debitis animi tenetur. - Aspernatur ea ab consequatur. - Vitae et ut aliquid fugiat. - Vel nisi explicabo vero. example: - brand_id: Excepturi aut ducimus ut est corrupti. brand_name: Eius eveniet quaerat rerum cumque voluptatem. institution_brand_id: Incidunt quia eum repellendus. institution_client_id: Praesentium vero et. institution_icon_url: Vel et autem. institution_id: Excepturi rerum qui eius. institution_industry: Consequuntur consequatur reiciendis delectus accusantium. institution_logo_url: Eligendi numquam debitis. institution_name: Dolorum cumque vel. product_id: Dolores modi. product_name: Aut perferendis accusamus. redirect_uris: - Debitis animi tenetur. - Aspernatur ea ab consequatur. - Vitae et ut aliquid fugiat. - Vel nisi explicabo vero. - brand_id: Excepturi aut ducimus ut est corrupti. brand_name: Eius eveniet quaerat rerum cumque voluptatem. institution_brand_id: Incidunt quia eum repellendus. institution_client_id: Praesentium vero et. institution_icon_url: Vel et autem. institution_id: Excepturi rerum qui eius. institution_industry: Consequuntur consequatur reiciendis delectus accusantium. institution_logo_url: Eligendi numquam debitis. institution_name: Dolorum cumque vel. product_id: Dolores modi. product_name: Aut perferendis accusamus. redirect_uris: - Debitis animi tenetur. - Aspernatur ea ab consequatur. - Vitae et ut aliquid fugiat. - Vel nisi explicabo vero. security: - Token_header_Authorization: [] post: tags: - dcr summary: Register DCR front-door description: Go through DCR flow operationId: front-door#Register DCR requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RegisterDCRRequestBody' example: institution_id: Voluptas adipisci adipisci ducimus. product_id: Qui nihil et voluptates aperiam. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/RegisterDCRResponseBody' example: client_id: Id nulla. security: - Token_header_Authorization: [] put: tags: - dcr summary: Update DCR registration front-door description: Update DCR operationId: front-door#Update DCR registration requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RegisterDCRRequestBody' example: institution_id: Dignissimos aliquid consequuntur. product_id: Eveniet omnis sit voluptatibus harum voluptatibus ducimus. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/RegisterDCRResponseBody' example: client_id: Aliquid quibusdam ut voluptas sit id. security: - Token_header_Authorization: [] /dcr/{product_id}: get: tags: - dcr summary: Get DCR registration front-door description: Get DCR registration operationId: front-door#Get DCR registration parameters: - name: product_id in: path description: The CDR product id to register. required: true schema: type: string description: The CDR product id to register. example: Repudiandae aliquid. example: Ad dolores voluptatem non explicabo. - name: institution_id in: query description: The ID of the institution. allowEmptyValue: true required: true schema: type: string description: The ID of the institution. example: Esse id. example: Est consectetur voluptatem quasi. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Dcrregistration' example: application_type: Voluptate maxime tempore facilis et. authorization_signed_response_alg: Aut quis autem et. client_description: Et consequatur. client_id: Quis est odit quae voluptatem. client_id_issued_at: 6307350827720579869 client_name: Cumque est velit porro qui fuga. client_uri: Soluta enim quia eum quo voluptatem rerum. grant_types: - Est perferendis molestiae. - Soluta ea natus. - Cupiditate saepe id iusto nisi. id_token_signed_response_alg: Enim voluptatibus ut necessitatibus. jwks_uri: Unde aut velit omnis aliquid ullam provident. legal_entity_id: Consequatur cupiditate occaecati ratione quam. legal_entity_name: Pariatur aut quos eos aut odit nihil. logo_uri: Repellendus molestiae labore. org_id: Veniam voluptatem nisi mollitia aut. org_name: Magni tenetur. recipient_base_uri: Eos maxime mollitia dicta inventore. redirect_uris: - Hic error eligendi eaque veritatis commodi illum. - Voluptatem magnam ut consequatur et rerum repudiandae. request_object_signing_alg: Id ipsam mollitia earum cupiditate est incidunt. require_pushed_authorization_requests: Aliquam fugiat ipsa nam. response_types: - Accusantium deserunt consequatur. - Unde ea nulla provident rerum aspernatur. revocation_uri: Doloremque dolorum doloremque assumenda. scope: Sapiente et voluptas quisquam modi doloremque ut. software_id: Quos aliquam possimus sed voluptatem adipisci consequatur. software_roles: Eius vel veniam. software_statement: Sit hic velit magnam. token_endpoint_auth_method: Laboriosam velit voluptatem. token_endpoint_auth_signing_alg: Non repellendus sed enim. security: - Token_header_Authorization: [] /end-users: get: tags: - end-users - public - v1 - v2 summary: List end users front-door description: List end users operationId: front-door#List end users parameters: - name: email in: query description: Email address to filter end users by allowEmptyValue: true schema: type: string description: Email address to filter end users by example: john_starmer@gmail.com example: john_starmer@gmail.com responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Enduser' example: - email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" - email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" example: - email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" - email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" - email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] post: tags: - end-users - public - v1 - v2 - v3 summary: Create end user front-door description: Creates a new end user operationId: front-door#Create end user requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateEndUserRequestBody' example: abn: 51 824 753 556 email: john_starmer@gmail.com name: John Starmer phone: "+614123456789" responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Createenduser' example: end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB "400": description: 'end_user_already_exists: user with that email already exists' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "403": description: 'insufficient_scopes: token doesn''t have enough scope to access the resource' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /end-users/{end_user_id}: post: tags: - end-users - public - v1 - v2 - v3 summary: Update end user front-door description: Update an end user operationId: front-door#Update end user parameters: - name: end_user_id in: path description: ID of the end user required: true schema: type: string description: ID of the end user example: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB example: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateEndUserRequestBody' example: abn: 51 824 753 556 email: john_starmer@gmail.com phone: "+614123456789" session_id: ses-123 responses: "204": description: No Content response. "400": description: 'end_user_already_exists: user with that email already exists' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "404": description: 'end_user_not_found: end user not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /end-users/{id}: delete: tags: - end-users - public - v1 - v2 - v3 summary: Delete end user front-door description: Allows a client to delete an end user operationId: front-door#Delete end user parameters: - name: id in: path description: The id of the end user to delete. required: true schema: type: string description: The id of the end user to delete. example: 482c0e2b-5866-46b1-b795-220b7bba45b5 example: 482c0e2b-5866-46b1-b795-220b7bba45b5 responses: "204": description: No Content response. "404": description: 'end_user_not_found: End user not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] get: tags: - end-users - public - v1 - v2 - v3 summary: Get end user by id front-door description: Finds an end user by end user id operationId: front-door#Get end user by id parameters: - name: id in: path description: ID of the end user to fetch. required: true schema: type: string description: ID of the end user to fetch. example: 482c0e2b-5866-46b1-b795-220b7bba45b5 example: 482c0e2b-5866-46b1-b795-220b7bba45b5 responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Enduser' example: email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "404": description: 'end_user_not_found: end user not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /global/institutions: get: tags: - institutions summary: Fetch institutions front-door description: Fetch a list of institutions operationId: front-door#Fetch institutions parameters: - name: industry in: query description: The type of Institution, an example is banking or energy. allowEmptyValue: true schema: type: string description: The type of Institution, an example is banking or energy. example: Itaque assumenda quas fugit facilis porro dolor. example: Tenetur molestiae. responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Institution' example: - brand_id: brand-001 icon_url: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking logo_url: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 resource_url: https://eastpac.com.au status: connections: status: OUTAGE wkc_url: https://eastpac.com.au/.well-known/openid-configuration - brand_id: brand-001 icon_url: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking logo_url: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 resource_url: https://eastpac.com.au status: connections: status: OUTAGE wkc_url: https://eastpac.com.au/.well-known/openid-configuration - brand_id: brand-001 icon_url: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking logo_url: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 resource_url: https://eastpac.com.au status: connections: status: OUTAGE wkc_url: https://eastpac.com.au/.well-known/openid-configuration example: - brand_id: brand-001 icon_url: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking logo_url: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 resource_url: https://eastpac.com.au status: connections: status: OUTAGE wkc_url: https://eastpac.com.au/.well-known/openid-configuration - brand_id: brand-001 icon_url: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking logo_url: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 resource_url: https://eastpac.com.au status: connections: status: OUTAGE wkc_url: https://eastpac.com.au/.well-known/openid-configuration - brand_id: brand-001 icon_url: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking logo_url: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 resource_url: https://eastpac.com.au status: connections: status: OUTAGE wkc_url: https://eastpac.com.au/.well-known/openid-configuration - brand_id: brand-001 icon_url: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking logo_url: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 resource_url: https://eastpac.com.au status: connections: status: OUTAGE wkc_url: https://eastpac.com.au/.well-known/openid-configuration "404": description: 'institutions_not_found: Institutions not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] post: tags: - institutions summary: Create institutions front-door description: Create an instituion operationId: front-door#Create institutions requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateInstitutionsRequestBody' example: brand_id: 578efc60-4eb1-eb11-a822-000d3a884a20 icon_url: banking_Bank Australia_icon_1656329405.png id: "85" industry: banking logo_url: https://www.bankaust.com.au/globalassets/assets/imagery/logos/bank-australia/ba_horizontal_logo.png name: Bank Australia priority: 50 resource_url: https://resource.cdr-api.bankaust.com.au wkc_url: https://identity-mtls.cdr-api.bankaust.com.au/.well-known/openid-configuration responses: "201": description: Created response. security: - Token_header_Authorization: [] /global/institutions/{id}: put: tags: - institutions summary: Update institutions front-door description: Update an institution operationId: front-door#Update institutions parameters: - name: id in: path required: true schema: type: string example: "85" example: "85" requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateInstitutionsRequestBody' example: icon_url: banking_Bank Australia_icon_1656329405.png logo_url: https://www.bankaust.com.au/globalassets/assets/imagery/logos/bank-australia/ba_horizontal_logo.png responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/CreateCustomAuthResponseBody' example: message: Sapiente ducimus molestias praesentium repellendus. "404": description: 'institution_not_found: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /global/institutions/{id}/upload: post: tags: - custom-auth summary: Upload global institution image front-door description: Upload global institution image operationId: front-door#Upload global institution image parameters: - name: id in: path description: The institution id. required: true schema: type: string description: The institution id. example: Et beatae odio rem accusantium sapiente. example: Quaerat atque et ut eius molestiae. - name: Content-Type in: header description: Content-Type header, must define value for multipart boundary. allowEmptyValue: true schema: type: string description: Content-Type header, must define value for multipart boundary. example: Eos aliquid. example: Sed sunt. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Uploadedimageresponse' example: image_name: Rerum deleniti perferendis ut mollitia consequuntur ab. "400": description: 'invalid_multipart_request: Error returned when the request body is not a valid multipart content.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "404": description: 'institution_not_found: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "500": description: 'internal_error: Fault while processing upload.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /institutions: get: tags: - institutions - public - v1 - v2 - v3 summary: List institutions by client front-door description: Gets a list of institutions a client subscribes to. operationId: front-door#List institutions by client parameters: - name: industry in: query description: The type of the institution e.g. “banking” or “energy” allowEmptyValue: true schema: type: string description: The type of the institution e.g. “banking” or “energy” example: energy enum: - banking - energy example: banking - name: client_id in: query description: Your team ID. You can get this from the settings menu of the Fiskil Console allowEmptyValue: true required: true schema: type: string description: Your team ID. You can get this from the settings menu of the Fiskil Console example: your-team-id example: your-team-id - name: sess_id in: query description: The auth session id allowEmptyValue: true schema: type: string description: The auth session id example: Et est quia enim ducimus. example: Debitis molestiae et laboriosam ut. - name: institution_mode in: query description: The institution mode. If set to recommended, will load recommended institution data only allowEmptyValue: true schema: type: string description: The institution mode. If set to recommended, will load recommended institution data only example: recommended enum: - recommended example: recommended responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/InstitutionByClient' example: - icon: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking is_accessible: true logo: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 status: connections: status: OUTAGE - icon: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking is_accessible: true logo: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 status: connections: status: OUTAGE - icon: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking is_accessible: true logo: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 status: connections: status: OUTAGE - icon: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking is_accessible: true logo: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 status: connections: status: OUTAGE example: - icon: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking is_accessible: true logo: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 status: connections: status: OUTAGE - icon: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking is_accessible: true logo: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 status: connections: status: OUTAGE - icon: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking is_accessible: true logo: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 status: connections: status: OUTAGE - icon: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking is_accessible: true logo: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 status: connections: status: OUTAGE "400": description: 'bad_request: EndUserID is not associated with clientID passed in request' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] put: tags: - institutions summary: Update Client Custom Institution Configuration front-door description: Creates/updates a new ClientCustomInstitutions record operationId: front-door#Update Client Custom Institution Configuration requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateClientCustomInstitutionConfigurationRequestBody' example: client_id: Possimus eos repellat nobis rerum. industry: Corrupti adipisci et qui qui quas voluptatem. institutions: - id: Velit vitae et perferendis aspernatur itaque quasi. name: Est at et aut dolores non nihil. - id: Velit vitae et perferendis aspernatur itaque quasi. name: Est at et aut dolores non nihil. - id: Velit vitae et perferendis aspernatur itaque quasi. name: Est at et aut dolores non nihil. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Updateclientcustominstitutionconfigurationresponse' example: message: institutions updated security: - Token_header_Authorization: [] /institutions/{id}: get: tags: - institutions - public - v1 - v2 - v3 summary: Get institution by id front-door description: Get institution by id operationId: front-door#Get institution by id parameters: - name: id in: path description: The ID of the institution to fetch details of required: true schema: type: string description: The ID of the institution to fetch details of example: "10" example: "10" responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/InstitutionByClient' example: icon: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking is_accessible: true logo: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 status: connections: status: DEGRADED "404": description: 'institution_not_found: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /permissions: get: tags: - permissions - public - v1 - v2 - v3 summary: List permissions front-door description: Returns a list of Fiskil permissions. operationId: front-door#List permissions parameters: - name: industry in: query description: The industry to filter on allowEmptyValue: true schema: type: string description: The industry to filter on example: banking example: banking responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Permission' example: - description: This will give the provider access to all of your transaction information industry: banking name: transactions scope: bank:transactions:read standards: - CDR - description: This will give the provider access to all of your transaction information industry: banking name: transactions scope: bank:transactions:read standards: - CDR example: - description: This will give the provider access to all of your transaction information industry: banking name: transactions scope: bank:transactions:read standards: - CDR - description: This will give the provider access to all of your transaction information industry: banking name: transactions scope: bank:transactions:read standards: - CDR security: [] /public.jwks: get: tags: - docs summary: Get JWKs front-door description: Returns a list of Fiskil public keys in as JWKs operationId: front-door#Get JWKs responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/JWKs' example: keys: - alg: PS256 e: AQAB kid: fiskil_kid_sig kty: RSA "n": uMtxVF1tgOy7xIAbTHQxvToZCB9nkrg_UpGWIWOE42Or0r2RNMBom_MFZka4tL7pUaZSLUtZJpXNZyYgZ63T3_EZKNyUfgmsEVg7J--FW-jnktY_T7hgkGjrLlW0a1nJlCfmV4bR31L4fnYDkpsQopxYMfw6CFFOoD1e9_xk6PA8VLOBs4vnUmIaw1heJZRIu0iekYVMSnrY1R_uePfgGWxsZEl53lGHRsB1lxQ9s8mPKZwdUjsX5zQUAQBTK3tsCy2jIO4oAA8GX_SBsrIQ4VMtH7e7sCIiTQGxKsIHWqPF0at4lH5cZtRiYUQYz6a6v48JQ5Glg33ld5GNGe-XdS7FlCvNVLIzBpJViO0WIMzMTFqnwNI5cxRTLJLedMwx9WUdG-G5675tFgkXWbYtwcteCRoWz85f0EPSBnCn1nVUosMnkkgTcdnKHng5TWKWYQda6x3FxBcG06Dmj52fJVA62ThVNvM2QMG0cfBMv4cSYMaCa8EsCPgTmBcXRyiwHxDK-w3hrVEW4t32MYY0pkkLvg4ZSzUsEp79kOWwGSIqGUkE-oh9fFQixPJr4MFsSHutsbI5zQkGkUfMoO_Z9NeleGSSVz62prT_Lvyh35_o_FgxVNauRO0fty2Bhqjk7xAsaiAr1udu_l1SvncheKkvAYp1hI0dPC4L-hGfZks use: sig - alg: PS256 e: AQAB kid: fiskil_kid_sig kty: RSA "n": uMtxVF1tgOy7xIAbTHQxvToZCB9nkrg_UpGWIWOE42Or0r2RNMBom_MFZka4tL7pUaZSLUtZJpXNZyYgZ63T3_EZKNyUfgmsEVg7J--FW-jnktY_T7hgkGjrLlW0a1nJlCfmV4bR31L4fnYDkpsQopxYMfw6CFFOoD1e9_xk6PA8VLOBs4vnUmIaw1heJZRIu0iekYVMSnrY1R_uePfgGWxsZEl53lGHRsB1lxQ9s8mPKZwdUjsX5zQUAQBTK3tsCy2jIO4oAA8GX_SBsrIQ4VMtH7e7sCIiTQGxKsIHWqPF0at4lH5cZtRiYUQYz6a6v48JQ5Glg33ld5GNGe-XdS7FlCvNVLIzBpJViO0WIMzMTFqnwNI5cxRTLJLedMwx9WUdG-G5675tFgkXWbYtwcteCRoWz85f0EPSBnCn1nVUosMnkkgTcdnKHng5TWKWYQda6x3FxBcG06Dmj52fJVA62ThVNvM2QMG0cfBMv4cSYMaCa8EsCPgTmBcXRyiwHxDK-w3hrVEW4t32MYY0pkkLvg4ZSzUsEp79kOWwGSIqGUkE-oh9fFQixPJr4MFsSHutsbI5zQkGkUfMoO_Z9NeleGSSVz62prT_Lvyh35_o_FgxVNauRO0fty2Bhqjk7xAsaiAr1udu_l1SvncheKkvAYp1hI0dPC4L-hGfZks use: sig security: [] /status/institutions: get: tags: - institution-status summary: Fetch institution statuses page front-door description: Fetches a complete list of banking and energy institutions and their respective statuses. operationId: front-door#Fetch institution statuses page responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Institutionstatuspageresult' example: - industry: energy institution_statuses: - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage - industry: energy institution_statuses: - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage - industry: energy institution_statuses: - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage - industry: energy institution_statuses: - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage example: - industry: energy institution_statuses: - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage - industry: energy institution_statuses: - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage "404": description: 'institution_statuses_not_found: Institution statuses not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /status/institutions/{institution_id}/details: get: tags: - institution-status summary: Fetch institution status details front-door description: Fetches institution-specific current outage as well as a list of all incidents and scheduled outages. operationId: front-door#Fetch institution status details parameters: - name: page in: query description: Page number for paginating outages list. allowEmptyValue: true schema: type: integer description: Page number for paginating outages list. example: 8800569860965087895 format: int64 example: 4005506905200219984 - name: outage_type in: query description: Filter where, if provided, filters by scheduled outages or incidents. allowEmptyValue: true schema: type: string description: Filter where, if provided, filters by scheduled outages or incidents. example: scheduled enum: - scheduled - incident example: incident - name: institution_id in: path description: Description of the update. required: true schema: type: string description: Description of the update. example: Est reprehenderit nihil. example: Accusamus qui. responses: "201": description: Created response. content: application/json: schema: $ref: '#/components/schemas/Institutionoutagesresult' example: current_incident: created_at: Autem neque magni et omnis deleniti ipsum. description: Soluta labore id. end_at: Natus consequatur ex qui. id: Ut explicabo fugit nam nihil ullam reprehenderit. incident_updates: - description: Eum iusto sed amet facilis aut. status: Voluptatibus odio voluptate eos sint tempore aperiam. update_at: Fugiat et possimus neque optio. - description: Eum iusto sed amet facilis aut. status: Voluptatibus odio voluptate eos sint tempore aperiam. update_at: Fugiat et possimus neque optio. start_at: Sed dolorem laborum. title: Veritatis error et facilis fugit corporis illum. current_scheduled_outage: id: Nulla quis amet dicta consequatur dolores. institution_id: Est nihil. is_partial: true outage_end: Ut quos. outage_reason: Sunt voluptatem. outage_start: Deleniti molestias velit cum earum ipsam. has_next_page: true institution_id: "1" institution_logo_url: Reiciendis ea. institution_name: NAB institution_status: Healthy next_scheduled_outage: id: Nulla quis amet dicta consequatur dolores. institution_id: Est nihil. is_partial: true outage_end: Ut quos. outage_reason: Sunt voluptatem. outage_start: Deleniti molestias velit cum earum ipsam. outages: - description: Ut in. duration: 7113594325144523084 end_at: Omnis asperiores ad officiis quos. id: Et eius delectus sed iure. incident_updates: - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. outage_type: Incident start_at: Est ab a nisi et voluptatem commodi. status: Enim exercitationem. title: Exercitationem quo amet et. - description: Ut in. duration: 7113594325144523084 end_at: Omnis asperiores ad officiis quos. id: Et eius delectus sed iure. incident_updates: - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. outage_type: Incident start_at: Est ab a nisi et voluptatem commodi. status: Enim exercitationem. title: Exercitationem quo amet et. - description: Ut in. duration: 7113594325144523084 end_at: Omnis asperiores ad officiis quos. id: Et eius delectus sed iure. incident_updates: - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. outage_type: Incident start_at: Est ab a nisi et voluptatem commodi. status: Enim exercitationem. title: Exercitationem quo amet et. - description: Ut in. duration: 7113594325144523084 end_at: Omnis asperiores ad officiis quos. id: Et eius delectus sed iure. incident_updates: - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. outage_type: Incident start_at: Est ab a nisi et voluptatem commodi. status: Enim exercitationem. title: Exercitationem quo amet et. "400": description: 'institution_status_details_not_found: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /status/institutions/{institution_id}/incidents: post: tags: - institution-status summary: Create incident for institution front-door description: Creates an Incident for a provided institution. operationId: front-door#Create incident for institution parameters: - name: institution_id in: path description: Unique identifier of the institution affected by the incident. required: true schema: type: string description: Unique identifier of the institution affected by the incident. example: Hic sint qui. example: Dignissimos quia. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateIncidentForInstitutionRequestBody' example: description: At amet sit hic sapiente minima facere. end_at: Dolore esse. start_at: Numquam voluptatem enim et a velit. title: Nulla quae accusantium temporibus odit alias. responses: "201": description: Created response. "404": description: 'institution_not_found: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /status/institutions/{institution_id}/incidents/historical: get: tags: - institution-status summary: Fetch historical institution incidents front-door description: Fetches completed scheduled outages and manual incidents for an institution, ordered by most recently ended first. operationId: front-door#Fetch historical institution incidents parameters: - name: institution_id in: path description: Unique identifier of the institution. required: true schema: type: string description: Unique identifier of the institution. example: "22" example: "22" - name: from in: query description: Optional RFC3339 timestamp. Only incident windows ending at or after this time are returned. allowEmptyValue: true schema: type: string description: Optional RFC3339 timestamp. Only incident windows ending at or after this time are returned. example: "2025-05-01T00:00:00Z" example: "2025-05-01T00:00:00Z" - name: to in: query description: Optional RFC3339 timestamp. Only incident windows starting at or before this time are returned. allowEmptyValue: true schema: type: string description: Optional RFC3339 timestamp. Only incident windows starting at or before this time are returned. example: "2025-05-31T23:59:59Z" example: "2025-05-31T23:59:59Z" responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Historicalinstitutionincident' example: - end_at: "2025-05-01T15:00:00Z" source: incident start_at: "2025-05-01T14:00:00Z" title: Scheduled maintenance - end_at: "2025-05-01T15:00:00Z" source: incident start_at: "2025-05-01T14:00:00Z" title: Scheduled maintenance - end_at: "2025-05-01T15:00:00Z" source: incident start_at: "2025-05-01T14:00:00Z" title: Scheduled maintenance - end_at: "2025-05-01T15:00:00Z" source: incident start_at: "2025-05-01T14:00:00Z" title: Scheduled maintenance example: - end_at: "2025-05-01T15:00:00Z" source: incident start_at: "2025-05-01T14:00:00Z" title: Scheduled maintenance - end_at: "2025-05-01T15:00:00Z" source: incident start_at: "2025-05-01T14:00:00Z" title: Scheduled maintenance - end_at: "2025-05-01T15:00:00Z" source: incident start_at: "2025-05-01T14:00:00Z" title: Scheduled maintenance - end_at: "2025-05-01T15:00:00Z" source: incident start_at: "2025-05-01T14:00:00Z" title: Scheduled maintenance "400": description: 'bad_request: Invalid time range parameters' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "404": description: 'institution_not_found: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /status/institutions/{institution_id}/incidents/updates: post: tags: - institution-status summary: Create incident update for institution front-door description: Creates an update (or provides new update) for an ongoing institution incident. operationId: front-door#Create incident update for institution parameters: - name: institution_id in: path description: Unique identifier of the institution affected by the incident. required: true schema: type: string description: Unique identifier of the institution affected by the incident. example: Et aperiam esse quo. example: Nam illo. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateIncidentUpdateForInstitutionRequestBody' example: description: Rem sit doloremque. status: Resolved responses: "201": description: Created response. "404": description: 'invalid_incident_update: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /status/institutions/subscription: post: tags: - institution-status summary: Subscribe to institution status updates front-door description: Subscribes a user's email address for institution status updates. operationId: front-door#Subscribe to institution status updates requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SubscribeToInstitutionStatusUpdatesRequestBody' example: email_address: Debitis repudiandae dolorum. responses: "201": description: Created response. "400": description: 'bad_request: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "500": description: 'internal_error: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /status/institutions/subscription/verification: get: tags: - institution-status summary: Handle subscription verification callback front-door description: Handles the institution status verification code callback GET request from the initial email. operationId: front-door#Handle subscription verification callback parameters: - name: email_address in: query description: Email address of the user subscribing to institution status updates. allowEmptyValue: true required: true schema: type: string description: Email address of the user subscribing to institution status updates. example: Pariatur expedita. example: Molestias cum culpa consequuntur. - name: verification_code in: query description: Verification code which has been pasEmail address of the user to subscribe to institution status updates. allowEmptyValue: true required: true schema: type: string description: Verification code which has been pasEmail address of the user to subscribe to institution status updates. example: Ut reiciendis dicta. example: Quo corrupti ut. responses: "303": description: See Other response. headers: Location: description: Target URL for redirection after completing institution status email activities schema: type: string description: Target URL for redirection after completing institution status email activities example: Ut et est harum quo. example: Minus quia optio voluptate accusamus. "500": description: 'internal_error: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /status/institutions/unsubscription/verification: get: tags: - institution-status summary: Handle unsubscription from institution status updates front-door description: Handles the process of unsubscribing a user's email from receiving institution status updates from incidents. operationId: front-door#Handle unsubscription from institution status updates parameters: - name: email_address in: query description: Email address to unsubscribe from institution status updates. allowEmptyValue: true required: true schema: type: string description: Email address to unsubscribe from institution status updates. example: Quis delectus placeat. example: Reiciendis alias. - name: unsubscription_code in: query description: UUIDv4 string which verifies that the user receives the initial email from which they are unsubscribing. allowEmptyValue: true required: true schema: type: string description: UUIDv4 string which verifies that the user receives the initial email from which they are unsubscribing. example: Perspiciatis ratione qui molestiae. example: Quas voluptatibus ea incidunt nostrum sit quis. responses: "303": description: See Other response. headers: Location: description: Target URL for redirection after completing institution status email activities schema: type: string description: Target URL for redirection after completing institution status email activities example: Voluptas quidem ut voluptatem consequuntur omnis. example: Aperiam omnis quas iusto. "500": description: 'internal_error: Internal Server Error response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /swagger.yaml: get: tags: - docs summary: Download ./gen/http/openapi3.yaml operationId: front-door#/swagger.yaml responses: "200": description: File downloaded /team/{id}/end-users: get: tags: - team-end-users summary: Get team end users front-door description: Get team end users operationId: front-door#Get team end users parameters: - name: query in: query description: Email address or end user ID to filter end users by allowEmptyValue: true schema: type: string description: Email address or end user ID to filter end users by example: john_starmer@gmail.com example: john_starmer@gmail.com - name: page in: query description: The page number to fetch allowEmptyValue: true schema: type: integer description: The page number to fetch default: 1 example: 1 format: int64 example: 1 - name: page_size in: query description: The number of items per page allowEmptyValue: true schema: type: integer description: The number of items per page default: 25 example: 25 format: int64 example: 25 - name: id in: path description: Team id required: true schema: type: string description: Team id example: Ea et. example: Corrupti soluta. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Paginatedendusers' example: end_users: - auth_session_counts: active: 3389301260341144675 inactive: 3149020480602711017 consent_counts: active: 3389301260341144675 inactive: 3149020480602711017 email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" - auth_session_counts: active: 3389301260341144675 inactive: 3149020480602711017 consent_counts: active: 3389301260341144675 inactive: 3149020480602711017 email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" page: 3201353609029485232 page_size: 947293243321321099 total: 4606731749761630642 "400": description: 'pagination_error: Invalid pagination parameters' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] post: tags: - end-users summary: Create end user in console front-door description: Create end user in console operationId: front-door#Create end user in console parameters: - name: id in: path description: Team id required: true schema: type: string description: Team id example: Ea accusamus vero non ipsam reprehenderit. example: Et odio. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateEndUserInConsoleRequestBody' example: abn: Ex id sit porro quia. email: Magni labore deserunt ea quis. name: Laudantium omnis distinctio laudantium laborum enim. phone: Non voluptatum magnam officiis ut. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Createenduser' example: end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB "400": description: 'end_user_already_exists: user with that email already exists' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /team/{id}/end-users/{end_user_id}/authsessions: get: tags: - auth summary: Get auth session for end user in console front-door description: Get auth session for end user in console operationId: front-door#Get auth session for end user in console parameters: - name: id in: path description: Team ID required: true schema: type: string description: Team ID example: Perspiciatis quia atque est. example: Voluptatem odio. - name: end_user_id in: path description: End user id required: true schema: type: string description: End user id example: Ipsam autem quisquam beatae sed molestiae. example: Accusantium dolores rerum iure dolorem sed. responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Fiskilauthsession' example: - arrangement_id: 94549a73-a554-4b76-b824-d96898829751 arrangement_id_expiration_date: "2022-02-18T01:57:59Z" auth_url: auth.fiskil.com?session_id=ea564d-56012s4-6ds4564 cancel_uri: https://acme.com/cancel client_id: 5qcql2s0bn9qfh1m5qd1sl4gth created_at: "2022-02-18T01:57:59Z" end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB events: - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED expires_at: "2022-02-18T01:57:59Z" institution_id: "10" is_terminal: true missing_abn: true missing_email: true redirect_uri: https://acme.com/success session_id: ea564d-56012s4-6ds4564 - arrangement_id: 94549a73-a554-4b76-b824-d96898829751 arrangement_id_expiration_date: "2022-02-18T01:57:59Z" auth_url: auth.fiskil.com?session_id=ea564d-56012s4-6ds4564 cancel_uri: https://acme.com/cancel client_id: 5qcql2s0bn9qfh1m5qd1sl4gth created_at: "2022-02-18T01:57:59Z" end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB events: - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED expires_at: "2022-02-18T01:57:59Z" institution_id: "10" is_terminal: true missing_abn: true missing_email: true redirect_uri: https://acme.com/success session_id: ea564d-56012s4-6ds4564 example: - arrangement_id: 94549a73-a554-4b76-b824-d96898829751 arrangement_id_expiration_date: "2022-02-18T01:57:59Z" auth_url: auth.fiskil.com?session_id=ea564d-56012s4-6ds4564 cancel_uri: https://acme.com/cancel client_id: 5qcql2s0bn9qfh1m5qd1sl4gth created_at: "2022-02-18T01:57:59Z" end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB events: - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED expires_at: "2022-02-18T01:57:59Z" institution_id: "10" is_terminal: true missing_abn: true missing_email: true redirect_uri: https://acme.com/success session_id: ea564d-56012s4-6ds4564 - arrangement_id: 94549a73-a554-4b76-b824-d96898829751 arrangement_id_expiration_date: "2022-02-18T01:57:59Z" auth_url: auth.fiskil.com?session_id=ea564d-56012s4-6ds4564 cancel_uri: https://acme.com/cancel client_id: 5qcql2s0bn9qfh1m5qd1sl4gth created_at: "2022-02-18T01:57:59Z" end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB events: - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED expires_at: "2022-02-18T01:57:59Z" institution_id: "10" is_terminal: true missing_abn: true missing_email: true redirect_uri: https://acme.com/success session_id: ea564d-56012s4-6ds4564 - arrangement_id: 94549a73-a554-4b76-b824-d96898829751 arrangement_id_expiration_date: "2022-02-18T01:57:59Z" auth_url: auth.fiskil.com?session_id=ea564d-56012s4-6ds4564 cancel_uri: https://acme.com/cancel client_id: 5qcql2s0bn9qfh1m5qd1sl4gth created_at: "2022-02-18T01:57:59Z" end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB events: - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED expires_at: "2022-02-18T01:57:59Z" institution_id: "10" is_terminal: true missing_abn: true missing_email: true redirect_uri: https://acme.com/success session_id: ea564d-56012s4-6ds4564 - arrangement_id: 94549a73-a554-4b76-b824-d96898829751 arrangement_id_expiration_date: "2022-02-18T01:57:59Z" auth_url: auth.fiskil.com?session_id=ea564d-56012s4-6ds4564 cancel_uri: https://acme.com/cancel client_id: 5qcql2s0bn9qfh1m5qd1sl4gth created_at: "2022-02-18T01:57:59Z" end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB events: - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED expires_at: "2022-02-18T01:57:59Z" institution_id: "10" is_terminal: true missing_abn: true missing_email: true redirect_uri: https://acme.com/success session_id: ea564d-56012s4-6ds4564 security: - Token_header_Authorization: [] /team/{id}/end-users/{end_user_id}/consent: get: tags: - consent summary: Get consents for end user in console front-door description: Get consents for end user in console operationId: front-door#Get consents for end user in console parameters: - name: id in: path description: Team ID required: true schema: type: string description: Team ID example: Pariatur ut voluptatem quam ad qui. example: Facilis non dicta perferendis. - name: end_user_id in: path description: End user id required: true schema: type: string description: End user id example: Dolor quae fugit totam nemo eligendi. example: Quia consequatur nihil. responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Consent' example: - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked example: - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked - account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked security: - Token_header_Authorization: [] /team/{team_id}/auth/session/console: post: tags: - auth summary: Add auth session in console front-door description: Create an auth session in console operationId: front-door#Add auth session in console parameters: - name: team_id in: path description: Team id required: true schema: type: string description: Team id example: Tenetur magnam accusamus itaque sapiente enim. example: Consequatur nihil eos. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddAuthSessionInConsoleRequestBody' example: cancel_uri: https://acme.com/cancel end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB institution_id: "10" redirect_uri: https://acme.com/success responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/AddAuthSessionInConsoleResponseBody' example: auth_url: auth-session.com/redirect-url expires_at: 1213467 id: 5qcql2s0bn9qfh1m5qd1sl4gth session_id: ea564d-56012s4-6ds4564 "400": description: 'invalid_institution_id: Bad Request response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /team/{team_id}/auth/session/console/send: post: tags: - auth summary: Email auth session link in console front-door description: Email auth session link in console operationId: front-door#Email auth session link in console parameters: - name: team_id in: path description: The Team ID required: true schema: type: string description: The Team ID example: 22325VgWkf6GkW2149t633Bucup example: 22325VgWkf6GkW2149t633Bucup requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DenyAuthorisationRequest' example: end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB session_id: 22325VgWkf6GkW2149t633Bucup responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/CreateCustomAuthResponseBody' example: message: Necessitatibus consequatur libero rerum voluptatem ea fugit. "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "404": description: 'end_user_not_found: Not Found response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /team/{team_id}/end-users/{end_user_id}: get: tags: - end-users summary: Get end user by id in console front-door description: Finds an end user by end user id in console operationId: front-door#Get end user by id in console parameters: - name: team_id in: path description: Team id required: true schema: type: string description: Team id example: Eum commodi et quam. example: Minima nostrum eum dolor corporis. - name: end_user_id in: path description: End user id required: true schema: type: string description: End user id example: Qui molestiae consequatur architecto. example: Nesciunt nemo consequatur. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Enduser' example: email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "404": description: 'end_user_not_found: end user not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /team/{team_id}/end-users/bulk-delete: post: tags: - team-end-users summary: Bulk delete team end users front-door description: Delete multiple end users for a team operationId: front-door#Bulk delete team end users parameters: - name: team_id in: path description: The team id. required: true schema: type: string description: The team id. example: Nulla aperiam quia et aut hic. example: Magni sequi labore ut ab nulla blanditiis. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BulkDeleteTeamEndUsersRequestBody' example: end_user_ids: - Molestiae quasi aut non. - Vel numquam eum vero ut voluptas tenetur. - Sunt et. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Bulkdeleteendusersresult' example: deleted_count: 4604576612067160931 "400": description: 'bad_request: Invalid request parameters' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /team/{team_id}/notifications: get: tags: - notifications summary: List notifications front-door description: List webhook notifications for a team, paginated, with optional filters operationId: front-door#List notifications parameters: - name: webhook_id in: query description: Filter by webhook ID allowEmptyValue: true required: true schema: type: string description: Filter by webhook ID example: webhook-123 example: webhook-123 - name: status in: query description: Filter for unacknowledged notifications only allowEmptyValue: true schema: type: string description: Filter for unacknowledged notifications only default: all example: all enum: - all - success - failure example: failure - name: types in: query description: Filter by notification types, e.g., 'energy.invoices.sync.completed' allowEmptyValue: true schema: type: array items: type: string example: Totam laboriosam quia recusandae nostrum quibusdam. description: Filter by notification types, e.g., 'energy.invoices.sync.completed' example: - energy.balances.sync.completed - energy.invoices.sync.completed example: - energy.balances.sync.completed - energy.invoices.sync.completed - name: end_user_id in: query description: Filter by end user ID allowEmptyValue: true schema: type: string description: Filter by end user ID example: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB example: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB - name: cursor in: query description: Cursor for pagination allowEmptyValue: true schema: type: string description: Cursor for pagination default: "" example: cursor-123 example: cursor-123 - name: page_size in: query description: The number of items per page allowEmptyValue: true schema: type: integer description: The number of items per page default: 25 example: 25 format: int64 example: 25 - name: team_id in: path description: Team ID required: true schema: type: string description: Team ID example: Recusandae perspiciatis. example: Voluptas voluptas. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Paginatednotifications' example: cursor: Ab aspernatur exercitationem maxime et ut. notifications: - acknowledged: false arrangement_id: arrangement-456 delivery_attempt: 3 end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB error: Failed to send notification id: a9f8e3c7-d5a2-4db4-8c6e-734a1db0f9f4 request: '{"key": "value"}' response: '{"status": "success"}' sent_at: "2025-05-01T14:00:00Z" status: 200 team_id: team-123 type: energy.invoices.sync.completed webhook_id: webhook-123 - acknowledged: false arrangement_id: arrangement-456 delivery_attempt: 3 end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB error: Failed to send notification id: a9f8e3c7-d5a2-4db4-8c6e-734a1db0f9f4 request: '{"key": "value"}' response: '{"status": "success"}' sent_at: "2025-05-01T14:00:00Z" status: 200 team_id: team-123 type: energy.invoices.sync.completed webhook_id: webhook-123 - acknowledged: false arrangement_id: arrangement-456 delivery_attempt: 3 end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB error: Failed to send notification id: a9f8e3c7-d5a2-4db4-8c6e-734a1db0f9f4 request: '{"key": "value"}' response: '{"status": "success"}' sent_at: "2025-05-01T14:00:00Z" status: 200 team_id: team-123 type: energy.invoices.sync.completed webhook_id: webhook-123 - acknowledged: false arrangement_id: arrangement-456 delivery_attempt: 3 end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB error: Failed to send notification id: a9f8e3c7-d5a2-4db4-8c6e-734a1db0f9f4 request: '{"key": "value"}' response: '{"status": "success"}' sent_at: "2025-05-01T14:00:00Z" status: 200 team_id: team-123 type: energy.invoices.sync.completed webhook_id: webhook-123 page_size: 8723984059917204742 "400": description: 'invalid_event_type: Invalid event type' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /team/{team_id}/notifications/{notification_id}: get: tags: - notifications summary: Get notification by id front-door description: Get a single webhook notification by its ID operationId: front-door#Get notification by id parameters: - name: team_id in: path description: Team ID required: true schema: type: string description: Team ID example: Est ullam facilis voluptatem. example: Quia iure voluptas laboriosam asperiores. - name: notification_id in: path description: Notification ID required: true schema: type: string description: Notification ID example: Nulla soluta tempore et voluptatum numquam. example: Voluptatem autem similique enim ut iusto. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Notification' example: acknowledged: false arrangement_id: arrangement-456 delivery_attempt: 3 end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB error: Failed to send notification id: a9f8e3c7-d5a2-4db4-8c6e-734a1db0f9f4 request: '{"key": "value"}' response: '{"status": "success"}' sent_at: "2025-05-01T14:00:00Z" status: 200 team_id: team-123 type: energy.invoices.sync.completed webhook_id: webhook-123 "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' "404": description: 'not_found: Notification not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /team/{teamId}/end-users/{endUserId}: delete: tags: - team-end-users summary: Delete team end user front-door description: Delete team end user operationId: front-door#Delete team end user parameters: - name: teamId in: path description: The team id. required: true schema: type: string description: The team id. example: Nihil ut. example: Officiis quia rerum laboriosam corrupti. - name: endUserId in: path description: The end user id. required: true schema: type: string description: The end user id. example: Impedit aspernatur ut aut sed. example: Dignissimos asperiores voluptas unde et occaecati. responses: "204": description: No Content response. "404": description: 'end_user_not_found: End user not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /token: post: tags: - front-door summary: Create client access token front-door description: Creates a new access token operationId: front-door#Create client access token requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateClientAccessTokenRequestBody' example: client_id: Nihil itaque laborum. client_secret: Corporis aut et sit. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/CreateClientAccessTokenResponseBody' example: expires_in: 3415136825317430557 token: Est sunt odit non quam porro. "401": description: 'unauthorized: Unauthorized response.' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: [] /webhooks: get: tags: - webhooks summary: List webhooks front-door description: List webhooks associated with a team operationId: front-door#List webhooks responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Webhook' example: - description: Velit laudantium aliquid laborum perspiciatis et autem. endpoint_url: Quia perspiciatis ullam error et. events: - Occaecati velit odit aut suscipit. - Asperiores corporis possimus tempora quia eum et. - Architecto qui maxime dolores. - Iure ullam fuga molestiae aut nam iste. id: Recusandae id maiores molestiae. name: Corporis et ad fugiat. signing_secret: Maiores minus doloribus fugiat ut aut. team_id: Quisquam id. updated_at: Laboriosam consectetur velit qui et. - description: Velit laudantium aliquid laborum perspiciatis et autem. endpoint_url: Quia perspiciatis ullam error et. events: - Occaecati velit odit aut suscipit. - Asperiores corporis possimus tempora quia eum et. - Architecto qui maxime dolores. - Iure ullam fuga molestiae aut nam iste. id: Recusandae id maiores molestiae. name: Corporis et ad fugiat. signing_secret: Maiores minus doloribus fugiat ut aut. team_id: Quisquam id. updated_at: Laboriosam consectetur velit qui et. example: - description: Velit laudantium aliquid laborum perspiciatis et autem. endpoint_url: Quia perspiciatis ullam error et. events: - Occaecati velit odit aut suscipit. - Asperiores corporis possimus tempora quia eum et. - Architecto qui maxime dolores. - Iure ullam fuga molestiae aut nam iste. id: Recusandae id maiores molestiae. name: Corporis et ad fugiat. signing_secret: Maiores minus doloribus fugiat ut aut. team_id: Quisquam id. updated_at: Laboriosam consectetur velit qui et. - description: Velit laudantium aliquid laborum perspiciatis et autem. endpoint_url: Quia perspiciatis ullam error et. events: - Occaecati velit odit aut suscipit. - Asperiores corporis possimus tempora quia eum et. - Architecto qui maxime dolores. - Iure ullam fuga molestiae aut nam iste. id: Recusandae id maiores molestiae. name: Corporis et ad fugiat. signing_secret: Maiores minus doloribus fugiat ut aut. team_id: Quisquam id. updated_at: Laboriosam consectetur velit qui et. - description: Velit laudantium aliquid laborum perspiciatis et autem. endpoint_url: Quia perspiciatis ullam error et. events: - Occaecati velit odit aut suscipit. - Asperiores corporis possimus tempora quia eum et. - Architecto qui maxime dolores. - Iure ullam fuga molestiae aut nam iste. id: Recusandae id maiores molestiae. name: Corporis et ad fugiat. signing_secret: Maiores minus doloribus fugiat ut aut. team_id: Quisquam id. updated_at: Laboriosam consectetur velit qui et. security: - Token_header_Authorization: [] post: tags: - webhooks summary: Create webhook front-door description: Create a webook associated with an event for a team operationId: front-door#Create webhook requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateWebhookRequestBody' example: description: Dignissimos saepe non eos. endpoint_url: Reiciendis quidem. events: - Libero repellendus ullam tempore voluptatem. - Inventore in et sint voluptatibus et. - Ea quis facilis et. name: Et sit consequuntur beatae. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Webhook' example: description: Exercitationem facilis fugit totam. endpoint_url: Optio harum nihil sint nulla. events: - Pariatur quibusdam. - Ratione occaecati aperiam explicabo. - Quis ut assumenda odit tenetur suscipit non. id: Illo molestias. name: Assumenda atque est non facilis itaque voluptatum. signing_secret: Voluptatem voluptatem et dicta amet dolores. team_id: Ipsam facilis sequi vero et voluptatibus voluptas. updated_at: Nihil vero corrupti quas sit maiores necessitatibus. "400": description: 'invalid_event: Unrecognized event' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /webhooks/{id}: delete: tags: - webhooks summary: Delete webhook front-door description: Delete a webhook associated with an id operationId: front-door#Delete webhook parameters: - name: id in: path description: ID of the webhook required: true schema: type: string description: ID of the webhook example: Necessitatibus est dolorum tempora omnis. example: Possimus quibusdam veniam et. responses: "204": description: No Content response. "400": description: 'webhook_not_found: The webhook was not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] get: tags: - webhooks summary: Get webhook by id front-door description: Get a webhook associated with an id operationId: front-door#Get webhook by id parameters: - name: id in: path description: ID of the webhook required: true schema: type: string description: ID of the webhook example: Explicabo omnis distinctio. example: Eligendi aut laboriosam ipsum. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Webhook' example: description: Unde recusandae sunt omnis exercitationem. endpoint_url: Magni quibusdam sed est. events: - Totam ab. - Maiores quis vel voluptatem molestiae quia quos. id: Ex facilis nemo itaque iusto omnis. name: Aliquid omnis. signing_secret: Et id aut molestiae. team_id: Cupiditate harum est molestias. updated_at: Sit consequatur placeat. "404": description: 'webhook_not_found: Webhook not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] post: tags: - webhooks summary: Update webhook front-door description: Update a webook associated with an id operationId: front-door#Update webhook parameters: - name: id in: path description: ID of the webhook required: true schema: type: string description: ID of the webhook example: Beatae asperiores. example: Aperiam non doloremque doloribus. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateWebhookRequestBody' example: description: Nihil explicabo. endpoint_url: Iure asperiores corporis aut. name: Quidem facilis quibusdam optio distinctio deserunt. responses: "200": description: OK response. content: application/json: schema: $ref: '#/components/schemas/Webhook' example: description: Consequatur nesciunt facilis consequatur error iure. endpoint_url: Similique et aspernatur et. events: - Et et. - Vero ducimus. id: Architecto nihil consequatur est ut nihil incidunt. name: Est expedita aut possimus et culpa amet. signing_secret: Architecto officiis voluptates. team_id: Ratione corrupti impedit expedita fugiat modi. updated_at: Possimus architecto eum sit. "400": description: 'webhook_not_found: The webhook was not found' content: application/vnd.goa.error: schema: $ref: '#/components/schemas/Error' security: - Token_header_Authorization: [] /webhooks/events: get: tags: - webhooks summary: List available webhook events front-door description: List all available webhook events operationId: front-door#List available webhook events responses: "200": description: OK response. content: application/json: schema: type: array items: $ref: '#/components/schemas/EventGroup' example: - events: - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. name: At accusamus nemo. - events: - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. name: At accusamus nemo. - events: - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. name: At accusamus nemo. - events: - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. name: At accusamus nemo. example: - events: - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. name: At accusamus nemo. - events: - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. name: At accusamus nemo. - events: - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. name: At accusamus nemo. security: - Token_header_Authorization: [] components: schemas: AddAuthSessionInConsoleRequestBody: type: object properties: cancel_uri: type: string description: Your url to cancel an auth flow example: https://acme.com/cancel end_user_id: type: string description: The end_user that will be consenting with an external provider example: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB institution_id: type: string description: The institution id selected for the auth session example: "10" redirect_uri: type: string description: Where the end user will be redirected to on success example: https://acme.com/success example: cancel_uri: https://acme.com/cancel end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB institution_id: "10" redirect_uri: https://acme.com/success required: - end_user_id - redirect_uri - cancel_uri AddAuthSessionInConsoleResponseBody: type: object properties: auth_url: type: string description: The computed auth URL. example: auth-session.com/redirect-url expires_at: type: integer description: The computed auth URL expires at. example: 1213467 format: int64 id: type: string description: The client id. example: 5qcql2s0bn9qfh1m5qd1sl4gth session_id: type: string description: Session Id example: ea564d-56012s4-6ds4564 example: auth_url: auth-session.com/redirect-url expires_at: 1213467 id: 5qcql2s0bn9qfh1m5qd1sl4gth session_id: ea564d-56012s4-6ds4564 required: - id - session_id - expires_at - auth_url Authorise: type: object properties: location: type: string description: A link to the institutions site where the consent process and be continued example: Repellendus deleniti hic. session_id: type: string description: The session ID of the authorisation request example: Aut quidem. description: The information required to continue the authorisation process example: location: Velit fuga maxime quo beatae. session_id: Amet commodi aspernatur. required: - location - session_id AuthoriseRequest: type: object properties: auth_session_id: type: string description: The ID of the auth session example: Beatae dicta aliquam molestiae in adipisci. cancel_uri: type: string example: https://www.powerpal.net/ cdr_arrangement_id: type: string description: An existing CDR Arrangement ID to update example: Debitis voluptatem est repellendus. client_id: type: string description: Client ID example: Veritatis blanditiis. consent_period_string: type: string description: The consent period in string format example: 3 months enum: - 20 minutes - 1 day - 1 week - 1 month - 3 months - 6 months - 9 months - 12 months - Once-off end_user_id: type: string description: The end user ID. example: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB institution_id: type: string description: The institutions ID. example: "85" redirect_uri: type: string example: https://www.powerpal.net/cancel scope: type: array items: type: string example: Nihil est qui vero amet. description: The scopes to use example: - Culpa sequi. - Expedita cupiditate rerum est maxime ab. - Rerum et. - Iste exercitationem cumque autem accusantium vel. example: auth_session_id: Qui soluta blanditiis recusandae qui et. cancel_uri: https://www.powerpal.net/ cdr_arrangement_id: Dolorem quia ut magni suscipit. client_id: Tempora quis fuga perferendis est qui quae. consent_period_string: 3 months end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB institution_id: "85" redirect_uri: https://www.powerpal.net/cancel scope: - Veniam mollitia beatae ut. - Odit quia. required: - client_id - end_user_id - institution_id - consent_period_string AuthorizeCallbackTemporaryRedirectResponseBody: type: object properties: response_mode: type: string example: Tenetur facilis voluptatem similique reprehenderit doloribus. response_page: type: string example: Vitae earum aut sit doloribus perspiciatis impedit. example: response_mode: Officia reprehenderit aliquid nisi neque et. response_page: Commodi odio qui eaque saepe quod. required: - response_mode BulkDeleteTeamEndUsersRequestBody: type: object properties: end_user_ids: type: array items: type: string example: Error velit illum laboriosam. description: List of end user IDs to delete example: - Et quae cupiditate sunt et. - Dolores ratione et hic. minItems: 1 maxItems: 25 example: end_user_ids: - Exercitationem necessitatibus ut minima similique. required: - end_user_ids Bulkdeleteendusersresult: type: object properties: deleted_count: type: integer description: Number of end users successfully deleted example: 8456240693213848911 format: int64 example: deleted_count: 2331616657921044560 required: - deleted_count CDRError: type: object properties: clientId: type: string description: The id of the requesting client example: Inventore deleniti distinctio. endUserId: type: string description: The id of the requesting end user example: Dolorum eum nisi et ea possimus. institutionId: type: string description: The id of the requested institution example: Id ut ipsam dolore. req: type: string description: The http request (possibly with the body removed) example: Dicta voluptas aperiam mollitia magnam. reqBody: type: string description: The http request body example: Et illo totam. res: type: string description: The http response (possibly with the body removed) example: Non minus quidem aut voluptas nostrum. resBody: type: string description: The http response body example: Debitis ab in est libero. time: type: string description: The (approximate, +- 2s) time of the request example: Aspernatur dignissimos minus doloribus sequi. description: Information about an http request that failed example: clientId: Tempore ab aut sit consequatur ut. endUserId: Tempore sint nam. institutionId: Est non voluptatem quas. req: Quia et et ducimus excepturi neque. reqBody: Expedita maxime minima animi rerum at quod. res: Aut excepturi nisi accusantium. resBody: Dolorum quasi. time: Numquam ducimus tempora. required: - req - res - reqBody - resBody - time - clientId - endUserId - institutionId Certificate: type: object properties: brand_id: type: string description: The CDR brand ID example: 7a1a0eb6-1711-ec11-a83f-000d3a8842e1 brand_name: type: string description: The CDR brand name example: Fiskil name: type: string description: A human readable name for the certificate. Generally the CDR product name is a good choice. example: Genie product_id: type: string description: The CDR product ID example: 4b9f604f-fe02-ed11-a830-000d3a8830d6 redirect_uri: type: array items: type: string example: Sit tenetur. description: The CDR redirect uri for the product. example: - auth.fiskil.com/callback example: brand_id: 7a1a0eb6-1711-ec11-a83f-000d3a8842e1 brand_name: Fiskil name: Genie product_id: 4b9f604f-fe02-ed11-a830-000d3a8830d6 redirect_uri: - auth.fiskil.com/callback required: - name - product_id - brand_id - brand_name - redirect_uri ConnectionStatus: type: object properties: status: type: string description: Whether the connection (consent) flow with an institution is healthy example: DEGRADED enum: - HEALTHY - DEGRADED - OUTAGE example: status: HEALTHY required: - status Consent: type: object properties: account_ids: type: array items: type: string example: Modi voluptas est quas veniam. description: List of IDs of accounts that were authorised for this consent. The details of the accounts can be looked up using the Accounts API for the appropriate industry. example: - "1234567890" - "1234567891" active: type: boolean description: Indicates whether consent is active or not example: true app_logo: type: string description: URL to a logo of your application example: https://acme.com/app-logo.png app_name: type: string description: Your application name example: MyCoolApp arrangement_id: type: string description: CDR arrangement ID provided by DH. example: 94549a73-a554-4b76-b824-d96898829751 created_at: type: string description: When the Consent was created example: "2021-03-18T02:46:42Z" duration: type: integer description: The time period access was granted. Its in seconds example: 7776000 format: int64 end_user_email: type: string description: End users email example: tony.stark@example.com end_user_id: type: string description: ID of the end user that authorised the consent example: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: type: string description: RFC3339 date-time that the consent expires (or already expired) at example: "2023-01-01T10:42:40Z" institution_id: type: string description: The identifier for the institution the Consent is held with. example: "11" institution_logo: type: string description: Institution logo example: https://example.com/images/gringotts-logo.png institution_name: type: string description: Institution name example: Gringgotts institution_type: type: string description: Institution Type example: banking last_accessed: type: string description: The last time the ADR, or Fiskil used the consent to access data. example: "2023-01-02T10:42:42Z" last_consent: type: string description: The last time the Consent was acknowledged by the End User. example: "2023-01-01T10:42:40Z" permissions: type: array items: type: string example: Et ea. description: A list of the data permissions granted. example: - accounts - balances - transactions termination_reason: type: string description: Reason for consent termination example: Expired or Revoked example: account_ids: - "1234567890" - "1234567891" active: true app_logo: https://acme.com/app-logo.png app_name: MyCoolApp arrangement_id: 94549a73-a554-4b76-b824-d96898829751 created_at: "2021-03-18T02:46:42Z" duration: 7776000 end_user_email: tony.stark@example.com end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB expires_at: "2023-01-01T10:42:40Z" institution_id: "11" institution_logo: https://example.com/images/gringotts-logo.png institution_name: Gringgotts institution_type: banking last_accessed: "2023-01-02T10:42:42Z" last_consent: "2023-01-01T10:42:40Z" permissions: - accounts - balances - transactions termination_reason: Expired or Revoked required: - arrangement_id - end_user_email - end_user_id - institution_id - institution_name - institution_logo - permissions - duration - last_accessed - last_consent - expires_at - active - created_at - app_name - app_logo - institution_type - termination_reason - account_ids Counts: type: object properties: active: type: integer description: Number of active records example: 2368674039895948429 format: int64 inactive: type: integer description: Number of inactive records example: 1725560023296477854 format: int64 example: active: 8722058858394838730 inactive: 4115434800899438900 required: - active - inactive CreateACDRCertificateRequestBody: type: object properties: brand_id: type: string description: The CDR brand ID example: 7a1a0eb6-1711-ec11-a83f-000d3a8842e1 brand_name: type: string description: The CDR brand name example: Fiskil mtls_cert: type: string description: The mTLS certificate for http authentication example: Nostrum cum tempore tempore. mtls_key: type: string description: The mTLS private key for http authentication example: Quibusdam maiores consequatur explicabo ipsum sit. name: type: string description: A human readable name for the certificate. Generally the CDR product name is a good choice. example: Genie product_id: type: string description: The CDR product ID example: 4b9f604f-fe02-ed11-a830-000d3a8830d6 redirect_uris: type: array items: type: string example: Non non incidunt qui. description: The CDR redirect uri for the product. example: - auth.fiskil.com/callback example: brand_id: 7a1a0eb6-1711-ec11-a83f-000d3a8842e1 brand_name: Fiskil mtls_cert: Odio in soluta. mtls_key: Voluptatem eos laborum. name: Genie product_id: 4b9f604f-fe02-ed11-a830-000d3a8830d6 redirect_uris: - auth.fiskil.com/callback required: - name - product_id - brand_id - brand_name - redirect_uris CreateACustomerOnboardingRequestBody: type: object properties: customer_connection_commercial: type: boolean example: true customer_connection_news: type: boolean example: false customer_industry: type: string example: Totam non culpa est impedit et. customer_intention: type: string example: Quae at facere. customer_interests: type: array items: type: string example: Alias vitae. example: - Quae asperiores saepe illum ea a nihil. - Repellendus est. customer_service: type: string example: Est aspernatur et et. customer_service_providing: type: string example: Inventore et sint sunt error enim. customer_users_scale: type: string example: Enim ea sed sunt incidunt tempore sit. example: customer_connection_commercial: true customer_connection_news: true customer_industry: Dolores quae atque facilis eos. customer_intention: Rem omnis voluptatum illo praesentium. customer_interests: - Error et neque ea ea et. - Quia doloribus et in. customer_service: Possimus incidunt voluptatem maiores adipisci praesentium. customer_service_providing: Voluptates vel atque. customer_users_scale: Quia sit culpa sapiente. required: - customer_service - customer_intention CreateACustomerOnboardingResponseBody: type: object properties: id: type: string description: The client id. example: Praesentium ad voluptas accusantium repellat. example: id: Quis vero quibusdam eos ab ut. required: - id CreateAuthSessionRequestBody: type: object properties: arrangement_id: type: string description: Existing CDR arrangement ID to amend/update example: 94549a73-a554-4b76-b824-d96898829751 cancel_uri: type: string description: Where the end user will be redirected on cancellation or failure. Required for redirect flows. example: https://acme.com/cancel end_user_id: type: string description: The end_user that will be consenting with an external provider example: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB institution_id: type: string description: The institution id selected for the auth session. The user will not be able to select another institution during the consent flow. example: "10" redirect_uri: type: string description: Where the end user will be redirected to on success. Required for redirect flow. example: https://acme.com/success example: arrangement_id: 94549a73-a554-4b76-b824-d96898829751 cancel_uri: https://acme.com/cancel end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB institution_id: "10" redirect_uri: https://acme.com/success required: - end_user_id CreateClientAccessTokenRequestBody: type: object properties: client_id: type: string example: Qui atque mollitia quae. client_secret: type: string example: Sed in accusantium voluptas. example: client_id: A maxime ipsam sed adipisci. client_secret: Voluptas officia placeat magnam. required: - client_id - client_secret CreateClientAccessTokenResponseBody: type: object properties: expires_in: type: integer example: 5545451286224651500 format: int64 token: type: string example: Beatae quia et. example: expires_in: 1349020989310001101 token: Nisi molestiae. required: - token - expires_in CreateCustomAuthRequestBody: type: object properties: additional_use_cases: type: array items: type: string example: Est dolores ex. example: - Adipisci et voluptatum accusamus. - Rerum debitis optio id qui aut necessitatibus. - Incidunt qui dolores nostrum. - Omnis quas vero corrupti. app_name: type: string example: Ea ratione voluptatem velit sed alias. button_border_radius: type: integer example: 8159546421761315521 format: int64 button_color: type: string example: Est veritatis doloremque iure sapiente. button_text_color: type: string example: Veniam voluptatem. consent_period: type: integer example: 783196851459586940 format: int64 consent_period_string: type: string example: 6 months enum: - 20 minutes - 1 day - 1 week - 1 month - 3 months - 6 months - 9 months - 12 months - Once-off consumer_type: type: string example: Quam voluptatum exercitationem. customer_authorization: type: string example: Impedit quas cum ipsum illum et tempora. data_minimisation: type: string example: Aut dicta quas sequi. history_fetch_period_in_month: type: integer example: 1621431883078600053 format: int64 industry: type: string example: Voluptatem facere nemo. main_primary: type: string example: Itaque numquam id architecto voluptas. main_secondary: type: string example: Aut veritatis architecto. notification_email: type: string example: Et quos. policy_uri: type: string example: Ea doloribus aperiam doloribus. providers: type: string example: Recusandae nam necessitatibus pariatur. scope: type: array items: type: string example: Distinctio eum tempora et adipisci et quis. example: - Nihil aliquid enim aliquam doloribus voluptas. - Et consequatur qui consectetur quis molestiae pariatur. service_usage_disclosure: type: string example: Quidem et aut quasi nihil maxime. show_cdr_footer: type: boolean example: true supporting_parties: type: array items: type: string example: Debitis numquam rerum nihil et. example: - Quis sint quia corrupti dolor debitis in. - Temporibus ut quasi incidunt. - Quam qui modi omnis. use_cases: type: array items: type: string example: Maxime et ut cumque aliquid. example: - Temporibus modi repellat exercitationem optio reprehenderit sunt. - Et atque tempora temporibus repudiandae quibusdam. withdraw_consent: type: string example: Temporibus tenetur quidem rerum nihil nostrum consequuntur. example: additional_use_cases: - Vel eligendi nesciunt maxime non. - Quaerat totam explicabo et ea odio. - Tenetur et ad aspernatur minima. - Minima qui temporibus. app_name: Tempore sed error a nihil omnis. button_border_radius: 5453742835732984939 button_color: Sed nesciunt ut enim dicta et et. button_text_color: Rerum eum consequatur et a ut accusamus. consent_period: 7582080914986341917 consent_period_string: 6 months consumer_type: Molestiae provident labore mollitia sunt id esse. customer_authorization: Aut aut id molestiae. data_minimisation: Placeat nihil aliquam quidem. history_fetch_period_in_month: 242405794267235427 industry: Minima est libero consequuntur. main_primary: Iure rerum nemo ipsum et cum officiis. main_secondary: Non excepturi quia voluptatem et officia qui. notification_email: Dicta temporibus sunt nam. policy_uri: Dolores nostrum. providers: Perspiciatis est molestiae labore voluptatem. scope: - Eum fuga. - Autem et explicabo labore adipisci. - Eius et autem autem ipsum. - Voluptatem distinctio architecto nobis eos. service_usage_disclosure: Quis et quia quisquam. show_cdr_footer: false supporting_parties: - Sed voluptates nam expedita itaque. - Debitis sint quibusdam accusantium excepturi explicabo. use_cases: - Soluta voluptatum quod voluptas. - Dicta natus aut animi atque. - Praesentium blanditiis molestias. withdraw_consent: Numquam harum reprehenderit corrupti labore fugit. required: - app_name - scope - industry CreateCustomAuthResponseBody: type: object properties: message: type: string example: Et velit dolores accusantium. example: message: Dolores dolores recusandae velit. required: - message CreateEndUserInConsoleRequestBody: type: object properties: abn: type: string description: Australian Business Number (ABN) of the end user example: Sequi molestiae. email: type: string description: An End Users email address. This should be their primary email, as it is used for notifying the End User about their consents. example: Sed sed aut. name: type: string description: Name of end user example: Deserunt qui minus. phone: type: string description: An End Users Phone example: Iure nisi et dolorum laudantium architecto. example: abn: Ut quis inventore et. email: Sunt et impedit neque. name: Laudantium ipsum dignissimos necessitatibus. phone: Ut aperiam voluptatem facilis pariatur. CreateEndUserRequestBody: type: object properties: abn: type: string description: Australian Business Number (ABN) of the end user if they represent a business example: 51 824 753 556 email: type: string description: An End Users email address. This should be their primary email, as it is used for notifying the End User about their consents. example: john_starmer@gmail.com name: type: string description: Name of the end user example: John Starmer phone: type: string description: An End Users Phone number in E.164 format example: "+614123456789" example: abn: 51 824 753 556 email: john_starmer@gmail.com name: John Starmer phone: "+614123456789" CreateIncidentForInstitutionRequestBody: type: object properties: description: type: string description: Description of the incident. example: Aliquid quia. end_at: type: string description: Timestamp at which the incident has concluded (can be historical or forward-looking) in RFC3339 format. example: Dolorem veritatis occaecati eligendi ut voluptates. start_at: type: string description: Start time of the incident (can be historical or forward-looking) in RFC3339 format. example: Dicta aspernatur in aperiam unde. title: type: string description: Title of the incident example: Facere est odit iure non similique facilis. example: description: Eos corporis. end_at: Temporibus quia occaecati dolor suscipit sed non. start_at: Libero praesentium provident quia expedita. title: Nemo atque quis nihil velit unde. required: - description - title CreateIncidentUpdateForInstitutionRequestBody: type: object properties: description: type: string description: Description of the update. example: Non accusamus ex sunt. status: type: string example: Identified enum: - Identified - Investigating - Resolved example: description: Velit commodi soluta consectetur et sint dolorem. status: Investigating required: - description - status CreateInstitutionsRequestBody: type: object properties: brand_id: type: string example: 578efc60-4eb1-eb11-a822-000d3a884a20 icon_url: type: string example: banking_Bank Australia_icon_1656329405.png id: type: string example: "85" industry: type: string example: banking logo_url: type: string example: https://www.bankaust.com.au/globalassets/assets/imagery/logos/bank-australia/ba_horizontal_logo.png name: type: string example: Bank Australia priority: type: integer example: 50 format: int64 resource_url: type: string example: https://resource.cdr-api.bankaust.com.au wkc_url: type: string example: https://identity-mtls.cdr-api.bankaust.com.au/.well-known/openid-configuration example: brand_id: 578efc60-4eb1-eb11-a822-000d3a884a20 icon_url: banking_Bank Australia_icon_1656329405.png id: "85" industry: banking logo_url: https://www.bankaust.com.au/globalassets/assets/imagery/logos/bank-australia/ba_horizontal_logo.png name: Bank Australia priority: 50 resource_url: https://resource.cdr-api.bankaust.com.au wkc_url: https://identity-mtls.cdr-api.bankaust.com.au/.well-known/openid-configuration required: - id - wkc_url - name - resource_url - logo_url - icon_url - brand_id - industry - priority CreateWebhookRequestBody: type: object properties: description: type: string description: Description for the webhook example: Et voluptatem cupiditate dolorem reprehenderit molestiae et. endpoint_url: type: string description: URL that the webhook will be sent to example: Ut sunt ipsum eligendi. events: type: array items: type: string example: Non sint eos rem quisquam. description: Events that the webhook will be subscribed to example: - Commodi velit enim. - Quia perspiciatis voluptatibus ad placeat. name: type: string description: Name for the webhook example: Est nihil. example: description: Quae mollitia qui minima quod laudantium perferendis. endpoint_url: Quis rerum ea nemo. events: - Atque unde ab. - Vitae vero minima. name: Fuga officiis aspernatur aperiam porro molestias voluptatem. required: - name - description - events - endpoint_url Createenduser: type: object properties: end_user_id: type: string description: A unique identifier for the End User object. example: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB example: end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB required: - end_user_id CustomInstitution: type: object properties: id: type: string description: The institution ID example: Eligendi autem sed. name: type: string description: The institution Name example: Unde et qui. example: id: Accusamus voluptate voluptatem sint praesentium. name: Sit beatae et maiores quaerat. required: - id - name Customauth: type: object properties: access_level: type: string example: Aliquam aut vel. additional_use_cases: type: array items: type: string example: Facilis repellat recusandae sed illo sed aliquam. example: - Vel et. - Eos consequatur id eligendi. - Ad ut dolores aut voluptates occaecati. app_name: type: string example: Quia sint aut. button_border_radius: type: integer example: 2131209838953992953 format: int64 button_color: type: string example: Sit itaque quod laudantium. button_text_color: type: string example: Ea doloribus similique similique et. client_id: type: string example: Sapiente et beatae dolorem consequuntur eum natus. client_type: type: string example: Voluptatibus fugit in eligendi qui saepe aspernatur. consent_period: type: integer example: 6569534747016118399 format: int64 consent_period_string: type: string example: Provident consequuntur quibusdam. consumer_type: type: string example: Voluptas et. created_at: type: string example: Vitae et iure. customer_authorization: type: string example: Tempore ipsa qui voluptas et quibusdam facere. data_minimisation: type: string example: Est dignissimos incidunt rerum explicabo natus. end_user: $ref: '#/components/schemas/Enduserdetails' history_fetch_period_in_month: type: integer example: 5671231115168058164 format: int64 industry: type: string example: Veritatis quia omnis sint suscipit. institution_mode: type: string example: Modi excepturi corporis et omnis et. logo: type: string example: Voluptatem quasi. main_primary: type: string example: Tempore eos et possimus. main_secondary: type: string example: Optio dolore voluptatem est eos ex corrupti. notification_email: type: string example: Quod est illo voluptas. policy_uri: type: string example: Hic similique itaque. providers: type: string example: Ipsum suscipit. sandbox_enabled: type: boolean example: true scope: type: array items: type: string example: Suscipit magni optio cumque pariatur est inventore. example: - Quo porro tenetur eligendi. - Eos vel labore aliquam odit aut dicta. service_usage_disclosure: type: string example: Vel impedit eos dolorem eius. show_cdr_footer: type: boolean example: false supporting_parties: type: array items: type: string example: Quisquam numquam vero quae. example: - Modi aut recusandae. - Animi itaque aut est ea aut. - Non nostrum non et repudiandae illo. - Voluptate explicabo est dolor nihil ratione. updated_at: type: string example: Velit ut explicabo harum. use_cases: type: array items: type: string example: Voluptate impedit saepe velit possimus. example: - Velit ducimus pariatur unde eius consequatur nulla. - Est autem itaque voluptas iure. - Nihil recusandae sunt rerum. withdraw_consent: type: string example: Provident enim nisi recusandae cupiditate neque. example: access_level: Quisquam aperiam earum. additional_use_cases: - Quia aut exercitationem nesciunt eveniet magni consequuntur. - Veritatis voluptatibus dolorem consequatur est. - Occaecati eos a voluptas molestiae dignissimos et. app_name: Mollitia voluptatem ipsa. button_border_radius: 1933816453473703750 button_color: Aut et. button_text_color: Eius aliquid quo. client_id: Neque voluptatem. client_type: Veritatis vel omnis ratione quia aut. consent_period: 3193377421892172123 consent_period_string: Placeat corporis debitis dolores magnam molestias. consumer_type: Provident recusandae. created_at: Quaerat qui. customer_authorization: Cumque adipisci. data_minimisation: Est aut. end_user: abn: Est nihil et facilis. business_name: Aliquid sapiente consequuntur qui a necessitatibus nisi. history_fetch_period_in_month: 7724289426598284505 industry: Animi eligendi neque ut sed. institution_mode: Voluptatibus sit molestias. logo: Eligendi neque ut tenetur beatae quis facilis. main_primary: Ullam autem aut aperiam et tenetur. main_secondary: Sunt eum accusantium quo autem. notification_email: Et magnam minima tempore. policy_uri: Illum ut aut quas ut in odio. providers: Aut hic ea impedit. sandbox_enabled: false scope: - Sed enim qui itaque id. - Libero voluptatem. - Ipsam explicabo sint quo quibusdam. - Molestiae ut a omnis cupiditate quasi. service_usage_disclosure: Incidunt qui reprehenderit quasi non aliquid. show_cdr_footer: true supporting_parties: - Recusandae ea qui quae placeat ut rem. - Dolorem voluptas quibusdam vel quia. - Accusantium velit. updated_at: Rerum maxime exercitationem dolorem atque. use_cases: - Atque aut. - Sit ut et facilis autem. - Porro et quod et maiores quisquam aut. withdraw_consent: Recusandae beatae. required: - client_id - client_type - app_name - industry - scope - created_at - updated_at Dataholder: type: object properties: brand_id: type: string example: Quia eos reiciendis. brand_name: type: string example: Ut laudantium harum sint dolorem numquam temporibus. endpoint_details: type: object example: Nisi ex id.: Ea rerum ea eum consequatur. Omnis ea fugiat nesciunt placeat quaerat.: Magnam incidunt nostrum veniam. Unde reprehenderit.: Voluptatum recusandae quidem ab itaque a. additionalProperties: type: string example: Velit dolor id. logo_uri: type: string example: Velit cumque et. example: brand_id: Nihil eaque eveniet. brand_name: Beatae amet. endpoint_details: Fugiat deleniti vitae impedit impedit occaecati.: Adipisci at adipisci. In totam nisi sunt.: Commodi illum est eum. logo_uri: Neque magni nihil ut. required: - brand_id - brand_name - endpoint_details - logo_uri Dcrentry: type: object properties: brand_id: type: string example: Autem rerum beatae ea consequatur voluptatum. brand_name: type: string example: Rerum dolor magni sunt eum ut. institution_brand_id: type: string example: Et laborum enim minima libero sunt necessitatibus. institution_client_id: type: string example: Non sint ut consectetur qui numquam aut. institution_icon_url: type: string example: Impedit occaecati nisi. institution_id: type: string example: Debitis ipsam similique. institution_industry: type: string example: Porro dolores repudiandae dignissimos est et. institution_logo_url: type: string example: Harum omnis inventore optio. institution_name: type: string example: Quia sunt laborum sed iure. product_id: type: string example: Commodi vero dolorem voluptatum voluptas sit. product_name: type: string example: Quam eos. redirect_uris: type: array items: type: string example: Nemo dignissimos et iure sit sunt. example: - Magni impedit quibusdam voluptatum cumque sit numquam. - Est earum minus. - Enim reprehenderit. - Explicabo nesciunt tenetur eum voluptates. example: brand_id: Maxime modi ducimus quibusdam voluptatem. brand_name: Et animi sunt et sed. institution_brand_id: Et id non earum tempora. institution_client_id: Eaque quo sed aut aut. institution_icon_url: Magni explicabo adipisci illo necessitatibus. institution_id: Repellendus rerum voluptatibus modi. institution_industry: Ipsam aut. institution_logo_url: Ea laboriosam quae ut incidunt voluptas. institution_name: Beatae voluptates aut qui. product_id: Rerum ut nisi voluptas. product_name: Sequi maxime ex quo. redirect_uris: - Sit soluta dolorum. - Hic eaque asperiores iure neque. - Amet ut omnis eum incidunt quas odit. required: - institution_id - institution_logo_url - institution_icon_url - institution_name - institution_brand_id - institution_industry - product_id - product_name - brand_id - brand_name - redirect_uris - institution_client_id Dcrregistration: type: object properties: application_type: type: string example: Impedit nesciunt. authorization_signed_response_alg: type: string example: Amet et est. client_description: type: string example: Aut veniam corporis exercitationem rerum doloremque expedita. client_id: type: string example: Error aut soluta magni eligendi rem. client_id_issued_at: type: integer example: 2391889061367105057 format: int64 client_name: type: string example: Omnis itaque provident est consequuntur. client_uri: type: string example: Assumenda corporis aut. grant_types: type: array items: type: string example: Id ratione beatae molestias. example: - Natus quia explicabo sit similique repellendus nesciunt. - Sit sit delectus aut. - Vel deleniti doloremque itaque inventore cum totam. id_token_signed_response_alg: type: string example: Ipsam sit dolores et laudantium voluptas. jwks_uri: type: string example: Corrupti quisquam ut qui vitae laudantium. legal_entity_id: type: string example: Cumque possimus totam voluptatem animi. legal_entity_name: type: string example: Quod officia ut aut. logo_uri: type: string example: Saepe magnam. org_id: type: string example: Earum officia. org_name: type: string example: Enim expedita autem ipsam magni rem natus. recipient_base_uri: type: string example: Magni ullam. redirect_uris: type: array items: type: string example: Maxime consequatur vel hic rem qui laborum. example: - Perspiciatis temporibus. - Sunt ad velit ut doloremque. - Dicta quos autem rerum saepe. request_object_signing_alg: type: string example: Aperiam ad excepturi. require_pushed_authorization_requests: type: string example: Sit unde aut quo accusamus ut. response_types: type: array items: type: string example: Sapiente eos placeat atque dolorem eum molestiae. example: - Occaecati et. - Dolores repellat aut. - Libero et. - Quod aut vel voluptate fuga alias fugit. revocation_uri: type: string example: Iusto tempora fuga molestias ad sunt. scope: type: string example: Autem omnis ad ratione atque. software_id: type: string example: Facere nisi ex. software_roles: type: string example: Aut praesentium asperiores qui voluptatem eius facere. software_statement: type: string example: Quo cupiditate amet molestias. token_endpoint_auth_method: type: string example: Cupiditate architecto delectus. token_endpoint_auth_signing_alg: type: string example: Ut incidunt rem. example: application_type: Molestiae non soluta error earum. authorization_signed_response_alg: Modi autem. client_description: Iste dicta velit qui sit. client_id: Et consequuntur a iure voluptatem. client_id_issued_at: 9121610628488420739 client_name: Rerum qui qui aut. client_uri: Dolorum reprehenderit autem explicabo officiis laborum. grant_types: - Nihil tenetur suscipit distinctio. - Repellendus debitis voluptatem mollitia totam. - Odio nam est eveniet occaecati nihil ea. id_token_signed_response_alg: Debitis reprehenderit incidunt culpa. jwks_uri: Voluptas sit voluptas rerum ullam neque aut. legal_entity_id: Saepe enim ipsa aut odio. legal_entity_name: Harum assumenda inventore corrupti sed. logo_uri: Beatae soluta aspernatur aperiam illo. org_id: Molestiae et nobis tenetur qui odio assumenda. org_name: Inventore adipisci soluta voluptates. recipient_base_uri: Ad doloribus omnis aut ipsam. redirect_uris: - Sit ab quos libero dolor sit. - Occaecati alias quia sint sunt dolorem. - Perspiciatis esse nam amet. - Necessitatibus voluptatum. request_object_signing_alg: Deleniti porro suscipit harum ipsam. require_pushed_authorization_requests: Iusto incidunt cumque eos. response_types: - Natus dicta molestiae quos ab qui temporibus. - Ut quibusdam suscipit officia dolores. revocation_uri: Est maxime. scope: Ut assumenda odit sit quae. software_id: Minus similique. software_roles: Voluptatem quae id aut fuga molestiae. software_statement: Corporis expedita. token_endpoint_auth_method: Neque incidunt. token_endpoint_auth_signing_alg: Esse quia neque. required: - application_type - authorization_signed_response_alg - client_description - client_id - client_id_issued_at - client_name - client_uri - grant_types - id_token_signed_response_alg - jwks_uri - legal_entity_id - legal_entity_name - logo_uri - org_id - org_name - recipient_base_uri - redirect_uris - request_object_signing_alg - require_pushed_authorization_requests - response_types - revocation_uri - scope - software_id - software_roles - software_statement - token_endpoint_auth_method - token_endpoint_auth_signing_alg DenyAuthorisationRequest: type: object properties: end_user_id: type: string description: The end user ID. example: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB session_id: type: string description: The session ID. example: "85" example: end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB session_id: "85" required: - end_user_id - session_id DenyAuthorisationResult: type: object properties: cancel_uri: type: string example: https://www.adrapp.net/error=access_denied&error_id=err_acde070d-8c4c-4f0d-9d8a-162843c10333&error_type=CONSENT_ENDUSER_DENIED&error_description=End-user denied consent during consent creation inside third-party data-holder application. End-user needs to create new consent.&error_uri=https://data.docs.fiskil.dev/errors#CONSENT_ENDUSER_DENIED example: cancel_uri: https://www.adrapp.net/error=access_denied&error_id=err_acde070d-8c4c-4f0d-9d8a-162843c10333&error_type=CONSENT_ENDUSER_DENIED&error_description=End-user denied consent during consent creation inside third-party data-holder application. End-user needs to create new consent.&error_uri=https://data.docs.fiskil.dev/errors#CONSENT_ENDUSER_DENIED required: - cancel_uri Enduser: type: object properties: email: type: string description: An End Users email address. This should be their primary email, as it is used for notifying the End User about their consents. example: john_starmer@gmail.com id: type: string description: A unique identifier for the End User object. example: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: type: string description: An End Users name. example: John Starmer phone: type: string description: An End Users Phone. It is used for notifying the End User about their consents. example: "+614123456789" example: email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" required: - id Enduserdetails: type: object properties: abn: type: string example: Dignissimos est occaecati facere harum ducimus autem. business_name: type: string example: Sunt sed veritatis ut incidunt reiciendis minus. example: abn: Eum in rerum doloribus sit. business_name: Laboriosam ex totam dolor laborum. required: - business_name - abn Enduserwithcounts: type: object properties: auth_session_counts: $ref: '#/components/schemas/Counts' consent_counts: $ref: '#/components/schemas/Counts' email: type: string description: An End Users email address. This should be their primary email, as it is used for notifying the End User about their consents. example: john_starmer@gmail.com id: type: string description: A unique identifier for the End User object. example: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: type: string description: An End Users name. example: John Starmer phone: type: string description: An End Users Phone. It is used for notifying the End User about their consents. example: "+614123456789" example: auth_session_counts: active: 3389301260341144675 inactive: 3149020480602711017 consent_counts: active: 3389301260341144675 inactive: 3149020480602711017 email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" required: - id Error: type: object properties: fault: type: boolean description: Is the error a server-side fault? example: true id: type: string description: ID is a unique identifier for this particular occurrence of the problem. example: 123abc message: type: string description: Message is a human-readable explanation specific to this occurrence of the problem. example: parameter 'p' must be an integer name: type: string description: Name is the name of this class of errors. example: bad_request temporary: type: boolean description: Is the error temporary? example: true timeout: type: boolean description: Is the error a timeout? example: false example: fault: true id: 123abc message: parameter 'p' must be an integer name: bad_request temporary: true timeout: false required: - name - id - message - temporary - timeout - fault Event: type: object properties: description: type: string description: Description of the event example: Assumenda amet in ut quidem. name: type: string description: Name of the event example: Qui et magnam rerum. example: description: Blanditiis dolorem esse repellendus voluptates soluta fugit. name: Deleniti et minus illum quaerat ratione occaecati. required: - name - description EventGroup: type: object properties: events: type: array items: $ref: '#/components/schemas/Event' description: Events in the group example: - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. name: type: string description: Name of the event group example: Eum dolor et voluptas ipsa non laborum. example: events: - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. - description: Et laudantium velit ipsum qui adipisci placeat. name: Veniam molestiae ex asperiores aliquam debitis voluptates. name: Odio enim laudantium reprehenderit qui architecto voluptatem. required: - name - events FetchAccessTokenError: type: object properties: client_id: type: string description: The ID of the client that owns the arrangement example: Sed ut perspiciatis excepturi deserunt et. institution_id: type: string description: The ID of the institution that the arrangement belongs to example: Et dicta ullam facere cum. message: type: string description: Error message example: Aspernatur quibusdam. name: type: string example: Voluptate sed magni eos nihil expedita omnis. description: Custom error for inactive consent example: client_id: Hic ullam eos magnam. institution_id: Iure cum alias a rerum. message: Earum quam tempore explicabo. name: Vitae facilis quia qui nulla sequi. required: - name - message - client_id - institution_id FetchAnAccessTokenResponseBody: type: object properties: client_id: type: string description: The ID of the client that owns the arrangement example: Quaerat ad. client_mtls_secret_location: type: string description: The location of the client mTLS secret. example: Facere nobis qui est est. expires_at: type: integer description: The time at which the access token expires example: 4002622332659783995 format: int64 institution_base_url: type: string description: The location of data holders resource url. example: https://resource.cdr-api.bankaust.com.au institution_id: type: string description: The ID of the institution that owns the arrangement example: Et aut ipsam eum sint quia quo. token: type: string description: An access token. This will be refreshed before delivery. example: Dolor cumque aut in doloribus sit. example: client_id: Deleniti nulla veniam libero quaerat. client_mtls_secret_location: Et qui quisquam laudantium doloribus. expires_at: 1906003928310166195 institution_base_url: https://resource.cdr-api.bankaust.com.au institution_id: Aut recusandae rerum impedit dicta. token: Sit beatae pariatur est itaque a id. required: - token - client_mtls_secret_location - institution_base_url - client_id - institution_id - expires_at Fiskilauthsession: type: object properties: arrangement_id: type: string description: Existing CDR arrangement ID to amend/update example: 94549a73-a554-4b76-b824-d96898829751 arrangement_id_expiration_date: type: string description: Existing CDR arrangement ID expiration date example: "2022-02-18T01:57:59Z" auth_url: type: string description: The computed auth URL. example: auth.fiskil.com?session_id=ea564d-56012s4-6ds4564 cancel_uri: type: string description: Your url to cancel an auth flow example: https://acme.com/cancel client_id: type: string description: The client that the end user belongs to example: 5qcql2s0bn9qfh1m5qd1sl4gth created_at: type: string description: Time at which session is created example: "2022-02-18T01:57:59Z" end_user_id: type: string description: The end_user that will be consenting with an external provider example: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB events: type: array items: $ref: '#/components/schemas/Fiskilauthsessionevent' description: The recorded events of the session/consent flow. example: - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED expires_at: type: string description: Time at which session expires example: "2022-02-18T01:57:59Z" institution_id: type: string description: The institution id selected for the auth session example: "10" is_terminal: type: boolean description: The terminal state example: true missing_abn: type: boolean description: Indicates whether the end user is missing ABN information example: true missing_email: type: boolean description: Indicates whether the end user is missing email information example: true redirect_uri: type: string description: Where the end user will be redirected to on success example: https://acme.com/success session_id: type: string description: Session Id example: ea564d-56012s4-6ds4564 example: arrangement_id: 94549a73-a554-4b76-b824-d96898829751 arrangement_id_expiration_date: "2022-02-18T01:57:59Z" auth_url: auth.fiskil.com?session_id=ea564d-56012s4-6ds4564 cancel_uri: https://acme.com/cancel client_id: 5qcql2s0bn9qfh1m5qd1sl4gth created_at: "2022-02-18T01:57:59Z" end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB events: - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED - event_time: "2022-02-18T01:57:59Z" meta: Est maiores rerum nostrum quaerat modi.: Qui laborum voluptatem. type: AUTH_SESSION_CREATED expires_at: "2022-02-18T01:57:59Z" institution_id: "10" is_terminal: false missing_abn: true missing_email: true redirect_uri: https://acme.com/success session_id: ea564d-56012s4-6ds4564 required: - session_id - client_id - end_user_id - redirect_uri - cancel_uri - created_at - expires_at - auth_url Fiskilauthsessionevent: type: object properties: event_time: type: string description: The time at which the event occurred example: "2022-02-18T01:57:59Z" meta: type: object description: The event metadata example: Commodi id animi id.: Harum numquam. Rerum ad suscipit dolorem odit.: Pariatur veniam. Voluptatem distinctio.: Sit perspiciatis nisi neque pariatur voluptatem tempora. additionalProperties: type: string example: Non nihil veritatis id. type: type: string description: The type of the event example: AUTH_SESSION_CREATED example: event_time: "2022-02-18T01:57:59Z" meta: Dolorem quos dolorem.: Sint et quis. Neque deleniti adipisci magni rerum qui.: Eius dicta commodi. Totam commodi at est natus consequatur illo.: Non rerum ad ut. type: AUTH_SESSION_CREATED required: - type - meta - event_time Fiskilclient: type: object properties: access_level: type: string description: The updated access level of the client example: Officiis a est fuga vitae reprehenderit. id: type: string description: The id of the client example: Accusamus dolorem sit. name: type: string description: The name of the client example: Hic omnis est qui inventore. product_id: type: string description: The CDR product id that the client uses. example: Quibusdam nesciunt. send_email: type: boolean description: Notify client about consent created using email example: false example: access_level: Velit voluptas id rerum consequatur ut. id: Asperiores dolor impedit consequatur itaque. name: Provident rerum rerum. product_id: Accusamus possimus voluptatem blanditiis laudantium maiores. send_email: true required: - id - name - product_id - send_email Fiskilcustomeronboarding: type: object properties: customer_connection_commercial: type: boolean example: true customer_connection_news: type: boolean example: true customer_industry: type: string example: Nihil neque. customer_intention: type: string example: Itaque incidunt at ut minima. customer_interests: type: array items: type: string example: Neque velit officia commodi sunt. example: - Est minus. - Possimus architecto aut est quia nisi sint. - Iure blanditiis quo praesentium. customer_service: type: string example: Natus vel. customer_service_providing: type: string example: Magni nesciunt sint magni minus iure sed. customer_users_scale: type: string example: Deserunt excepturi quam. id: type: string example: Molestias voluptatem. example: customer_connection_commercial: true customer_connection_news: true customer_industry: Fugit quidem. customer_intention: Molestias commodi. customer_interests: - Eius eum non odit et maiores totam. - Fuga distinctio quasi. - Earum enim dolores et asperiores. customer_service: Voluptatum et qui. customer_service_providing: Eos similique et rerum quaerat voluptas odio. customer_users_scale: Qui magnam. id: Aperiam hic beatae deserunt. required: - id - customer_service - customer_intention GetClientConfigForInternalUsageResponseBody: type: object properties: transaction_refresh_enabled: type: boolean description: Whether transaction refresh is enabled for the client example: false transaction_refresh_max_per_window: type: integer description: Maximum number of transaction refreshes allowed per window example: 1 format: int64 transaction_refresh_min_interval: type: integer description: Minimum interval between transaction refreshes, in seconds example: 10800 format: int64 example: transaction_refresh_enabled: false transaction_refresh_max_per_window: 1 transaction_refresh_min_interval: 10800 required: - transaction_refresh_max_per_window - transaction_refresh_min_interval - transaction_refresh_enabled Historicalinstitutionincident: type: object properties: end_at: type: string description: End time of the outage or incident in RFC3339 format. example: "2025-05-01T15:00:00Z" source: type: string description: Source of the historical incident. example: incident enum: - scheduled - incident start_at: type: string description: Start time of the outage or incident in RFC3339 format. example: "2025-05-01T14:00:00Z" title: type: string description: Human-readable incident title or scheduled outage reason. example: Scheduled maintenance example: end_at: "2025-05-01T15:00:00Z" source: incident start_at: "2025-05-01T14:00:00Z" title: Scheduled maintenance required: - start_at - end_at - source - title IncidentResponse: type: object properties: created_at: type: string description: Datetime of incident creation in RFC3339 format. example: Itaque quia voluptatem sit repellendus. description: type: string description: Description of the incident. example: Ab qui eveniet nostrum quia veniam et. end_at: type: string description: Datetime the incident has completed. example: Possimus consequatur distinctio et. id: type: string description: Datetime the incident has completed. example: Perspiciatis vel ducimus. incident_updates: type: array items: $ref: '#/components/schemas/IncidentUpdate' description: Array of updates for the incident. example: - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. start_at: type: string description: Datetime of incident start. example: Aut et cupiditate. title: type: string description: Name provided for the incident. example: Dignissimos expedita qui et omnis ullam optio. description: Institution incident response type. example: created_at: Temporibus qui. description: Nisi ut et. end_at: Laudantium reprehenderit minus enim sed aspernatur. id: Ex aut itaque quae voluptatem. incident_updates: - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. start_at: Error quisquam eum id deserunt deserunt. title: Ullam sed. required: - created_at - description - id - start_at - title IncidentUpdate: type: object properties: description: type: string description: Unique identifier of the update. example: Necessitatibus labore quia. status: type: string description: Status that the incident was transitioned to. example: Voluptatem ut saepe nisi voluptatem ducimus. update_at: type: string description: Datetime at which the update was made. example: Ratione ea. example: description: Laudantium repudiandae repellat quidem esse. status: Quam nihil. update_at: Reprehenderit omnis possimus praesentium quia. required: - description - status - update_at Institution: type: object properties: brand_id: type: string example: brand-001 icon_url: type: string description: The Institutions icon example: https://eastpaclogo.com.au/eastpac-icon.svg id: type: string description: A unique identifier for the Institution object. example: "22" industry: type: string description: The type of Instituion example: banking logo_url: type: string description: The institutions logo example: https://eastpaclogo.com.au/eastpac.svg name: type: string description: Institution name example: Eastpac priority: type: integer example: 1 format: int64 resource_url: type: string example: https://eastpac.com.au status: $ref: '#/components/schemas/InstitutionStatus' wkc_url: type: string description: Well known configuration url for an institution example: https://eastpac.com.au/.well-known/openid-configuration example: brand_id: brand-001 icon_url: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking logo_url: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 resource_url: https://eastpac.com.au status: connections: status: OUTAGE wkc_url: https://eastpac.com.au/.well-known/openid-configuration required: - id - wkc_url - name - resource_url - logo_url - icon_url - brand_id - industry - priority - status InstitutionByClient: type: object properties: icon: type: string description: A URL to an icon for the institution example: https://eastpaclogo.com.au/eastpac-icon.svg id: type: string description: The id of the institution example: "22" industry: type: string description: The industry of the institution e.g. “banking” or “energy” example: banking enum: - banking - energy is_accessible: type: boolean description: Whether this institution is accessible by the teamID. Determines if institution can be used example: true logo: type: string description: A URL to the logo of the institution example: https://eastpaclogo.com.au/eastpac.svg name: type: string description: The name of the institution example: Eastpac priority: type: integer description: The order that this institution will appear in during an auth session example: 1 format: int64 status: $ref: '#/components/schemas/InstitutionStatus' description: Gets a list of institutions from the perspective of the client. example: icon: https://eastpaclogo.com.au/eastpac-icon.svg id: "22" industry: banking is_accessible: true logo: https://eastpaclogo.com.au/eastpac.svg name: Eastpac priority: 1 status: connections: status: OUTAGE required: - id - name - logo - icon - industry - priority - status InstitutionStatus: type: object properties: connections: $ref: '#/components/schemas/ConnectionStatus' description: The overall status of an institution example: connections: status: OUTAGE required: - connections InstitutionStatusDisplay: type: object properties: icon: type: string description: The URL of the institution's icon. example: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: type: string description: The unique identifier of the institution. example: "22" name: type: string description: The name of the institution. example: Westpac status: type: string description: The overall status of the institution example: Healthy enum: - Healthy - Outage example: icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage required: - icon - id - name - status Institutionoutagesresult: type: object properties: current_incident: $ref: '#/components/schemas/IncidentResponse' current_scheduled_outage: $ref: '#/components/schemas/ScheduledOutageResponse' has_next_page: type: boolean description: Whether the list of outages has a next page. example: false institution_id: type: string description: Institution ID of which the details has been requested. example: "1" institution_logo_url: type: string description: URL of the institution logo page. example: Dolores voluptatem perspiciatis eligendi minima sed. institution_name: type: string description: Name of the institution which corresponds to the ID being queried. example: NAB institution_status: type: string description: Status of the institution whose details are being currently queried. example: Healthy enum: - Healthy - Outage next_scheduled_outage: $ref: '#/components/schemas/ScheduledOutageResponse' outages: type: array items: $ref: '#/components/schemas/Outageresponse' description: List of outages sorted in start_at (descending order). example: - description: Ut in. duration: 7113594325144523084 end_at: Omnis asperiores ad officiis quos. id: Et eius delectus sed iure. incident_updates: - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. outage_type: Incident start_at: Est ab a nisi et voluptatem commodi. status: Enim exercitationem. title: Exercitationem quo amet et. - description: Ut in. duration: 7113594325144523084 end_at: Omnis asperiores ad officiis quos. id: Et eius delectus sed iure. incident_updates: - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. outage_type: Incident start_at: Est ab a nisi et voluptatem commodi. status: Enim exercitationem. title: Exercitationem quo amet et. example: current_incident: created_at: Autem omnis reprehenderit dolores sit. description: Temporibus consequatur accusamus aliquid et accusamus quia. end_at: Ea commodi. id: Aspernatur quia nulla praesentium illum. incident_updates: - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. start_at: Qui minima. title: Distinctio aut voluptatem ipsum dolores sit. current_scheduled_outage: id: Ad dicta in molestiae. institution_id: Cum et quibusdam. is_partial: false outage_end: Vitae dolores aspernatur sapiente possimus deleniti ipsum. outage_reason: Repellat tempore quasi adipisci nostrum. outage_start: Quisquam magni sequi ut facilis quibusdam ad. has_next_page: true institution_id: "1" institution_logo_url: Perspiciatis aut. institution_name: NAB institution_status: Outage next_scheduled_outage: id: Ad dicta in molestiae. institution_id: Cum et quibusdam. is_partial: false outage_end: Vitae dolores aspernatur sapiente possimus deleniti ipsum. outage_reason: Repellat tempore quasi adipisci nostrum. outage_start: Quisquam magni sequi ut facilis quibusdam ad. outages: - description: Ut in. duration: 7113594325144523084 end_at: Omnis asperiores ad officiis quos. id: Et eius delectus sed iure. incident_updates: - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. outage_type: Incident start_at: Est ab a nisi et voluptatem commodi. status: Enim exercitationem. title: Exercitationem quo amet et. - description: Ut in. duration: 7113594325144523084 end_at: Omnis asperiores ad officiis quos. id: Et eius delectus sed iure. incident_updates: - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. outage_type: Incident start_at: Est ab a nisi et voluptatem commodi. status: Enim exercitationem. title: Exercitationem quo amet et. required: - institution_id - institution_name - institution_status - next_scheduled_outage - outages - has_next_page - institution_logo_url Institutionstatuspageresult: type: object properties: industry: type: string description: The industry of which the institutions belong to. example: energy enum: - banking - energy institution_statuses: type: array items: $ref: '#/components/schemas/InstitutionStatusDisplay' description: An array of all institutions in the industry and their overall status. example: - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage example: industry: energy institution_statuses: - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage - icon: https://storage.googleapis.com/global_institutions_prod/icons/1-national-australia-bank-icon.png id: "22" name: Westpac status: Outage required: - industry - institution_statuses JWK: type: object properties: alg: type: string description: The key algorithm. example: PS256 e: type: string description: RSA specific key parameters. example: AQAB kid: type: string description: The key identifier example: fiskil_kid_sig kty: type: string description: The key type. example: RSA "n": type: string description: RSA specific key parameters. example: uMtxVF1tgOy7xIAbTHQxvToZCB9nkrg_UpGWIWOE42Or0r2RNMBom_MFZka4tL7pUaZSLUtZJpXNZyYgZ63T3_EZKNyUfgmsEVg7J--FW-jnktY_T7hgkGjrLlW0a1nJlCfmV4bR31L4fnYDkpsQopxYMfw6CFFOoD1e9_xk6PA8VLOBs4vnUmIaw1heJZRIu0iekYVMSnrY1R_uePfgGWxsZEl53lGHRsB1lxQ9s8mPKZwdUjsX5zQUAQBTK3tsCy2jIO4oAA8GX_SBsrIQ4VMtH7e7sCIiTQGxKsIHWqPF0at4lH5cZtRiYUQYz6a6v48JQ5Glg33ld5GNGe-XdS7FlCvNVLIzBpJViO0WIMzMTFqnwNI5cxRTLJLedMwx9WUdG-G5675tFgkXWbYtwcteCRoWz85f0EPSBnCn1nVUosMnkkgTcdnKHng5TWKWYQda6x3FxBcG06Dmj52fJVA62ThVNvM2QMG0cfBMv4cSYMaCa8EsCPgTmBcXRyiwHxDK-w3hrVEW4t32MYY0pkkLvg4ZSzUsEp79kOWwGSIqGUkE-oh9fFQixPJr4MFsSHutsbI5zQkGkUfMoO_Z9NeleGSSVz62prT_Lvyh35_o_FgxVNauRO0fty2Bhqjk7xAsaiAr1udu_l1SvncheKkvAYp1hI0dPC4L-hGfZks use: type: string description: Identifies the intent of the key. example: sig description: A JWK set example: alg: PS256 e: AQAB kid: fiskil_kid_sig kty: RSA "n": uMtxVF1tgOy7xIAbTHQxvToZCB9nkrg_UpGWIWOE42Or0r2RNMBom_MFZka4tL7pUaZSLUtZJpXNZyYgZ63T3_EZKNyUfgmsEVg7J--FW-jnktY_T7hgkGjrLlW0a1nJlCfmV4bR31L4fnYDkpsQopxYMfw6CFFOoD1e9_xk6PA8VLOBs4vnUmIaw1heJZRIu0iekYVMSnrY1R_uePfgGWxsZEl53lGHRsB1lxQ9s8mPKZwdUjsX5zQUAQBTK3tsCy2jIO4oAA8GX_SBsrIQ4VMtH7e7sCIiTQGxKsIHWqPF0at4lH5cZtRiYUQYz6a6v48JQ5Glg33ld5GNGe-XdS7FlCvNVLIzBpJViO0WIMzMTFqnwNI5cxRTLJLedMwx9WUdG-G5675tFgkXWbYtwcteCRoWz85f0EPSBnCn1nVUosMnkkgTcdnKHng5TWKWYQda6x3FxBcG06Dmj52fJVA62ThVNvM2QMG0cfBMv4cSYMaCa8EsCPgTmBcXRyiwHxDK-w3hrVEW4t32MYY0pkkLvg4ZSzUsEp79kOWwGSIqGUkE-oh9fFQixPJr4MFsSHutsbI5zQkGkUfMoO_Z9NeleGSSVz62prT_Lvyh35_o_FgxVNauRO0fty2Bhqjk7xAsaiAr1udu_l1SvncheKkvAYp1hI0dPC4L-hGfZks use: sig required: - alg - kty - use - kid - e - "n" JWKs: type: object properties: keys: type: array items: $ref: '#/components/schemas/JWK' example: - alg: PS256 e: AQAB kid: fiskil_kid_sig kty: RSA "n": uMtxVF1tgOy7xIAbTHQxvToZCB9nkrg_UpGWIWOE42Or0r2RNMBom_MFZka4tL7pUaZSLUtZJpXNZyYgZ63T3_EZKNyUfgmsEVg7J--FW-jnktY_T7hgkGjrLlW0a1nJlCfmV4bR31L4fnYDkpsQopxYMfw6CFFOoD1e9_xk6PA8VLOBs4vnUmIaw1heJZRIu0iekYVMSnrY1R_uePfgGWxsZEl53lGHRsB1lxQ9s8mPKZwdUjsX5zQUAQBTK3tsCy2jIO4oAA8GX_SBsrIQ4VMtH7e7sCIiTQGxKsIHWqPF0at4lH5cZtRiYUQYz6a6v48JQ5Glg33ld5GNGe-XdS7FlCvNVLIzBpJViO0WIMzMTFqnwNI5cxRTLJLedMwx9WUdG-G5675tFgkXWbYtwcteCRoWz85f0EPSBnCn1nVUosMnkkgTcdnKHng5TWKWYQda6x3FxBcG06Dmj52fJVA62ThVNvM2QMG0cfBMv4cSYMaCa8EsCPgTmBcXRyiwHxDK-w3hrVEW4t32MYY0pkkLvg4ZSzUsEp79kOWwGSIqGUkE-oh9fFQixPJr4MFsSHutsbI5zQkGkUfMoO_Z9NeleGSSVz62prT_Lvyh35_o_FgxVNauRO0fty2Bhqjk7xAsaiAr1udu_l1SvncheKkvAYp1hI0dPC4L-hGfZks use: sig - alg: PS256 e: AQAB kid: fiskil_kid_sig kty: RSA "n": uMtxVF1tgOy7xIAbTHQxvToZCB9nkrg_UpGWIWOE42Or0r2RNMBom_MFZka4tL7pUaZSLUtZJpXNZyYgZ63T3_EZKNyUfgmsEVg7J--FW-jnktY_T7hgkGjrLlW0a1nJlCfmV4bR31L4fnYDkpsQopxYMfw6CFFOoD1e9_xk6PA8VLOBs4vnUmIaw1heJZRIu0iekYVMSnrY1R_uePfgGWxsZEl53lGHRsB1lxQ9s8mPKZwdUjsX5zQUAQBTK3tsCy2jIO4oAA8GX_SBsrIQ4VMtH7e7sCIiTQGxKsIHWqPF0at4lH5cZtRiYUQYz6a6v48JQ5Glg33ld5GNGe-XdS7FlCvNVLIzBpJViO0WIMzMTFqnwNI5cxRTLJLedMwx9WUdG-G5675tFgkXWbYtwcteCRoWz85f0EPSBnCn1nVUosMnkkgTcdnKHng5TWKWYQda6x3FxBcG06Dmj52fJVA62ThVNvM2QMG0cfBMv4cSYMaCa8EsCPgTmBcXRyiwHxDK-w3hrVEW4t32MYY0pkkLvg4ZSzUsEp79kOWwGSIqGUkE-oh9fFQixPJr4MFsSHutsbI5zQkGkUfMoO_Z9NeleGSSVz62prT_Lvyh35_o_FgxVNauRO0fty2Bhqjk7xAsaiAr1udu_l1SvncheKkvAYp1hI0dPC4L-hGfZks use: sig - alg: PS256 e: AQAB kid: fiskil_kid_sig kty: RSA "n": uMtxVF1tgOy7xIAbTHQxvToZCB9nkrg_UpGWIWOE42Or0r2RNMBom_MFZka4tL7pUaZSLUtZJpXNZyYgZ63T3_EZKNyUfgmsEVg7J--FW-jnktY_T7hgkGjrLlW0a1nJlCfmV4bR31L4fnYDkpsQopxYMfw6CFFOoD1e9_xk6PA8VLOBs4vnUmIaw1heJZRIu0iekYVMSnrY1R_uePfgGWxsZEl53lGHRsB1lxQ9s8mPKZwdUjsX5zQUAQBTK3tsCy2jIO4oAA8GX_SBsrIQ4VMtH7e7sCIiTQGxKsIHWqPF0at4lH5cZtRiYUQYz6a6v48JQ5Glg33ld5GNGe-XdS7FlCvNVLIzBpJViO0WIMzMTFqnwNI5cxRTLJLedMwx9WUdG-G5675tFgkXWbYtwcteCRoWz85f0EPSBnCn1nVUosMnkkgTcdnKHng5TWKWYQda6x3FxBcG06Dmj52fJVA62ThVNvM2QMG0cfBMv4cSYMaCa8EsCPgTmBcXRyiwHxDK-w3hrVEW4t32MYY0pkkLvg4ZSzUsEp79kOWwGSIqGUkE-oh9fFQixPJr4MFsSHutsbI5zQkGkUfMoO_Z9NeleGSSVz62prT_Lvyh35_o_FgxVNauRO0fty2Bhqjk7xAsaiAr1udu_l1SvncheKkvAYp1hI0dPC4L-hGfZks use: sig description: A JWK set example: keys: - alg: PS256 e: AQAB kid: fiskil_kid_sig kty: RSA "n": uMtxVF1tgOy7xIAbTHQxvToZCB9nkrg_UpGWIWOE42Or0r2RNMBom_MFZka4tL7pUaZSLUtZJpXNZyYgZ63T3_EZKNyUfgmsEVg7J--FW-jnktY_T7hgkGjrLlW0a1nJlCfmV4bR31L4fnYDkpsQopxYMfw6CFFOoD1e9_xk6PA8VLOBs4vnUmIaw1heJZRIu0iekYVMSnrY1R_uePfgGWxsZEl53lGHRsB1lxQ9s8mPKZwdUjsX5zQUAQBTK3tsCy2jIO4oAA8GX_SBsrIQ4VMtH7e7sCIiTQGxKsIHWqPF0at4lH5cZtRiYUQYz6a6v48JQ5Glg33ld5GNGe-XdS7FlCvNVLIzBpJViO0WIMzMTFqnwNI5cxRTLJLedMwx9WUdG-G5675tFgkXWbYtwcteCRoWz85f0EPSBnCn1nVUosMnkkgTcdnKHng5TWKWYQda6x3FxBcG06Dmj52fJVA62ThVNvM2QMG0cfBMv4cSYMaCa8EsCPgTmBcXRyiwHxDK-w3hrVEW4t32MYY0pkkLvg4ZSzUsEp79kOWwGSIqGUkE-oh9fFQixPJr4MFsSHutsbI5zQkGkUfMoO_Z9NeleGSSVz62prT_Lvyh35_o_FgxVNauRO0fty2Bhqjk7xAsaiAr1udu_l1SvncheKkvAYp1hI0dPC4L-hGfZks use: sig - alg: PS256 e: AQAB kid: fiskil_kid_sig kty: RSA "n": uMtxVF1tgOy7xIAbTHQxvToZCB9nkrg_UpGWIWOE42Or0r2RNMBom_MFZka4tL7pUaZSLUtZJpXNZyYgZ63T3_EZKNyUfgmsEVg7J--FW-jnktY_T7hgkGjrLlW0a1nJlCfmV4bR31L4fnYDkpsQopxYMfw6CFFOoD1e9_xk6PA8VLOBs4vnUmIaw1heJZRIu0iekYVMSnrY1R_uePfgGWxsZEl53lGHRsB1lxQ9s8mPKZwdUjsX5zQUAQBTK3tsCy2jIO4oAA8GX_SBsrIQ4VMtH7e7sCIiTQGxKsIHWqPF0at4lH5cZtRiYUQYz6a6v48JQ5Glg33ld5GNGe-XdS7FlCvNVLIzBpJViO0WIMzMTFqnwNI5cxRTLJLedMwx9WUdG-G5675tFgkXWbYtwcteCRoWz85f0EPSBnCn1nVUosMnkkgTcdnKHng5TWKWYQda6x3FxBcG06Dmj52fJVA62ThVNvM2QMG0cfBMv4cSYMaCa8EsCPgTmBcXRyiwHxDK-w3hrVEW4t32MYY0pkkLvg4ZSzUsEp79kOWwGSIqGUkE-oh9fFQixPJr4MFsSHutsbI5zQkGkUfMoO_Z9NeleGSSVz62prT_Lvyh35_o_FgxVNauRO0fty2Bhqjk7xAsaiAr1udu_l1SvncheKkvAYp1hI0dPC4L-hGfZks use: sig - alg: PS256 e: AQAB kid: fiskil_kid_sig kty: RSA "n": uMtxVF1tgOy7xIAbTHQxvToZCB9nkrg_UpGWIWOE42Or0r2RNMBom_MFZka4tL7pUaZSLUtZJpXNZyYgZ63T3_EZKNyUfgmsEVg7J--FW-jnktY_T7hgkGjrLlW0a1nJlCfmV4bR31L4fnYDkpsQopxYMfw6CFFOoD1e9_xk6PA8VLOBs4vnUmIaw1heJZRIu0iekYVMSnrY1R_uePfgGWxsZEl53lGHRsB1lxQ9s8mPKZwdUjsX5zQUAQBTK3tsCy2jIO4oAA8GX_SBsrIQ4VMtH7e7sCIiTQGxKsIHWqPF0at4lH5cZtRiYUQYz6a6v48JQ5Glg33ld5GNGe-XdS7FlCvNVLIzBpJViO0WIMzMTFqnwNI5cxRTLJLedMwx9WUdG-G5675tFgkXWbYtwcteCRoWz85f0EPSBnCn1nVUosMnkkgTcdnKHng5TWKWYQda6x3FxBcG06Dmj52fJVA62ThVNvM2QMG0cfBMv4cSYMaCa8EsCPgTmBcXRyiwHxDK-w3hrVEW4t32MYY0pkkLvg4ZSzUsEp79kOWwGSIqGUkE-oh9fFQixPJr4MFsSHutsbI5zQkGkUfMoO_Z9NeleGSSVz62prT_Lvyh35_o_FgxVNauRO0fty2Bhqjk7xAsaiAr1udu_l1SvncheKkvAYp1hI0dPC4L-hGfZks use: sig - alg: PS256 e: AQAB kid: fiskil_kid_sig kty: RSA "n": uMtxVF1tgOy7xIAbTHQxvToZCB9nkrg_UpGWIWOE42Or0r2RNMBom_MFZka4tL7pUaZSLUtZJpXNZyYgZ63T3_EZKNyUfgmsEVg7J--FW-jnktY_T7hgkGjrLlW0a1nJlCfmV4bR31L4fnYDkpsQopxYMfw6CFFOoD1e9_xk6PA8VLOBs4vnUmIaw1heJZRIu0iekYVMSnrY1R_uePfgGWxsZEl53lGHRsB1lxQ9s8mPKZwdUjsX5zQUAQBTK3tsCy2jIO4oAA8GX_SBsrIQ4VMtH7e7sCIiTQGxKsIHWqPF0at4lH5cZtRiYUQYz6a6v48JQ5Glg33ld5GNGe-XdS7FlCvNVLIzBpJViO0WIMzMTFqnwNI5cxRTLJLedMwx9WUdG-G5675tFgkXWbYtwcteCRoWz85f0EPSBnCn1nVUosMnkkgTcdnKHng5TWKWYQda6x3FxBcG06Dmj52fJVA62ThVNvM2QMG0cfBMv4cSYMaCa8EsCPgTmBcXRyiwHxDK-w3hrVEW4t32MYY0pkkLvg4ZSzUsEp79kOWwGSIqGUkE-oh9fFQixPJr4MFsSHutsbI5zQkGkUfMoO_Z9NeleGSSVz62prT_Lvyh35_o_FgxVNauRO0fty2Bhqjk7xAsaiAr1udu_l1SvncheKkvAYp1hI0dPC4L-hGfZks use: sig required: - keys Notification: type: object properties: acknowledged: type: boolean description: Indicates whether the notification has been acknowledged. example: false arrangement_id: type: string description: The ID of the arrangement associated with this notification. example: arrangement-456 delivery_attempt: type: integer description: Number of attempts made to deliver the notification. example: 3 format: int64 end_user_id: type: string description: The ID of the end user associated with this notification. example: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB error: type: string description: Error message if the notification failed. example: Failed to send notification id: type: string description: A unique identifier for the Notification object. example: a9f8e3c7-d5a2-4db4-8c6e-734a1db0f9f4 request: type: string description: The request payload sent to the webhook. example: '{"key": "value"}' response: type: string description: The response payload received from the webhook. example: '{"status": "success"}' sent_at: type: string description: Timestamp when the notification was sent (RFC3339 format). example: "2025-05-01T14:00:00Z" status: type: integer description: Status code of the webhook response. example: 200 format: int64 team_id: type: string description: The ID of the team that owns this notification. example: team-123 type: type: string description: Event type of the notification. example: energy.invoices.sync.completed webhook_id: type: string description: The ID of the webhook associated with this notification. example: webhook-123 example: acknowledged: false arrangement_id: arrangement-456 delivery_attempt: 3 end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB error: Failed to send notification id: a9f8e3c7-d5a2-4db4-8c6e-734a1db0f9f4 request: '{"key": "value"}' response: '{"status": "success"}' sent_at: "2025-05-01T14:00:00Z" status: 200 team_id: team-123 type: energy.invoices.sync.completed webhook_id: webhook-123 required: - id - webhook_id - team_id - arrangement_id - end_user_id - type - acknowledged - error - request - delivery_attempt - response - status - sent_at NotifyClientOfStripePaymentOKResponseBody: type: object properties: status: type: string example: Aliquid et cupiditate magni non consequuntur alias. example: status: Qui dolor suscipit exercitationem. required: - status Outageresponse: type: object properties: description: type: string description: Description of the incident or reason for the scheduled outage. example: Dolores quae qui enim temporibus. duration: type: integer description: Number of minutes the outage is expected to / has lasted. example: 8234486996183371947 format: int64 end_at: type: string description: Datetime at which the outage ended in RFC3339 format. example: Et qui rem ipsa quibusdam maiores. id: type: string description: Unique identifier for the outage. example: Iste aut. incident_updates: type: array items: $ref: '#/components/schemas/IncidentUpdate' description: Array of updates for an incident. example: - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. outage_type: type: string description: Type of outage for the institution. example: Scheduled outage enum: - Incident - Scheduled outage start_at: type: string description: Datetime at which the outage started in RFC3339 format. example: Delectus quos. status: type: string description: Status of the institution outage. example: Et repellat iure esse. title: type: string description: Name of the incident. example: Enim quod sint unde enim. description: Generic outage response type which contains fields for both scheduled outages and incidents. example: description: Est consequatur tempora nam ab. duration: 1798987923159484057 end_at: Cum molestiae ducimus itaque provident eveniet eligendi. id: Accusamus illum voluptatem voluptatem possimus. incident_updates: - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. - description: Ab enim nihil excepturi dolores suscipit. status: Omnis hic officia laudantium id dicta fugiat. update_at: Autem expedita animi at quod aut explicabo. outage_type: Scheduled outage start_at: Ullam natus blanditiis dolorem repellendus porro tempore. status: Iusto adipisci commodi. title: Tempore delectus et molestiae. required: - description - duration - end_at - id - incident_updates - start_at - status - outage_type Paginatedendusers: type: object properties: end_users: type: array items: $ref: '#/components/schemas/Enduserwithcounts' description: List of end users example: - auth_session_counts: active: 3389301260341144675 inactive: 3149020480602711017 consent_counts: active: 3389301260341144675 inactive: 3149020480602711017 email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" - auth_session_counts: active: 3389301260341144675 inactive: 3149020480602711017 consent_counts: active: 3389301260341144675 inactive: 3149020480602711017 email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" page: type: integer description: Current page number example: 3229106738106422721 format: int64 page_size: type: integer description: Number of items per page example: 3265086238278500698 format: int64 total: type: integer description: Total number of end users example: 7747483411962518698 format: int64 example: end_users: - auth_session_counts: active: 3389301260341144675 inactive: 3149020480602711017 consent_counts: active: 3389301260341144675 inactive: 3149020480602711017 email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" - auth_session_counts: active: 3389301260341144675 inactive: 3149020480602711017 consent_counts: active: 3389301260341144675 inactive: 3149020480602711017 email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" - auth_session_counts: active: 3389301260341144675 inactive: 3149020480602711017 consent_counts: active: 3389301260341144675 inactive: 3149020480602711017 email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" - auth_session_counts: active: 3389301260341144675 inactive: 3149020480602711017 consent_counts: active: 3389301260341144675 inactive: 3149020480602711017 email: john_starmer@gmail.com id: 482c0e2b-5866-46b1-b795-220b7bba45b5 name: John Starmer phone: "+614123456789" page: 3458199752842631255 page_size: 7375970927617746579 total: 171251810645949472 required: - end_users - total - page - page_size Paginatednotifications: type: object properties: cursor: type: string description: Cursor for pagination example: Dolorem et unde pariatur impedit. notifications: type: array items: $ref: '#/components/schemas/Notification' description: List of webhook notifications example: - acknowledged: false arrangement_id: arrangement-456 delivery_attempt: 3 end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB error: Failed to send notification id: a9f8e3c7-d5a2-4db4-8c6e-734a1db0f9f4 request: '{"key": "value"}' response: '{"status": "success"}' sent_at: "2025-05-01T14:00:00Z" status: 200 team_id: team-123 type: energy.invoices.sync.completed webhook_id: webhook-123 - acknowledged: false arrangement_id: arrangement-456 delivery_attempt: 3 end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB error: Failed to send notification id: a9f8e3c7-d5a2-4db4-8c6e-734a1db0f9f4 request: '{"key": "value"}' response: '{"status": "success"}' sent_at: "2025-05-01T14:00:00Z" status: 200 team_id: team-123 type: energy.invoices.sync.completed webhook_id: webhook-123 - acknowledged: false arrangement_id: arrangement-456 delivery_attempt: 3 end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB error: Failed to send notification id: a9f8e3c7-d5a2-4db4-8c6e-734a1db0f9f4 request: '{"key": "value"}' response: '{"status": "success"}' sent_at: "2025-05-01T14:00:00Z" status: 200 team_id: team-123 type: energy.invoices.sync.completed webhook_id: webhook-123 page_size: type: integer description: Number of items per page example: 1800658639855007942 format: int64 example: cursor: Adipisci voluptate qui amet molestiae vel. notifications: - acknowledged: false arrangement_id: arrangement-456 delivery_attempt: 3 end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB error: Failed to send notification id: a9f8e3c7-d5a2-4db4-8c6e-734a1db0f9f4 request: '{"key": "value"}' response: '{"status": "success"}' sent_at: "2025-05-01T14:00:00Z" status: 200 team_id: team-123 type: energy.invoices.sync.completed webhook_id: webhook-123 - acknowledged: false arrangement_id: arrangement-456 delivery_attempt: 3 end_user_id: eu_2yRHN2ag2y4p8kCtm5DOeccZEXB error: Failed to send notification id: a9f8e3c7-d5a2-4db4-8c6e-734a1db0f9f4 request: '{"key": "value"}' response: '{"status": "success"}' sent_at: "2025-05-01T14:00:00Z" status: 200 team_id: team-123 type: energy.invoices.sync.completed webhook_id: webhook-123 page_size: 3762779735735815568 required: - notifications - cursor - page_size Permission: type: object properties: description: type: string description: A description of the permission. example: This will give the provider access to all of your transaction information industry: type: string description: The industry this permission belongs to. example: banking name: type: string description: The name of the permission. example: transactions scope: type: string description: The CDS scope this permission translates to example: bank:transactions:read standards: type: array items: type: string example: Possimus et cumque eveniet ea quaerat. description: Information about the assocated standards example: - CDR description: Information about permissions. example: description: This will give the provider access to all of your transaction information industry: banking name: transactions scope: bank:transactions:read standards: - CDR required: - name - description - scope - standards - industry ReceivePubsubEventsPayload: type: object properties: deliveryAttempt: type: integer example: 6417616458688022130 format: int64 event: type: string example: Fugiat alias nobis. message: type: object properties: attributes: type: object example: Illum cupiditate ut impedit corrupti molestias.: Ut in. Maxime ex quo tenetur odit suscipit.: Provident nihil. additionalProperties: type: string example: Quos et vero voluptas voluptatibus dicta debitis. data: type: string example: Enim amet eos libero odit minus. messageId: type: string example: Suscipit dolor laudantium eius accusantium. publishTime: type: string example: Excepturi quis blanditiis aut voluptas consequatur. example: attributes: Aspernatur pariatur dolorum unde.: Magni qui sunt. Aut dolores.: Delectus voluptas provident similique. Et voluptas sunt eum dolore explicabo quod.: Nisi qui expedita tempora sit. data: Aut minus. messageId: Sed iure iste. publishTime: Assumenda beatae adipisci sapiente sed blanditiis. required: - data - messageId subscription: type: string example: Voluptatum nisi architecto ab. example: deliveryAttempt: 308222227731698181 event: Facilis magnam accusamus asperiores. message: attributes: Asperiores non.: Similique rerum autem magni placeat fugit dignissimos. Magni maxime voluptatem doloribus.: Voluptatem odit odio quia. Voluptates aut omnis dolorum sint.: Autem nesciunt. data: Et et voluptate est quam. messageId: Officia adipisci accusamus minus recusandae. publishTime: Veniam saepe officia. subscription: Velit placeat recusandae culpa. required: - message - subscription - event ReceivePubsubEventsPayload2: type: object properties: deliveryAttempt: type: integer example: 7151590634799536184 format: int64 message: type: object properties: attributes: type: object example: Aut tempore iure et.: Recusandae minima repellendus sit odit. Eligendi nemo eum ipsum et et totam.: Est eum facere nihil. additionalProperties: type: string example: Eos architecto delectus voluptates. data: type: string example: Illo facilis. messageId: type: string example: Officiis cupiditate ullam quia eligendi eligendi. publishTime: type: string example: Saepe in et facere. example: attributes: Provident iure quos voluptas vitae.: Incidunt sed earum. data: Sit ratione in ullam consequatur mollitia doloremque. messageId: Atque vel distinctio alias. publishTime: Veritatis ipsum autem. required: - data - messageId subscription: type: string example: Illum id laudantium dolor nostrum. example: deliveryAttempt: 6587238624213178086 message: attributes: Beatae omnis error.: Ut repellat veniam nostrum tenetur ut. data: Numquam aut facere reprehenderit deserunt placeat cum. messageId: Suscipit voluptatum quasi tenetur sit dolores. publishTime: Quia nostrum rerum quos eum ut. subscription: Enim repellat blanditiis ut quam. required: - message - subscription ReceivePubsubEventsPayload3: type: object properties: deliveryAttempt: type: integer example: 7682558198162904418 format: int64 message: type: object properties: attributes: type: object example: Corporis dolore qui.: Voluptatem non necessitatibus eos est quisquam quos. Facilis facere eum reprehenderit.: Nobis incidunt. Voluptatem quis hic eum doloribus voluptatem.: Velit rem quisquam sed iure perspiciatis. additionalProperties: type: string example: Dolorem ducimus et nihil enim. data: type: string example: Perferendis iusto ut illo. messageId: type: string example: Et nemo numquam fugit voluptatibus velit temporibus. publishTime: type: string example: Impedit non rem temporibus non. example: attributes: Quia maxime tempora.: Magni rerum reiciendis est voluptas deleniti. data: Laudantium fugiat sunt blanditiis. messageId: Molestias eum iure eius. publishTime: Porro a. required: - data - messageId subscription: type: string example: Sint doloremque et et. example: deliveryAttempt: 2601226427448735072 message: attributes: Inventore rerum distinctio itaque ullam.: Omnis eligendi voluptas suscipit voluptatem. Necessitatibus pariatur et et.: Modi autem vel ut et. Non iure necessitatibus est totam.: Qui omnis modi voluptate id quo quos. data: Ipsa debitis provident occaecati perferendis in modi. messageId: Iure sunt error. publishTime: Consequatur dolor ut dolore atque vero quaerat. subscription: Blanditiis non. required: - message - subscription RedirectResult: type: object properties: Location: type: string description: Target URL for redirection after completing institution status email activities example: Omnis amet qui. example: Location: Et est et eos necessitatibus. required: - Location RegisterDCRRequestBody: type: object properties: institution_id: type: string description: The ID of the institution. example: Reiciendis ratione. product_id: type: string description: The CDR product id to register. example: Autem sunt error voluptates. example: institution_id: Inventore quasi adipisci aliquid quod dolorem ut. product_id: Ipsam voluptas. required: - institution_id - product_id RegisterDCRResponseBody: type: object properties: client_id: type: string description: The newly generated client id from the institution. example: Quod sunt. example: client_id: Rerum sit. required: - client_id RevokeArrangementRequestBody: type: object properties: cdr_arrangement_id: type: string description: CDR arrangement ID. example: Est est aut provident quidem qui. cdr_arrangement_jwt: type: string example: Rerum quisquam. example: cdr_arrangement_id: Voluptas ut. cdr_arrangement_jwt: Amet et modi. required: - cdr_arrangement_jwt ScheduledOutageResponse: type: object properties: id: type: string description: Unique identifier of the scheduled outage example: Sapiente explicabo voluptatem provident ipsa. institution_id: type: string description: Unique institution identfier for which the outage is scheduled. example: Nesciunt veniam numquam. is_partial: type: boolean description: Whether the outage is expected to be partial or full. example: false outage_end: type: string description: Expected end time of the scheduled outage in RFC3339 format. example: Reiciendis quia consequuntur corrupti at aut. outage_reason: type: string description: Reason for the scheduled outage taking place. example: Qui voluptas ipsum ut. outage_start: type: string description: Expected start time of the scheduled outage in RFC3339 format. example: Quisquam laudantium quo voluptas nisi nihil adipisci. description: Scheduled outage response type. example: id: Pariatur rerum voluptatem et vero. institution_id: Aut quia recusandae at qui. is_partial: true outage_end: Qui sunt aliquam esse at quis. outage_reason: Numquam fuga velit autem id. outage_start: Voluptatum delectus adipisci veniam. required: - id - institution_id - outage_start - outage_end - is_partial - outage_reason SubmitCareerApplicationRequestBody: type: object properties: cover_letter_link: type: string description: link to cover letter example: Quisquam inventore ut magnam qui voluptas modi. email: type: string description: email address example: E@yF.Ka pattern: ^[a-zA-Z0-9._-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ name: type: string description: name example: Est asperiores debitis. phone: type: string description: phone number example: 438867 03 pattern: ^(\+|00)?[1-9][0-9 ]{8,16}$ resume_link: type: string description: link to your resume example: Voluptate cumque sit quia eum. website: type: string description: your personal website, github, linkedin, etc example: Quia expedita. example: cover_letter_link: Dignissimos et ea. email: n@0.Mo name: Dicta ipsum aut. phone: "009138884811" resume_link: Necessitatibus laboriosam. website: Minus ipsa eum. required: - email - name - phone - resume_link SubscribeToInstitutionStatusUpdatesRequestBody: type: object properties: email_address: type: string description: Email address of the user to subscribe to institution status updates. example: Cum quae necessitatibus enim ea numquam adipisci. example: email_address: Nobis asperiores quia. required: - email_address TriggerSyncForConsentRequestBody: type: object properties: permissions: type: array items: type: string example: Quo odio. description: The datasets to sync example: - Molestias fuga id exercitationem dolores error. - Soluta accusantium et qui quia repellat et. example: permissions: - Asperiores sit nam alias minima sit et. - Hic aliquid et voluptatum cumque. - Dicta aut voluptatem inventore magni quia animi. UpdateAClientRequestBody: type: object properties: send_email: type: boolean description: Notify client about consent created using email example: true example: send_email: false required: - send_email UpdateClientCustomInstitutionConfigurationRequestBody: type: object properties: client_id: type: string description: the client to create the custom configuration for example: Pariatur quisquam sed ab ipsam aut. industry: type: string description: The industry the custom configuration is for example: Et tempore sint voluptas aut et. institutions: type: array items: $ref: '#/components/schemas/CustomInstitution' description: The list of institutions in the custom configuration example: - id: Velit vitae et perferendis aspernatur itaque quasi. name: Est at et aut dolores non nihil. - id: Velit vitae et perferendis aspernatur itaque quasi. name: Est at et aut dolores non nihil. - id: Velit vitae et perferendis aspernatur itaque quasi. name: Est at et aut dolores non nihil. example: client_id: Vitae enim qui. industry: Esse accusantium rerum. institutions: - id: Velit vitae et perferendis aspernatur itaque quasi. name: Est at et aut dolores non nihil. - id: Velit vitae et perferendis aspernatur itaque quasi. name: Est at et aut dolores non nihil. required: - client_id - industry - institutions UpdateCustomAuthForClientRequestBody: type: object properties: additional_use_cases: type: array items: type: string example: Necessitatibus quia. example: - Culpa error eum aut molestiae blanditiis totam. - Reiciendis non tempora nesciunt et. - Vero esse sed quis voluptatibus in. app_name: type: string example: Rem ut dolorum qui. button_border_radius: type: integer example: 5595743404572975913 format: int64 button_color: type: string example: Molestiae voluptate animi enim. button_text_color: type: string example: Assumenda magni eos non ad. consent_period: type: integer example: 6558175888439730090 format: int64 consent_period_string: type: string example: 1 week enum: - 20 minutes - 1 day - 1 week - 1 month - 3 months - 6 months - 9 months - 12 months - Once-off consumer_type: type: string example: Id quia esse quia vel sapiente. customer_authorization: type: string example: Voluptate atque. data_minimisation: type: string example: Non dolorem ullam atque. history_fetch_period_in_month: type: integer example: 8336683819130658543 format: int64 industry: type: string example: Fuga necessitatibus consequatur culpa et. institution_mode: type: string example: Voluptatem atque non ipsa qui. logo: type: string example: Alias ab harum reiciendis sed voluptas et. main_primary: type: string example: Ut sit velit vel. main_secondary: type: string example: Atque aliquid vero qui. notification_email: type: string example: Ut qui saepe voluptate aliquam ipsum. policy_uri: type: string example: Quo quaerat tempore est et suscipit qui. providers: type: string example: Totam impedit cupiditate. sandbox_enabled: type: boolean example: false scope: type: array items: type: string example: Non sit asperiores voluptate. example: - Itaque voluptatem inventore. - Aut et deserunt. - Accusantium architecto tenetur earum eum consectetur. - Optio error nisi. service_usage_disclosure: type: string example: Et quia non aliquid. show_cdr_footer: type: boolean example: false supporting_parties: type: array items: type: string example: Aut in natus quos expedita. example: - Molestias vero molestias qui molestiae esse non. - Occaecati in. - Molestiae suscipit ea asperiores voluptate tempora. - Magnam iure ut corporis inventore consequatur sed. use_cases: type: array items: type: string example: Quo ipsa ipsa officiis. example: - Quia nobis et. - Accusamus rerum. - Quam aliquam rerum quo. withdraw_consent: type: string example: Ratione aliquam natus aut suscipit error est. example: additional_use_cases: - Saepe fuga consequatur eum et et. - Dignissimos eveniet. app_name: Et accusantium facilis earum sed dolorem. button_border_radius: 113929839841785668 button_color: Fugit reprehenderit. button_text_color: Occaecati cumque reiciendis et sit labore. consent_period: 3191239936819750334 consent_period_string: 12 months consumer_type: Qui sit iure. customer_authorization: Quia aspernatur laudantium. data_minimisation: Eligendi odio accusantium beatae qui autem inventore. history_fetch_period_in_month: 6791912216964873743 industry: Illum neque quia perferendis in odit culpa. institution_mode: Dolore illo eos ipsa sed porro sint. logo: Dolores pariatur quisquam debitis magni doloribus. main_primary: Labore ab non quaerat amet. main_secondary: Eum id perspiciatis quis adipisci aut. notification_email: Voluptates debitis sit porro minima sit reprehenderit. policy_uri: Et culpa. providers: Porro quisquam. sandbox_enabled: true scope: - Consectetur hic omnis. - Molestiae aliquam. service_usage_disclosure: Quaerat ipsam nulla non hic. show_cdr_footer: false supporting_parties: - Qui aut maiores voluptatem nemo autem. - Veniam in et et voluptates. - Praesentium libero et voluptatum non minus laboriosam. use_cases: - Rerum dicta dicta non commodi itaque. - Nam architecto voluptatem accusantium perspiciatis. withdraw_consent: Reprehenderit amet iusto eius mollitia vel. UpdateEndUserRequestBody: type: object properties: abn: type: string description: Australian Business Number (ABN) of the end user if they represent a business example: 51 824 753 556 email: type: string description: An End Users email address. This should be their primary email, as it is used for notifying the End User about their consents. example: john_starmer@gmail.com phone: type: string description: An End Users Phone number in E.164 format example: "+614123456789" session_id: type: string description: ID of the session example: ses-123 example: abn: 51 824 753 556 email: john_starmer@gmail.com phone: "+614123456789" session_id: ses-123 required: - session_id UpdateInstitutionsRequestBody: type: object properties: icon_url: type: string example: banking_Bank Australia_icon_1656329405.png logo_url: type: string example: https://www.bankaust.com.au/globalassets/assets/imagery/logos/bank-australia/ba_horizontal_logo.png example: icon_url: banking_Bank Australia_icon_1656329405.png logo_url: https://www.bankaust.com.au/globalassets/assets/imagery/logos/bank-australia/ba_horizontal_logo.png UpdateWebhookRequestBody: type: object properties: description: type: string description: Description for the webhook example: Aut quasi. endpoint_url: type: string description: URL that the webhook will be sent to example: Sunt voluptates eum. name: type: string description: Name for the webhook example: Inventore earum quaerat quod est. example: description: Autem rerum expedita pariatur blanditiis aliquam. endpoint_url: Sequi nam. name: Quis temporibus minus totam dolor id. Updateclientcustominstitutionconfigurationresponse: type: object properties: message: type: string description: Confirmation the institutions have been updated example: institutions updated description: Updates the list of custom client institutions example: message: institutions updated required: - message Uploadedimageresponse: type: object properties: image_name: type: string example: Soluta assumenda aut modi sunt minus ducimus. example: image_name: Quod eaque amet velit. required: - image_name Webhook: type: object properties: description: type: string description: Description for the webhook example: At et possimus inventore. endpoint_url: type: string description: URL that the webhook will be sent to example: Quasi blanditiis nobis. events: type: array items: type: string example: Qui laboriosam quia. description: Events that the webhook will be subscribed to example: - Suscipit odio non. - Doloremque quam veritatis tempore ipsa non. - Et asperiores nobis. id: type: string description: ID of the webhook example: Expedita sed cumque. name: type: string description: Name for the webhook example: Sed dolore quia dolores. signing_secret: type: string description: Secrete used to sign the payload of the webhook example: Explicabo aut qui illo. team_id: type: string description: TeamID of the webhook example: Nam inventore. updated_at: type: string description: Last updated time of the webhook example: Nihil sapiente consequatur eos autem qui. example: description: Rem itaque in similique recusandae rem. endpoint_url: Voluptatem rerum. events: - Et facere illo. - Sit aliquam incidunt rerum delectus sit perspiciatis. - Voluptates non consequatur. - Iusto beatae amet. id: Explicabo autem quam distinctio. name: Officia aut ratione itaque molestiae. signing_secret: Totam sit facere molestias placeat. team_id: Aliquid dolore. updated_at: At tenetur dolores et explicabo explicabo ut. required: - id - name - description - team_id - events - endpoint_url - updated_at - signing_secret securitySchemes: Token_header_Authorization: type: http scheme: bearer bearerFormat: JWT tags: - name: Public description: APIs intended to be called by Fiskil clients. The details can be found at https://docs.fiskil.com/data-api/api-reference