v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB

d) Customer Management

Search for customers in the tenant

Returns customers matching the supplied filters. If fields=customerId is passed, only the customerId of each match is returned without requiring full-profile read permissions.

get/eclipse-conductor/rest/v1/tenants/{tenantId}/customers

Path parameters

tenantIdinteger required

Query parameters

accountNumberstring

Account number for any wallet. If it is passed then it will ignore other fields

asylumRefNumberstring

customerIdinteger

emailstring

externalUniqueIdstring

fieldsstring

Field data to include. Comma separated list. Supports customerId or positions.

firstNamestring

identitystring

includeAdminUsersboolean

lastNamestring

limitinteger

nationalIdentityNumberstring

offsetinteger

onlyShowAllowedboolean

When the parameter is set to true, Only the customers that the user has permission to access will be returned. However, if the parameter is set to false and the user does not have permission, will result in an error being thrown.

passportCountrystring

passportNumberstring

phone1string

userTypeIdinteger

walletIdinteger

Response

accountableInstitutionCifstring

additionalIdentityNumberstring

Additional identity number

asylumCountryOfIssuancestring

ISO Alpha-2 country code for Issue of Asylum

asylumDateOfIssuancestring

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

asylumPaperExpirystring

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

asylumRefNumberstring

Asylum ref number

birthCitystring

Customer City of birth

birthCountrystring

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'EMAIL' | 'PUSH' | 'SMS' | 'TEMPLATE'

countryOfResidencestring

Customer's resident country

countryOfTaxationstring

FATCA/CRS: ISO country code of taxation jurisdiction

createdstring date-time

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

customerIdinteger

Unique system generated identifier for a customer

dateOfBirthstring

Customer Date of birth must be in form of yyyyMMdd

emailstring

Customers email address

externalUniqueIdstring

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

firstNamestring

Customer first/given name

gender'F' | 'M' | 'O'

Gender. M:Male, F:Female, O:Other

industrystring

Industry customer belongs to

isForeignTaxResidentboolean

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

lastModifiedstring date-time

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

lastNamestring

Customers last/family name

localestring

ISO 639-1 language code of the customer

maidenNamestring

Customers maiden name

maritalStatus'D' | 'M' | 'S' | 'W'

Maritial status of the customer. S:Single, M:Married, D:Divorced, W:Widowed

middleNamestring

Customers middle name

monthlyIncomeinteger

Customer's expected income per month

nationalIdentityCountryOfIssuancestring

ISO Alpha-2 country code for Issue of National Identity

nationalIdentityDateOfIssuancestring

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

nationalIdentityExpirystring

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

nationalIdentityNumberstring

National identity number

nationalIdentitySerialNumberstring

national identity serial number of customer

nationalitystring

Nationality of Customer

nextMandatoryKycDatestring date-time

nextOfKinInfostring

Next of kin info as a json

otherstring

passportCountrystring

ISO Alpha-2 country code

passportDateOfIssuancestring

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

passportExpirystring

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

passportNumberstring

National identity number

passportPlaceOfIssuancestring

Mandatory If the passport number is provided.

permitExpirystring

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

permitNumberstring

Permit number

phone1string

Customers primary phone number

phone2string

Customers secondary phone number

professionstring

Customer's profession

profileCompletionStatusinteger

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

purposeOfUsestring

Purpose of business Relationship

riskRatingstring

riskScorenumber

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.

schoolNamestring

School name of customer

sourceOfFundsstring

Customer's source of fund

sourceOfWealthstring

ssnstring

FATCA/CRS: US Social Security Number

status'ACTIVE' | 'BARRED' | 'INACTIVE'

Status of the eclipse customer. ACTIVE:Customer is Active, INACTIVE customer is INACTIVE

taxNumberstring

Tax number of customer

temporaryIdentityExpirystring

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

tenantIdinteger

The unique identifier of the tenant this customer belongs to

title'CHIEF' | 'DR' | 'MISS' | 'MR' | 'MRS' | 'MS' | 'SIR'

userTypeIdinteger

versioninteger required

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.

walletRiskScorenumber

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"
        }
      }
    ]
  }
]