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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
UK Open Banking

UK Open Banking Domestic VRP Consents API

The Domestic VRP Consents API from UK Open Banking — 3 operation(s) for domestic vrp consents.

Documentation Provider Profile APIs.io OpenAPI GitHub

UK Open Banking Domestic VRP Consents API is one of 42 APIs that UK Open Banking publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Domestic VRP Consents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and rate-limit docs.

This API exposes 6 operations across 3 paths, and defines 58 schemas. It is described by OpenAPI 3.0.0, at version 4.0.1.

Requests are made against a single base URL, /open-banking/v4.0/aisp.

6 operations 3 paths 58 schemas 1 DELETE1 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.1
Base URL
https://{aspsp-host}/open-banking/v4.0
Authentication
OAuth 2.0, OAuth 2.0
Contact
Service Desk
License
open-licence
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

UK Open Banking Domestic VRP Consents API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (TPPOAuth2Security) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (PSUOAuth2Security) using the authorizationCode flow, exposing 1 scope.

  • TPPOAuth2Security — TPP client credential authorisation flow with the ASPSP
  • PSUOAuth2Security — OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 1 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Domestic VRP Consents 6
POST
/domestic-vrp-consents
Create a domestic VRP consent
domesticVrpConsentsPost 8 params body → 201400401403405406409415
GET
/domestic-vrp-consents/{ConsentId}
Get a Domestic VRP Consent
domesticVrpConsentsGet 7 params → 200400401403405406415429
DELETE
/domestic-vrp-consents/{ConsentId}
Delete a Domestic VRP Consent
domesticVrpConsentsDelete 7 params → 204400401403405406415429
PUT
/domestic-vrp-consents/{ConsentId}
Replace an existing domestic VRP consent
domesticVrpConsentsPut 9 params body → 200400401403405406409415
PATCH
/domestic-vrp-consents/{ConsentId}
Update an existing domestic VRP consent
domesticVrpConsentsPatch 9 params body → 200400401403405406409415
POST
/domestic-vrp-consents/{ConsentId}/funds-confirmation
Confirm Funds Availability for a Domestic VRP
domesticVrpConsentsFundsConfirmation 8 params body → 201400401403405406415429

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress7 (18 properties), OBRisk1 (9 properties), OBDomesticVRPControlParameters (8 properties), OBDomesticVRPInitiation (7 properties). Each schema is shown below with its type and property counts.

