---
updatedAt: 2025-10-24T06:29:45.000Z
agentTools:
  projectIndex: https://developer.integrated.finance/llms.txt
---

# Update an Open Banking Consent

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Open Banking API",
    "description": "Operations for Open Banking",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://sandbox-api.integrated.finance/v1/{instanceId}",
      "description": "Sandbox",
      "variables": {}
    },
    {
      "url": "https://api.integrated.finance/v1/{instanceId}",
      "description": "Production",
      "variables": {}
    }
  ],
  "paths": {
    "/open-banking/{openBankingCode}/consents/{id}": {
      "patch": {
        "tags": [
          "Open Banking Consents"
        ],
        "summary": "Update an Open Banking Consent",
        "operationId": "open-banking-consent.update",
        "parameters": [
          {
            "name": "openBankingCode",
            "in": "path",
            "description": "Alpha 2 code of the open banking country",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "path",
            "description": "ID of the consent",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AccountOpenBankingConsentUpdateRequest"
              },
              "example": {
                "workflow": {
                  "code": "direct"
                },
                "data": {
                  "consent": {
                    "action": "approve",
                    "userId": "00000000-0000-0000-0000-000000000000",
                    "accounts": [
                      "00000000-0000-0000-0000-000000000000",
                      "00000000-0000-0000-0000-000000000000"
                    ]
                  }
                },
                "connect": {},
                "metadata": {}
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Open banking consent updated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountOpenBankingConsentUpdateResponse"
                },
                "example": {
                  "workflow": {
                    "code": "direct"
                  },
                  "data": {
                    "resource": {
                      "location": "https://example.company_return#code={code}&state={state}&id_token={token}"
                    }
                  },
                  "connect": {},
                  "metadata": {}
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "OpenBakingConsentAccount": {
        "type": "object",
        "properties": {
          "accountId": {
            "type": "string",
            "format": "uuid"
          },
          "currency": {
            "type": "string"
          },
          "iban": {
            "type": "string"
          }
        }
      },
      "OpenBankingConsent": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "id of open banking consent"
          },
          "thirdPartyProvider": {
            "$ref": "#/components/schemas/ThirdPartyOpenBankingProvider"
          },
          "status": {
            "$ref": "#/components/schemas/OpenBankingConsentStatus"
          },
          "content": {
            "$ref": "#/components/schemas/OpenBankingConsentContentResource"
          },
          "requestCreatedDateTime": {
            "type": "string",
            "description": "Date & time that the consent request was created",
            "format": "date-time"
          },
          "requestDateTime": {
            "type": "string",
            "description": "Date & time that the consent request was created",
            "format": "date-time"
          },
          "requestExpiryDateTime": {
            "type": "string",
            "description": "Date & time that the consent request expires (or expired)",
            "format": "date-time"
          },
          "grantedDateTime": {
            "type": "string",
            "description": "Date & time that the consent was granted",
            "format": "date-time"
          },
          "grantDateTime": {
            "type": "string",
            "description": "Date & time that the consent was granted",
            "format": "date-time"
          },
          "expiryDateTime": {
            "type": "string",
            "description": "Date & time that the consent expires / expired",
            "format": "date-time"
          },
          "grantExpiryDateTime": {
            "type": "string",
            "description": "Date & time that the consent expires / expired",
            "format": "date-time"
          },
          "revokedDateTime": {
            "type": "string",
            "description": "Date & time that the consent was revoked by the account holder",
            "format": "date-time"
          }
        },
        "description": "Open Banking Consent Resource Object"
      },
      "OpenBankingConsentContentAccountResource": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/OpenBankingConsentContentResource"
          },
          {
            "type": "object",
            "properties": {
              "scope": {
                "$ref": "#/components/schemas/OpenBankingConsentScope"
              },
              "permissions": {
                "$ref": "#/components/schemas/OpenBankingPermissionContentResource"
              }
            }
          }
        ]
      },
      "OpenBankingConsentContentPaymentResource": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/OpenBankingConsentContentResource"
          },
          {
            "type": "object",
            "properties": {
              "scope": {
                "$ref": "#/components/schemas/OpenBankingConsentScope"
              },
              "paymentScope": {
                "$ref": "#/components/schemas/OpenBankingPaymentScope"
              },
              "paymentType": {
                "$ref": "#/components/schemas/OpenBankingPaymentType"
              },
              "instructedAmount": {
                "type": "number"
              },
              "instructedCurrency": {
                "type": "string"
              },
              "creditorAccount": {
                "$ref": "#/components/schemas/OpenBankingCreditorAccount"
              },
              "debtorAccount": {
                "$ref": "#/components/schemas/OpenBankingDebtorAccount"
              },
              "permissions": {
                "$ref": "#/components/schemas/OpenBankingPermissionContentResource"
              },
              "currencyOfTransfer": {
                "type": "string"
              },
              "requestedExecutionDateTime": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        ]
      },
      "OpenBankingConsentContentResource": {
        "required": [
          "scope"
        ],
        "type": "object",
        "properties": {
          "scope": {
            "type": "string"
          }
        },
        "description": "content of open banking consent",
        "discriminator": {
          "propertyName": "scope"
        }
      },
      "OpenBankingConsentScope": {
        "type": "string",
        "enum": [
          "accounts",
          "payments",
          "funds-confirmations"
        ]
      },
      "OpenBankingConsentStatus": {
        "type": "string",
        "description": "status of open banking consent",
        "enum": [
          "awaiting-authorisation",
          "awaiting-exchange",
          "authorisation-declined",
          "authorised",
          "revoked",
          "expired",
          "rejected",
          "consumed"
        ]
      },
      "OpenBankingCreditorAccount": {
        "type": "object",
        "properties": {
          "schemeName": {
            "type": "string"
          },
          "identification": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "iban": {
            "type": "string"
          },
          "currency": {
            "type": "string"
          }
        }
      },
      "OpenBankingDebtorAccount": {
        "type": "object",
        "properties": {
          "iban": {
            "type": "string"
          },
          "currency": {
            "type": "string"
          }
        }
      },
      "OpenBankingEUPermissionContentResource": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/OpenBankingPermissionContentResource"
          },
          {
            "type": "object",
            "properties": {
              "type": {
                "type": "string"
              },
              "accounts": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/OpenBakingConsentAccount"
                }
              },
              "transactions": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/OpenBakingConsentAccount"
                }
              },
              "balances": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/OpenBakingConsentAccount"
                }
              },
              "payments": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/OpenBakingConsentAccount"
                }
              }
            }
          }
        ]
      },
      "OpenBankingGBPermissionContentResource": {
        "type": "object",
        "allOf": [
          {
            "$ref": "#/components/schemas/OpenBankingPermissionContentResource"
          },
          {
            "type": "object",
            "properties": {
              "type": {
                "type": "string"
              },
              "grantedPermissions": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/OpenBankingPermissionGB"
                }
              }
            }
          }
        ]
      },
      "OpenBankingPaymentScope": {
        "type": "string",
        "enum": [
          "domestic",
          "international"
        ]
      },
      "OpenBankingPaymentType": {
        "type": "string",
        "enum": [
          "standard",
          "scheduled",
          "standing-order"
        ]
      },
      "OpenBankingPermissionContentResource": {
        "required": [
          "openBankingCode"
        ],
        "type": "object",
        "properties": {
          "openBankingCode": {
            "type": "string"
          }
        },
        "discriminator": {
          "propertyName": "openBankingCode"
        }
      },
      "OpenBankingPermissionGB": {
        "type": "string",
        "enum": [
          "read-accounts-basic",
          "read-accounts-detail",
          "read-balances",
          "read-beneficiaries-basic",
          "read-beneficiaries-detail",
          "read-direct-debits",
          "read-offers",
          "read-pan",
          "read-party",
          "read-party-psu",
          "read-products",
          "read-scheduled-payments-basic",
          "read-scheduled-payments-detail",
          "read-standing-orders-basic",
          "read-standing-orders-detail",
          "read-statements-basic",
          "read-statements-detail",
          "read-transactions-basic",
          "read-transactions-credits",
          "read-transactions-debits",
          "read-transactions-detail"
        ]
      },
      "ThirdPartyOpenBankingProvider": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "website": {
            "type": "string"
          },
          "applicationName": {
            "type": "string"
          },
          "applicationDescription": {
            "type": "string"
          },
          "applicationWebsite": {
            "type": "string"
          }
        },
        "description": "parameters of open banking provider"
      },
      "AccountOpenBankingConsentOutput": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string"
          },
          "consent": {
            "$ref": "#/components/schemas/OpenBankingConsent"
          }
        },
        "description": "account open banking consent data model",
        "readOnly": true
      },
      "AccountOpenBankingConsentUpdateConnectContainer": {
        "type": "object",
        "description": "connect container"
      },
      "AccountOpenBankingConsentUpdateDataContainer": {
        "type": "object",
        "properties": {
          "consent": {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "description": "custom map including fields to update"
            },
            "description": "custom map including fields to update"
          },
          "account open banking consent": {
            "$ref": "#/components/schemas/AccountOpenBankingConsentOutput"
          }
        },
        "description": "data container"
      },
      "AccountOpenBankingConsentUpdateMetadataContainer": {
        "type": "object",
        "description": "metadata container"
      },
      "AccountOpenBankingConsentUpdateResponse": {
        "required": [
          "connect",
          "data",
          "metadata",
          "workflow"
        ],
        "type": "object",
        "properties": {
          "workflow": {
            "$ref": "#/components/schemas/AccountOpenBankingConsentUpdateWorkflowContainer"
          },
          "data": {
            "$ref": "#/components/schemas/AccountOpenBankingConsentUpdateDataContainer"
          },
          "connect": {
            "$ref": "#/components/schemas/AccountOpenBankingConsentUpdateConnectContainer"
          },
          "metadata": {
            "$ref": "#/components/schemas/AccountOpenBankingConsentUpdateMetadataContainer"
          }
        },
        "description": "response model"
      },
      "AccountOpenBankingConsentUpdateWorkflowContainer": {
        "required": [
          "code"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "workflow code",
            "enum": [
              "direct"
            ]
          }
        },
        "description": "workflow container"
      },
      "AccountOpenBankingConsentUpdateRequest": {
        "required": [
          "connect",
          "data",
          "metadata",
          "workflow"
        ],
        "type": "object",
        "properties": {
          "workflow": {
            "$ref": "#/components/schemas/AccountOpenBankingConsentUpdateWorkflowContainer"
          },
          "data": {
            "$ref": "#/components/schemas/AccountOpenBankingConsentUpdateDataContainer"
          },
          "connect": {
            "$ref": "#/components/schemas/AccountOpenBankingConsentUpdateConnectContainer"
          },
          "metadata": {
            "$ref": "#/components/schemas/AccountOpenBankingConsentUpdateMetadataContainer"
          }
        },
        "description": "request model"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```