This API is for confirmation of payee inbound. This API will provide the Pay.UK defined response for name matching on a received name with the banks stored name on the provided account details (Account Number + Sortcode) for both retail and business.
https://www.openbanking.org.uk/terms
production
https://openbanking-ma-sandbox.santander.co.uk/sanuk/external-sandbox
Santander Internal Release Version: 2.9.1
Paths
/accounts/name-verification
post /accounts/name-verification
Account Name Verification
Account name verification endpoint
Lookup the account details by way of a POST to find the payee. Return a match indicator, reason code and correct account name (in the event of a close match)
TPPOAuth2SecurityNV
TPPOAuth2SecurityNV
(oauth2 application)
Token URL
$(token-url)
Scopes
name-verification
An access token explicitly created for confirmation of payee
Authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-fapi-financial-id
Required in header
string
The unique id of the ASPSP to which the request is issued
x-fapi-interaction-id
Required in header
string
An RFC4122 UID used as a correlation id
x-jws-signature
Required in header
string / base64
Header containing a detached JWS signature of the body of the request payload
requestBody
Required in body
object
Request object as per technical guide
Content-Type
Optional in header
string
application/json; charset=utf-8
Accept
Optional in header
string
application/json; charset=utf-8
200
400
Bad Request
401
Unauthorised
{
"schema": {
"type": "string"
}
}403
Forbidden
{
"schema": {
"type": "string"
}
}404
Not Found
{
"schema": {
"type": "string"
}
}405
Method Not Allowed
{
"schema": {
"type": "string"
}
}406
Not Acceptable
{
"schema": {
"type": "string"
}
}429
Too Many Requests
{
"schema": {
"type": "string"
}
}500
Internal Server Error
502
Bad Gateway
{
"schema": {
"type": "string"
}
}503
Service Unavailable
{
"schema": {
"type": "string"
}
}504
Gateway Timeout
{
"schema": {
"type": "string"
}
}Example Request
Example Response
POST https://openbanking-ma-sandbox.santander.co.uk/sanuk/external-sandbox/open-banking/v3.1/confirmation-payee/accounts/name-verification
Try this operation
Definitions
{
"required": [
"Data",
"Links",
"Meta"
],
"properties": {
"Data": {
"required": [
"VerificationReport"
],
"properties": {
"VerificationReport": {
"required": [
"Matched",
"ReasonCode",
"Name"
],
"properties": {
"Matched": {
"type": "boolean",
"example": true
},
"ReasonCode": {
"type": "string",
"example": "ANNM"
},
"Name": {
"type": "string",
"example": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Links": {
"required": [
"Self"
],
"properties": {
"Self": {
"type": "string",
"example": "string"
}
},
"type": "object"
},
"Meta": {
"properties": [],
"type": "object"
}
}
}
{
"required": [
"Code",
"Id",
"Message",
"Errors"
],
"properties": {
"Code": {
"description": "High level textual error code, to help categorize the errors.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Id": {
"description": "A unique reference for the error instance, for audit purposes, in case of unknown\/unclassified errors.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Message": {
"description": "Brief Error message, e.g., 'There is something wrong with the request parameters provided'",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ErrorCode": {
"description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE doesn't standardise this field",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Path": {
"description": "Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Url": {
"description": "URL to help remediate the problem, or provide more information, or to API Reference, or help etc",
"type": "string"
}
},
"required": [
"ErrorCode",
"Message"
],
"additionalProperties": false
}
}
}
}
{
"required": [
"Data"
],
"properties": {
"Data": {
"required": [
"SchemeName",
"AccountType",
"Identification",
"Name",
"SecondaryIdentification"
],
"properties": {
"SchemeName": {
"type": "string",
"example": "SortCodeAccountNumber"
},
"AccountType": {
"type": "string",
"example": "Business"
},
"Identification": {
"type": "string",
"example": "12345612345678"
},
"Name": {
"type": "string",
"example": "Adam Test"
},
"SecondaryIdentification": {
"type": "string",
"example": ""
}
},
"type": "object"
}
}
}