CoP | Documentation

Fetch Records Using BatchID

GET /requester/v1.0/cop-iban-check/bulk-account-verifications/batch/{batchId}

The API allows us to download the response report of a particular file that had been processed earlier in bulk upload name verification. By using the batchID associated with the file, the user will be able to download this response report.

Request Headers

Attribute	Type	Condition	Description
Authorization	String	Mandatory	An authorisation token as per https://tools.ietf.org/html/rfc6750

Request Parameters

Attribute	Type	Conditional	Description
pageIndex	Integer	Optional	The page selected for the response
pageSize	Integer	Optional	The no. of transactions to be displayed in each page
format	String	Optional	Allowed values : csv. If it is provided as csv, the response format will be downloaded as a csv file. If left blank, JSON response will be received.

Response Headers

Attribute	Type	Condition	Description
Content-Type	String	Mandatory	Value = application/json or application/csv

Response Body

Attribute	Type	Condition	Description
File	application/csv	Optional	if a request param 'format' is specified as csv. csv file containing the list of name verification request corresponding to the particular batchID will be downloaded.

(OR)

Attribute	Type	Condition	Description
Result	AuditDto	Mandatory	A JSON Response with list of name verification request corresponding to the particular batchID will be displayed
Result.ID	String	Mandatory	Each transaction will have a unique ID associated for it
Result.RequestTimeIssued	OffsetDateTime	Mandatory	The date & time when the request was sent
Result.RequestSource	String	Optional	Whether the request was made using single request or batch
Result.RequestStatus	String	Optional	Whether the transaction/request is successfully processed or failed
Result.BatchId	String	Optional	A unique BatchID is generated for every batch uploaded
Result.RequestSchemeName	String	Optional	Scheme Name can either be SCAN/IBAN. SCAN will consist of 6+8 digits; IBAN will consist of 22 characters in which last 14 digits will consist of SCAN.
Result.RequestAccountType	String	Optional	Account type of the payee, it could be either a personal account or a business account.
Result.RequestIdentification	String	Optional	Payee's sort code and account number or IBAN
Result.RequestName	String	Optional	Payee's account name from the request
Result.RequestSecondaryIdentification	String	Optional	Secondary Reference Data of the payee provided for SRD level name checks
Result.RequestedOrgId	String	Optional	Organisation ID of the CoP Requestor Participant
Result.RequestedOrgName	String	Optional	Organisation Name of the CoP Requestor Participant
Result.UserId	String	Optional	The ID of user who has initiated the request
Result.ClientId	String	Optional	The ID of the application from where request has been initiated
Result.UserType	String	Optional	Whether the user is a management user or one of the developers
Result.RequestedCopEpUrl	String	Optional	End point URL of the Responder
Result.ResponseTimeReceived	OffsetDateTime	Optional	The date & time when the response was received
Result.ResponseMatched	Boolean	Optional	If the payee details fully match then, Matched = TRUE, else, Matched = FALSE
Result.ResponseReasonCode	String	Optional	When Matched = False, reason codes are returned based on the relevant scenarios
Result.ResponseName	String	Optional	For certain reason codes such as MBAM, BAMM and PAMM the actual account names of the payee is returned
Result.PayUkCopRegistrationId	String	Optional	PayUkCopRegistrationId registered in OBIE of the requesting participant
Result.OutcomeCode	String	Optional	The outcome code associated with Management Information Report. Th codes denotes whether the customer decided to cancel the transaction or continue with it
Result.SLAResponse	String	Optional	The time taken for the response to be returned for a request
Result.TransactionNotes	List (TransactionNote)	Optional	Notes added by the user for a transaction
Result.TransactionNotes.Index	String	Mandatory	It specifies the order of a particular note from the list of notes
Result.TransactionNotes.TransactionId	String	Mandatory	An audit.ID associated for the transaction notes
Result.TransactionNotes.Note	String (256 chars)	Mandatory	The content of notes added
Result.TransactionNotes.CreatedDate	String ($date-time)	Mandatory	The date & time when the response was received
Result.TransactionNotes.CreatedBy	String	Mandatory	The user who has added the note
Result.TransactionNotes.FirstName	String	Mandatory	First Name of the creator
Result.TransactionNotes.LastName	String	Mandatory	Last Name of the creator
Pagination	Pagination	Mandatory	Details about the page
Pagination.PageIndex	Integer	Mandatory	The page selected for the response
Pagination.PageSize	Integer	Mandatory	The no. of transactions to be displayed in each page
Pagination.PageTotal	Integer	Mandatory	Total no. of transactions displayed in a page
Pagination.Total	Integer	Mandatory	Total no. of transactions of the provided BatchID

Response Codes

Status Code	Description
200	File downloaded successfully
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 as csv file

Request

GET /requester/v1.0/cop-iban-check/bulk-account-verifications/batch/{batchId}?format=csv
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA

Response

HTTP/1.1 200 OK
cache-control: private
content-length: 244
content-type: application/csv

Example as JSON

Request

GET /requester/v1.0/cop-iban-check/bulk-account-verifications/batch/{batchId}
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
content-type: application/json

Response

HTTP/1.1 200 OK
cache-control: private
content-length: 244
content-type: application/json

{
  "result": [
    {
      "Id": "TBKE689579",
      "RequestTimeIssued": "2023-11-23T12:27:32.457Z",
      "RequestSource": "BATCH",
      "RequestStatus": "SUCCESS",
      "BatchId": "1700742452KyK",
      "RequestSchemeName": "SortCodeAccountNumber",
      "RequestAccountType": "Personal",
      "RequestIdentification": "10000011100024",
      "RequestName": "Count Kavin Anderson",
      "RequestedOrgId": "0015800001ZEc1XAAT",
      "RequestedOrgName": "HSBC UK",
      "UserId": "admin+int@banfico.com",
      "ClientId": "Test2293",
      "UserType": "internal",
      "RequestedCopEpUrl": "https://api.qnb-cop-sbx.banfico.io/responder/v1.0/cop-iban-check/account-verifications",
      "ResponseTimeReceived": "2023-11-23T12:27:32.566Z",
      "ResponseMatched": false,
      "ResponseReasonCode": "AC01",
      "PayUkCopRegistrationId": "000001",
      "SLAResponse": true,
      "TransactionNotes": []
    },
    {
      "Id": "ZEDP689578",
      "RequestTimeIssued": "2023-11-23T12:27:32.367Z",
      "RequestSource": "BATCH",
      "RequestStatus": "SUCCESS",
      "BatchId": "1700742452KyK",
      "RequestSchemeName": "SortCodeAccountNumber",
      "RequestAccountType": "Personal",
      "RequestIdentification": "10000011100002",
      "RequestName": "Mr JAmEs JohNsoN",
      "RequestedOrgId": "0015800001ZEc1XAAT",
      "RequestedOrgName": "HSBC UK",
      "UserId": "admin+int@banfico.com",
      "ClientId": "Test2293",
      "UserType": "internal",
      "RequestedCopEpUrl": "https://api.qnb-cop-sbx.banfico.io/responder/v1.0/cop-iban-check/account-verifications",
      "ResponseTimeReceived": "2023-11-23T12:27:32.452Z",
      "ResponseMatched": false,
      "ResponseReasonCode": "AC01",
      "PayUkCopRegistrationId": "000001",
      "SLAResponse": true,
      "TransactionNotes": []
    }
  ],
  "pagination": {
    "pageIndex": 0,
    "pageSize": 20,
    "pageTotal": 1,
    "total": 2
  }
}

Getting Started

Internal Developer

External Developer