OBVRPInteractionTypes
string
Indicates interaction type, currently if customer is present or not present. If not provided the default is OffSession (customer is not present) when the indiv…
OBRemittanceInformation2
object
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' rec…
2 properties
LEI
string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Finan…
ExternalCategoryPurpose1Code
string
Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For a full list of values refer to ExternalCategoryPurpose1Code i…
OBVRPFundsConfirmationResponse
object
The confirmation of funds response contains the result of a funds availability check.
1 property 1 required
StreetName
string
Name of a street or thoroughfare.
OBUltimateCreditor1
object
Ultimate party to which an amount of money is due.
5 properties
Links
object
Links relevant to the payload
5 properties 1 required
ActiveOrHistoricCurrencyCode
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international st…
OBCashAccountCreditor3
object
5 properties 3 required
CountryCode
string
Nation with its own government.
OBInternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in…
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
PostCode
string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
Department
string
Identification of a division of a large organisation or building.
OBActiveCurrencyAndAmount_SimpleType
string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
ExternalProxyAccountType1Code
string
Specifies the external proxy account type code, as published in the proxy account type external code set. For a full list of values see ExternalProxyAccountTyp…
OBVRPConsentType
string
OBVRPFundsConfirmationRequest
object
The OBVRPFundsConfirmationRequest object must be used to request funds availability for a specific amount in the Debtor Account included in the VRP consents.
1 property 1 required
OBActiveOrHistoricCurrencyAndAmount
object
2 properties 2 required
OBExternalPurpose1Code
string
For a full set of values refer to ExternalPurpose1Code in ISOExternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
ISODateTime
string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below:…
OBAddressType2Code
string
Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Extern…
BuildingName
string
Name of a referenced building.
BuildingNumber
string
Number that identifies the position of a building on a street.
OBPAFundsAvailableResult1
object
Availability result, clearly indicating the availability of funds given the Amount in the request.
2 properties 2 required
Floor
string
Number that identifies the level within a building
OBReferredDocumentInformation
object
5 properties
ExternalCreditorReferenceType1Code
string
Specifies the amount type, as published in an external referred amount code set. For a full list of values refer to ExternalCreditorReferenceType1Code in ISOEx…
SubDepartment
string
Identification of a sub-division of a large organisation or building.
OBRegulatoryReporting1
object
Information needed due to regulatory and statutory requirements
3 properties
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
CareOf
string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail f…
OBStatusReason
object
3 properties
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
OBVRPAuthenticationMethods
string
OBInternalExtendedAccountType1Code
string
Specifies the extended type of account if known. For a full set of values refer to OBInternalExtendedAccountType1Code in OBInternalCodeSet [here](https://githu…
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
OBRegulatoryAuthority2
object
Entity requiring the regulatory reporting information.
2 properties
Meta
object
Meta Data relevant to the payload. At present no fields are used for VRP.
OBDomesticVRPInitiation
object
7 properties
PostBox
string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
OBUltimateDebtor1
object
Ultimate party that owes an amount of money to the (ultimate) creditor.
5 properties
ExternalDocumentType1Code
string
Specifies the document type as published in an external document type code list. For a full list of values refer to ExternalDocumentType1Code in ISOExternalCod…
UnitNumber
string
Number that identifies the unit of a specific address .
OBDomesticVRPControlParameters
object
8 properties 4 required
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties 2 required
OBInternalConsentStatus1Code
string
Specifies the status of consent resource in code form. Only AWAU and RJCT can be returned on initial submission. For a full list of values see OBInternalConsen…
OBStructuredRegulatoryReporting3
object
Set of elements used to provide details on the regulatory reporting information.
5 properties
CountrySubDivision
string
Identifies a subdivision of a country such as state, region, county.
OBDomesticVRPConsentResponse
object
4 properties 2 required
OBRemittanceInformationStructured
object
7 properties
Room
string
Information that locates and identifies a room to form part of an address
OBDomesticVRPConsentRequest
object
2 properties 2 required
OBRisk1
object
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
9 properties
OBCashAccountDebtorWithName
object
5 properties 2 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
OBError1
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

open-banking-uk-domestic-vrp-consents-api-openapi.yml Raw ↑

Other APIs UK Open Banking publishes across the network.

UK Open Banking Open Data API
AE Profile APIs.io
UK Open Banking Dynamic Client Registration API
AE Profile APIs.io
UK Open Banking Directory API
AE Profile APIs.io
UK Open Banking Account Access Consents API
AE Profile APIs.io
UK Open Banking Accounts API
AE Profile APIs.io
UK Open Banking ATM API
AE Profile APIs.io
UK Open Banking Balances API
AE Profile APIs.io
UK Open Banking BCA API
AE Profile APIs.io
UK Open Banking Beneficiaries API
AE Profile APIs.io
UK Open Banking Branch API
AE Profile APIs.io
UK Open Banking CCC API
AE Profile APIs.io
UK Open Banking Direct Debits API
AE Profile APIs.io
#Domestic VRP Consents
← Back to U APIs
API Details
ID
open-banking-uk:open-banking-uk-domestic-vrp-consents-api
Base URL
https://{aspsp-host}/open-banking/v4.0
Docs
https://openbankinguk.github.io/read-write-api-site3/v4.0.1/
Provider
UK Open Banking
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=open-banking-uk-domestic-vrp-consents-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/open-banking-uk-domestic-vrp-consents-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of UK Open Banking Domestic VRP Consents 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.