VOP | Documentation

Personal Account Management

Create Personal Account:

POST /responder/v1.0/cop-iban-check/uk/personal-accounts

The API allows us to create personal account.

Request Headers

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

Request Body

Attribute	Type	Condition	Description
Data	PersonalAccount	Mandatory

Response Headers

Attribute	Type	Condition	Description
Content-Type	String	Mandatory	application/json

Response Body

Attribute	Type	Condition	Description
Data	Response	Mandatory

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

Request

POST /responder/v1.0/cop-iban-check/uk/personal-accounts
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
Content-Type: application/json
Accept: application/json

{
  "accountNumber": "96348762",
  "personalAccountAttribute": [{
    "honorific": "Mr",
    "firstName": "Jonathan",
    "middleName": "",
    "lastName": "Smith",
    "preferredName": "",
    "accountName": ""
  }],
  "jointAccount": false,
  "accountLevelSRD": false,
  "accountType": "Personal",
  "accountStatus": "ACTIVE",
  "accountRef": "",
  "sortCode": "100000",
  "restrictedCode": ""
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

{
  "result" : {
    "accountNumber": "19191919",
    "accountType": "Personal",
    "accountRef": "",
    "sortCode": "100000",
    "restrictedCode": "",
    "personalAccountAttribute": [{
      "accountNumber": "19191919",
      "honorific": "",
      "firstName": "erlich",
      "middleName": "",
      "lastName": "bachman",
      "preferredName": "",
      "accountName": ""
    } ],
    "jointAccount": false,
    "accountLevelSRD": false
  },
  "links": { }
}

Modify Personal Account:

PUT /responder/v1.0/cop-iban-check/uk/personal-accounts

Request Headers

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

Request param

Attribute	Type	Condition
sortCode	String	Mandatory
accountNumber	String	Mandatory
accountRef	String	Optional

Request Body

Attribute	Type	Condition
Data	PersonalAccount	Mandatory

Response Headers

Attribute	Type	Condition	Description
Content-Type	String	Mandatory	application/json

Response Body

Attribute	Type	Condition
Data	Response	Mandatory

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

Request

PUT /responder/v1.0/cop-iban-check/uk/personal-accounts?accountNumber=47423949&sortCode=100001
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
Content-Type: application/json
Accept: application/json

{
  "jointAccount": false,
  "personalAccountAttribute": [
    {
      "honorific": "Mr",
      "firstName": "Steve",
      "middleName": "",
      "lastName": "Smith",
      "preferredName": "",
      "accountName": "Jonathan"
    }
  ],
  "accountNumber": "47423949",
  "accountStatus": "ACTIVE",
  "accountLevelSRD": false,
  "restrictedCode": "",
  "sortCode": "100001",
  "accountType": "Personal"
}

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
  "result": {
    "accountNumber": "47423949",
    "accountType": "Personal",
    "jointAccount": false,
    "accountLevelSRD": false,
    "accountRef": "",
    "sortCode": "100001",
    "restrictedCode": "",
    "version": 0,
    "createdDate": "2024-09-03T08:04:39.175+00:00",
    "createdBy": "Conformance-APP4760",
    "accountStatus": "ACTIVE",
    "isActive": true,
    "lastModifiedDate": "2024-09-03T11:47:40.721+00:00",
    "lastModifiedBy": "danica.john+ad@banfico.com",
    "createOperationType": "SINGLE_API",
    "lastModifiedOperationType": "SINGLE_API",
    "personalAccountAttribute": [
      {
        "accountNumber": "47423949",
        "accountRef": "",
        "sortCode": "100001",
        "honorific": "Mr",
        "firstName": "Steve",
        "middleName": "",
        "lastName": "Smith",
        "preferredName": "",
        "attributeIndex": 0,
        "version": 0,
        "accountName": "Jonathan"
      }
    ]
  },
  "links": {}
}

Delete Personal Account:

DELETE /responder/v1.0/cop-iban-check/uk/personal-accounts

Request Headers

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

Request param

Attribute	Type	Condition
sortCode	String	Mandatory
accountNumber	String	Mandatory
accountRef	String	Optional

Response Headers

Attribute	Type	Condition	Description
Content-Type	String	Mandatory	application/json

Response Body

Attribute	Type	Condition
Data	Response	Mandatory

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

Request

DELETE /responder/v1.0/cop-iban-check/uk/personal-accounts?accountNumber=16824932&sortCode=100000
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
Content-Type: application/json
Accept: application/json

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
  "result": "Deleted account with accountNumber: 16824932",
  "links": {}
}

Business Account Management

Create Business Account:

POST /responder/v1.0/cop-iban-check/uk/business-accounts

The API allows us to create business account

Request Headers

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

Request Body

Attribute	Type	Condition	Description
Data	BusinessAccount	Mandatory

