Incremental loading offers a more efficient and effective way to update large datasets in bulk upload scenarios. By focusing on only the changed data. The system compares the uploaded document by the customer with our records to determine which ones have been added, modified, or deleted since the last upload.
POST /responder/v1.0/cop-iban-check/uk/bulk-personal-accounts
The API allows us to upload a list of account details in a file (.xls or .xlsx or .csv) and account creation will be done against each row provided.
The account details have to be uploaded using this template
and the data in the file will undergo a validation check prior to account creation.
File with no validation failures will be processed further for account creation.
File with validation failures will not be processed. The row/rows with validation failures will be displayed in the JSON response.
The account details have to be uploaded using this template
Response Headers
Attribute
Type
Condition
Description
Content-Type
String
Mandatory
application/json
Response Body
Attribute
Type
Condition
Description
Data
Response
Mandatory
Success response - File with no validation failures
Data
ValidationFailureResponse
Mandatory
Failure response - File with validation failures
Response Codes
Status Code
Description
201
Created
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
Request
POST /responder/v1.0/cop-iban-check/uk/bulk-personal-accounts
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
Content-Type: multipart/form-data
Accept: multipart/form-data
Form-data:
Key: fileValue: A .xls or .xlsx or .csv file has to be uploaded in the provided template
Response
# Success Response for files with no validation failuresHTTP/1.1 201 CREATED
Content-Type: application/json
{"result":"Upload successful and accounts will be created now",
"links":{}}
Failure Response
# Failure Response for files with validation failuresHTTP/1.1 400 Bad Request
Content-Type: application/json
{"Code":"Field Invalid",
"Id":"1665557004ayE",
"Message":"Upload failed. Click here to download the file containing the details of error(s). Fix the errors and upload the file again",
"Errors":[{"ErrorCode":"Field Invalid",
"Message":"Failed Index: 2, Failed Column: Invalid account number 250000011"}, {"ErrorCode":"Field Invalid",
"Message":"Failed Index: 5, Failed Column: Invalid sort code 1000001"}]}
Personal account field validations
Field
Condition
Constraint
AccountNumber
Mandatory
Should be either 8 or 22 digits
Honorific
Optional
Should not contain integers
FirstName
Mandatory
Should not contain integers
MiddleName
Optional
Should not contain integers
LastName
Mandatory
Should not contain integers
PreferredName
Optional
Should not contain integers
AccountName
Optional
Should not contain integers
IsJointAccount
Mandatory
true/false
IsAccountLevelSRD
Mandatory
true/false
AccountType
Mandatory
Personal/Business
AccountRef
Optional
Should be less than 140 characters
SortCode
Mandatory
Should be either 6 digits or null
RestrictedCode
Optional
OPTO/CASS
Business Account Management using Bulk Upload
Incremental Approach:
Incremental loading offers a more efficient and effective way to update large datasets in bulk upload scenarios. By focusing on only the changed data. The system compares the uploaded document by the customer with our records to determine which ones have been added, modified, or deleted since the last upload.
POST /responder/v1.0/cop-iban-check/uk/bulk-business-accounts
The API allows us to upload a list of account details in a file (.xls or .xlsx or .csv) and account creation will be done against each row provided.
The account details have to be uploaded using this template
and the data in the file will undergo a validation check prior to account creation.
File with no validation failures will be processed further for account creation.
File with validation failures will not be processed. Validation failures will be displayed in the JSON response.
The account details have to be uploaded using this template
Response Headers
Attribute
Type
Condition
Description
Content-Type
String
Mandatory
application/json
Response Body
Attribute
Type
Condition
Description
Data
Response
Mandatory
Success response - File with no validation failures
Data
ValidationFailureResponse
Mandatory
Failure response - File with validation failures
Response Codes
Status Code
Description
201
Created
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
Request
POST /responder/v1.0/cop-iban-check/uk/bulk-business-accounts
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
Content-Type: multipart/form-data
Accept: multipart/form-data
Form-data:
Key: fileValue: A .xls or .xlsx or .csv file has to be uploaded in the provided template
Response
# Success Response for files with no validation failuresHTTP/1.1 200 OK
Content-Type: application/json
{"result":"Upload successful and accounts will be created now",
"links":{}}
Failure Response
# Failure Response for files with validation failuresHTTP/1.1 400 Bad Request
Content-Type: application/json
{"Code":"Field Invalid",
"Id":"1665556860VfZ",
"Message":"Upload failed. Click here to download the file containing the details of error(s). Fix the errors and upload the file again",
"Errors":[{"ErrorCode":"Field Invalid",
"Message":"Failed Index: 3, Failed Column: Invalid account number 231007022"}, {"ErrorCode":"Field Invalid",
"Message":"Failed Index: 5, Failed Column: Invalid account type Businss"}, {"ErrorCode":"Field Invalid",
"Message":"Failed Index: 7, Failed Column: Invalid sort code 1000000"}]}
VOP