# ClearBank Customer API

**Canonical:** https://apis.io/apis/clearbank/clearbank-customer-api/  
**Provider:** ClearBank — https://apis.io/providers/clearbank/  
**Base URL:** https://institution-api.clearbank.co.uk  
**Documentation:** https://clearbank.github.io/uk/docs/api/

ClearBank Customer API is one of 15 APIs that [ClearBank](https://apis.io/providers/clearbank/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The Customer API from ClearBank — 6 operation(s) for customer.

## Operations (9)

| Method | Path | Summary |
|---|---|---|
| GET | `/customers/v2/customers/{customerId}` | Retrieves a customer by their customer ID. |
| GET | `/customers/v2/customers/{customerId}/related-parties` | Retrieves the related party data of a customer by their customer ID. |
| POST | `/customers/v2/customers/{customerId}/related-parties` | Adds a new related party to an existing customer. Note that relationships must be unique: if a relationship already exists that links the same two customers ... |
| POST | `/customers/v2/customers/{customerId}/current-addresses` | Updates a customer's current address while maintaining their previous addresses history. |
| DELETE | `/customers/v2/customers/{customerId}/related-parties/{relatedCustomerId}/{relatedPartyType}` | Removes a related party link between two customers. |
| PUT | `/customers/v2/customers/{customerId}/identity-documents/{idCountryOfIssue}-{idType}` | Adds or updates a customer's identity document. Returns 200 OK when updating an existing ID, or 201 Created when adding a new ID. |
| DELETE | `/customers/v2/customers/{customerId}/identity-documents/{idCountryOfIssue}-{idType}` | Removes a customer's identity document. |
| PUT | `/customers/v2/customers/{customerId}/tax-residencies/{countryOfTaxResidence}` | Adds or updates a customer's tax residency entry for the specified country. Returns 200 OK when updating an existing tax residency, or 201 Created when addin... |
| DELETE | `/customers/v2/customers/{customerId}/tax-residencies/{countryOfTaxResidence}` | Removes a customer's tax residency entry for the specified country. |

## Machine-readable artifacts (4)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/clearbank/refs/heads/main/openapi/clearbank-customer-api-openapi.yml
- **Documentation** — https://clearbank.github.io/uk/docs/api/
- **APIReference** — https://clearbank.github.io/uk/docs/api/overview/
- **Documentation** — https://clearbank.github.io/uk/docs/embedded-banking/retail-customers/

## Other ClearBank APIs (12)

- [ClearBank Accounts API](https://apis.io/apis/clearbank/clearbank-accounts-api/)
- [ClearBank Co P API](https://apis.io/apis/clearbank/clearbank-cop-api/)
- [ClearBank Create Fx Quote Endpoint API](https://apis.io/apis/clearbank/clearbank-createfxquoteendpoint-api/)
- [ClearBank Customer Due Diligence API](https://apis.io/apis/clearbank/clearbank-customer-due-diligence-api/)
- [ClearBank External Cross Border Customer Payments V4 API](https://apis.io/apis/clearbank/clearbank-externalcrossbordercustomerpaymentsv4-api/)
- [ClearBank External Customer Payments V6 API](https://apis.io/apis/clearbank/clearbank-externalcustomerpaymentsv6-api/)
- [ClearBank External Institution Payments V6 API](https://apis.io/apis/clearbank/clearbank-externalinstitutionpaymentsv6-api/)
- [ClearBank External Return Payments V6 API](https://apis.io/apis/clearbank/clearbank-externalreturnpaymentsv6-api/)
- [ClearBank Fps Payments API](https://apis.io/apis/clearbank/clearbank-fpspayments-api/)
- [ClearBank Fx Orders API](https://apis.io/apis/clearbank/clearbank-fx-orders-api/)
- [ClearBank Payments API](https://apis.io/apis/clearbank/clearbank-payments-api/)
- [ClearBank Retail API](https://apis.io/apis/clearbank/clearbank-retail-api/)

## Tags

Customers

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/clearbank/clearbank-customer-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/clearbank/.