Create new customer

post

https://api.sandbox.keyrails.com/api/v1/customers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create Customer Model

businessLegalName

string

required

length ≥ 1

businessTradeName

string

required

length ≥ 1

taxIdentificationNumber

string

required

length ≥ 1

website

string

required

length ≥ 1

incorporationDate

date-time

required

length ≥ 1

Date format YYYY-MM-DD

countryOfIncorporation

string

enum

required

length ≥ 1

Two-letter alpha-2 country code

companyRegistrationNumber

string

required

length ≥ 1

registeredAddress

object

required

Address

operationalAddress

object

required

Address

contactPerson

object

required

businessIndustryType

string

enum

required

Allowed:

businessIndustries

array of strings | null

The industry in which this business operates. Click here for the complete list of valid industries based on the industry type.

businessIndustries

businessIndustryOther

string | null

Provide value when businessIndustryType=Other

withLivenessCheck

boolean

required

If set to TRUE, add associated person API will return a verification URL. The customer must use this URL to complete the liveness check.

If set to FALSE, then identityDocumentFront must be provided when adding an associated persons. directorsLivenessCheck and shareHoldersLivenessCheck must be provided when uploading documents.

businessModel

string | null

termsOfServiceAcceptance

object

required

customerBaseBreakdown

string

enum

required

Allowed:

customerJurisdictions

array of strings

required

length ≥ 1

Two-letter alpha-2 country code - See the list of supported countries https://docs.keyrails.com/reference/get_api-v1-lists-countries

customerJurisdictions*

isBusinessRegulated

boolean

required

isNamedAccountRequired

boolean | null

regulatedEntity

string | null

notRegulatedReason

string | null

sourceOfFunds

string

required

length ≥ 1

accountPurpose

string

required

length ≥ 1

string

required

length ≥ 1

externalWalletAddress

string | null

externalWalletOwnershipProof

string | null

Base64 encoded following the data-uri scheme i.e. data:image/[type];base64,[base_64_encoded_file_contents]

Valid file types: .pdf, .jpeg, .jpg, .png

transactionOriginCountries

array of strings

required

length ≥ 1

Two-letter alpha-2 country code - See the list of supported countries https://docs.keyrails.com/reference/get_api-v1-lists-countries

transactionOriginCountries*

transactionDestinationCountries

array of strings

required

length ≥ 1

Two-letter alpha-2 country code - See the list of supported countries https://docs.keyrails.com/reference/get_api-v1-lists-countries

transactionDestinationCountries*

compliance

object

required

transactionBreakdown

object

required

companySourceOfWealthExplanation

string

required

length ≥ 1

companySourceOfWealthEvidence

string

required

Base64 encoded following the data-uri scheme i.e. data:image/[type];base64,[base_64_encoded_file_contents]

Valid file types: .pdf, .jpeg, .jpg, .png

shareholdersSourceOfWealthExplanation

string

required

length ≥ 1

shareholdersSourceOfWealthEvidence

string

required

Base64 encoded following the data-uri scheme i.e. data:image/[type];base64,[base_64_encoded_file_contents]

Valid file types: .pdf, .jpeg, .jpg, .png

fundingSourceExplanation

string

required

length ≥ 1

fundingSourceEvidence

string

required

Base64 encoded following the data-uri scheme i.e. data:image/[type];base64,[base_64_encoded_file_contents]

Valid file types: .pdf, .jpeg, .jpg, .png

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200CreateCustomerResponseModel

400Bad Request

401Unauthorized

404Not Found