v1
latestOpenAPI 3.1.02026-07-24416405768.8 KBRegister a new Customer
Registers a new customer profile under the tenant and returns the created customer.
Path parameters
Request body
Additional identity number
ISO Alpha-2 country code for Issue of Asylum
Mandatory If the asylum number is provided and must be in form of yyyyMMdd
Mandatory If the asylum ref number is provided and must be in form of yyyyMMdd
Asylum ref number
Customer City of birth
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'.
Customer's resident country
FATCA/CRS: ISO country code of taxation jurisdiction
Customer Date of birth must be in form of yyyyMMdd
Customers email address
A globally unique identifier set by the tenant for this customer. Useful for correlating between the tenants systems and Eclipse
Customer first/given name
Gender. M:Male, F:Female, O:Other
Industry customer belongs to
FATCA/CRS: Whether the customer is a foreign tax resident
Customers last/family name
ISO 639-1 language code of the customer
Customers maiden name
Maritial status of the customer. S:Single, M:Married, D:Divorced, W:Widowed
Customers middle name
Customer's expected income per month
ISO Alpha-2 country code for Issue of National Identity
Mandatory If the national identity number is provided and must be in form of yyyyMMdd
Mandatory If the national identity number is provided and must be in form of yyyyMMdd
National identity number
national identity serial number of customer
Nationality of Customer
Next of kin info as a json
ISO Alpha-2 country code
Mandatory If the passport number is provided and must be in form of yyyyMMdd
Mandatory If the passport number is provided and must be in form of yyyyMMdd
National identity number
Mandatory If the passport number is provided.
Mandatory If the PERMIT is provided and must be in form of yyyyMMdd.
Permit number
Customers primary phone number
Customers secondary phone number
Customer's profession
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
Purpose of business Relationship
School name of customer
Customer's source of fund
FATCA/CRS: US Social Security Number
Status of the eclipse customer. ACTIVE:Customer is Active, INACTIVE customer is INACTIVE
Tax number of customer
Mandatory If the temporary Id is provided and must be in form of yyyyMMdd. User should enter temporaryIdentityExpiry = issue date + 2 months
Example request
{
"nextMandatoryKycDate": "2022-03-10T12:15:50-04:00"
}Response
OK
Additional identity number
ISO Alpha-2 country code for Issue of Asylum
Mandatory If the asylum number is provided and must be in form of yyyyMMdd
Mandatory If the asylum ref number is provided and must be in form of yyyyMMdd
Asylum ref number
Customer City of birth
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'
Customer's resident country
FATCA/CRS: ISO country code of taxation jurisdiction
ISO 8601 date/time of when the record was first created
Unique system generated identifier for a customer
Customer Date of birth must be in form of yyyyMMdd
Customers email address
A globally unique identifier set by the tenant for this customer. Useful for correlating between the tenants systems and Eclipse
Customer first/given name
Gender. M:Male, F:Female, O:Other
Industry customer belongs to
FATCA/CRS: Whether the customer is a foreign tax resident
ISO 8601 date/time of when the record was last modified
Customers last/family name
ISO 639-1 language code of the customer
Customers maiden name
Maritial status of the customer. S:Single, M:Married, D:Divorced, W:Widowed
Customers middle name
Customer's expected income per month
ISO Alpha-2 country code for Issue of National Identity
Mandatory If the national identity number is provided and must be in form of yyyyMMdd
Mandatory If the national identity number is provided and must be in form of yyyyMMdd
National identity number
national identity serial number of customer
Nationality of Customer
Next of kin info as a json
ISO Alpha-2 country code
Mandatory If the passport number is provided and must be in form of yyyyMMdd
Mandatory If the passport number is provided and must be in form of yyyyMMdd
National identity number
Mandatory If the passport number is provided.
Mandatory If the PERMIT is provided and must be in form of yyyyMMdd.
Permit number
Customers primary phone number
Customers secondary phone number
Customer's profession
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
Purpose of business Relationship
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.
School name of customer
Customer's source of fund
FATCA/CRS: US Social Security Number
Status of the eclipse customer. ACTIVE:Customer is Active, INACTIVE customer is INACTIVE
Tax number of customer
Mandatory If the temporary Id is provided and must be in form of yyyyMMdd. User should enter temporaryIdentityExpiry = issue date + 2 months
The unique identifier of the tenant this customer belongs to
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.
Wallet risk score is calculated by multiplying the risk of the wallet type by the risk of the customer profile.
Example response
{
"created": "2022-03-10T12:15:50-04:00",
"lastModified": "2022-03-10T12:15:50-04:00",
"nextMandatoryKycDate": "2022-03-10T12:15:50-04:00",
"positions": [
{
"organisation": {
"created": "2022-03-10T12:15:50-04:00",
"lastModified": "2022-03-10T12:15:50-04:00"
}
}
]
}