Register a new Customer

post

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/customers

Registers a new customer profile under the tenant and returns the created customer. Optionally accepts a positions list to atomically assign the customer one or more Organisation positions as part of the same call — the recommended way to link a new customer to an Organisation without a separate call to the positions API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

Body Params

A customer of a Tenant. A physical human being with a legal identity. Customers can be grouped into an organisation if needed. Customers can belong to multiple organisations. Customers link to an organisation is through the posiiton they hold in that organisation.

accountableInstitutionCif

string

additionalIdentityNumber

string

length between 5 and 20

^[A-Za-z0-9/]*$

Additional identity number

asylumCountryOfIssuance

string

length between 2 and 2

ISO Alpha-2 country code for Issue of Asylum

asylumDateOfIssuance

string

length between 8 and 8

^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$

Mandatory If the asylum number is provided and must be in form of yyyyMMdd

asylumPaperExpiry

string

length between 8 and 8

^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$

Mandatory If the asylum ref number is provided and must be in form of yyyyMMdd

asylumRefNumber

string

length between 5 and 15

^[A-Za-z0-9]+(?:\/[A-Za-z0-9]+)*$

Asylum ref number

birthCity

string

length between 0 and 20

Customer City of birth

birthCountry

string

length between 0 and 60

Customer Country of birth. From 1st July 2022 it will only accept the ISO two character country code. for example if 'South Africa' has added as Passport place of issuance it will be replaced by 'ZA'.

communicationPreference

string

enum

Allowed:

countryOfResidence

string

Customer's resident country

countryOfTaxation

string

length between 0 and 3

FATCA/CRS: ISO country code of taxation jurisdiction

dateOfBirth

string

length between 8 and 8

^(18|19|20)(\d{2})(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$

Customer Date of birth must be in form of yyyyMMdd

string

length between 10 and 50

^[\w\.\+-]+@([\w-]+\.)+[\w-]{2,10}$

Customers email address

externalUniqueId

string

required

length between 6 and 100

A globally unique identifier set by the tenant for this customer. Useful for correlating between the tenants systems and Eclipse

firstName

string

length between 2 and 50

^\D*$

Customer first/given name

gender

string

enum

The gender of the customer

Allowed:

industry

string

Industry customer belongs to

isForeignTaxResident

boolean

FATCA/CRS: Whether the customer is a foreign tax resident

lastName

string

length between 2 and 50

^\D*$

Customers last/family name

locale

string

length between 2 and 2

ISO 639-1 language code of the customer

maidenName

string

length between 2 and 50

Customers maiden name

maritalStatus

string

enum

Maritial status of the customer

Allowed:

middleName

string

length between 2 and 50

^[A-Za-z0-9][A-Za-z0-9\s.\-'&]*$

Customers middle name

mobileNumberValidated

boolean

Optional. Set only when the channel has already verified phone1 using their own solution. When true, Eclipse trusts it directly and sets mobileNumberValidated to true without an OTP check.

monthlyIncome

int64

Customer's expected income per month

nationalIdentityCountryOfIssuance

string

length between 2 and 2

ISO Alpha-2 country code for Issue of National Identity

nationalIdentityDateOfIssuance

string

length between 8 and 8

^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$

Mandatory If the national identity number is provided and must be in form of yyyyMMdd

nationalIdentityExpiry

string

length between 8 and 8

^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$

Mandatory If the national identity number is provided and must be in form of yyyyMMdd

nationalIdentityNumber

string

length between 5 and 20

^[A-Za-z0-9/-]*$

National identity number

nationalIdentitySerialNumber

string

length between 0 and 20

national identity serial number of customer

nationality

string

length between 0 and 50

Nationality of Customer

nextMandatoryKycDate

date-time

nextOfKinInfo

string

length between 0 and 500

Next of kin info as a json

other

string

length between 0 and 5000

passportCountry

string

length between 2 and 2

ISO Alpha-2 country code

passportDateOfIssuance

string

length between 8 and 8

^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$

Mandatory If the passport number is provided and must be in form of yyyyMMdd

passportExpiry

string

length between 8 and 8

^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$

Mandatory If the passport number is provided and must be in form of yyyyMMdd

passportNumber

string

length between 5 and 20

^[A-Za-z0-9]*$

National identity number

passportPlaceOfIssuance

string

length between 2 and 60

Mandatory If the passport number is provided.

permitExpiry

string

length between 8 and 8

^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$

Mandatory If the PERMIT is provided and must be in form of yyyyMMdd.

permitNumber

string

Permit number

phone1

string

^[0-9]{8,16}$

Customers primary phone number

phone2

string

^[0-9]{8,16}$

Customers secondary phone number

positions

array of objects

Optional list of Organisation positions to assign to the customer as part of creation, so the customer and its Organisation position(s) are created together in one atomic call. If a position fails to be created (e.g. an invalid organisationId, or a duplicate position for that Organisation), the entire call fails and no customer is created. This is the recommended way to link a new customer to an Organisation: a customer created without at least one entry here is not linked to any Organisation, and will not be found by Organisation-scoped position lookups (e.g. GET /organisations/{organisationId}/positions) until a position is added via the positions API. Equivalent to separately calling the positions API for each entry, but without the risk of the customer being created without its position if the second call is never made.

positions

profession

string

Customer's profession

profileCompletionStatus

int32

Determines if the customer can update their own Profile, Adddress,Documents. This int is a bitmask. Least significant bit (bit 1) means the basic profile data like last name is complete and cannot be changed by the customer themselves. Bit 2 indicates Address data cannot be changed. Bit 3 means documents are complete. Bit 4 means attachments are complete. E.g. To disallow changing attachments, documents, and addresses only, this int would be set as 1110 = 14

purposeOfUse

string

Purpose of business Relationship

riskRating

string

schoolName

string

length between 0 and 50

School name of customer

sourceOfFunds

string

Customer's source of fund

sourceOfWealth

string

ssn

string

length between 0 and 50

FATCA/CRS: US Social Security Number

status

string

enum

Status of the customer. This is set/updated by the tenant and acts as a flag. It has no associated logic or implications within Eclipse itself

Allowed:

taxNumber

string

length between 0 and 20

Tax number of customer

temporaryIdentityExpiry

string

length between 8 and 8

^\d{4}(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01])$

Mandatory If the temporary Id is provided and must be in form of yyyyMMdd. User should enter temporaryIdentityExpiry = issue date + 2 months

title

string

enum

The title/salutation of the customer

Allowed:

userTypeId

int32

Responses

400

Bad Request

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

500Internal Server Error