Across 6 paths, the API surfaces 9 operations — 3 DELETE, 2 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
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 with the same relationship type, your requ…
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 adding a new tax residency.
The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are PreviousAddressGetResponse (10 properties), RetailCustomerGetResponse (10 properties), AddressGetResponse (10 properties), PersonalDetailsGetResponse (8 properties). Each schema is shown below with its type and property counts.
CurrentAddressRequest
object
The customer's current address.
8 properties6 required
PersonalDetailsGetResponse
object
Customer's personal details
8 properties
CreateRelatedPartyRequest
object
A request to link one customer to another as a related party.
3 properties2 required
ValidationProblemDetails
object
A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807
6 properties
CreatedRelatedPartyResponse
object
Response containing information about the created related party.
2 properties
SpecialStatusValue
string
Supported special statuses.
CustomerStatus
string
Represents the status of a customer in the system. This will always be 'Active'.
ProblemDetails
object
A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807
5 properties
AddressGetResponse
object
The details of the customer's address history.
10 properties
RelatedPartyType
string
Related party types.
RetailCustomerGetResponse
object
The Retail Customer type response body.
10 properties
KycAmlGetResponse
object
KYC/AML information of the customer.
4 properties
UpdateTaxResidencyRequest
object
The customer's tax residency update request.
2 properties
PreviousAddressGetResponse
object
The details of the customer's address history.
10 properties
CraRating
string
The customer's CRA rating. Determined by the outcomes of your due diligence checks.
CustomerType
string
The type of customer. This will always be 'Retail'.
CustomerSubresourceCreatedResponse
object
Represents the response returned when a subresource is created for a customer.
1 property
IdentityDocumentsGetResponse
object
Customer's Identity documents
4 properties
TaxDetailsGetResponse
object
Tax details of the customer.
3 properties
USPerson
string
Specifies the classification of a person as a U.S. person for regulatory or reporting purposes.
ReasonForNoTaxId
string
Supported reasons for not having a tax ID (required if no tax ID number provided).
TaxResidencyGetResponse
object
Customer TaxResidency.
3 properties
AddressType
string
Represents the type of the address
UpdateIdentityDocumentRequest
object
The customer's identity document.
2 properties2 required
RelatedPartyGetResponse
object
Response model for Related Party.
3 properties
PepType
string
Indicates if the customer is a Politically Exposed Person.
IdType
string
The type of ID document.
RcaType
string
Indicates if the customer is a Relative or Close Associate.
AddressHistoryGetResponse
object
Addresses associated with the customer.
2 properties
CountryCode
string
3-letter country codes as defined in ISO 3166-1
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of ClearBank Customer API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
