Dynamic registration | Virgin Money Developer Portal

Page contents

Endpoint config
API calls
Models

What this API does:

To start interacting with Virgin Money via our Open Banking APIs, register with Open Banking and then use the Dynamic Registration endpoint for each brand.*

This API allows you to be given authorisation credentials to be used to call the Token endpoint.

*For the purposes of testing, our sandbox is a single registration.

If you wish to on-board with us using Dynamic Client Registration, you must be enrolled with Open Banking.

If you are not enrolled with Open Banking and have suitable eIDAS (QWAC/QSEAL) certificates and appropriate permissions from your relevant NCA please email us at OpenBankingResponse@cybg.com with the subject "Manual Registration" and we will process your request.

Endpoint configuration

GET /.well-known/openid-configuration

Sandbox: cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.0/.well-known/openid-configuration

Production: api.openbanking.virginmoney.com/open-banking/v3.0/.well-known/openid-configuration

This endpoint allows you to retrieve details of the urls required to interact with us (e.g Dynamic Registration).

POST /register

Sandbox: cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.2/register

Production: api.openbanking.virginmoney.com/open-banking/v3.2/register

The API endpoint lets you ask Virgin Money to create a new domestic-standing-order-consents resource:

The POST action tells Virgin Money that a domestic standing order payment consent has been staged. At this point, it does not identify the customer to Virgin Money; the request payload may not contain information about the account to be debited.
The endpoint lets you send a copy of the consent between the customer and you, to Virgin Money for the customer to authorise.

This endpoint allows you to register with the bank. Pass in the required details to allow yourself to be validated by Virgin Money. Assuming you pass this validation step, you will then be provided with Client Credentials and a Client Secret.

The request will support JOSE as a body/request payload. For the structure of the request JOSE, please refer to Open Banking.

Currently we support only new registration.

PUT /register/{ConsentId}

Sandbox: api.openbanking.virginmoney.com/open-banking/v3.2/register

Production: api.openbanking.virginmoney.com/open-banking/v3.2/register

The endpoint allows you to update previously registered details with the bank. Pass in the required details to allow yourself to be validated by Virgin Money. Assuming you pass this validation step, your details will be updated.

The request will support JOSE as a body/request payload. For the structure of the request JOSE, please refer to Open Banking.

Before calling the API, you must have an access token issued by Virgin Money using a 'Client Credentials' grant.

DELETE /register/{ConsentId}

Sandbox: api.openbanking.virginmoney.com/open-banking/v3.2/register

Production: api.openbanking.virginmoney.com/open-banking/v3.2/register

The endpoint allows you to delete the registration.

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

GET /register/{ClientId}

Sandbox: api.openbanking.virginmoney.com/open-banking/v3.2/register

Production: api.openbanking.virginmoney.com/open-banking/v3.2/register/{ClientId}

The endpoint allows you to retrieve registration details from the bank.

Before calling the API, you must have an access token issued by Virgin Money using 'Client Credentials' grant.

API calls

Default

GET /open-banking/v3.0/.well-known/openid-configuration Open Banking OIDC Server

Open Banking OIDC Server

No parameters

Responses

Response content type

Code	Description
200	OK

POST /open-banking/v3.2/register Register client details

Name

Description

body *

(body)

Example Value Model

{}

Parameter content type

{

description:

Jose

}

Content-Type *

string

(header)

application/jose

Responses

Response content type

Code Description

201

Created

Example Value Model

{
  "iss": "string",
  "iat": "string",
  "exp": "string",
  "aud": "string",
  "jti": "string",
  "client_id": "string",
  "client_secret": "string",
  "redirect_uris": [
    "string"
  ],
  "tokenEndpointAuthMethod": "string",
  "grant_types": [
    "string"
  ],
  "responseTypes": [
    "string"
  ],
  "software_id": "string",
  "scope": "string",
  "softwareStatement": "string",
  "applicationType": "string",
  "idTokenSignedResponseAlg": "string",
  "requestObjectSigningAlg": "string",
  "tokenEndpointAuthSigningAlg": "string"
}

