Across 2 paths, the API surfaces 2 operations — 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Retail 2
POST
/customers/v2/retail
Requests creation of retail customer. On a success, you will receive a customer ID which you can then use to create accounts for this customer.
V2RetailPost3 paramsbody→ 201400404409422403
PATCH
/customers/v2/retail/{customerId}
Requests update of retail customer.
V2RetailPatch4 paramsbody→ 200400404422403
Schemas 29
The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are PreviousAddressRequest (9 properties), CreatePersonalDetailsRequest (8 properties), CurrentAddressRequest (8 properties), PersonalDetailsPatchModel (8 properties). Each schema is shown below with its type and property counts.
KycAmlPatchModel
object
Patch model containing KYC/AML fields that were updated. Only properties that changed are present.
4 properties
CurrentAddressRequest
object
The customer's current address.
8 properties6 required
UpdateRetailTaxDetailsRequest
object
Tax details for a retail customer.
2 properties
ValidationProblemDetails
object
A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807
6 properties
CreateRetailRequest
object
Request body for creating a retail customer.
6 properties4 required
SpecialStatusValue
string
Supported special statuses.
RetailCustomerPatchResponse
object
Summary of the fields that have been updated for retail customer PATCH. Contains only sections and properties that were changed.
5 properties
CountryCode
string
3-letter country codes as defined in ISO 3166-1
CreatedResourceResponse
object
Response containing information about the created resource.
1 property
ProblemDetails
object
A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807
5 properties
CreateAddressHistoryRequest
object
The customer's address history.
2 properties1 required
CreateTaxResidencyRequest
object
Request to create a information about a customer's tax residency, including country of tax residence and tax identification details.
3 properties1 required
PersonalDetailsPatchModel
object
Patch model containing personal detail fields that were updated. Only properties that changed are present.
8 properties
PreviousAddressRequest
object
The customer's previous address.
9 properties6 required
CraRating
string
The customer's CRA rating. Determined by the outcomes of your due diligence checks.
UpdateRetailRequest
object
Retail Customer update request. Null values are ignored.
4 properties
CreateCustomerIdentityDocumentRequest
object
Create an identity document for a customer
4 properties4 required
UpdateKycAmlRequest
object
KYC AML update request. Null values are ignored.
4 properties
USPerson
string
Specifies the classification of a person as a U.S. person for regulatory or reporting purposes.
CreateKycAmlRequest
object
KYC/AML information for the customer.
4 properties4 required
ReasonForNoTaxId
string
Supported reasons for not having a tax ID (required if no tax ID number provided).
AddressType
string
Represents the type of the address
CreateRetailTaxDetailsRequest
object
Tax details for a retail customer.
3 properties3 required
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.
RetailCustomerTaxDetailsPatchModel
object
Patch model containing retail customer tax detail fields that were updated.
2 properties
CreatePersonalDetailsRequest
object
Personal details for the customer.
8 properties4 required
UpdatePersonalDetailsRequest
object
Personal Details update request. Null values are ignored.
8 properties
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 Retail 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.
