Sikoia Banking API

openapi: 3.0.1
info:
  title: Sikoia Adverse Media Banking API
  termsOfService: https://sikoia.com/About/Terms
  version: '1.0'
servers:
- url: https://api.sikoia.com
  description: API (Production)
- url: https://oauth2.sikoia.com
  description: Authorization Server (Production)
- url: https://api-staging.sikoia.com
  description: API (Staging)
- url: https://oauth2-staging.sikoia.com
  description: Authorization Server (Staging)
security:
- authorizationHeader: []
- apiKeyHeader: []
tags:
- name: Banking
paths:
  /v2/openbanking:
    post:
      tags:
      - Banking
      summary: Create Open Banking connection
      description: "### Creates a new Open Banking connection request.\r\n\r\nThis generates a URL that takes your end customer through a consent flow to connect their accounts.\r\n\r\nThe `country_code` is optional.  If it is included then your end customer will only be able to select a bank institution from that country.\r\n"
      operationId: POST_v2-openbanking
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.CreateTokenRequest'
            example:
              entity_id: 78662640-73fc-4fa9-8367-ef4660d35cee
              entity_type: company
              country_code: GB
      responses:
        '201':
          description: The Token Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.CreateTokenResponse'
              example:
                bank_connection_id: e81154bd-f85f-4223-8b4f-36643843fa99
                bank_connection_url: https://verify.sikoia.com/openbanking/123456
                entity_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                entity_type: company
                datetime_requested: '2024-02-12T04:21:07.0000000+00:00'
                datetime_refreshed: '2024-02-11T04:21:07.0000000+00:00'
                datetime_connected: '2024-02-14T04:21:07.0000000+00:00'
                datetime_expiry: '2024-05-12T04:24:34.0000000+00:00'
                status: Connected
                country_code: GB
                institution_name: Sandbox
                institution_logo: https://logolink.com
                account_connection_ids: '["820eec09-dbdd-4c90-b0f2-acbca66f1ad5", "132d3353-ad29-46e0-b66a-caed8b572e93", "93886787-3307-4319-afa7-48540bf21362"]'
                source: Document
                document_id: r51154bd-f85f-4223-8b4f-36643843fa33
        '400':
          description: Invalid Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: 26adafd9-9c08-4ec2-8532-251f771630ef
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: b747b03f-caaf-42f8-b04b-2d4427f2dbec
        '404':
          description: Entity ID or Type Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id f6566eff-e7de-4437-afec-754d6842d1e0.
                correlation_id: 7b3e3dee-48ad-426b-9b60-1f744fa73006
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 6fc274ac-f322-48a8-8acb-b276b5beafab
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: b988cbda-f68a-4d49-b14d-2ca90810b0e3
  /v2/openbanking/{bank_connection_id}:
    get:
      tags:
      - Banking
      summary: Retrieve Open Banking connection status
      description: "### Returns an Open Banking connection status.\r\n\r\nThis endpoint returns the status of the Open Banking connection, revealing the state of the end customer consent flow.\r\n\r\nIt will also return a list of connected accounts once the connection has been successfully established.\r\n"
      operationId: GET_v2-openbanking-bank_connection_id
      parameters:
      - name: bank_connection_id
        in: path
        description: Bank Connection Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieved Open Banking Connection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.CreateTokenResponse'
              example:
                bank_connection_id: e81154bd-f85f-4223-8b4f-36643843fa99
                bank_connection_url: https://verify.sikoia.com/openbanking/123456
                entity_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                entity_type: company
                datetime_requested: '2024-02-12T04:21:07.0000000+00:00'
                datetime_refreshed: '2024-02-11T04:21:07.0000000+00:00'
                datetime_connected: '2024-02-14T04:21:07.0000000+00:00'
                datetime_expiry: '2024-05-12T04:24:34.0000000+00:00'
                status: Connected
                country_code: GB
                institution_name: Sandbox
                institution_logo: https://logolink.com
                account_connection_ids: '["820eec09-dbdd-4c90-b0f2-acbca66f1ad5", "132d3353-ad29-46e0-b66a-caed8b572e93", "93886787-3307-4319-afa7-48540bf21362"]'
                source: Document
                document_id: r51154bd-f85f-4223-8b4f-36643843fa33
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: dba18918-728e-4547-af42-8dc770613c0c
        '404':
          description: Bank Connection ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 0e4a8ab3-2d28-411a-acd8-55106076bda2.
                correlation_id: 5b68753e-ee86-4ba2-ac94-1ab5c58342a1
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 2e7f1bec-f9b0-40be-887c-610b06c9a3e2
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: f8b87f95-c0be-4ad3-bf02-bd3e36d1aa32
    delete:
      tags:
      - Banking
      summary: Delete an Open Banking connection
      description: "### Deletes an existing Open Banking connection\r\n\r\nThis also deletes all of the associated account, balance, and transaction data for the Open Banking connection.\r\n\r\nPlease note that this action cannot be undone.\r\n"
      operationId: DELETE_v2-openbanking-bank_connection_id
      parameters:
      - name: bank_connection_id
        in: path
        description: Bank Connection Id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully Deleted Open Banking connection
        '400':
          description: Open Banking connection Deleted/Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidRequest
                status: 400
                title: Validation Errors
                detail: Entity Id is required.
                correlation_id: 45be1c62-2c31-4809-9ab7-68ffbfc05009
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 1b324e61-e778-479a-8172-a184a4555587
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 1be35715-d9ad-48f9-8683-c14ccba45e19
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 25741886-17c7-49c6-ba07-c7e73cd4c01e
  /v2/{entity_type}/{entity_id}/openbanking:
    get:
      tags:
      - Banking
      summary: List all Open Banking connections
      description: "### Returns a list of all open banking connections requested for an entity.\r\n\r\nThis list includes `bank_connection_id` and associated `account_connection_id`, which can be used to retrieve more detailed account data.\r\n\r\nInclude the query parameter completed with a value of `true` if you only want to retrieve completed connections.\r\n"
      operationId: GET_v2-entity_type-entity_id-openbanking
      parameters:
      - name: entity_type
        in: path
        description: Entity Type
        required: true
        schema:
          enum:
          - Companies
          - Persons
          - Cases
          type: string
      - name: entity_id
        in: path
        description: Entity ID
        required: true
        schema:
          type: string
      - name: completed
        in: query
        description: Return complete/incomplete/all OB Connections
        schema:
          type: boolean
      responses:
        '200':
          description: List of Open Banking Connections
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.CreateTokenResponse'
              example:
              - bank_connection_id: e81154bd-f85f-4223-8b4f-36643843fa99
                bank_connection_url: https://verify.sikoia.com/openbanking/123456
                entity_id: 78662640-73fc-4fa9-8367-ef4660d35cee
                entity_type: company
                datetime_requested: '2024-02-12T04:21:07.0000000+00:00'
                datetime_refreshed: '2024-02-11T04:21:07.0000000+00:00'
                datetime_connected: '2024-02-14T04:21:07.0000000+00:00'
                datetime_expiry: '2024-05-12T04:24:34.0000000+00:00'
                status: Connected
                country_code: GB
                institution_name: Sandbox
                institution_logo: https://logolink.com
                account_connection_ids: '["820eec09-dbdd-4c90-b0f2-acbca66f1ad5", "132d3353-ad29-46e0-b66a-caed8b572e93", "93886787-3307-4319-afa7-48540bf21362"]'
                source: Document
                document_id: r51154bd-f85f-4223-8b4f-36643843fa33
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 9ea93a05-8486-4ea4-b326-7155d11e3696
        '404':
          description: Entity ID or Type Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 875a09f4-0ef7-4026-a839-77b54f941166.
                correlation_id: aa910e9b-fb08-4faa-9b49-7f0ad79a1f6f
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 27b878d6-acca-49a7-a638-d83a07b870e5
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 3ade176a-f5e5-4566-9281-1bba5f022f6c
  /v2/bankaccounts/{account_connection_id}:
    get:
      tags:
      - Banking
      summary: Retrieve account details
      description: "### Returns detailed account data.\r\n\r\nFetches the account details for a specific `account_connection_id` covering accounts connected through open banking or those for which bank statements have been uploaded.\r\n"
      operationId: GET_v2-bankaccounts-account_connection_id
      parameters:
      - name: account_connection_id
        in: path
        description: Account Connection Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Account Details Retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.GetAccountDetailsResponse'
              example:
                account_connection_id: 132d3353-ad29-46e0-b66a-caed8b572e93
                account_type: CREDIT_CARD
                status: Connected
                currency: GBP
                owners_name: '["Acme Inc"]'
                identifications:
                - type: SORT_CODE
                  value: '100001'
                bank_connection_id: e81154bd-f85f-4223-8b4f-36643843fa99
                datetime_last_refreshed: '2024-02-12T04:28:00.0000000+00:00'
                datetime_connected: '2024-02-12T04:24:50.0000000+00:00'
                datetime_expiry: '2024-05-12T04:24:34.0000000+00:00'
                country_code: GB
                institution_logo: https://logolink.com
                institution_name: Sandbox
                source: Document
                document_id: r51154bd-f85f-4223-8b4f-36643843fa33
                data_source_id: 01951375-a680-77ce-b196-44d1feedc47c
                full_address: Flat 23, 49 Sample Street, London
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: df6a0d9a-046f-47e7-8a78-ee91ba629e13
        '404':
          description: Account Connection ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 616ee00a-fbd6-4706-ba79-e7be3a71837a.
                correlation_id: 731be44f-376b-4be0-ba1e-c794de930d41
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: d94609b6-a46b-47fa-b4fd-ebf265991a96
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: f8687c0d-2c03-4737-aa3e-3d74c15b27ff
  /v2/{entity_type}/{entity_id}/bankaccounts:
    get:
      tags:
      - Banking
      summary: List all accounts
      description: "### Returns a list of all bank accounts for an entity.\r\n\r\nProvides a comprehensive list of all bank accounts associated with an entity. This includes accounts connected through open banking or for which bank statements have been uploaded.\r\n\r\nThis list includes the account_connection_id for each account, which can be used to retrieve more detailed data from the following endpoints:\r\n*`GET /v2/bankaccounts/{account_connection_id}`\r\n*`GET /v2/bankaccounts/{account_connection_id}/balances`\r\n*`GET /v2/bankaccounts/{account_connection_id}/transactions`\r\n"
      operationId: GET_v2-entity_type-entity_id-bankaccounts
      parameters:
      - name: entity_type
        in: path
        description: Entity Type
        required: true
        schema:
          enum:
          - Companies
          - Persons
          - Cases
          type: string
      - name: entity_id
        in: path
        description: Entity ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of Accounts Retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.GetAccountDetailsResponse'
              example:
              - account_connection_id: 132d3353-ad29-46e0-b66a-caed8b572e93
                account_type: CREDIT_CARD
                status: Connected
                currency: GBP
                owners_name: '["Acme Inc"]'
                identifications:
                - type: SORT_CODE
                  value: '100001'
                bank_connection_id: e81154bd-f85f-4223-8b4f-36643843fa99
                datetime_last_refreshed: '2024-02-12T04:28:00.0000000+00:00'
                datetime_connected: '2024-02-12T04:24:50.0000000+00:00'
                datetime_expiry: '2024-05-12T04:24:34.0000000+00:00'
                country_code: GB
                institution_logo: https://logolink.com
                institution_name: Sandbox
                source: Document
                document_id: r51154bd-f85f-4223-8b4f-36643843fa33
                data_source_id: 01951375-a680-77ce-b196-44d1feedc47c
                full_address: Flat 23, 49 Sample Street, London
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: b89a5490-4bf4-4aba-984d-3b39b1580c9e
        '404':
          description: Entity ID or Entity Type Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 48a668b7-0d22-4924-aa4f-a30d6363963f.
                correlation_id: fcdd14a2-79a0-4f9b-bb3a-8f87eb54fbde
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 39deb474-0600-4a03-b763-153ea6b6f75a
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 21234e98-6397-456d-9691-6dfe688aabcf
  /v2/bankaccounts/{account_connection_id}/balances:
    get:
      tags:
      - Banking
      summary: Retrieve account balances
      description: "### Returns bank account balances.\r\n\r\nFetches the account balance details for a specific `account_connection_id` covering accounts connected through open banking or those for which bank statements have been uploaded.\r\n"
      operationId: GET_v2-bankaccounts-account_connection_id-balances
      parameters:
      - name: account_connection_id
        in: path
        description: Account Connection Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Account Balances Retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.AccountBalancesResponse'
              example:
                account_connection_id: 132d3353-ad29-46e0-b66a-caed8b572e93
                balances:
                - type: CLOSING_AVAILABLE
                  amount:
                    value: '1528-08-01'
                    currency: USD
                  date: '2024-02-12T16:24:50.1490000+00:00'
                datetime_refreshed: '2024-02-12T04:25:09.0000000+00:00'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 35e72111-9c05-4843-8f37-13c56ece25b6
        '404':
          description: Account Connection ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id fccb194f-5c85-4f6c-8548-ec58106ac3c1.
                correlation_id: 3e4e883a-7b12-4500-b62a-66cf9f0aee33
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 50794c6f-cc99-4bbc-9c8e-4b9649e84f96
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 89deb46e-1126-4bbd-888f-3179d329d467
  /v2/bankaccounts/{account_connection_id}/transactions:
    get:
      tags:
      - Banking
      summary: Retrieve account transactions
      description: "### Returns detailed bank account transaction data.\r\n\r\nFetches a list off all available transactions for a specific `account_connection_id` covering accounts connected through open banking or those for which bank statements have been uploaded.\r\n"
      operationId: GET_v2-bankaccounts-account_connection_id-transactions
      parameters:
      - name: account_connection_id
        in: path
        description: Account Connection Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Account Balances Retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.AccountTransactionsResponse'
              example:
                account_connection_id: 132d3353-ad29-46e0-b66a-caed8b572e93
                transactions:
                - transaction_id: 0730deba-767a-4c40-bc89-ac7c96e5a1c9
                  date: '2024-02-12T02:57:24.0000000+00:00'
                  booking_datetime: '2024-02-12T02:57:24.0000000+00:00'
                  value_date_time: '2024-02-12T02:57:24.0000000+00:00'
                  status: PENDING
                  amount:
                    amount: '-1.1'
                    currency: GBP
                  currency: GBP
                  reference: Acme123Ltd
                  description: 1B8BAA320D3E4BFAB8B32495157B3604
                  merchant:
                    merchant_name: string
                    merchant_category: string
                  iso_bank_transaction_code:
                    domain_code:
                      code: PMNT
                      name: Payments
                    family_code:
                      code: PMNT
                      name: Payments
                    sub_family_code:
                      code: PMNT
                      name: Payments
                  proprietary_bank_transaction_code:
                    code: open-banking-sip-Debit
                    issuer: ozone
                datetime_refreshed: '2024-02-12T03:34:25.0000000+00:00'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: InvalidToken
                status: 401
                title: Invalid Token
                detail: Invalid token
                correlation_id: 6afe5488-dfa0-4fee-803f-ce31b471ce17
        '404':
          description: Account Connection ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ResourceNotFound
                status: 404
                title: Resource Not Found
                detail: No resources found with id 3db67787-8bb1-42b2-bab2-19cc165a558c.
                correlation_id: 2554038b-b911-4263-8064-07a86ba471a6
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: RateLimit
                status: 429
                title: Too Many Requests
                detail: You've exceeded the maximum API request limit per minute. Please try again later.
                correlation_id: 3c4294c9-6a34-46be-9e6b-ac3344066caa
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaCore.Common.SikoiaErrorResponse'
              example:
                type: ServerError
                status: 500
                title: Internal Server Error
                detail: Something has gone wrong, please try again
                correlation_id: 44e146ba-a608-4f4c-84f9-a8c16f1ade42
  /v2/bankaccounts/{account_connection_id}/refresh:
    post:
      tags:
      - Banking
      summary: Refresh an account
      description: "### Initiates a refresh of account data.\r\n\r\nTriggers an asynchronous refresh of the account details, balances and transactions for a specific Open Banking `account_connection_id`.\r\n"
      operationId: POST_v2-bankaccounts-account_connection_id-refresh
      parameters:
      - name: account_connection_id
        in: path
        description: Account Connection Id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Account Details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SikoiaSharedModels.OpenBanking.OpenBanking.GetAccountDetailsResponse'
              example:
                account_connection_id: 132d3353-ad29-46e0-b66a-caed8b572e93
                account_type: CREDIT_CARD
                status: Connected
                currency: GBP
                owners_name: '["Acme Inc"]'
                identifications:
                - type: SORT_CODE
                  value: '100001'
                bank_connection_id: e81154bd-f85f-4223-8b4f-36643843fa99
                datetime_last_refreshed: '2024-02-12T04:28:00.0000000+00:00'
                datetime_connected: '2024-02-12T04:24:50.0000000+00:00'
        

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sikoia/refs/heads/main/openapi/sikoia-banking-api-openapi.yml