Update a customer profile

put

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

Update allowed fields on the customer profile

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

customerId

int64

required

Body Params

accountableInstitutionCif

string

additionalIdentityNumber

string

length between 5 and 20

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

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

asylumPaperExpiry

string

length between 8 and 8

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

asylumRefNumber

string

length between 5 and 15

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 - Eclipse will support ISO two character, all the existing countries will be replaced by the ISO two character country code. For example if 'South Africa' has added as Birth Country it will be replaced by 'ZA'

communicationPreference

string

enum

Allowed:

countryOfResidence

string

Customer's resident country

created

date-time

ISO 8601 date/time of when the record was first created

customerId

int64

Unique system generated identifier for a customer

dateOfBirth

string

length between 8 and 8

Customer Date of birth must be in form of yyyyMMdd

string

length between 10 and 50

Customers email address

externalUniqueId

string

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

Customer first/given name

gender

string

enum

The gender of the customer

Allowed:

industry

string

Industry customer belongs to

lastModified

date-time

ISO 8601 date/time of when the record was last modified

lastName

string

length between 2 and 50

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

Customers middle name

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

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

nationalIdentityExpiry

string

length between 8 and 8

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

nationalIdentityNumber

string

length between 5 and 20

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

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

passportExpiry

string

length between 8 and 8

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

passportNumber

string

length between 5 and 20

National identity number

passportPlaceOfIssuance

string

length between 2 and 60

Mandatory If the passport number is provided.

permitExpiry

string

length between 8 and 8

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

permitNumber

string

Permit number

phone1

string

Customers primary phone number

phone2

string

Customers secondary phone number

positions

array of objects

Positions the customer has in organisations. Only populated if the fields parameter has positions in it

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. Bit 5 means DOB is complete. But 6 means National Identity number is complete. E.g. To disallow changing attachments, documents, and addresses only, this int would be set as 001110 = 14

purposeOfUse

string

Purpose of business Relationship

reasonCode

string

enum

Allowed:

riskRating

string

riskScore

number

Customers are assigned a risk score based on their KYC information. The score is determined by various factors and helps financial institutions manage risk and prevent fraud or losses.

schoolName

string

length between 0 and 50

School name of customer

sourceOfFunds

string

Customer's source of fund

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

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

version

int32

required

≥ 0

A number indicating the version of the record. Updates will only be accepted if the passed in version is the same as the current version on record. This is in order to prevent concurrent modifications by multiple users.

walletRiskScore

number

Wallet risk score is calculated by multiplying the risk of the wallet type by the risk of the customer profile.

Headers

performReKyc

string

Responses

400

Bad Request

200OK