Consents
Account access consents for third-party applications.
Consents
Consents in OBP allow a user to grant a third-party application access to their account data or to make payments on their behalf. Consents are central to Open Banking and PSD2 compliance. For recurring payments, see Variable Recurring Payments.
How Consents Work
- Create a consent — the third-party app requests a consent specifying which accounts and views it needs access to
- User authorises — the account holder reviews and approves the consent (via redirect, OTP, or SCA)
- Access granted — the app receives a consent JWT that it can use to access the permitted resources
- Consent expires or is revoked — consents have a time limit and can be revoked by the user at any time
Account Access Consents
Account access consents grant read access to account data (balances, transactions, etc.) for a limited time. This is the standard Open Banking / PSD2 Account Information Service (AIS) flow.
Creating an Account Access Consent
POST https://YOUR_OBP_HOST/obp/v6.0.0/banks/BANK_ID/my/consents/SCA_METHOD
{
"everything": false,
"account_access": [
{
"account_routing": {
"scheme": "AccountId",
"address": "ACCOUNT_ID"
},
"view_id": "owner"
}
],
"entitlements": [],
"consumer_id": "CONSUMER_ID_OF_TPP",
"valid_from": "2026-01-01T00:00:00Z",
"time_to_live": 3600
}The SCA_METHOD determines how the user authorises the consent. Options include SMS, EMAIL, and IMPLICIT.
Answering the Consent Challenge
After creation, the user receives a challenge (e.g. an OTP via SMS or email). Answer it to activate the consent:
POST https://YOUR_OBP_HOST/obp/v6.0.0/banks/BANK_ID/consents/CONSENT_ID/challenge
{
"answer": "123456"
}Using the Consent
Once authorised, the consent response includes a JWT. The third-party application includes this JWT in API calls to access the permitted account data:
curl -X GET "https://YOUR_OBP_HOST/obp/v6.0.0/my/banks/BANK_ID/accounts/ACCOUNT_ID/owner/transactions" \
-H "Content-Type: application/json" \
-H "Consent-JWT: YOUR_CONSENT_JWT"Managing Consents
Users can view and revoke their consents:
GET /obp/v6.0.0/banks/BANK_ID/my/consentsDELETE /obp/v6.0.0/banks/BANK_ID/my/consents/CONSENT_IDYou can also manage your consents in the portal under My Consents.
Consent Status
| Status | Description |
|---|---|
INITIATED | Consent created, awaiting user authorisation |
ACCEPTED | User has authorised the consent, it is now active |
REJECTED | User rejected the consent request |
REVOKED | User revoked a previously active consent |
Related
- Variable Recurring Payments — VRP consents for recurring payments
- Account Access — how Views control data access
- OAuth2 / OIDC — authentication flows for third-party apps
- Transaction Requests — making payments
- What Opey Can Do — how the AI assistant uses consents built from your entitlements
- My Consents — manage your active consents
- Consent endpoints in the API Explorer