{ "openapi": "3.0.2", "info": { "title": "ClearBank Retail Customer V2 APIs", "contact": { "name": "API Support", "url": "https://clear.bank", "email": "fiapisupport@clear.bank" }, "version": "2.0-customers-retail" }, "paths": { "/customers/v2/customers/{customerId}": { "get": { "tags": [ "Customer" ], "summary": "Retrieves a customer by their customer ID.", "operationId": "V2CustomerGet", "parameters": [ { "name": "Authorization", "in": "header", "description": "Your API token, retrieved from the web portal.", "required": true, "schema": { "type": "string" } }, { "name": "DigitalSignature", "in": "header", "description": "Signed hash of the body of the request. The hash is signed by your private key.", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-Id", "in": "header", "description": "A unique identifier for the request.", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "description": "The ID of the customer.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetailCustomerGetResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden" } } } }, "/customers/v2/customers/{customerId}/related-parties": { "get": { "tags": [ "Customer" ], "summary": "Retrieves the related party data of a customer by their customer ID.", "operationId": "V2RelatedPartiesGet", "parameters": [ { "name": "Authorization", "in": "header", "description": "Your API token, retrieved from the web portal.", "required": true, "schema": { "type": "string" } }, { "name": "DigitalSignature", "in": "header", "description": "Signed hash of the body of the request. The hash is signed by your private key.", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-Id", "in": "header", "description": "A unique identifier for the request.", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "description": "The ID of the original customer.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "value":{ "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyGetResponse" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Customer" ], "summary": "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 request will be rejected.", "operationId": "V2RelatedPartyPost", "parameters": [ { "name": "Authorization", "in": "header", "description": "Your API token, retrieved from the web portal.", "required": true, "schema": { "type": "string" } }, { "name": "DigitalSignature", "in": "header", "description": "Signed hash of the body of the request. The hash is signed by your private key.", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-Id", "in": "header", "description": "A unique identifier for the request.", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "description": "The ID of the original customer.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Information required to add related party to customer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRelatedPartyRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedRelatedPartyResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "403": { "description": "Forbidden" } } } }, "/customers/v2/customers/{customerId}/current-addresses": { "post": { "tags": [ "Customer" ], "summary": "Updates a customer's current address while maintaining their previous addresses history.", "operationId": "V2CustomersCurrentAddressPost", "parameters": [ { "name": "Authorization", "in": "header", "description": "Your API token, retrieved from the web portal.", "required": true, "schema": { "type": "string" } }, { "name": "DigitalSignature", "in": "header", "description": "Signed hash of the body of the request. The hash is signed by your private key.", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-Id", "in": "header", "description": "A unique identifier for the request.", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "description": "The ID of the customer.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Information required to update the customer's address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentAddressRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSubresourceCreatedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "403": { "description": "Forbidden" } } } }, "/customers/v2/customers/{customerId}/related-parties/{relatedCustomerId}/{relatedPartyType}": { "delete": { "tags": [ "Customer" ], "summary": "Removes a related party link between two customers.", "operationId": "V2RelatedPartyDelete", "parameters": [ { "name": "Authorization", "in": "header", "description": "Your API token, retrieved from the web portal.", "required": true, "schema": { "type": "string" } }, { "name": "DigitalSignature", "in": "header", "description": "Signed hash of the body of the request. The hash is signed by your private key.", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-Id", "in": "header", "description": "A unique identifier for the request.", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "description": "The ID of the customer.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "relatedCustomerId", "in": "path", "description": "The ID of the related customer to unlink.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "relatedPartyType", "in": "path", "description": "The type of related party. Used to disambiguate where a party is related in more than one way.", "required": true, "schema": { "$ref": "#/components/schemas/RelatedPartyType" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "403": { "description": "Forbidden" } } } }, "/customers/v2/customers/{customerId}/identity-documents/{idCountryOfIssue}-{idType}": { "put": { "tags": [ "Customer" ], "summary": "Adds or updates a customer's identity document. Returns 200 OK when updating an existing ID, or 201 Created when adding a new ID.", "operationId": "V2CustomerIdentityDocumentPut", "parameters": [ { "name": "Authorization", "in": "header", "description": "Your API token, retrieved from the web portal.", "required": true, "schema": { "type": "string" } }, { "name": "DigitalSignature", "in": "header", "description": "Signed hash of the body of the request. The hash is signed by your private key.", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-Id", "in": "header", "description": "A unique identifier for the request.", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "description": "The ID of the customer.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "idCountryOfIssue", "in": "path", "description": "Country of issue.", "required": true, "schema": { "$ref": "#/components/schemas/CountryCode" } }, { "name": "idType", "in": "path", "description": "Type of identity document.", "required": true, "schema": { "$ref": "#/components/schemas/IdType" } } ], "requestBody": { "description": "The updated details of the identity document.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIdentityDocumentRequest" } } } }, "responses": { "200": { "description": "OK" }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSubresourceCreatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "Customer" ], "summary": "Removes a customer's identity document.", "operationId": "V2CustomerIdentityDocumentDelete", "parameters": [ { "name": "Authorization", "in": "header", "description": "Your API token, retrieved from the web portal.", "required": true, "schema": { "type": "string" } }, { "name": "DigitalSignature", "in": "header", "description": "Signed hash of the body of the request. The hash is signed by your private key.", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-Id", "in": "header", "description": "A unique identifier for the request.", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "description": "The ID of the customer.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "idCountryOfIssue", "in": "path", "description": "Country of issue.", "required": true, "schema": { "$ref": "#/components/schemas/CountryCode" } }, { "name": "idType", "in": "path", "description": "Type of identity document.", "required": true, "schema": { "$ref": "#/components/schemas/IdType" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden" } } } }, "/customers/v2/customers/{customerId}/tax-residencies/{countryOfTaxResidence}": { "put": { "tags": [ "Customer" ], "summary": "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.", "operationId": "V2CustomerTaxResidencyPut", "parameters": [ { "name": "Authorization", "in": "header", "description": "Your API token, retrieved from the web portal.", "required": true, "schema": { "type": "string" } }, { "name": "DigitalSignature", "in": "header", "description": "Signed hash of the body of the request. The hash is signed by your private key.", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-Id", "in": "header", "description": "A unique identifier for the request.", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "description": "The ID of the customer.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "countryOfTaxResidence", "in": "path", "description": "Country of tax residence.", "required": true, "schema": { "$ref": "#/components/schemas/CountryCode" } } ], "requestBody": { "description": "Tax residency details (TIN or reason for no TIN).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaxResidencyRequest" } } } }, "responses": { "200": { "description": "OK" }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSubresourceCreatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "Customer" ], "summary": "Removes a customer's tax residency entry for the specified country.", "operationId": "V2CustomerTaxResidencyDelete", "parameters": [ { "name": "Authorization", "in": "header", "description": "Your API token, retrieved from the web portal.", "required": true, "schema": { "type": "string" } }, { "name": "DigitalSignature", "in": "header", "description": "Signed hash of the body of the request. The hash is signed by your private key.", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-Id", "in": "header", "description": "A unique identifier for the request.", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "description": "The ID of the customer.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "countryOfTaxResidence", "in": "path", "description": "Country of tax residence to remove.", "required": true, "schema": { "$ref": "#/components/schemas/CountryCode" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "403": { "description": "Forbidden" } } } }, "/customers/v2/retail": { "post": { "tags": [ "Retail" ], "summary": "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.", "operationId": "V2RetailPost", "parameters": [ { "name": "Authorization", "in": "header", "description": "Your API token, retrieved from the web portal.", "required": true, "schema": { "type": "string" } }, { "name": "DigitalSignature", "in": "header", "description": "Signed hash of the body of the request. The hash is signed by your private key.", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-Id", "in": "header", "description": "A unique identifier for the request.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Information required to create retail customer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRetailRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedResourceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "403": { "description": "Forbidden" } } } }, "/customers/v2/retail/{customerId}": { "patch": { "tags": [ "Retail" ], "summary": "Requests update of retail customer.", "operationId": "V2RetailPatch", "parameters": [ { "name": "Authorization", "in": "header", "description": "Your API token, retrieved from the web portal.", "required": true, "schema": { "type": "string" } }, { "name": "DigitalSignature", "in": "header", "description": "Signed hash of the body of the request. The hash is signed by your private key.", "required": true, "schema": { "type": "string" } }, { "name": "X-Request-Id", "in": "header", "description": "A unique identifier for the request.", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "description": "The ID of the customer.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Information required to update a retail customer.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRetailRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetailCustomerPatchResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } }, "403": { "description": "Forbidden" } } } } }, "components": { "schemas": { "AddressGetResponse": { "type": "object", "properties": { "addressType": { "$ref": "#/components/schemas/AddressType" }, "buildingNameNumber": { "type": "string", "description": "The building name or number at this address.", "nullable": true, "example": "322" }, "streetName": { "type": "string", "description": "The customer's address' street name.", "nullable": true, "example": "Long Road" }, "county": { "type": "string", "description": "County of the customer's address.", "nullable": true, "example": "Greenshire" }, "city": { "type": "string", "minLength": 1, "description": "City of the customer's address.", "nullable": true, "example": "Cyan City" }, "postalCode": { "type": "string", "description": "Postal code of the customer's address. If this address is in the UK, must be a valid UK postcode and conform to the regex pattern.", "nullable": true, "example": "PG15 8AB", "pattern": "^([Gg][Ii][Rr] 0[Aa]{2})|((([A-Za-z][0-9]{1,2})|(([A-Za-z][A-Ha-hJ-Yj-y][0-9]{1,2})|(([A-Za-z][0-9][A-Za-z])|([A-Za-z][A-Ha-hJ-Yj-y][0-9]?[A-Za-z])))) [0-9][A-Za-z]{2})$" }, "country": { "$ref": "#/components/schemas/CountryCode" }, "validFrom": { "type": "string", "description": "The date from which the customer started living at this address.", "format": "date", "nullable": true, "example": "2022-05-15" }, "validTo": { "type": "string", "description": "The date at which the customer stopped living at this address.", "format": "date", "nullable": true }, "isCurrentAddress": { "type": "boolean", "description": "Indicates if this is the customer's current address.", "nullable": true } }, "additionalProperties": false, "description": "The details of the customer's address history." }, "PreviousAddressGetResponse": { "type": "object", "properties": { "addressType": { "$ref": "#/components/schemas/AddressType" }, "buildingNameNumber": { "type": "string", "description": "The building name or number at this address.", "nullable": true, "example": "9" }, "streetName": { "type": "string", "description": "The customer's address' street name.", "nullable": true, "example": "Short Road" }, "county": { "type": "string", "description": "County of the customer's address.", "nullable": true, "example": "Blueshire" }, "city": { "type": "string", "minLength": 1, "description": "City of the customer's address.", "nullable": true, "example": "Lilac City" }, "postalCode": { "type": "string", "description": "Postal code of the customer's address. If this address is in the UK, must be a valid UK postcode and conform to the regex pattern.", "nullable": true, "example": "LB1 7CC", "pattern": "^([Gg][Ii][Rr] 0[Aa]{2})|((([A-Za-z][0-9]{1,2})|(([A-Za-z][A-Ha-hJ-Yj-y][0-9]{1,2})|(([A-Za-z][0-9][A-Za-z])|([A-Za-z][A-Ha-hJ-Yj-y][0-9]?[A-Za-z])))) [0-9][A-Za-z]{2})$" }, "country": { "$ref": "#/components/schemas/CountryCode" }, "validFrom": { "type": "string", "description": "The date from which the customer started living at this address.", "format": "date", "nullable": true, "example": "2021-02-18" }, "validTo": { "type": "string", "description": "The date at which the customer stopped living at this address.", "format": "date", "nullable": true, "example": "2022-05-15" }, "isCurrentAddress": { "type": "boolean", "description": "Indicates if this is the customer's current address.", "nullable": true, "example": false } }, "additionalProperties": false, "description": "The details of the customer's address history." }, "AddressHistoryGetResponse": { "type": "object", "properties": { "currentAddress": { "$ref": "#/components/schemas/AddressGetResponse" }, "previousAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/PreviousAddressGetResponse" }, "description": "Array of the customer's previous addresses.", "nullable": true } }, "additionalProperties": false, "description": "Addresses associated with the customer." }, "AddressType": { "enum": [ "ResidentialAddress" ], "type": "string", "example": "ResidentialAddress", "description": "Represents the type of the address" }, "CountryCode": { "enum": [ "AFG", "ALB", "ATA", "DZA", "ASM", "AND", "AGO", "ATG", "AZE", "ARG", "AUS", "AUT", "BHS", "BHR", "BGD", "ARM", "BRB", "BEL", "BMU", "BTN", "BOL", "BIH", "BWA", "BVT", "BRA", "BLZ", "IOT", "SLB", "VGB", "BRN", "BGR", "MMR", "BDI", "BLR", "KHM", "CMR", "CAN", "CPV", "CYM", "CAF", "LKA", "TCD", "CHL", "CHN", "TWN", "CXR", "CCK", "COL", "COM", "MYT", "COG", "COD", "COK", "CRI", "HRV", "CUB", "CYP", "CZE", "BEN", "DNK", "DMA", "DOM", "ECU", "SLV", "GNQ", "ETH", "ERI", "EST", "FRO", "FLK", "SGS", "FJI", "FIN", "ALA", "FRA", "GUF", "PYF", "ATF", "DJI", "GAB", "GEO", "GMB", "PSE", "DEU", "GHA", "GIB", "KIR", "GRC", "GRL", "GRD", "GLP", "GUM", "GTM", "GIN", "GUY", "HTI", "HMD", "VAT", "HND", "HKG", "HUN", "ISL", "IND", "IDN", "IRN", "IRQ", "IRL", "ISR", "ITA", "CIV", "JAM", "JPN", "KAZ", "JOR", "KEN", "PRK", "KOR", "KWT", "KGZ", "LAO", "LBN", "LSO", "LVA", "LBR", "LBY", "LIE", "LTU", "LUX", "MAC", "MDG", "MWI", "MYS", "MDV", "MLI", "MLT", "MTQ", "MRT", "MUS", "MEX", "MCO", "MNG", "MDA", "MNE", "MSR", "MAR", "MOZ", "OMN", "NAM", "NRU", "NPL", "NLD", "CUW", "ABW", "SXM", "BES", "NCL", "VUT", "NZL", "NIC", "NER", "NGA", "NIU", "NFK", "NOR", "MNP", "UMI", "FSM", "MHL", "PLW", "PAK", "PAN", "PNG", "PRY", "PER", "PHL", "PCN", "POL", "PRT", "GNB", "TLS", "PRI", "QAT", "REU", "ROU", "RUS", "RWA", "BLM", "SHN", "KNA", "AIA", "LCA", "MAF", "SPM", "VCT", "SMR", "STP", "SAU", "SEN", "SRB", "SYC", "SLE", "SGP", "SVK", "VNM", "SVN", "SOM", "ZAF", "ZWE", "ESP", "SSD", "SDN", "ESH", "SUR", "SJM", "SWZ", "SWE", "CHE", "SYR", "TJK", "THA", "TGO", "TKL", "TON", "TTO", "ARE", "TUN", "TUR", "TKM", "TCA", "TUV", "UGA", "UKR", "MKD", "EGY", "GBR", "GGY", "JEY", "IMN", "TZA", "USA", "VIR", "BFA", "URY", "UZB", "VEN", "WLF", "WSM", "YEM", "ZMB" ], "type": "string", "example": "GBR", "description": "3-letter country codes as defined in ISO 3166-1" }, "CraRating": { "enum": [ "LowRisk", "MediumRisk", "HighRisk", "VeryHighRisk" ], "type": "string", "description": "The customer's CRA rating. Determined by the outcomes of your due diligence checks." }, "CreateAddressHistoryRequest": { "required": [ "currentAddress" ], "type": "object", "properties": { "currentAddress": { "$ref": "#/components/schemas/CurrentAddressRequest" }, "previousAddresses": { "type": "array", "items": { "$ref": "#/components/schemas/PreviousAddressRequest" }, "description": "The customer's previous addresses.", "nullable": true } }, "additionalProperties": false, "description": "The customer's address history." }, "CreateCustomerIdentityDocumentRequest": { "required": [ "idCountryOfIssue", "idExpiryDate", "idNumber", "idType" ], "type": "object", "properties": { "idCountryOfIssue": { "$ref": "#/components/schemas/CountryCode" }, "idType": { "$ref": "#/components/schemas/IdType" }, "idNumber": { "minLength": 1, "type": "string", "description": "The ID number of the document.", "nullable": true, "example": "855865736946" }, "idExpiryDate": { "type": "string", "description": "The expiry date of the document.", "format": "date", "example": "2028-05-18" } }, "additionalProperties": false, "description": "Create an identity document for a customer" }, "CreateCustomerNameAndCountryDetailsRequest": { "required": [ "countryOfResidence", "firstName", "surname" ], "type": "object", "properties": { "firstName": { "minLength": 1, "maxLength": 255, "type": "string", "description": "The customer's first name. Must not include substrings: 'aka', 'known as', or 'unknown' (case insensitive).", "nullable": true, "example": "Kirsty", "pattern": "[^0-9!$%^_=+>