GET /authorize

  • Live
  • Sandbox
  • Versionless

Usage

GET /authorize

Description

This API allows you to enable a Member to be able to confirm a payment, account information or funds confirmation request.

At the moment, in our Sandbox, we require you to exchange your certificate as part of MTLS for this endpoint however we are looking into changing this. Please bear with us whilst we get this changed.

API Reference

/authorize
get /authorize

Resource URL

https://api-internal.obtpp.nationwideinterfaces.io/open-banking/oauth /authorize

Query Parameters

client_id
(required)

TPPs MUST provide this value and set it to the client id issued to them by the ASPSP to which the authorization code grant request is being made.

response_type
(required)

OAuth 2.0 requires that this parameter is provided. Value is set to 'code id_token', 'code id_token token' or 'code' TPPs MUST provide this parameter and set its value to one of the three above depending on what the NBS supports as described in its well-known configuration endpoint.

redirect_uri
(required)

TPPs MUST provide the URI to which they want the resource owner's user agent to be redirected to after authorization. This MUST be a valid, absolute URL that was registered during Client Registration with the NBS.

scope
(required)

TPPs MUST specify the scope that is being requested. At a minimum the scope parameter MUST contain openid. The scopes MUST be a sub-set of the scopes that were registered during Client Registration with the NBS.

state

TPPs MAY provide a state parameter. The parameter may be of any format and is opaque to the NBS.

nonce
(required)

Used to help mitigate against replay attacks

request
(required)

The TPP MUST provide a value for this parameter. The parameter MUST contain a JWS that is signed by the TPP. The JWS payload MUST consist of a JSON object cotntaining a request object as per OIDC Core 6.1.

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Resource Summary

Security

Content Type

application/json

Category

OAuth

Response Error Details
  • 400 Bad request
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not found
  • 405 Method Not Allowed
  • 406 Not Acceptable
  • 429 Too Many Requests
  • 500 Internal Server Error

Working...

API Personas

Sam Jones
  • Retail
  • Lives alone
  • Is overdrawn
View Persona
Patrick Nadwarna
  • Retail
  • No regular payments
  • Large balance
View Persona
Cathy Powell
  • Retail
  • Fraud victim
  • Restricted account
View Persona
Josh Chambers
  • Retail
  • Economics student
  • Uses different payment channels
View Persona
Maz Patel
  • Retail
  • Full-time mum
  • Frequent spender
View Persona
Darren Nowak
  • Retail
  • Rarely at home
  • Financially savvy
View Persona
Janet Simpson
  • Retail
  • Closing current account
  • Insufficient funds
View Persona
Melanie Rossi
  • Retail
  • Travels a lot
  • Locked current account
View Persona
Hattie Walker
  • Retail
  • Credit card account
  • Frequent credit card use
View Persona
Victor Braganza
  • Retail
  • Credit card account
  • Inactive account
View Persona
Alex Baker
  • Retail
  • Credit card account
  • Restricted account
View Persona
Martin Hanger
  • Retail
  • Buying new house
  • Evaluating affordability
View Persona
Keesha Mclintock
  • Retail
  • Credit card account
  • Applying for a mortgage
View Persona
Jason Costello
  • Business
  • J C Plumbing
  • New business
View Persona
Jozef Ivan
  • Business
  • The Cake Cave
  • New business
View Persona
Brian McKay
  • Business
  • Johnson's Fish & Chip
  • Money Laundering- Fraud
View Persona
Lee Waterman
  • Business
  • L W Car Parts
  • Lots of payments
View Persona
Muhammed Patel
  • Business
  • Snips
  • Shrinking business
View Persona
Sharon Snow
  • Business
  • Endeavour Web Designs
  • Established, highly successful
View Persona
Lucy Baines
  • Business
  • The Royal Oak
  • Moving business account
View Persona
Roland Hanbury
  • Business
  • Grey Fox Marketing
  • Working abroad
View Persona