Response Headers

Attribute	Type	Condition	Description
Content-Type	String	Mandatory	application/json

Response Body

Attribute	Type	Condition	Description
Data	Response	Mandatory

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

Request

POST /responder/v1.0/cop-iban-check/uk/business-accounts
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
Content-Type: application/json
Accept: application/json

{
  "accountNumber" : "94753274",
  "businessAccountAttributes":{
      "accountName": "Pied piper",
      "holdingCompanyName":"New pied piper",
      "tradingName":"piper",
      "abbreviatedName":"PIP",
      "invoiceDiscountingAccountIndicator":false
  },
  "jointAccount":false,
  "accountLevelSRD":false,
  "accountType": "Business",
  "sortCode": "100000",
  "restrictedCode": "",
  "accountStatus":"INACTIVE"
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

{
  "result" : {
    "accountNumber" : "18181818",
    "accountType" : "Business",
    "accountRef" : "",
    "sortCode" : "100000",
    "restrictedCode" : "",
    "businessAccountAttributes" : {
      "accountNumber" : "18181818",
      "accountName" : "pied piper",
      "holdingCompanyName" : "",
      "tradingName" : "",
      "abbreviatedName" : "PDP",
      "invoiceDiscountingAccountIndicator" : false
    },
    "jointAccount" : false,
    "accountLevelSRD" : false
  },
  "links" : { }
}

Modify Business Account:

PUT /responder/v1.0/cop-iban-check/uk/business-accounts

Request Headers

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

Request param

Attribute	Type	Condition
sortCode	String	Mandatory
accountNumber	String	Mandatory
accountRef	String	Optional

Request Body

Attribute	Type	Condition
Data	BusinessAccount	Mandatory

Response Headers

Attribute	Type	Condition	Description
Content-Type	String	Mandatory	application/json

Response Body

Attribute	Type	Condition
Data	Response	Mandatory

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

Request

PUT /responder/v1.0/cop-iban-check/uk/business-accounts?accountNumber=98126734&sortCode=100000
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
Content-Type: application/json
Accept: application/json

{
  "sortCode": "100000",
  "accountNumber": "98126734",
  "accountStatus": "ACTIVE",
  "businessAccountAttributes": {
    "accountName": "Mr. Bharath J",
    "accountNumber": "98126734",
    "holdingCompanyName": "Tata",
    "tradingName": "Tata groups",
    "abbreviatedName": "TATA",
    "invoiceDiscountingAccountIndicator": false
  },
  "jointAccount": false,
  "accountType": "Business",
  "accountLevelSRD": false,
  "accountRef": "",
  "restrictedCode": "CASS"
}

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
  "result": {
    "accountNumber": "98126734",
    "accountType": "Business",
    "jointAccount": false,
    "accountLevelSRD": false,
    "accountRef": "",
    "sortCode": "100000",
    "restrictedCode": "CASS",
    "version": 0,
    "accountStatus": "ACTIVE",
    "isActive": true,
    "businessAccountAttributes": {
      "accountNumber": "98126734",
      "accountRef": "",
      "sortCode": "100000",
      "accountName": "Mr. Bharath J",
      "holdingCompanyName": "Tata",
      "tradingName": "Tata groups",
      "abbreviatedName": "TATA",
      "invoiceDiscountingAccountIndicator": false,
      "version": 0
    }
  },
  "links": {}
}

Delete Business Account:

DELETE /responder/v1.0/cop-iban-check/uk/business-accounts

Request Headers

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

Request param

Attribute	Type	Condition
sortCode	String	Mandatory
accountNumber	String	Mandatory
accountRef	String	Optional

Response Headers

Attribute	Type	Condition	Description
Content-Type	String	Mandatory	application/json

Response Body

Attribute	Type	Condition
Data	Response	Mandatory

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

Request

DELETE /responder/v1.0/cop-iban-check/uk/business-accounts?accountNumber=24041758&sortCode=100000
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
Content-Type: application/json
Accept: application/json

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
  "result": "Deleted account with accountNumber: 24041758",
  "links": {}
}

Getting Started

Internal Developer

External Developer

Personal Account Management

Create Personal Account:

Request Headers

Request Body

Response Headers

Response Body

Response Codes

Request

Response

Modify Personal Account:

Request Headers

Request param

Request Body

Response Headers

Response Body

Response Codes

Request

Response

Delete Personal Account:

Request Headers

Request param

Response Headers

Response Body

Response Codes

Request

Response

Business Account Management

Create Business Account:

Request Headers

Request Body

Response Headers

Response Body

Response Codes

Request

Response

Modify Business Account:

Request Headers

Request param

Request Body

Response Headers

Response Body

Response Codes

Request

Response

Delete Business Account:

Request Headers

Request param

Response Headers

Response Body

Response Codes

Request

Response