---
updatedAt: 2026-06-03T11:10:13.000Z
agentTools:
  projectIndex: https://docs-us.thisisbud.com/llms.txt
---

# Retrieve Revoke Consent Status

Check the status and result of a Revoke Consent task. 

Use the `task_id` taken from a successful `Initiate Revoke Consent` request.


# OpenAPI definition

````json
{
  "openapi": "3.0.3",
  "info": {
    "version": "1.0.0",
    "title": "Connect API",
    "contact": {
      "name": "API Support",
      "url": "http://www.thisisbud.com/support",
      "email": "contact@thisisbud.com"
    },
    "x-logo": {
      "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAATAAAABuCAQAAAAKAYdLAAAACXBIWXMAAC4jAAAuIwF4pT92AAAAB3RJTUUH4wQDDggcbXcx7wAABeJJREFUeNrt3W2IFVUcx/HvXRW1VdQedy1bZVfoYX0osVQyfSGElKbRA5oFIaIlhAkWUYm6gvqqDMHMoBeKlhayCCZC2AMRPay7aJrSZmauZhQqaj7t7u1Fi965987s7D1n7pk7/j73zX2Y85//mXt2Zu45Z2ZBREREREREREREREREREREREREREREREREREREREREREREREREROIiZSFGH+YxgsOs5U/X1bFiPDPpQT3bu1DmcaZyg+vErWpjD+s47zoN6Mte0qRJc4Iq18lYMJv2jvosD11mRUeJpD32UO7664BFGQl94DoZY704fbU2rQwKVWYwbc6bQlSPBaYbtMz4K7nP53lpGkK/q8+7MTxUmeEWtmJcGX+j5psmM0I3l9vCirKAV36OuE46QsbfaHL/9opnL9tcpxBf3V0nkAgzWMRj9HadhrH+3Gk7pBqYDZdY3oXfnHE2gc1U2gyoQ6Rk+pKZdgOqgYnXF7TYDGe3gcWgW85QH9cJxMAVm8HsNrBqhhV1U9g33XUCzo1gsM1wdhtYio8ZWsytYdksFrpOwbGhbLYb0PavyLs5wA+c9v28lRa+Zzt/+y5RwwKqaOCdgCjZRvEit/A1a7jou8xwJjOMAb7D+ylqqCmw1imeZ0oCBrv7Mzp+/QofFTDCdZG13Jw3Wi1nOpbZT9+QGUziUkeZ3T49z+P4pqCRuCkhM1jjfMwwqsdG182rsAaWJs0JxuWJ9knGEq+EzODHjDLTcj5NsbjgwehwDazm6vyL5D2MG5i7booKdjE25917M57XhoxUG1hmJUsjrmWtlVl18ZQ2DeCyH6ycT7kpIJ+wuQWVeZJXI69HcpsXHDQN4LajtZIlkcbvzWqn9St1R3nPNIT93wzt/MSZPO+nqKA65699Nos5FdHmgZkMzHnvIj9zLm9+Q7jd0nqP8VtkdSqWNppYxT+u08g+yW8OnKRXw4ac08hnPUscyvjkw5AZXM4os9jzyY6sdZ3h5YC++jLm0lrASf50T5krzEn0QbOLbB8in2FvwKfNPJczCXd0hLV7wPPqL8bybt691//aWWfhkPo2681PjZPDbgP7lYZOl1nNJs9rW4elXD2zfkK8wIFOy2w1XuuWyOpTkuw2sHOhlqrzvIqu59gbuYEdIcqcjSyb65SLX5EHOepgrbuKtJ6nHNQtxtx0U5xM8DoXMkez7K5xM7Tp4iS4WOvszvss5feSP9Fvo5EVnDDfHGJfpd157Y48xFRGmfaEaWcu/qqYZxpCDcxcqR8Mg9xlGkANzNz+BDcx4zEJNTBzv5gPCSeXTvJtmM+3PJqIKdNj6GE3pJsG5mIwOMp1ptnABgd1sq+G7ebnXZncHCKjG3+M1zpLTzMz7AZ00cBG5pmlFb3JmkQTSpPd21HZbWD9Qy21zPPK/zricNH6+B7mvZFreTpEtAFWt0dpsnoWZreBVTG+kyVS1GVN4/vDd9lJVIRY5yzfPdPlrPHHdTwYItr1bkLcTia8M1qPM9F3yRRjcuaYprNmHxzyfNbQyQlnGTM47ynhndFan7WuCywLODz35I2sC9DCXheZHBNpsXvZmu1fkZXs5rjPnPzb8hyAzrIzINr9HOBIwNXat+ZcleS1hame1714izc55jNvbVDBtz7pyWuJuI15P/tnx1F0UwzsQpprO5nil2KIQSZbqcspnwp57+iu2MQT1mMmhNue/MMR3xfwMi8VYRhnmJqXP/MG1lZwyVNMy9l/FR4tf/mdvB553Uz2sXFn+n1YaGCNBZZr5mH25by7xzCb3PKrmM+lgmK1BV4hdc0+2g2zjq8m1wlAOY1dvqXGKep87oZYzUmDW3Vs8+myuIf6Am6AsiT0Nljp/CYl0Twaze9ZaaN3u5w5jAy5L2ylhe/4nAu+S1Qwl+oCsrjCV2wM2KXfwSPUcmPIGv9LPZ91Ye1TEnEb80ztNLE+Dv8MS0RERERERERERERERERERERERERERERERERERERERERERERERERs+Q/rhi5WauEgfQAAAABJRU5ErkJggg=="
    },
    "description": "These endpoints handle the connections to banking providers and the ingestion of first party transaction data. Bud manages all of the connections to each of the individual providers and enables access to all of the providers via a single set of API endpoints.\n\nBud currently supports three methods of connecting your customers data to the Bud platform:\n\n  1. You can use the [__Bud Connect__](#operation/v2_ob_authorisation_gateway_url_post) endpoint which returns a link to Bud’s pre-built customer connection journey that can be configured to your brand.\n\n  2. If you have your own license you can choose to host the customer connection journey yourself, using [Bud's APIs](#operation/open_banking_authorisation_url_post) to create the connection. __If you are an agent of Bud but feel that your application could benefit from a more native feel please talk to your Bud Account Manager or email help@thisisbud.com for further details.__\n\n  3. If you already have transactional data that you’re looking to enrich, you can use Bud’s [Ingest Endpoints](#tag/Ingest-Data) to push your data onto the Bud platform without needing your customers to connect their accounts \n  \nNote: a number of the calls within this service are asynchronous, and as such, follow a pattern of sending a request and responding with a task ID. This task ID can then be tracked, allowing for a more efficient, cross network implementation.\n"
  },
  "tags": [
    {
      "name": "Create a Connection",
      "x-displayName": "Create a Connection",
      "description": "Create a new connection to a Banking provider by using either: (i) Bud's configurable frontend UI (__Bud Connect__), built to maximise conversion; or (ii) Bud's individual API endpoints to help you build your own connect flow.\n"
    },
    {
      "name": "Manage a Connection",
      "x-displayName": "Manage a Connection",
      "description": "Different endpoints that allow to to manage an existing customer connection. This includes the ability to:\n  (i) Refresh the data associated with a given connection, pulling in the latest account \n      information into the Bud platform;\n  (ii) Renew an existing consent  by-passing the need to go through Strong Customer \n      Authentication (SCA) with their bank;\n  (iii) Revoke a consent, removing the ability for Bud to fetch any further data associated\n      with that consent.\n"
    },
    {
      "name": "Ingest First Party Data",
      "x-displayName": "Ingest First Party Data",
      "description": "Initiate the asynchronous process of pushing a customer's account information (i.e. first party data) onto the Bud platform. These asynchronous requests create a task to store the given accounts or transactions against the specified customers. The Task ID returned by this request can be used to verify the current status of the process.\n"
    }
  ],
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "servers": [
    {
      "url": "https://api-sandbox.thisisbud.com",
      "description": "Bud sandbox"
    }
  ],
  "paths": {
    "/v1/open-banking/providers": {
      "get": {
        "tags": [
          "Create a Connection"
        ],
        "summary": "Retrieve Bank Providers",
        "description": "List the available bank providers with their name, icon and maintenance status.\n",
        "operationId": "open_banking_providers_get",
        "security": [
          {
            "OAuth2": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/paths/~1v2~1ingest~1accounts/post/parameters/0"
          },
          {
            "in": "query",
            "required": false,
            "name": "region",
            "description": "A comma separated list of Bud regions to be shown. If no filter is applied, all the providers are returned.",
            "schema": {
              "type": "string",
              "enum": [
                "USA"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of providers available via Bud's Bank Aggregation APIs",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "operation_id",
                    "data"
                  ],
                  "properties": {
                    "operation_id": {
                      "title": "Operation Id Field",
                      "type": "string",
                      "description": "A unique identifier/reference associated with a given endpoint/operation"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "title": "Open Banking Providers",
                        "type": "object",
                        "required": [
                          "provider",
                          "display_name",
                          "maintenance_window",
                          "maintenance_status",
                          "icon",
                          "regions",
                          "mobile_only"
                        ],
                        "properties": {
                          "provider": {
                            "type": "string",
                            "description": "The name of the available open banking provider used as an identifier throughout Bud's API services"
                          },
                          "display_name": {
                            "type": "string",
                            "description": "The name of the available open banking provider used for display purposes"
                          },
                          "maintenance_window": {
                            "anyOf": [
                              {
                                "title": "Maintenance Window Object",
                                "type": "object",
                                "description": "Details on any scheduled maintenance windows",
                                "properties": {
                                  "start": {
                                    "type": "string",
                                    "description": "The start datetime (ISO8601) of the maintenance window"
                                  },
                                  "end": {
                                    "type": "string",
                                    "nullable": true,
                                    "description": "The end datetime (ISO8601) of the maintenance window. When this value is `null` it means Bud will manually remove the maintenance flag when the provider is back healthy."
                                  }
                                }
                              },
                              {
                                "type": "object",
                                "nullable": true
                              }
                            ]
                          },
                          "maintenance_status": {
                            "type": "string",
                            "description": "The status of the maintenance window associated with the provider",
                            "enum": [
                              "active",
                              "inactive"
                            ]
                          },
                          "icon": {
                            "type": "string",
                            "description": "A URL for the icon of the corresponding provider"
                          },
                          "regions": {
                            "type": "array",
                            "description": "A list of the different regions (i.e. country codes in ISO 3166 format) associated with the open banking provider",
                            "items": {
                              "type": "string"
                            }
                          },
                          "mobile_only": {
                            "type": "boolean",
                            "description": "If true, the provider is only available on mobile devices and requires a dedicated provider app to be installed on the device"
                          }
                        }
                      }
                    },
                    "metadata": {
                      "oneOf": [
                        {
                          "title": "Results Metadata Object",
                          "type": "object",
                          "description": "Metadata associated with the response schema",
                          "properties": {
                            "results": {
                              "type": "number",
                              "description": "The number of results returned"
                            }
                          }
                        },
                        {
                          "type": "object",
                          "nullable": true
                        }
                      ]
                    }
                  },
                  "example": {
                    "operation_id": "open_banking_providers_get",
                    "data": [
                      {
                        "provider": "citi",
                        "display_name": "Citibank",
                        "maintenance_window": {
                          "start": "2024-01-07T11:48:00+0000",
                          "end": "2024-01-08T11:48:00+0000"
                        },
                        "maintenance_status": "active",
                        "icon": "https://assets.thisisbud.com/example-icon",
                        "regions": [
                          "USA"
                        ],
                        "mobile_only": false
                      },
                      {
                        "provider": "chase",
                        "display_name": "Chase",
                        "maintenance_window": null,
                        "maintenance_status": "inactive",
                        "icon": "https://assets.thisisbud.com/example-icon",
                        "regions": [
                          "USA"
                        ],
                        "mobile_only": false
                      },
                      {
                        "provider": "bankofamerica",
                        "display_name": "Bank of America",
                        "maintenance_window": null,
                        "maintenance_status": "inactive",
                        "icon": "https://assets.thisisbud.com/example-icon",
                        "regions": [
                          "USA"
                        ],
                        "mobile_only": false
                      },
                      {
                        "provider": "capitalone",
                        "display_name": "Capital One",
                        "maintenance_window": null,
                        "maintenance_status": "inactive",
                        "icon": "https://assets.thisisbud.com/example-icon",
                        "regions": [
                          "USA"
                        ],
                        "mobile_only": false
                      },
                      {
                        "provider": "wellsfargo",
                        "display_name": "Wells Fargo",
                        "maintenance_window": null,
                        "maintenance_status": "inactive",
                        "icon": "https://assets.thisisbud.com/example-icon",
                        "regions": [
                          "USA"
                        ],
                        "mobile_only": false
                      },
                      {
                        "provider": "pnc",
                        "display_name": "PNC Bank",
                        "maintenance_window": null,
                        "maintenance_status": "inactive",
                        "icon": "https://assets.thisisbud.com/example-icon",
                        "regions": [
                          "USA"
                        ],
                        "mobile_only": false
                      },
                      {
                        "provider": "fidelity",
                        "display_name": "Fidelity",
                        "maintenance_window": null,
                        "maintenance_status": "inactive",
                        "icon": "https://assets.thisisbud.com/example-icon",
                        "regions": [
                          "USA"
                        ],
                        "mobile_only": false
                      },
                      {
                        "provider": "td",
                        "display_name": "TD Bank",
                        "maintenance_window": null,
                        "maintenance_status": "inactive",
                        "icon": "https://assets.thisisbud.com/example-icon",
                        "regions": [
                          "USA"
                        ],
                        "mobile_only": false
                      },
                      {
                        "provider": "usbank",
                        "display_name": "US Bank",
                        "maintenance_window": null,
                        "maintenance_status": "inactive",
                        "icon": "https://assets.thisisbud.com/example-icon",
                        "regions": [
                          "USA"
                        ],
                        "mobile_only": false
                      },
                      {
                        "provider": "transamerica",
                        "display_name": "Transamerica",
                        "maintenance_window": null,
                        "maintenance_status": "inactive",
                        "icon": "https://assets.thisisbud.com/example-icon",
                        "regions": [
                          "USA"
                        ],
                        "mobile_only": false
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request contains an invalid payload."
          },
          "401": {
            "description": "Unauthorized (BearerToken in 'Authorization' header fails the authentication)"
          },
          "5XX": {
            "description": "An unexpected error occurred on the server side"
          }
        }
      }
    },
    "/v1/open-banking/refresh": {
      "post": {
        "deprecated": true,
        "tags": [
          "Manage a Connection"
        ],
        "summary": "Initiate Refresh",
        "description": "Instruct Bud to retrieve the latest account information for a customer. Refresh the accounts from a single provider with an existing connection.\n\nBy default this task will retrieve transactions since the last pull of transactions less seven days. This can be overridden using the `from` body parameter to a maximum of 90 days previously.\n\nAfter initiating this long running process, make sure to check the status of the it till completion before trying to access the Customer's data or initiating another refresh.\n\nIf the customer's provider was fetched (connect or refresh) within the last hour, the endpoint will return the task_id of the previous task instead of refreshing the data again.\n\nIf the customer's consent has been revoked or expired for this provider, Bud will be unable to refresh the account. \nThis will be confirmed in the response of the refresh status endpoint associated with the `task_id` provided in the response to this endpoint, where the `reconnect_required` field will set to `true` and status set to `Completed`.\n",
        "operationId": "open_banking_refresh_post",
        "security": [
          {
            "OAuth2": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/paths/~1v2~1ingest~1accounts/post/parameters/0"
          },
          {
            "in": "header",
            "name": "X-Customer-Id",
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "required": true,
            "description": "A unique identifier for a Customer, as registered on Bud's platform.",
            "example": "c3339af9-2426-44d4-9c4d-ddb8fd281e23"
          },
          {
            "in": "header",
            "name": "X-Customer-Idempotent-Identifier",
            "schema": {
              "type": "string"
            },
            "description": "Use the internal client identifier, provided in the `client_metadata` object when creating the customer in __Create Customer V3__, in place of an `X-Customer-Id` header.\n"
          },
          {
            "in": "header",
            "name": "X-Customer-Ip-Address",
            "schema": {
              "type": "string"
            },
            "required": true,
            "description": "The IP address of the personal device the customer is initiating the refresh from.\nThis header should _only_ be supplied if the customer has initiated the refresh from a personal device, and never if the refresh has been initated from an automated process such as a script.\nThe IP address is forwarded to the provider and can help avoid hitting limits on how frequently a refresh can be initiated.\n"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "title": "Open Banking Refresh Payload",
                "type": "object",
                "description": "Expected request payload structure",
                "required": [
                  "provider"
                ],
                "properties": {
                  "provider": {
                    "type": "string",
                    "description": "The name of the provider the task is trying to connect to"
                  },
                  "from": {
                    "type": "string",
                    "description": "The datetime (ISO 8601) that defines the time since when the Customer's data needs to be collected.\nDefaults to the datetime of the last pull of transactions less seven days to account for any potential changes to the most recent set of transactions.\nRefreshes can only go back to a maximum of 90 days from the current date.\n"
                  },
                  "to": {
                    "type": "string",
                    "description": "The datetime (ISO 8601) that defines the time up to which the Customer's data needs to be collected. Defaults to the current datetime.\nRefreshes can only go back to a maximum of 90 days from the current date.\n"
                  }
                }
              },
              "example": {
                "provider": "citi",
                "from": "2019-03-01T00:00:00+00:00",
                "to": "2019-06-01T00:00:00+00:00"
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "A new Task has been generated to request the Customer's bank account refresh. The generated `task_id` can be used to check the Task's status.",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Task Created Response",
                  "type": "object",
                  "description": "Expected response structure",
                  "required": [
                    "operation_id",
                    "data",
                    "metadata"
                  ],
                  "properties": {
                    "operation_id": {
                      "$ref": "#/paths/~1v1~1open-banking~1providers/get/responses/200/content/application~1json/schema/properties/operation_id"
                    },
                    "data": {
                      "title": "Task Created View",
                      "description": "Standard successful task created response.",
                      "type": "object",
                      "required": [
                        "task_id",
                        "provider"
                      ],
                      "properties": {
                        "task_id": {
                          "$ref": "#/paths/~1v1~1open-banking~1account-access-consent~1revoke~1{task_id}/get/responses/200/content/application~1json/schema/properties/data/properties/task_id"
                        },
                        "provider": {
                          "type": "string",
                          "description": "The provider (ASPSP) associated with this task"
                        }
                      }
                    },
                    "metadata": {
                      "title": "Async Task Metadata",
                      "type": "object",
                      "description": "Metadata associated with an asynchronous task",
                      "properties": {
                        "status": {
                          "type": "string",
                          "description": "The status of the job associated with the specified task id",
                          "enum": [
                            "Completed",
                            "Pending",
                            "Failed"
                          ]
                        },
                        "next_url": {
                          "type": "string",
                          "description": "The URL to call to obtain the results of the task"
                        },
                        "next_url_delay": {
                          "type": "number",
                          "description": "The time in milliseconds that the client should wait before polling the relevant GET endpoint with the above task id"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "operation_id": "open_banking_refresh_post",
                  "data": {
                    "provider": "citi",
                    "task_id": "360e5821-4f18-4077-83f4-c9a7c1768bea"
                  },
                  "metadata": {
                    "next_url": "/v1/open-banking/refresh/360e5821-4f18-4077-83f4-c9a7c1768bea",
                    "next_url_delay": 50,
                    "status": "Pending"
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request contains an invalid payload.",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Bad Request Response",
                  "type": "object",
                  "description": "Expected response structure",
                  "required": [
                    "operation_id",
                    "code_id",
                    "message",
                    "errors"
                  ],
                  "properties": {
                    "operation_id": {
                      "$ref": "#/paths/~1v1~1open-banking~1providers/get/responses/200/content/application~1json/schema/properties/operation_id"
                    },
                    "code_id": {
                      "type": "string",
                      "description": "A descriptive enough string that is linked to the reason for the error."
                    },
                    "message": {
                      "type": "string"
                    },
                    "errors": {
                      "anyOf": [
                        {
                          "title": "Error Object",
                          "type": "object",
                          "nullable": true,
                          "description": "Contains a field specific error message",
                          "additionalProperties": {
                            "type": "string"
                          }
                        },
                        {
                          "title": "Array of Error Object",
                          "description": "Contains a list of error messages",
                          "type": "object",
                          "additionalProperties": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          }
                        }
                      ]
                    }
                  }
                },
                "examples": {
                  "Parameter missing": {
                    "value": {
                      "operation_id": "open_banking_refresh_post",
                      "code_id": "failed_validation",
                      "message": "Failed validation",
                      "errors": {
                        "customer_id": "This value should not be blank"
                      }
                    }
                  },
                  "Provider in Maintenance": {
                    "value": {
                      "operation_id": "open_banking_refresh_post",
                      "code_id": "provider_maintenance",
                      "message": "The provider is in maintenance.",
                      "errors": {
                        "provider": "The provider is currently disabled due to planned maintenance or known issues."
                      }
                    }
                  }
                }
              }
            }
          },
          "405": {
            "description": "The request uses an unexpected HTTP method"
          },
          "5XX": {
            "description": "An unexpected error occurred on the server side"
          }
        },
        "callbacks": {
          "RefreshCompletedCallBack": {
            "{$request.body#/redirect_url}": {
              "description": "This callback is sent to your configured 'Aggregator refresh completed' webhook URL on the completion of a connect task.\n",
              "post": {
                "security": [],
                "parameters": [
                  {
                    "$ref": "#/paths/~1v2~1ingest~1accounts/post/callbacks/FPIIngestFailedCallback/{$request.body#~1redirect_url}/post/parameters/0"
                  },
                  {
                    "$ref": "#/paths/~1v2~1ingest~1accounts/post/callbacks/FPIIngestFailedCallback/{$request.body#~1redirect_url}/post/parameters/1"
                  }
                ],
                "summary": "Refresh Completed Notification Callback",
                "requestBody": {
                  "required": true,
                  "description": "This callback is sent to your configured 'Aggregator refresh completed' webhook URL on the completion of a refresh task.",
                  "content": {
                    "application/json": {
                      "schema": {
                        "title": "OB Webhook Payload",
                        "type": "object",
                        "description": "The payload sent to the client defined webhook (via the console) when an Open Banking (connect or refresh) task completes.\n",
                        "required": [
                          "data"
                        ],
                        "properties": {
                          "data": {
                            "description": "Open Banking Task Event Data",
                            "required": [
                              "task_type",
                              "customer_id",
                              "task_id",
                              "status",
                              "result"
                            ],
                            "properties": {
                              "task_id": {
                                "description": "The task identifier that the event relates to",
                                "type": "string",
                                "example": "e145c656-4a90-45db-a025-af7765482c8c"
                              },
                              "status": {
                                "type": "string",
                                "description": "The general status of a task",
                                "enum": [
                                  "Completed",
                                  "Failed"
                                ]
                              },
                              "task_type": {
                                "type": "string",
                                "enum": [
                                  "connect",
                                  "refresh"
                                ],
                                "description": "The type of task that completed"
                              },
                              "customer_id": {
                                "description": "The customer the event relates to",
                                "type": "string",
                                "example": "19677d9f-90e7-44a6-a32e-566990623da4"
                              },
                              "result": {
                                "$ref": "#/paths/~1open-banking~1v2~1refresh/post/callbacks/RefreshV2CompletedCallBack/{$request.body#~1redirect_url}/post/requestBody/content/application~1json/schema/properties/result"
                              },
                              "has_new_transactions": {
                                "type": "string",
                                "enum": [
                                  "true",
                                  "false"
                                ],
                                "description": "To describe whether new transactions have been pulled from the relevant ASPSP during the refresh. Note that if this field is set to `false` then there is no need to make a request to any other downstream endpoints to collect the data related to that customer.\n"
                              },
                              "reconnect_required": {
                                "type": "string",
                                "enum": [
                                  "true",
                                  "false"
                                ],
                                "description": "If true, the customer must re-connect to the specified provider"
                              },
                              "provider": {
                                "type": "string",
                                "description": "Name of the provider (banking institution) the task interacted with"
                              },
                              "consent_id": {
                                "type": "string",
                                "description": "The consent identifier that the event relates to"
                              }
                            }
                          }
                        }
                      },
                      "examples": {
                        "Success": {
                          "description": "Successful refresh",
                          "value": {
                            "data": {
                              "task_id": "03af1639-78a6-402d-809b-902a0b00a77d",
                              "status": "Completed",
                              "result": "success",
                              "task_type": "refresh",
                              "customer_id": "b6f898f8-99e8-4529-8e90-64d96fe05aa4",
                              "reconnect_required": "false",
                              "has_new_transactions": "true"
                            }
                          }
                        },
                        "Failure": {
                          "description": "Failed refresh due to a consent being revoked",
                          "value": {
                            "data": {
                              "task_id": "03af1639-78a6-402d-809b-902a0b00a77d",
                              "status": "Failed",
                              "result": "connection_revoked",
                              "task_type": "refresh",
                              "customer_id": "b6f898f8-99e8-4529-8e90-64d96fe05aa4",
                              "reconnect_required": "true",
                              "has_new_transactions": "false"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "responses": {
                  "200": {
                    "description": "Your server returns this code if it accepts the callback"
                  },
                  "300": {
                    "description": "The notification will not be retried, redirects will not be followed"
                  },
                  "400": {
                    "description": "The notification will not be retried"
                  },
                  "500": {
                    "description": "The request will be retried shortly. If it fails multiple times, we will stop attempting to deliver the notification for this single event. \n"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/open-banking/account-access-consent/revoke/{task_id}": {
      "get": {
        "tags": [
          "Manage a Connection"
        ],
        "summary": "Retrieve Revoke Consent Status",
        "description": "Check the status and result of a Revoke Consent task. \n\nUse the `task_id` taken from a successful `Initiate Revoke Consent` request.\n",
        "operationId": "open_banking_account_access_consent_revoke_get",
        "security": [
          {
            "OAuth2": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/paths/~1v2~1ingest~1accounts/post/parameters/0"
          },
          {
            "$ref": "#/paths/~1v1~1open-banking~1refresh/post/parameters/1"
          },
          {
            "$ref": "#/paths/~1v1~1open-banking~1refresh/post/parameters/2"
          },
          {
            "$ref": "#/paths/~1ingestion~1v3~1tasks~1{task_id}/get/parameters/1"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Revoke Account Access Intent Response",
                  "type": "object",
                  "description": "Expected response from a get status request for a revoke account access intent call",
                  "required": [
                    "operation_id",
                    "data",
                    "metadata"
                  ],
                  "properties": {
                    "operation_id": {
                      "$ref": "#/paths/~1v1~1open-banking~1providers/get/responses/200/content/application~1json/schema/properties/operation_id"
                    },
                    "data": {
                      "type": "object",
                      "title": "Revoke Task Data",
                      "required": [
                        "task_id",
                        "provider",
                        "status"
                      ],
                      "properties": {
                        "task_id": {
                          "title": "Task Id",
                          "type": "string",
                          "description": "Bud Task identifier returned from an async task for the requested action"
                        },
                        "provider": {
                          "type": "string",
                          "description": "The provider (ASPSP) associated with this task"
                        },
                        "status": {
                          "type": "string",
                          "description": "The status of the job associated with the specified task id",
                          "enum": [
                            "Completed",
                            "Pending",
                            "Failed"
                          ]
                        },
                        "result": {
                          "type": "string",
                          "description": "The result of the operation."
                        }
                      }
                    },
                    "metadata": {
                      "type": "object",
                      "title": "Revoke Task Metadata",
                      "required": [
                        "status"
                      ],
                      "properties": {
                        "status": {
                          "type": "string",
                          "description": "The status of the job associated with the specified task id",
                          "enum": [
                            "Completed",
                            "Pending",
                            "Failed"
                          ]
                        },
                        "next_url": {
                          "type": "string",
                          "description": "The url to try next if the `status` property returned is `Pending`"
                        },
                        "next_url_delay": {
                          "type": "number",
                          "description": "The time in milliseconds that the client should wait before polling again, if the `status` property returned is `Pending`"
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "completed": {
                    "summary": "Completed",
                    "value": {
                      "operation_id": "open_banking_revoke_task_get",
                      "data": {
                        "task_id": "1ceb1d81-a80e-4825-a7c0-4d69424c9874",
                        "provider": "capitalone",
                        "status": "Completed",
                        "result": "success"
                      },
                      "metadata": {
                        "status": "Completed"
                      }
                    }
                  },
                  "pending": {
                    "summary": "Pending",
                    "value": {
                      "operation_id": "open_banking_revoke_task_get",
                      "data": {
                        "task_id": "1ceb1d81-a80e-4825-a7c0-4d69424c9874",
                        "provider": "capitalone",
                        "status": "Pending"
                      },
                      "metadata": {
                        "status": "Pending",
                        "next_url": "/v1/open-banking/account-access-consent/revoke/1ceb1d81-a80e-4825-a7c0-4d69424c9874",
                        "next_url_delay": 50
                      }
                    }
                  },
                  "failed": {
                    "summary": "Failed",
                    "value": {
                      "operation_id": "open_banking_revoke_task_get",
                      "data": {
                        "task_id": "1ceb1d81-a80e-4825-a7c0-4d69424c9874",
                        "provider": "capitalone",
                        "status": "Failed"
                      },
                      "metadata": {
                        "status": "Failed"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request contains an invalid payload.",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Revoke Account Access Intent Status Validation Error",
                  "type": "object",
                  "required": [
                    "operation_id",
                    "code_id",
                    "message"
                  ],
                  "properties": {
                    "operation_id": {
                      "$ref": "#/paths/~1v1~1open-banking~1providers/get/responses/200/content/application~1json/schema/properties/operation_id"
                    },
                    "code_id": {
                      "type": "string",
                      "enum": [
                        "failed_validation"
                      ]
                    },
                    "message": {
                      "type": "string",
                      "enum": [
                        "invalid request"
                      ]
                    },
                    "errors": {
                      "type": "object",
                      "description": "Extra information on the validation errors"
                    }
                  }
                },
                "examples": {
                  "missing_customer_header": {
                    "summary": "Missing X-Customer-Id header",
                    "value": {
                      "operation_id": "open_banking_revoke_task_get",
                      "code_id": "failed_validation",
                      "message": "invalid request",
                      "errors": {
                        "customer-id": "This value should not be blank"
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized (BearerToken in 'Authorization' header fails the authentication)"
          },
          "5XX": {
            "description": "An unexpected error occurred on the server side"
          }
        }
      }
    },
    "/v2/ingest/accounts": {
      "post": {
        "tags": [
          "Ingest First Party Data"
        ],
        "summary": "Ingest Accounts",
        "description": "This endpoint is for pushing customer(s) account(s) and balance(s) through the Bud architecture.\nIt can ingest data for multiple customers per request.\nBy default, this is synchronous and will report any issue with the data in the response.\nIf a 'X-Disable-Synchronous' header is present and set to true, the process will create a task in the background and be entirely 'non-blocking'.\nIn this scenario, the response metadata will contain a Task ID and the next URL which would then be used for finding out the operation's result.\n",
        "operationId": "v2_ingest_accounts_post",
        "security": [
          {
            "OAuth2": []
          }
        ],
        "parameters": [
          {
            "in": "header",
            "name": "X-Client-Id",
            "schema": {
              "type": "string"
            },
            "required": true,
            "description": "The API Client Identifier (Service Application Identifier).",
            "example": "8711bbef-b357-4c2d-97ca-0d9df4206e9a"
          },
          {
            "$ref": "#/components/parameters/IngestAccountsContentType"
          },
          {
            "name": "X-Disable-Synchronous",
            "in": "header",
            "description": "If present and set to true, a task is created and a response is returned immediately\n\nNote: This flag cannot be set to `true` if a `customer_idempotent_identifier` is supplied instead of a `customer_id`.\n",
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "*/*": {
              "schema": {
                "oneOf": [
                  {
                    "title": "Bud Accounts Request",
                    "description": "Ingest accounts expected request body.",
                    "type": "array",
                    "items": {
                      "title": "Ingest Customer With Accounts",
                      "description": "A customer with a accounts data.",
                      "type": "object",
                      "required": [
                        "accounts"
                      ],
                      "oneOf": [
                        {
                          "$ref": "#/paths/~1ingestion~1v3~1accounts~1close/post/requestBody/content/application~1json/schema/items/oneOf/0"
                        },
                        {
                          "$ref": "#/paths/~1ingestion~1v3~1accounts~1close/post/requestBody/content/application~1json/schema/items/oneOf/1"
                        }
                      ],
                      "properties": {
                        "accounts": {
                          "type": "array",
                          "description": "List of accounts that belongs to the customer.",
                          "minItems": 1,
                          "items": {
                            "title": "Ingest Customer Account",
                            "description": "An account item.",
                            "type": "object",
                            "required": [
                              "provider",
                              "account_id",
                              "currency",
                              "account_type",
                              "account_sub_type",
                              "balances"
                            ],
                            "properties": {
                              "provider": {
                                "type": "string",
                                "description": "The name of the provider."
                              },
                              "account_id": {
                                "type": "string",
                                "description": "The unique id associated with the account"
                              },
                              "currency": {
                                "type": "string",
                                "description": "Main currency (in ISO4217 format) of the account"
                              },
                              "account_type": {
                                "type": "string",
                                "description": "The type of the account",
                                "enum": [
                                  "Business",
                                  "Personal"
                                ]
                              },
                              "account_sub_type": {
                                "type": "string",
                                "description": "The sub type of the account",
                                "enum": [
                                  "AutoLoan",
                                  "BoatLoan",
                                  "Brokerage",
                                  "BusinessLoan",
                                  "CertificateOfDeposit",
                                  "ChargeCard",
                                  "CheckingAccount",
                                  "CreditCard",
                                  "CurrentAccount",
                                  "DebitCard",
                                  "DisabilityInsurance",
                                  "EMoney",
                                  "HealthInsurance",
                                  "HomeEquityLoan",
                                  "Insurance",
                                  "Investment",
                                  "Ira",
                                  "LiabilityInsurance",
                                  "LifeInsurance",
                                  "LineOfCredit",
                                  "Loan",
                                  "MoneyMarket",
                                  "Mortgage",
                                  "Other",
                                  "PersonalLoan",
                                  "PrePaidCard",
                                  "PropertyInsurance",
                                  "Roth",
                                  "RvLoan",
                                  "Savings",
                                  "SafeDepositBox",
                                  "StudentLoan",
                                  "TravelInsurance",
                                  "VehicleInsurance",
                                  "WealthAccount"
                                ]
                              },
                              "holder_name": {
                                "type": "string",
                                "description": "The name of the account holder"
                              },
                              "restriction": {
                                "type": "string",
                                "description": "The restriction on the account, if any.",
                                "enum": [
                                  "ViewOnly",
                                  "Restricted"
                                ]
                              },
                              "details": {
                                "deprecated": true,
                                "type": "array",
                                "description": "Provides the details to identify an account",
                                "items": {
                                  "title": "Ingest Account Details",
                                  "type": "object",
                                  "description": "Schema to define any further details about a given account",
                                  "required": [
                                    "scheme_name",
                                    "identification"
                                  ],
                                  "properties": {
                                    "scheme_name": {
                                      "type": "string",
                                      "description": "Name of the scheme associated with the account"
                                    },
                                    "identification": {
                                      "type": "string",
                                      "description": "A unique identifier for the account"
                                    },
                                    "secondary_identification": {
                                      "type": "string",
                                      "description": "Any secondary identifier associated with the account"
                                    },
                                    "name": {
                                      "type": "string",
                                      "description": "The name of the account holder"
                                    }
                                  }
                                }
                              },
                              "account_identifiers": {
                                "type": "array",
                                "description": "Provides the details to identify an account",
                                "items": {
                                  "title": "Ingest Account Identifiers",
                                  "type": "object",
                                  "description": "Schema to define identifiers for a given account",
                                  "required": [
                                    "type",
                                    "value"
                                  ],
                                  "properties": {
                                    "type": {
                                      "type": "string",
                                      "description": "The type of identifier detailed within the value field associated with the account",
                                      "enum": [
                                        "uk_sort_code",
                                        "uk_account_number",
                                        "iban",
                                        "us_account_number",
                                        "pan"
                                      ]
                                    },
                                    "value": {
                                      "type": "string",
                                      "description": "The identifier associated with the account"
                                    }
                                  }
                                }
                              },
                              "balances": {
                                "type": "array",
                                "description": "The balances associated with the account",
                                "items": {
                                  "title": "Ingest Account Balance",
                                  "type": "object",
                                  "description": "Information surrounding a Customer's Account Balance",
                                  "required": [
                                    "amount",
                                    "date_time",
                                    "type",
                                    "credit_debit_indicator"
                                  ],
                                  "properties": {
                                    "amount": {
                                      "title": "Amount",
                                      "description": "Amount structure",
                                      "allOf": [
                                        {
                                          "type": "object",
                                          "properties": {
                                            "local_currency": {
                                              "allOf": [
                                                {
                                                  "description": "The original three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) the payment was transacted in.\n\nExample: `USD`\n"
                                                },
                                                {
                                                  "$ref": "#/paths/~1v2~1ingest~1transactions/post/requestBody/content/*~1*/schema/oneOf/0/items/properties/transactions/items/properties/currency"
                                                }
                                              ]
                                            },
                                            "local_value": {
                                              "allOf": [
                                                {
                                                  "description": "The original value of the payment in the local currency. The value is formatted with the number of decimal places for the respective currency.\n\nExample: `10.98`\n"
                                                },
                                                {
                                                  "title": "Monetary Value",
                                                  "description": "The value of the monetary amount. The value is formatted with the number of decimal places for the respective currency. \n\nExample: `10.98`\n",
                                                  "type": "string"
                                                }
                                              ]
                                            }
                                          }
                                        },
                                        {
                                          "$ref": "#/paths/~1v2~1ingest~1transactions/post/responses/200/content/application~1json/schema/allOf/1/properties/data/items/properties/enriched_transactions/items/properties/amount"
                                        }
                                      ]
                                    },
                                    "credit_debit_indicator": {
                                      "type": "string",
                                      "description": "To describe whether the account balance is in debit or credit",
                                      "enum": [
                                        "incoming_credit",
                                        "outgoing_debit"
                                      ]
                                    },
                                    "credit_line": {
                                      "items": {
                                        "title": "Ingest Credit Line",
                                        "type": "object",
                                        "description": "A set of elements used to provide details on the credit line",
                                        "required": [
                                          "amount",
                                          "type"
                                        ],
                                        "properties": {
                                          "included": {
                                            "type": "boolean",
                                            "description": "Indicates whether or not the credit line is included in the balance of the account, if not present, credit line is not included in the balance amount of the account"
                                          },
                                          "amount": {
                                            "$ref": "#/paths/~1v2~1ingest~1accounts/post/requestBody/content/*~1*/schema/oneOf/0/items/properties/accounts/items/properties/balances/items/properties/amount"
                                          },
                                          "type": {
                                            "type": "string",
                                            "description": "Limit type, in a coded form",
                                            "enum": [
                                              "Available",
                                              "Credit",
                                              "Emergency",
                                              "Pre-Agreed",
                                              "Temporary"
                                            ]
                                          }
                                        }
                                      }
                                    },
                                    "date": {
                                      "type": "string",
                                      "format": "YYYY-MM-DD",
                                      "deprecated": true,
                                      "description": "The date associated with the balance of the given account"
                                    },
                                    "time": {
                                      "type": "string",
                                      "format": "hh:mm:ss",
                                      "deprecated": true,
                                      "description": "The time associated with the balance of the given account"
                                    },
                                    "date_time": {
                                      "type": "string",
                                      "format": "date-time",
                                      "description": "RFC 3339 format string of the date time of the balance"
                                    },
                                    "type": {
                                      "type": "string",
                                      "description": "Describes the state of the balance\n\n| Value                     | Description                                               |\n|:--------------------------|:----------------------------------------------------------|\n| `ClosingAvailable`        | Closing balance of amount of money that is at the disposal of the account owner on the date specified.               |\n| `ClosingBooked`           | Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period.      |\n| `ClosingCleared`          | Closing balance of amount of money that is cleared on the date specified.                     |\n| `Expected`                | Balance, composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted.  |\n| `ForwardAvailable`        | Forward available balance of money that is at the disposal of the account owner on the date specified.               |\n| `Information`             | Balance for informational purposes.      |\n| `InterimAvailable`        | Available balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.       |\n| `InterimBooked`           | Balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.       |\n| `InterimCleared`          | Cleared balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day.        |\n| `OpeningAvailable`        | Opening balance of amount of money that is at the disposal of the account owner on the date specified.        |\n| `OpeningBooked`           | Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.        |\n| `OpeningCleared`          | Opening balance of amount of money that is cleared on the date specified.       |\n| `PreviouslyClosedBooked`  | Balance of the account at the previously closed account reporting period. The opening booked balance for the new period has to be equal to this balance.  |\n",
                                      "enum": [
                                        "ClosingAvailable",
                                        "ClosingBooked",
                                        "ClosingCleared",
                                        "Expected",
                                        "ForwardAvailable",
                                        "Information",
                                        "InterimAvailable",
                                        "InterimBooked",
                                        "InterimCleared",
                                        "OpeningAvailable",
                                        "OpeningBooked",
                                        "OpeningCleared",
                                        "PreviouslyClosedBooked"
                                      ]
                                    }
                                  }
                                }
                              },
                              "opening_date_time": {
                                "type": "string",
                                "format": "date-time",
                                "description": "The opening date time of the account in RFC3339 format.",
                                "example": "2022-11-12T15:30:00Z"
                              },
                              "holders": {
                                "type": "array",
                                "description": "The account holders details associated with the account",
                                "items": {
                                  "title": "Account_Holder",
                                  "type": "object",
                                  "properties": {
                                    "name": {
                                      "type": "string",
                                      "description": "The name of the given account holder.\nExample: `John Smith`\n"
                                    },
                                    "relationship": {
                                      "type": "string",
                                      "description": "The relationship that the individual holder has with the account.\nCurrently supported values include (but are not necessarily limited to):\n  - `sole`\n  - `joint`\n  - `delegate`\n  - `unknown`\n"
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  {
                    "$ref": "#/components/schemas/IngestPlaidAccountsRequest"
                  },
                  {
                    "$ref": "#/components/schemas/IngestFinicityAccountsRequest"
                  }
                ]
              },
              "examples": {
                "bud-accounts-v1 Request (with Customer ID)": {
                  "summary": "Bud Accounts V1 (With Customer ID)",
                  "value": [
                    {
                      "customer_id": "c3339af9-2426-44d4-9c4d-ddb8fd281e23",
                      "accounts": [
                        {
                          "provider": "citi",
                          "account_id": "99473c28-21cf-4a9a-b79e-fd643dd7a4bc",
                          "currency": "USD",
                          "account_type": "Personal",
                          "account_sub_type": "CheckingAccount",
                          "account_identifiers": [
                            {
                              "type": "us_account_number",
                              "value": "98765432165444"
                            }
                          ],
                          "balances": [
                            {
                              "amount": {
                                "value": "7.00",
                                "currency": "USD"
                              },
                              "credit_debit_indicator": "outgoing_debit",
                              "credit_line": [
                                {
                                  "included": true,
                                  "amount": {
                                    "value": "200.00",
                                    "currency": "USD"
                                  },
                                  "type": "Credit"
                                }
                              ],
                              "date_time": "2020-12-01T00:00:00-07:00",
                              "type": "InterimBooked"
                            }
                          ],
                          "opening_date_time": "2019-11-01T00:00:00-07:00"
                        }
                      ]
                    },
                    {
                      "customer_id": "85db4cdf-5f79-4f4e-8388-f9a52da598a2",
                      "accounts": [
                        {
                          "provider": "chase",
                          "account_id": "bfd4ea71-58d7-4b24-8820-95029875cc9a",
                          "currency": "USD",
                          "account_type": "Personal",
                          "account_sub_type": "CheckingAccount",
                          "account_identifiers": [
                            {
                              "type": "us_account_number",
                              "value": "12312312313200"
                            }
                          ],
                          "balances": [
                            {
                              "amount": {
                                "value": "70005.00",
                                "currency": "USD"
                              },
                              "credit_debit_indicator": "incoming_credit",
                              "credit_line": [
                                {
                                  "included": true,
                                  "amount": {
                                    "value": "100.00",
                                    "currency": "USD"
                                  },
                                  "type": "Credit"
                                }
                              ],
                              "date_time": "2020-12-01T00:00:00-05:00",
                              "type": "InterimBooked"
                            }
                          ]
                        }
                      ]
                    }
                  ]
                },
                "bud-accounts-v1 Request (With Customer Idempotent Identifier)": {
                  "summary": "Bud Accounts V1 (With Customer Idempotent Identifier)",
                  "value": [
                    {
                      "customer_idempotent_identifier": "your_internal_id",
                      "accounts": [
                        {
                          "provider": "citi",
                          "account_id": "99473c28-21cf-4a9a-b79e-fd643dd7a4bc",
                          "currency": "USD",
                          "account_type": "Personal",
                          "account_sub_type": "CheckingAccount",
                          "account_identifiers": [
                            {
                              "type": "us_account_number",
                              "value": "98765432165444"
                            }
                          ],
                          "balances": [
                            {
                              "amount": {
                                "value": "7.00",
                                "currency": "USD"
                              },
                              "credit_debit_indicator": "outgoing_debit",
                              "credit_line": [
                                {
                                  "included": true,
                                  "amount": {
                                    "value": "200.00",
                                    "currency": "USD"
                                  },
                                  "type": "Credit"
                                }
                              ],
                              "date_time": "2020-12-01T00:00:00Z",
                              "type": "InterimBooked"
                            }
                          ]
                        }
                      ]
                    },
                    {
                      "customer_idempotent_identifier": "your_internal_id",
                      "accounts": [
                        {
                          "provider": "chase",
                          "account_id": "bfd4ea71-58d7-4b24-8820-95029875cc9a",
                          "currency": "USD",
                          "account_type": "Personal",
                          "account_sub_type": "CheckingAccount",
                          "account_identifiers": [
                            {
                              "type": "us_account_number",
                              "value": "12312312313200"
                            }
                          ],
                          "balances": [
                            {
                              "amount": {
                                "value": "70005.00",
                                "currency": "USD"
                              },
                              "credit_debit_indicator": "incoming_credit",
                              "credit_line": [
                                {
                                  "included": true,
                                  "amount": {
                                    "value": "100.00",
                                    "currency": "USD"
                                  },
                                  "type": "Credit"
                                }
                              ],
                              "date_time": "2020-12-01T00:00:00Z",
                              "type": "InterimBooked"
                            }
                          ]
                        }
                      ]
                    }
                  ]
                },
                "plaid-accounts-v1 Request (with Customer ID)": {
                  "summary": "Plaid Accounts V1 (with Customer ID)",
                  "value": [
                    {
                      "customer_id": "c3339af9-2426-44d4-9c4d-ddb8fd281e23",
                      "accounts": [
                        {
                          "account_id": "6PdjjRP6LmugpBy5NgQvUqpRXMWxzktg3rwrk",
                          "balances": {
                            "available": 100,
                            "current": 120,
                            "limit": 1200,
                            "iso_currency_code": "USD",
                            "last_updated_datetime": "2022-07-13T15:30:00Z"
                          },
                          "name": "Plaid Checking",
                          "official_name": "Plaid Gold Standard 0% Interest Checking",
                          "type": "depository",
                          "subtype": "checking"
                        }
                      ]
                    }
                  ]
                },
                "plaid-accounts-v1 Request (with Customer Idempotent Identifier)": {
                  "summary": "Plaid Accounts V1 (with Customer Idempotent Identifier)",
                  "value": [
                    {
                      "customer_idempotent_identifier": "your_internal_id",
                      "accounts": [
                        {
                          "account_id": "6PdjjRP6LmugpBy5NgQvUqpRXMWxzktg3rwrk",
                          "balances": {
                            "available": 100,
                            "current": 120,
                            "limit": 1200,
                            "iso_currency_code": "USD",
                            "last_updated_datetime": "2022-07-13T15:30:00Z"
                          },
                          "name": "Plaid Checking",
                          "official_name": "Plaid Gold Standard 0% Interest Checking",
                          "type": "depository",
                          "subtype": "checking"
                        }
                      ]
                    }
                  ]
                },
                "finicity-accounts-v1 Request (with Customer ID)": {
                  "summary": "Finicity V1 Accounts Request (with Customer ID)",
                  "description": "A sample finicity v1 accounts ingest request",
                  "value": [
                    {
                      "customer_id": "c3339af9-2426-44d4-9c4d-ddb8fd281e23",
                      "accounts": [
                        {
                          "id": "1014136057",
                          "name": "Super Checking",
                          "balance": 7456,
                          "type": "checking",
                          "status": "active",
                          "institutionId": "102224",
                          "balanceDate": 1588797048,
                          "currency": "USD",
                          "detail": {
                            "availableBalanceAmount": 5678.78,
                            "creditAvailableAmount": 10200,
                            "creditMaxAmount": 12000
                          }
                        }
                      ]
                    }
                  ]
                },
                "finicity-accounts-v1 Request (with Customer Idempotent Identifier)": {
                  "summary": "Finicity V1 Accounts Request (with Customer Idempotent Identifier)",
                  "description": "A sample finicity v1 accounts ingest request",
                  "value": [
                    {
                      "customer_idempotent_identifier": "your_internal_id",
                      "accounts": [
                        {
                          "id": "1014136057",
                          "name": "Super Checking",
                          "balance": 7456,
                          "type": "checking",
                          "status": "active",
                          "institutionId": "102224",
                          "balanceDate": 1588797048,
                          "currency": "USD",
                          "detail": {
                            "availableBalanceAmount": 5678.78,
                            "creditAvailableAmount": 10200,
                            "creditMaxAmount": 12000
                          }
                        }
                      ]
                    }
                  ]
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "A new Task has been created to ingest the given transactions. The generated `task_id` can be used to check the Task's status",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Ingest Transactions V2 Async Response",
                  "type": "object",
                  "allOf": [
                    {
                      "type": "object",
                      "required": [
                        "operation_id"
                      ],
                      "properties": {
                        "operation_id": {
                          "$ref": "#/paths/~1v1~1open-banking~1providers/get/responses/200/content/application~1json/schema/properties/operation_id",
                          "example": "v2_ingest_transactions_post"
                        }
                      }
                    },
                    {
                      "type": "object",
                      "required": [
                        "operation_id",
                        "metadata"
                      ],
                      "properties": {
                        "metadata": {
                          "title": "Created Task Details",
                          "description": "Metadata on the created task, including the task_id",
                          "type": "object",
                          "required": [
                            "task_id"
                          ],
                          "properties": {
                            "task_id": {
                              "type": "string",
                              "format": "uuid",
                              "description": "Can be used with the transaction status endpoint to retrieve the status of the full enriched process"
                            },
                            "next_url": {
                              "type": "string",
                              "description": "The path to call to obtain the current status of the task.",
                              "example": "/v2/ingest/status/4cef424c-1d7f-4cab-8be2-aee7e1774a00"
                            },
                            "next_url_delay": {
                              "type": "number",
                              "description": "The time in milliseconds that the client should wait before trying to retrieve the current status of the task.",
                              "example": 500
                            }
                          }
                        }
                      }
                    }
                  ]
                },
                "example": {
                  "operation_id": "v2_ingest_accounts_post",
                  "metadata": {
                    "task_id": "4cef424c-1d7f-4cab-8be2-aee7e1774a00",
                    "next_url": "/v2/ingest/status/4cef424c-1d7f-4cab-8be2-aee7e1774a00",
                    "next_url_delay": 250
                  }
                }
              }
            }
          },
          "204": {
            "description": "The data has been ingested successfully. Response has no body"
          },
          "400": {
            "description": "Bad Request that fails validations on headers and/or payload",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "type": "object",
                      "title": "JSON Decoding Error",
                      "required": [
                        "operation_id",
                        "code_id",
                        "message",
                        "errors"
                      ],
                      "properties": {
                        "operation_id": {
                          "$ref": "#/paths/~1v1~1open-banking~1providers/get/responses/200/content/application~1json/schema/properties/operation_id"
                        },
                        "code_id": {
                          "type": "string",
                          "enum": [
                            "failed_body_decode"
                          ]
                        },
                        "message": {
                          "type": "string",
                          "description": "High level description on what has failed "
                        },
                        "errors": {
                          "type": "object",
                          "description": "Contains more details on the decoding error",
                          "required": [
                            "decode_error"
                          ],
                          "properties": {
                            "decode_error": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "title": "Content Type Error",
                      "required": [
                        "operation_id",
                        "code_id",
                        "message",
                        "errors"
                      ],
                      "properties": {
                        "operation_id": {
                          "$ref": "#/paths/~1v1~1open-banking~1providers/get/responses/200/content/application~1json/schema/properties/operation_id"
                        },
                        "code_id": {
                          "type": "string",
                          "enum": [
                            "failed_validation"
                          ]
                        },
                        "message": {
                          "type": "string",
                          "description": "High level description on what has failed "
                        },
                        "errors": {
                          "type": "object",
                          "description": "Error details",
                          "properties": {
                            "content_type": {
                              "type": "string",
                              "description": "The content type header provided in the request is unknown"
                            },
                            "<index>.customer_id": {
                              "type": "string",
                              "description": "Missing customer ID. Index prefix is the index of the customer in the request"
                            },
                            "<index>.customer_secret": {
                              "type": "string",
                              "description": "Missing customer secret. Index is the index of the customer in the request"
                            },
                            "<index>.accounts": {
                              "type": "string",
                              "description": "Missing customer accounts. Index is the index of the customer in the request"
                            }
                          }
                        }
                      },
                      "example": {
                        "operation_id": "ingest_accounts_post",
                        "code_id": "failed_validation",
                        "message": "validation failure(s) in request payload",
                        "errors": {
                          "0.customer_secret": "The customer secret is mandatory"
                        }
                      }
                    },
                    {
                      "type": "object",
                      "title": "Accounts validation error",
                      "required": [
                        "operation_id",
                        "code_id",
                        "message",
                        "errors"
                      ],
                      "properties": {
                        "operation_id": {
                          "$ref": "#/paths/~1v1~1open-banking~1providers/get/responses/200/content/application~1json/schema/properties/operation_id"
                        },
                        "code_id": {
                          "type": "string",
                          "enum": [
                            "failed_validation"
                          ]
                        },
                        "message": {
                          "type": "string",
                          "description": "High level description on what has failed"
                        },
                        "errors": {
                          "type": "object",
                          "title": "Map of customers",
                          "description": "a map of customer IDs to account validation errors",
                          "properties": {
                            "missing_fields": {
                              "type": "object",
                              "title": "Map of Account",
                              "description": "A map of accounts to missing fields array.\n\nThe key contains the index of the account causing issues.\nSee example\n",
                              "additionalProperties": {
                                "type": "array",
                                "title": "Missing Fields",
                                "description": "list of required missing fields for a transaction",
                                "items": {
                                  "type": "string"
                                }
                              }
                            },
                            "invalid_fields": {
                              "type": "object",
                              "title": "Map of Account",
                              "description": "A map of accounts to invalid fields array.\n\nThe key contains the index of the account causing issues.\nSee example\n",
                              "additionalProperties": {
                                "type": "array",
                                "title": "Invalid Fields",
                                "description": "list of invalid fields for a transaction",
                                "items": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      },
                      "example": {
                        "operation_id": "v2_ingest_accounts_post",
                        "code_id": "failed_validation",
                        "message": "validation failure(s) in request payload",
                        "errors": {
                          "1db8c4b5-e5ae-429e-947b-6a4616ffc717": {
                            "missing_fields": {
                              "accounts[0]": [
                                "provider",
                                "account_id"
                              ],
                              "accounts[1]": [
                                "account_id"
                              ]
                            },
                            "invalid_fields": {
                              "accounts[0]": [
                                "currency"
                              ]
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized (BearerToken in 'Authorization' header fails the authentication)"
          },
          "5XX": {
            "description": "An unexpected error occurred on the server side"
          }
        },
        "callbacks": {
          "FPIIngestSucceededCallback": {
            "{$request.body#/redirect_url}": {
              "description": "Should the ingestion task succeed, this callback is sent to your configured 'First Party Data Ingestion Events' webhook URL on the completion of a Ingest Accounts task.\n",
              "post": {
                "security": [],
                "parameters": [
                  {
                    "$ref": "#/paths/~1v2~1ingest~1accounts/post/callbacks/FPIIngestFailedCallback/{$request.body#~1redirect_url}/post/parameters/0"
                  },
                  {
                    "$ref": "#/paths/~1v2~1ingest~1accounts/post/callbacks/FPIIngestFailedCallback/{$request.body#~1redirect_url}/post/parameters/1"
                  }
                ],
                "summary": "First Party Ingestion Succeeded Callback",
                "requestBody": {
                  "required": true,
                  "description": "Should the ingestion task succeed, this callback is sent to your configured 'First Party Data Ingestion Events' webhook URL on the completion of a Ingest Accounts task.",
                  "content": {
                    "application/json": {
                      "schema": {
                        "title": "FPI Ingestion Succeeded Webhook Payload",
                        "type": "object",
                        "description": "The payload sent to the client defined webhook (via the console) when an First Party Ingestion task succeeds.\n",
                        "required": [
                          "data"
                        ],
                        "properties": {
                          "data": {
                            "type": "object",
                            "required": [
                              "event",
                              "task_id",
                              "operation_id"
                            ],
                            "properties": {
                              "event": {
                                "description": "The event type",
                                "type": "string",
                                "example": "first_party_ingester.ingest.succeeded"
                              },
                              "task_id": {
                                "description": "The associated task ID",
                                "type": "string",
                                "example": "3928aca4-b73c-4f13-a540-1b3759e06d27"
                              },
                              "operation_id": {
                                "description": "The endpoint ID the operation was related to",
                                "type": "string",
                                "example": "v2_ingest_transactions_post"
                              },
                              "subtask_details": {
                                "description": "Details of the individual subtasks (customers) of the ingestion",
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "required": [
                                    "customer_id"
                                  ],
                                  "properties": {
                                    "customer_id": {
                                      "type": "string",
                                      "description": "A unique identifier for a Customer, as registered on Bud's platform."
                                    },
                                    "customer_idempotent_identifier": {
                                      "type": "string",
                                      "description": "The `idempotent_identifier` provided when the customer given was created."
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      },
                      "examples": {
                        "Success": {
                          "description": "Successful ingestion",
                          "value": {
                            "data": {
                              "event": "first_party_ingester.ingest.succeeded",
                              "operation_id": "v2_ingest_accounts_post",
                              "task_id": "6d37e192-1fdb-407d-82c6-58ee38cb60db"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "responses": {
                  "200": {
                    "description": "Your server returns this code if it accepts the callback"
                  },
                  "300": {
                    "description": "The notification will not be retried, redirects will not be followed"
                  },
                  "400": {
                    "description": "The notification will not be retried"
                  },
                  "500": {
                    "description": "The request will be retried shortly. If it fails multiple times, we will stop attempting to deliver the notification for this single event.\n"
                  }
                }
              }
            }
          },
          "FPIIngestFailedCallback": {
            "{$request.body#/redirect_url}": {
              "description": "Should the ingestion task fail, this callback is sent to your configured 'First Party Data Ingestion Events' webhook URL on the completion of a Ingest Accounts task.\n",
              "post": {
                "security": [],
                "parameters": [
                  {
                    "in": "header",
                    "name": "X-Signature",
                    "description": "The signed request body JWT",
                    "required": true,
                    "schema": {
                      "type": "string"
                    }
                  },
                  {
                    "in": "header",
                    "name": "X-Signing-ID",
                    "description": "The public key ID which should be used to verify the X-Signature header. Bud's list of public keys can be found at https://assets.thisisbud.com/bud-callback.jwks",
                    "required": true,
                    "schema": {
                      "type": "string"
                    }
                  }
                ],
                "summary": "First Party Ingestion Failed Callback",
                "requestBody": {
                  "required": true,
                  "description": "Should the ingestion task fail, this callback is sent to your configured 'First Party Data Ingestion Events' webhook URL on the completion of a Ingest Accounts task.",
                  "content": {
                    "application/json": {
                      "schema": {
                        "title": "FPI Ingestion Failed Webhook Payload",
                        "type": "object",
                        "description": "The payload sent to the client defined webhook (via the console) when an First Party Ingestion task fails.\n",
                        "required": [
                          "data"
                        ],
                        "properties": {
                          "data": {
                            "type": "object",
                            "required": [
                              "event",
                              "task_id",
                              "operation_id",
                              "result"
                            ],
                            "properties": {
                              "event": {
                                "description": "The event type",
                                "type": "string",
                                "example": "first_party_ingester.ingest.failed"
                              },
                              "task_id": {
                                "description": "The associated task ID",
                                "type": "string",
                                "example": "3928aca4-b73c-4f13-a540-1b3759e06d27"
                              },
                              "operation_id": {
                                "description": "The endpoint ID the operation was related to",
                                "type": "string",
                                "example": "v2_ingest_transactions_post"
                              },
                              "result": {
                                "description": "The error outcome of the ingestion if it failed",
                                "type": "string",
                                "example": "data_mapping_error"
                              },
                              "subtask_details": {
                                "description": "Details of the individual subtasks (customers) of the ingestion",
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "required": [
                                    "customer_id"
                                  ],
                                  "properties": {
                                    "customer_id": {
                                      "type": "string",
                                      "description": "A unique identifier for a Customer, as registered on Bud's platform."
                                    },
                                    "customer_idempotent_identifier": {
                                      "type": "string",
                                      "description": "The `idempotent_identifier` provided when the customer given was created."
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      },
                      "examples": {
                        "Success": {
                          "description": "Failed Ingestion",
                          "value": {
                            "data": {
                              "event": "first_party_ingester.ingest.failed",
                              "operation_id": "v2_ingest_transactions_post",
                              "task_id": "6d37e192-1fdb-407d-82c6-58ee38cb60db",
                              "result": "data_mapping_error"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "responses": {
                  "200": {
                    "description": "Your server returns this code if it accepts the callback"
                  },
                  "300": {
                    "description": "The notification will not be retried, redirects will not be followed"
                  },
                  "400": {
                    "description": "The notification will not be retried"
                  },
                  "500": {
                    "description": "The request will be retried shortly. If it fails multiple times, we will stop attempting to deliver the notification for this single event.\n"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/ingestion/v3/tasks/{task_id}": {
      "get": {
        "tags": [
          "Ingest First Party Data"
        ],
        "summary": "Retrieve Ingestion Task Status",
        "description": "Check the status of an ingest request. Please note that this works for both the Ingest Transactions endpoints And Ingest Accounts endpoints.\nIngestion tasks are accessible for 15 minutes after ingestion, after which they are deleted.\nReports status of the ingestion task, with details for each subtask (1 per customer).\n",
        "operationId": "v3_ingest_status_get",
        "security": [
          {
            "OAuth2": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/paths/~1v2~1ingest~1accounts/post/parameters/0"
          },
          {
            "in": "path",
            "name": "task_id",
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "required": true,
            "description": "Bud Task identifier returned from an async task for the requested action"
          }
        ],
        "responses": {
          "200": {
            "description": "The request was successfully processed.",
            "content": {
              "application/json": {
                "schema": {
                  "title": "Ingestion Task Status Response",
                  "type": "object",
                  "description": "Report on the status of an ingestion task",
                  "required": [
                    "operation_id",
                    "data",
                    "metadata"
                  ],
                  "properties": {
                    "operation_id": {
                      "$ref": "#/paths/~1v1~1open-banking~1providers/get/responses/200/content/application~1json/schema/properties/operation_id"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "title": "Customer Ingest Task",
                        "description": "A single customer ingest task status",
                        "type": "object",
                        "oneOf": [
                          {
                            "title": "With Customer ID",
                            "properties": {
                              "customer_id": {
                                "$ref": "#/paths/~1ingestion~1v3~1accounts~1close/post/requestBody/content/application~1json/schema/items/oneOf/0/properties/customer_id"
                              }
                            },
                            "required": [
                              "customer_id"
                            ]
                          },
                          {
                            "title": "With Customer Idempotent Identifier",
                            "properties": {
                              "customer_idempotent_identifier": {
                                "type": "string",
                                "description": "An internal client identifier. This identifier can then be used in place of `X-Customer-Id` across Bud's endpoints.\n"
                              }
                            },
                            "required": [
                              "customer_idempotent_identifier"
                            ]
                          }
                        ],
                        "required": [
                          "status"
                        ],
                        "properties": {
                          "status": {
                            "title": "Ingest Response Status",
                            "description": "Ingest response status.",
                            "type": "string",
                            "enum": [
                              "Completed",
                              "Failed",
                              "Pending"
                            ]
                          },
                          "result": {
                            "$ref": "#/paths/~1ingestion~1v3~1tasks~1{task_id}/get/responses/200/content/application~1json/schema/properties/metadata/properties/result"
                          },
                          "error": {
                            "description": "Any error messages describing why a sub task has failed.",
                            "type": "object",
                            "additionalProperties": true
                          }
                        }
                      }
                    },
                    "metadata": {
                      "title": "Ingest Task Metadata",
                      "description": "Expected response structure.",
                      "type": "object",
                      "required": [
                        "task_id",
                        "status"
                      ],
                      "properties": {
                        "task_id": {
                          "type": "string",
                          "format": "uuid",
                          "description": "Unique task identifier."
                        },
                        "status": {
                          "title": "Ingest Task Overall Status",
                          "description": "Ingest response status.",
                          "type": "string",
                          "enum": [
                            "Completed",
                            "Pending",
                            "Failed",
                            "PartialCompleted"
                          ]
                        },
                        "result": {
                          "title": "Ingestion Task Result",
                          "type": "string",
                          "description": "Indicates the outcome of the ingest task. Either success or various error codes:\n\n| code | description |\n| ---- | ----------- |\n| success | Ingestion completed successfully. Data is now available. |\n| validation_error | The request format is invalid. Please review the endpoint documentation for correct parameters and headers. |\n| data_mapping_error | The data payload does not match the expected schema. Ensure your data aligns with the defined structure. |\n| internal_error | Something went wrong on our side. Please retry your request later. |\n| timed_out | The task did not complete in due time. |\n"
                        },
                        "ingest_request_id": {
                          "type": "string",
                          "format": "uuid",
                          "description": "Unique identifier of the initial ingest request"
                        },
                        "ingest_route": {
                          "type": "string",
                          "description": "The endpoint used for this ingest task",
                          "enum": [
                            "ingest_accounts_post",
                            "ingest_transactions_post",
                            "v2_ingest_accounts_post",
                            "v2_ingest_transactions_post",
                            "v3_ingest_transactions_book_post",
                            "v3_ingest_transactions_decline_post"
                          ]
                        },
                        "ingest_schema": {
                          "type": "string",
                          "description": "The account/transaction schema used for the ingest",
                          "enum": [
                            "application/bud-accounts+json",
                            "application/bud-transaction-v2+json",
                            "application/bud-transaction-v3+json"
                          ]
                        },
                        "next_url": {
                          "description": "The URL to call to obtain the results of the task",
                          "type": "string"
                        },
                        "next_url_delay": {
                          "description": "Recommended delay in milliseconds before next call",
                          "type": "number"
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "Pending Task (with Customer ID)": {
                    "summary": "Pending Task (with Customer ID)",
                    "value": {
                      "operation_id": "v3_ingest_status_get",
                      "data": [
                        {
                          "customer_id": "f89ae931-8cb3-4352-ac9e-4e4572fe5026",
                          "status": "Pending"
                        }
                      ],
                      "metadata": {
                        "task_id": "3d592efc-493a-4548-8008-f738fd0877ab",
                        "status": "Pending",
                        "next_url": "/ingestion/v3/tasks/3d592efc-493a-4548-8008-f738fd0877ab",
                        "next_url_delay": 500
                      }
                    }
                  },
                  "Successful Task (with Customer ID)": {
                    "summary": "Successful Task (with Customer ID)",
                    "value": {
                      "operation_id": "v3_ingest_status_get",
                      "data": [
                        {
                          "customer_id": "f89ae931-8cb3-4352-ac9e-4e4572fe5026",
                          "status": "Completed",
                          "result": "success"
                        }
                      ],
                      "metadata": {
                        "task_id": "3d592efc-493a-4548-8008-f738fd0877ab",
                        "status": "Completed",
                        "result": "success",
                        "ingest_request_id": "213be00c-60ce-9af5-95ab-d450a9ffc2ac",
                        "ingest_route": "v2_ingest_transactions_post",
                        "ingest_schema": "application/bud-transaction-v3+json"
                      }
                    }
                  },
                  "Failed Task (with Customer ID)": {
                    "summary": "Failed Task (with Customer ID)",
                    "value": {
                      "operation_id": "v3_ingest_status_get",
                      "data": [
                        {
                          "customer_id": "f89ae931-8cb3-4352-ac9e-4e4572fe5026",
                          "status": "Failed",
                          "result": "data_mapping_error",
                          "error": {
                            "accounts[0].currency": "unexpected currency code: GlkjlkjBP, expected ISO-4217 currency code"
                          }
                        }
                      ],
                      "metadata": {
                        "task_id": "3d592efc-493a-4548-8008-f738fd0877ab",
                        "status": "Failed",
                        "result": "data_mapping_error"
                      }
                    }
                  },
                  "Pending Task (with Customer Idempotent Identifier)": {
                    "summary": "Pending Task (with Customer Idempotent Identifier)",
                    "value": {
                      "operation_id": "v3_ingest_status_get",
                      "data": [
                        {
                          "customer_idempotent_identifier": "your_internal_id",
                          "status": "Pending"
                        }
                      ],
                      "metadata": {
                        "task_id": "3d592efc-493a-4548-8008-f738fd0877ab",
                        "status": "Pending",
                        "next_url": "/ingestion/v3/tasks/3d592efc-493a-4548-8008-f738fd0877ab",
                        "next_url_delay": 500
                      }
                    }
                  },
                  "Successful Task (with Customer Idempotent Identifier)": {
                    "summary": "Successful Task (with Customer Idempotent Identifier)",
                    "value": {
                      "operation_id": "v3_ingest_status_get",
                      "data": [
                        {
                          "customer_idempotent_identifier": "your_internal_id",
                          "status": "Completed",
                          "result": "success"
                        }
                      ],
                      "metadata": {
                        "task_id": "3d592efc-493a-4548-8008-f738fd0877ab",
                        "status": "Completed",
                        "result": "success",
                        "ingest_request_id": "213be00c-60ce-9af5-95ab-d450a9ffc2ac",
                        "ingest_route": "v2_ingest_transactions_post",
                        "ingest_schema": "application/bud-transaction-v3+json"
                      }
                    }
                  },
                  "Failed Task (with Customer Idempotent Identifier)": {
                    "summary": "Failed Task (with Customer Idempotent Identifier)",
                    "value": {
                      "operation_id": "v3_ingest_status_get",
                      "data": [
                        {
                          "customer_idempotent_identifier": "your_internal_id",
                          "status": "Failed",
                          "result": "data_mapping_error",
                          "error": {
                            "accounts[0].currency": "unexpected currency code: GlkjlkjBP, expected ISO-4217 currency code"
                          }
                        }
                      ],
                      "metadata": {
                        "task_id": "3d592efc-493a-4548-8008-f738fd0877ab",
                        "status": "Failed",
                        "result": "data_mapping_error"
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized (BearerToken in 'Authorization' header fails the authentication)"
          },
          "404": {
            "description": "The task couldn't be found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "title": "Task Not Found",
                  "required": [
                    "operation_id",
                    "code_id",
                    "message"
                  ],
                  "properties": {
                    "operation_id": {
                      "$ref": "#/paths/~1v1~1open-banking~1providers/get/responses/200/content/application~1json/schema/properties/operation_id"
                    },
                    "code_id": {
                      "type": "string"
                    },
                    "message": {
                      "type": "string",
                      "description": "High level description on what has failed"
                    }
                  },
                  "example": {
                    "operation_id": "ingest_transactions_get",
                    "code_id": "not_found",
                    "message": "Task not found"
                  }
                },
                "example": {
                  "operation_id": "v2_ingest_status_get",
                  "code_id": "task_not_found",
                  "message": "Task ID [6c7d06a7-5b40-4556-91d4-6b6d1a7db3f1] does not exist or it has expired"
                }
              }
            }
          },
          "405": {
            "description": "The request uses an unexpected HTTP method"
          },
          "5XX": {
            "description": "An unexpected error occurred on the server side"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "OAuth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "/v1/oauth/token",
            "scopes": {}
          }
        },
        "description": "\nAuthentication flow:\n\n1. Perform OAuth2 Client Credentials authentication using API Credentials (`client_id`,`client_secret`) to obtain an `access_token` against `/v1/oauth/token` endpoint,\n2. Use `access_token` as Bearer Authorisation for every other API request,\n3. Include `X-Client-Id` (=client_id) within the header of every API request,\n4. Note that some of the requests may also require `X-Customer-Id` to be provided within the request header.\n\n### Examples\nObtain OAuth2 `access_token` and `refresh_token` using `grant_type=client_credentials` and HTTP Basic auth header\n\n```\ncurl --basic --user {{client_id}}:{{client_secret}} \\\n  -X POST https://api-sandbox.thisisbud.com/v1/oauth/token \\\n  -H 'Content-Type: application/x-www-form-urlencoded' \\\n  -d grant_type=client_credentials\n```\n\nSuccessful response:\n```\n{\n  \"operation_id\": \"oauth_token_post\",\n  \"data\": {\n    \"access_token\": \"dd0c17e3fd6d2ce94aa091257a3ea393b4f9b5cf3d3e998f07dc9826da86ff15\",\n    \"token_type\": \"bearer\",\n    \"expires_in\": 3600,\n    \"refresh_token\": \"fac32cca7559d9f6e8f1dfe9a99c71fa1dcfeb482bedf287d7934d2667ae54b3\"\n  }\n}\n```\n\nRefresh `access_token` token using `refresh_token` against `/v1/oauth/token` endpoint with `grant_type=refresh_token`\n\n```\ncurl -X POST \\\n  https://api-sandbox.thisisbud.com/v1/oauth/token \\\n  -H 'Content-Type: application/x-www-form-urlencoded' \\\n  -H 'X-Client-Id: {{client_id}}' \\\n  -d 'grant_type=refresh_token&refresh_token={{refresh_token}}'\n```\n\nSuccessful response:\n```\n{\n    \"operation_id\": \"oauth_token_post\",\n    \"data\": {\n        \"access_token\": \"cc0c17e3fd6d2ce94aa091257a3ea393b4f9b5cf3d3e998f07dc9826da86ff94\",\n        \"token_type\": \"bearer\",\n        \"expires_in\": 3600,\n        \"refresh_token\": \"ffc30cca7559d9f6e8f1dfe9a99c71fa1dcfeb482bedf287d7934d2667ae54b3\"\n    }\n}\n```\n"
      }
    }
  }
}
````