How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bud Financial Create a Connection API

Create a new connection to an Open 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.

Bud Financial Create a Connection API is one of 32 APIs that Bud Financial publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Create a Connection. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 7 operations across 7 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 2.10.10.

Requests are made against a single base URL, https://api-sandbox.thisisbud.com.

7 operations 7 paths 28 schemas 3 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.10.10
Base URL
https://api-sandbox.thisisbud.com
Authentication
HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Bud Financial Create a Connection API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (Basic). It supports OAuth 2.0 (OAuth2) using the clientCredentials flow.

  • OAuth2 — Authentication flow: 1. Perform OAuth2 Client Credentials authentication using API Credentials (clientid,clientsecret) to obtain an accesstoken against /v1/oau…

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Create a Connection 7

Create a new connection to an Open Banking provider by using either: (i) Bud's configurable frontend UI (Bud Connect), built to maximise conversion; or (ii) Bud's individual API e…

GET
/v1/open-banking/providers
Retrieve OB Providers
open_banking_providers_get 4 params → 2004004015XX
POST
/v2/open-banking/authorisation-gateway-url
Retrieve Authorisation Gateway URL (v2)
v2_ob_authorisation_gateway_url_post 4 params body → 2014004014054225XX
POST
/v1/open-banking/authorisation-url
Initiate Provider Authorisation
open_banking_authorisation_url_post 4 params body → 2024004014055XX
GET
/v1/open-banking/authorisation-url/{task_id}
Retrieve Authorisation URL
open_banking_authorisation_url_get 4 params → 2004004044055XX
POST
/v1/open-banking/authorisation-codesdeprecated
Submit Authorisation Codes
v1_open_banking_authorisation_codes_post 3 params body → 202400
POST
/v2/open-banking/authorisation-codes
Submit Authorisation Codes V2
v2_open_banking_authorisation_codes_post 3 params body → 202400409
GET
/v1/open-banking/connect/{connection_task_id}
Retrieve Connection Status
open_banking_connect_get 4 params → 2004004044055XX

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are AuthGatewayURLRequestv2 (11 properties), GetOBConnectData (8 properties), OBProvider (7 properties), TaskAuthorise (5 properties). Each schema is shown below with its type and property counts.

TaskManagerMetaData
object
Standard metadata response from the OB task manager
3 properties 3 required
OpenBankingAuthoriseRequest
object
Expected request payload structure
4 properties 1 required
TaskId
string
Bud Task identifier returned from an async task for the requested action
TaskAuthorise
object
Result of GET authorise taskId
5 properties 3 required
OBConnectWebhookBody
object
The payload sent to the client defined webhook (via the console) when an Open Banking (connect or refresh) task completes.
1 property 1 required
AuthGatewayURLResponse
object
Expected response structure.
2 properties 2 required
IngestResponseStatus
string
Ingest response status.
TaskStatusCaps
string
The general status of a task
MaintenanceWindowObject
object
Details on any scheduled maintenance windows
2 properties
TaskCreatedView
object
Standard successful task created response.
2 properties 2 required
BadRequestResponse
object
Expected response structure
4 properties 4 required
ConnectResultCodes
string
The result of the operation. Either success or various error codes.
TaskAuthoriseResponse
object
Expected response structure
3 properties 3 required
OpenBankingConnectResponse
object
Expected response structure
3 properties 3 required
OBSyncWebhookBody
object
The payload sent to the client defined webhook (via the console) when an Open Banking Synchronisation (connect or refresh) task completes.
2 properties 1 required
ProviderTypes
array
One or more provider types that can be used to filter the list of providers that are shown to the customer during the connection flow. If no filter is applied,…
AsyncTaskMetadata
object
Metadata associated with an asynchronous task
3 properties
TaskType
string
The type of task that completed
AuthorisationCodesResponse
object
2 properties 2 required
ResultsMetadata
object
Metadata associated with the response schema
1 property
Error
objectnull
Contains a field specific error message
Errors
object
Contains a list of error messages
AuthorisationCodesRequest
object
2 properties 1 required
TaskCreatedResponseOB
object
Expected response structure
3 properties 3 required
OBProvider
object
7 properties 7 required
GetOBConnectData
object
Status of an Open Banking Aggregation connect or refresh task
8 properties 4 required
OperationId
string
A unique identifier/reference associated with a given endpoint/operation
AuthGatewayURLRequestv2
object
11 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bud-co-create-a-connection-api-openapi.yml Raw ↑

Other APIs Bud Financial publishes across the network.

Bud Financial Aggregation Buckets API
Bud Financial Correct Financial Data API
Bud Financial Custom Insights API
Bud Financial Customer Application Links API
Bud Financial Customer Applications API
Bud Financial Debt Collection Finder API
Bud Financial Enrichment Resources API
Bud Financial Enrichment Totals API
Bud Financial Frontend Widgets API
Bud Financial Income Finder API
Bud Financial Ingest First Party Data API
Bud Financial Initiate Payment - Bud license API
Where this information came from

This is an independent, third-party profile of Bud Financial Create a Connection API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.