getCustomers

This method retrieves a filtered list of customers based on various query parameters.

Parameters

• cmsProjectId (string, optional): Filter by CMS project ID.
• currentPage (any, optional): Specify the current page for pagination.
• limit (any, optional): Limit the number of results returned.
• fromDate (date-time, optional): Filter results from this date.
• toDate (date-time, optional): Filter results up to this date.
• status (string, optional): Filter by customer status. Possible values are:
  • Active
  • Rejected
  • Dormant
  • To be reviewed
  • Failed
  • Escalated
  • Terminated
  • No status
• riskLevel (string, optional): Filter by risk level. Possible values are:
  • Low
  • Medium
  • High
  • No risk
• onBoardingLevel (string, optional): Filter by onboarding level. Possible values are:
  • Sign-up
  • AML screening
  • KYC
  • Questionaire
  • Onboarded
• softDeletedBefore (date-time, optional): Filter for customers soft-deleted before this date.
• search (string, optional): Search term to filter customers.
• countryOfResidence (string, optional): Filter by country of residence. Possible values are ISO 3166-1 alpha-3 country codes.
• type (string, optional): Filter by customer type. Possible values are:
  • Individual
  • Company

Returns

A JSON object containing the filtered list of customers and related metadata.

Usage Example

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.nexera.id/customers',
  headers: { 
    'Accept': 'application/json', 
    'Authorization': 'Bearer <TOKEN>'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});