#/definitions/OBClientRegistration1OBClientRegistration1{

iss	`string` Domain Name
iat	`string` Client created information
exp	`string` Expired At
aud	`string` Client id
jti	`string` JTI id in uuid format
client_id	`string` Client id in uuid format
client_secret	`string` Client_secret in uuid format
redirect_uris	[`string` redirects to https://redirector.openwrks.com/open-banking/callback Link opens in a new window ]
tokenEndpointAuthMethod	`string` client id in uuid format
grant_types	[`string` authorization_code,client_credentials,refresh_token ]
responseTypes	[`string` authorization_code,client_credentials,refresh_token ]
software_id	`string` Software id in UUID format
scope	`string` Scope
softwareStatement	`string` SoftwareStatementJWT
applicationType	`string` ApplicationType
idTokenSignedResponseAlg	`string` TokenSignedResponse information
requestObjectSigningAlg	`string` RequestObjectSigning information
tokenEndpointAuthSigningAlg	`string` Id token Signed Response Information

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a JOSE signature of the body of the payload.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a JOSE signature of the body of the payload.	string

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a JOSE signature of the body of the payload.	string

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a JOSE signature of the body of the payload.	string

PUT /open-banking/v3.2/register/{ClientId} Update client details

Name

Description

Authorization *

string

(header)

Base64 encode(ClientID:ClientSecret)

body *

(body)

Example Value Model

{}

Parameter content type

{

description:

Jose

}

ClientId *

string

(path)

Responses

Response content type

Code Description

200

Example Value Model

{
  "iss": "string",
  "iat": "string",
  "exp": "string",
  "aud": "string",
  "jti": "string",
  "client_id": "string",
  "client_secret": "string",
  "redirect_uris": [
    "string"
  ],
  "tokenEndpointAuthMethod": "string",
  "grant_types": [
    "string"
  ],
  "responseTypes": [
    "string"
  ],
  "software_id": "string",
  "scope": "string",
  "softwareStatement": "string",
  "applicationType": "string",
  "idTokenSignedResponseAlg": "string",
  "requestObjectSigningAlg": "string",
  "tokenEndpointAuthSigningAlg": "string"
}

#/definitions/OBClientRegistration1OBClientRegistration1{

iss	`string` Domain Name
iat	`string` Client created information
exp	`string` Expired At
aud	`string` Client id
jti	`string` JTI id in uuid format
client_id	`string` Client id in uuid format
client_secret	`string` Client_secret in uuid format
redirect_uris	[`string` redirects to https://redirector.openwrks.com/open-banking/callback Link opens in a new window ]
tokenEndpointAuthMethod	`string` client id in uuid format
grant_types	[`string` authorization_code,client_credentials,refresh_token ]
responseTypes	[`string` authorization_code,client_credentials,refresh_token ]
software_id	`string` Software id in UUID format
scope	`string` Scope
softwareStatement	`string` SoftwareStatementJWT
applicationType	`string` ApplicationType
idTokenSignedResponseAlg	`string` TokenSignedResponse information
requestObjectSigningAlg	`string` RequestObjectSigning information
tokenEndpointAuthSigningAlg	`string` Id token Signed Response Information

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a JOSE signature of the body of the payload.	string

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a JOSE signature of the body of the payload.	string

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a JOSE signature of the body of the payload.	string

DELETE /open-banking/v3.2/register/{ClientId} Delete client details

Name	Description
Authorization * string (header)	Base64 encode(ClientID:ClientSecret)
ClientId * string (path)

Responses

Response content type

Code Description

204

No Content

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a JOSE signature of the body of the payload.	string

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a JOSE signature of the body of the payload.	string

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a JOSE signature of the body of the payload.	string

GET /open-banking/v3.2/register/{ClientId} Get client details

Name	Description
Authorization * string (header)	Base64 encode(ClientID:ClientSecret)
ClientId * string (path)

Responses

Response content type

Code Description

200

Example Value Model

{
  "iss": "string",
  "iat": "string",
  "exp": "string",
  "aud": "string",
  "jti": "string",
  "client_id": "string",
  "client_secret": "string",
  "redirect_uris": [
    "string"
  ],
  "tokenEndpointAuthMethod": "string",
  "grant_types": [
    "string"
  ],
  "responseTypes": [
    "string"
  ],
  "software_id": "string",
  "scope": "string",
  "softwareStatement": "string",
  "applicationType": "string",
  "idTokenSignedResponseAlg": "string",
  "requestObjectSigningAlg": "string",
  "tokenEndpointAuthSigningAlg": "string"
}

#/definitions/OBClientRegistration1OBClientRegistration1{

iss	`string` Domain Name
iat	`string` Client created information
exp	`string` Expired At
aud	`string` Client id
jti	`string` JTI id in uuid format
client_id	`string` Client id in uuid format
client_secret	`string` Client_secret in uuid format
redirect_uris	[`string` redirects to https://redirector.openwrks.com/open-banking/callback Link opens in a new window ]
tokenEndpointAuthMethod	`string` client id in uuid format
grant_types	[`string` authorization_code,client_credentials,refresh_token ]
responseTypes	[`string` authorization_code,client_credentials,refresh_token ]
software_id	`string` Software id in UUID format
scope	`string` Scope
softwareStatement	`string` SoftwareStatementJWT
applicationType	`string` ApplicationType
idTokenSignedResponseAlg	`string` TokenSignedResponse information
requestObjectSigningAlg	`string` RequestObjectSigning information
tokenEndpointAuthSigningAlg	`string` Id token Signed Response Information

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

400

Bad request

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a JOSE signature of the body of the payload.	string

401

Unauthorized

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

403

Forbidden

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a JOSE signature of the body of the payload.	string

404

Not found

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

405

Method Not Allowed

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

406

Not Acceptable

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

429

Too Many Requests

Headers:

Name	Description	Type
Retry-After	Number in seconds to wait	integer
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string

500

Internal Server Error

Example Value Model

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

#/definitions/OBErrorResponse1OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	`string` minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	`string` minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	`string` minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	`string` URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

Headers:

Name	Description	Type
x-fapi-interaction-id	An RFC4122 UID used as a correlation id.	string
x-jws-signature	Header containing a JOSE signature of the body of the payload.	string

Models

OBErrorResponse1

OBErrorResponse1{

description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code*

string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message*

string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors*

[
minItems: 1

#/definitions/OBError1OBError1{

ErrorCode*	string minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	string minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	string minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	string URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]

}

OBError1

OBError1{

ErrorCode*	string minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing
Message*	string minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
Path	string minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
Url	string URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}

OBClientRegistration1

OBClientRegistration1{

iss	string Domain Name
iat	string Client created information
exp	string Expired At
aud	string Client id
jti	string JTI id in uuid format
client_id	string Client id in uuid format
client_secret	string Client_secret in uuid format
redirect_uris	[string redirects to https://redirector.openwrks.com/open-banking/callback Link opens in a new window ]
tokenEndpointAuthMethod	string client id in uuid format
grant_types	[string authorization_code,client_credentials,refresh_token ]
responseTypes	[string authorization_code,client_credentials,refresh_token ]
software_id	string Software id in UUID format
scope	string Scope
softwareStatement	string SoftwareStatementJWT
applicationType	string ApplicationType
idTokenSignedResponseAlg	string TokenSignedResponse information
requestObjectSigningAlg	string RequestObjectSigning information
tokenEndpointAuthSigningAlg	string Id token Signed Response Information

}

Having trouble?

Contact our dedicated team members via our ticketing system or via our support mailbox

OpenBankingResponse@virginmoney.com