Authorisation Gateweay URL Request Payload

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/thisisbud/main/json-schema/thisisbud-usauth-gateway-urlrequestv2-schema.json",
  "title": "Authorisation Gateweay URL Request Payload",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/thisisbud-openapi-us-openapi.yml#/components/schemas/USAuthGatewayURLRequestv2",
  "type": "object",
  "required": [
    "redirect_url"
  ],
  "properties": {
    "redirect_url": {
      "type": "string",
      "description": "URL where the Customer will be redirected to once they have completed the Connection flow. This can be a web based URL or a mobile application internal URL.\nWhen the Customer is redirected to your URL we include the following query parameters:\n- `status`: Represents the status of the connection. It can be `success`, `failure` or `pending`\n- `task_id`: Is the identifier that can be used to check the status of the connection task and retrieve more information in case of failure\n",
      "nullable": false,
      "maxLength": 2083
    },
    "providers": {
      "type": [
        "array",
        "null"
      ],
      "description": "Specify a list of one or more providers that will be displayed to the customer during the connection flow. If only a single provider is given, the customer will no longer be shown the select provider screen.\n\nNote, that these must match the `provider_id` returned by the Retrieve OB Providers endpoint.\n",
      "items": {
        "type": "string"
      }
    },
    "connect_more_accounts_button": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "When enabled, the customer will see an additional button at the end of the connection flow that allows them to start the connection flow again in order to connect to a new provider."
    },
    "accounts_summary": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "When enabled, the customer will be shown a summary screen at the end of the flow that lists the names and balances of all of the accounts that the customer has active consents for (including those connected in previous sessions)."
    },
    "initial_screen": {
      "type": [
        "string",
        "null"
      ],
      "description": "The first screen that the customer will be shown. When value is 'accounts_summary' the customer will see a list of the names and balances of the accounts that the customer currently has active consents for.\nWhen value is 'connect_accounts', the customer will see a list of providers to connect their accounts with.\nBy default this value is 'connect_accounts'. When the value is 'download_data', the customer can download their data in a JSON file.\nWhen the value is 'revoke_consent', the customer can revoke consent for accounts they have previously connected.\n",
      "enum": [
        "accounts_summary",
        "connect_accounts",
        "download_data",
        "revoke_consent"
      ]
    },
    "enable_async_connect": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "When enabled, once the consent authorisation has completed, the customer will be moved on in the flow. The data is then fetched and enriched in the background, instead of the customer waiting on a loading spinner"
    },
    "skip_success_screen": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "When enabled, once the customer has completed the connect flow, they will be redirected back to the client redirect_url bypassing the success screen. This should be used if you don’t want your customers to see the Bud success screen."
    }
  }
}