Confirmation of Payee Responder Service

POST /responder/pay.uk/v2.0/confirmation-payee/name-verification

The API allows to confirm payee account details.

Request Headers

Attribute	Type	Condition	Description
Authorization	String	Mandatory	An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-fapi-financial-id	String	Mandatory	The unique id of the ASPSP to which the request is issued.
x-fapi-interaction-id	UUID	Mandatory	An RFC4122 UID used as a correlation id (For Ex - 4e9d15b3-0db4-43b0-9dad-0ac74ae1ff12)
x-jws-signature	String	Mandatory	Header containing a detached JWS signature of the body of the request payload. The signature should be computed as defined in OBIE RW API 3.1.4
Content-Type	String	Mandatory	Standard HTTP Header; Represents the format of the payload being provided in the request. This must be set to application/json.
Accept	String	Optional	Standard HTTP Header; Determine the Content-Type that is required from the Server. If set, it must have the value: application/json. If set to any other value, the CoP Responder must respond with a 406 Not Acceptable.

Request Body

Attribute	Type	Condition	Description
Data	OBNameVerificationRequest1	Mandatory

Response Headers

Attribute	Type	Condition	Description
x-fapi-interaction-id	String	Mandatory	An RFC4122 UUID used as a correlation id.
x-jws-signature	String	Mandatory	Header containing a detached JWS signature of the body of the payload
Content-Type		Optional	Standard HTTP Header; represents the format of the payload being provided in the request. This must be set to application/json.
Retry-After	String	Optional	This header will include responses with the HTTP status code of 429 (Too many requests) and also 503 (Service Unavailable).

Response Body

Attribute	Type	Condition
Data	OBNameVerificationResponse1Data	Mandatory
Data.VerificationReport	VerificationReport	Mandatory
Data.VerificationReport.Matched	Boolean	Mandatory
Data.VerificationReport.ReasonCode	ReasonCodes	Conditionally Mandatory
Data.VerificationReport.Name	String	Conditionally Mandatory
Links	Links	Mandatory
Links.Self	String	Mandatory
Links.First	String	Optional
Links.Prev	String	Optional
Links.Next	String	Optional
Links.Last	String	Optional
Meta	Meta	Mandatory
Meta.TotalPages	Integer	Optional
Meta.FirstAvailableDateTime	OffsetDateTime	Optional
Meta.LastAvailableDateTime	OffsetDateTime	Optional

Response Codes

Status Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
405	Method Not Allowed
406	Not Acceptable
415	Unsupported Media Type
429	Too Many Requests
500	Internal Server Error

Example 1: Account with Secondary Reference Data (SRD)

• Request

POST /responder/pay.uk/v2.0/confirmation-payee/name-verification
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-fapi-financial-id: 001580000103UBAAC2
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
x-jws-signature: eyJodHRw..jVZrmU_2q5fGa
Content-Type: application/json
Accept: application/json

{
  "Data": {
    "AccountType": "Personal",
    "Identification": "10000010000009",
    "Name": "John Doe",
    "SchemeName": "SortCodeAccountNumber",
    "SecondaryIdentification": "Test"
  }
}

• Response

HTTP/1.1 200 OK
x-jws-signature: eyJodHRw..jVZrmU_2q5fGa
Content-Type: application/json

{
  "Data": {
   "VerificationReport": {
    "Matched": true
    }
  },
  "Links": {
     "Self": "/responder/pay.uk/v2.0/confirmation-payee/name-verification"
   },
  "Meta": {
    "TotalPages": 1
  }
}

Example 2: Account without Secondary Reference Data (SRD)

• Request

POST /responder/pay.uk/v2.0/confirmation-payee/name-verification
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-fapi-financial-id: 001580000103UBAAC2
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
x-jws-signature: eyJodHRw..jVZrmU_2q5fGa
Content-Type: application/json
Accept: application/json

{
  "Data": {
    "AccountType": "Personal",
    "Identification": "10000010000009",
    "Name": "John Doe",
    "SchemeName": "SortCodeAccountNumber"
  }
}

• Response

HTTP/1.1 200 OK
x-jws-signature: eyJodHRw..jVZrmU_2q5fGa
Content-Type: application/json

{
  "Data": {
   "VerificationReport": {
    "Matched": true
    }
  },
  "Links": {
     "Self": "/responder/pay.uk/v2.0/confirmation-payee/name-verification"
   },
  "Meta": {
    "TotalPages": 1
  }
}

Response codes

Reason Code	Description
ANNM	Account Name does not match.
MBAM	There may be a match on the Account Name. (No, Close Match).
BANM	Business account, name matches.
PANM	Personal account, name matches.
BAMM	Business account, name may match.
PAMM	Personal account, name may match.
AC01	Incorrect Account Number.
IVCR	Invalid Customer Reference.
ACNS	Account type not support for CoP.
OPTO	Opted out of the CoP Scheme.
CASS	Account has been switched.
SCNS	Sort code not supported by Endpoint.