ClearBank

API

GBP Accounts

GBP Payments

Multi-currency/FX

Embedded Banking

Know Your Customer (KYC)

Retail customer KYC

Using our retail KYC endpoint makes it easy to meet your due diligence requirements when onboarding retail customers. By simply sharing key customer information, you can conduct know your customer checks and receive the results via webhook.

For convenience, we'll also use the provided information to register a new customer if the checks succeed.

If you'd like access to this product, please speak to your Client Director.

A message flow diagram demonstrating how KYC works for a success and a declined check

KYC Check and Create a new Customer

post/v1/customercheck/retail

Use this endpoint to conduct KYC checks for a new customer. If the checks pass, the provided details are then used to create a new retail customer.

Parameters

  • Authorization string, header, Required

    Your API token, retrieved from the web portal.

  • DigitalSignature string, header, Required

    Signed hash of the body of the request. The hash is signed by your private key.

  • X-Request-Id string, header, Required

    A unique identifier for the request.

Request Payload (application/json)

  • customerData object, Required

request

{
  "customerData": {
    "name": {
      "firstName": "Adrien",
      "middleName": "Edin",
      "surname": "Reed-Myers"
    },
    "dateOfBirth": "1976-01-26",
    "nationality": [
      "GBR",
      "IRL"
    ],
    "taxResidency": [
      "GBR"
    ],
    "nationalInsuranceNumber": "AB112233C",
    "email": "example@emailprovider.co.uk",
    "mobile": "+447725666777",
    "currentAddress": {
      "buildingNameNumber": "22(A)",
      "streetName": "Long Road",
      "city": "York",
      "county": "Yorkshire",
      "postalCode": "YO31 7UH",
      "countryCode": "GBR"
    }
  }
}
Code copied

Response (application/json)

  • 202 Accepted
  • 400 Bad Request

Accepted

{
  "applicationId": "aac7c700-1ea6-5664-8804-ceeb066d3cf5"
}
Code copied

Bad Request

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Code copied

Associated Webhooks