Skip to main content

List customers (slim)

GET 
/Customer/Slim

List customers (slim)

Request​

Query Parameters

    pageOptions.page int32

    Possible values: >= 1 and <= 2147483647

    The 1-based page number for paginated results.

    pageOptions.count int32

    Possible values: >= 1 and <= 50

    The number of items to return per page (1–50).

    pageOptions.sortByProperty string

    The property name to sort results by.

    pageOptions.sortByAscending boolean

    When true, sorts results in ascending order; descending otherwise.

    pageOptions.searchValues object

    Key-value pairs used to filter results.

    pageOptions.findCodeToIncludeInPage string

    A specific code to locate; the page containing it will be returned.

    pageOptions.searchHistoricData boolean

    When true, includes soft-deleted or historical records in the results.

    purpose int32

    Possible values: [0, 1, 2]

    0 = KYC: KYC
    1 = Management: Management
    2 = ScreenZ: ScreenZ

Responses​

A paginated list of slim customers.

Schema
    page int32required

    The current page number in the paginated result set.

    count int32required

    The number of items returned on this page.

    hasNextPage booleanrequired

    Indicates whether additional pages of results are available after the current page.

    hasPreviousPage booleanrequired

    Indicates whether pages of results exist before the current page.

    totalCount int32required

    The total number of items across all pages.

    totalPages int32required

    The total number of pages available.

    items object[]nullable

    The collection of items returned for the current page.

  • Array [
    • customerCode stringnullablerequired

    The unique code identifying the customer.

    customerTypeCode stringnullablerequired

    The code identifying the customer's type classification.

    customerLegalTypeCode stringnullablerequired

    The code identifying the customer's legal entity type.

    lastname stringnullablerequired

    The customer's primary last name.

    lastname2 stringnullablerequired

    The customer's secondary or maiden last name.

    middleName stringnullablerequired

    The customer's middle name.

    firstname stringnullablerequired

    The customer's first name.

    fatherName stringnullablerequired

    The customer's father's name.

    motherName stringnullablerequired

    The customer's mother's name.

    birthDate date-timenullablerequired

    The customer's date of birth.

    gender int32nullablerequired

    The customer's gender (numeric code).

    mobilePhone1 stringnullablerequired

    The customer's primary mobile phone number.

    mobilePhone2 stringnullablerequired

    The customer's secondary mobile phone number.

    emailAddress1 stringnullablerequired

    The customer's primary email address.

    emailAddress2 stringnullablerequired

    The customer's secondary email address.

    taxCode stringnullablerequired

    The customer's tax identification number.

    taxOfficeCode stringnullablerequired

    The code of the tax office where the customer is registered.

    dependentMembers int32nullablerequired

    The number of dependent family members.

    educationLevelCode stringnullablerequired

    The code identifying the education level.

    originCityName stringnullablerequired

    The name of the customer's city of origin.

    originCountryCode stringnullablerequired

    The ISO country code of the origin country.

    nationalityCountryCode stringnullablerequired

    The ISO country code of the customer's nationality.

    teiresiasType stringnullablerequired

    The Tiresias (credit bureau) classification type for the customer.

    activeDate date-timenullablerequired

    The date when the customer record was activated.

    deactivationDate date-timenullablerequired

    The date when the customer record was deactivated.

    customerBranchCode stringnullablerequired

    The code of the branch that owns this customer record.

    customerWatchingBranchCode stringnullablerequired

    The code of the branch responsible for monitoring this customer.

    customerStatusCode stringnullablerequired

    The code representing the customer's current status.

    customerKycDate date-timenullablerequired

    The date of the customer's most recent Know Your Customer (KYC) review.

    customerRegistrationNumber stringnullablerequired

    The customer's official registration number.

    customerDisabilities stringnullablerequired

    Information about any disabilities recorded for the customer.

    customerTaxResidentPlace int32nullablerequired

    The numeric identifier of the customer's tax residence location.

    onBoardingStatusCode stringnullablerequired

    The code representing the customer's onboarding status.

    onBoardingStatusTitle stringnullablerequired

    The display title of the customer's onboarding status.

    bussinessTypeTitle stringnullablerequired

    The display title of the customer's business type.

    bussinessTypeCode stringnullablerequired

    The code identifying the customer's business type.

    customerBussinessTypeCode stringnullablerequired

    The code identifying the customer's business type.

    customerBussinessTypeTitle stringnullablerequired

    The display title of the customer's business type.

    birthPlaceCityCode stringnullablerequired

    The code of the city where the customer was born.

    birthPlaceCityName stringnullablerequired

    The name of the city where the customer was born.

    custCodeOriginal stringnullablerequired

    The customer's original code before any code migration or update.

    taxResidenceResponse object

    The customer's tax residence details.

    recidenceTitle stringnullablerequired

    The display title of the tax residence.

    createdBy stringnullablerequired

    The username or identifier of the user who created this record.

    createdAt date-timenullablerequired

    The date and time when this record was created.

    updatedBy stringnullablerequired

    The username or identifier of the user who last updated this record.

    updatedAt date-timenullablerequired

    The date and time when this record was last updated.

    customerRelations object[]nullable

    The list of relationships associated with this customer.

  • Array [
    • relationID int32required

    The numeric identifier of the customer relationship.

    relationDescription stringnullablerequired

    A textual description of the relationship type.

  • ]
    • customerYearIncomes object[]nullable

    The list of yearly income records for this customer.

  • Array [
    • fiscalYear int32nullablerequired

    The fiscal year for which the income is reported.

    yearIncome doublenullablerequired

    The total annual income amount.

    incomeTypeCode stringnullablerequired

    The code identifying the type of income.

    incomeTypeTitle stringnullablerequired

    The display title of the income type.

    createInfo object

    Audit metadata capturing who created this record and when.

    actionBy stringnullablerequired

    The username or identifier of the user who performed the action.

    actionAt date-timerequired

    The date and time when the action was performed.

    updateInfo object

    Audit metadata capturing who last updated this record and when.

    actionBy stringnullablerequired

    The username or identifier of the user who performed the action.

    actionAt date-timerequired

    The date and time when the action was performed.

  • ]
    • customerAmlCode stringnullablerequired

    The AML-specific code assigned to the customer.

    customerTypeTitle stringnullablerequired

    The display title of the customer type.

    taxOfficeTitle stringnullablerequired

    The display title of the tax office.

    educationLevelTitle stringnullablerequired

    The display title of the education level.

    originCountryName stringnullablerequired

    The display name of the customer's country of origin.

    nationalityCountryName stringnullablerequired

    The display name of the customer's nationality country.

    customerBranchTitle stringnullablerequired

    The display title of the branch that owns this customer record.

    customerWatchingBranchTitle stringnullablerequired

    The display title of the branch responsible for monitoring this customer.

    customerStatusTitle stringnullablerequired

    The display title of the customer status.

    riskLevel int32nullablerequired

    The computed risk level assigned to the customer.

    excludeFromAML booleannullablerequired

    Indicates whether this customer is excluded from AML processing.

    isSuspicious booleannullablerequired

    Indicates whether the customer is flagged as suspicious.

    groupCodes string[]nullablerequired

    The list of group codes the customer belongs to.

    customerStatus int32required

    Possible values: [0, 1, 2, 3, 4, 5, 6]

    The customer's status enumeration value.

    createInfo object

    Audit metadata capturing who created this record and when.

    actionBy stringnullablerequired

    The username or identifier of the user who performed the action.

    actionAt date-timerequired

    The date and time when the action was performed.

    updateInfo object

    Audit metadata capturing who last updated this record and when.

    actionBy stringnullablerequired

    The username or identifier of the user who performed the action.

    actionAt date-timerequired

    The date and time when the action was performed.

  • ]
Loading...