GET /beneficiaries?page=&per=&investor_id=
List of beneficiaries

Params

Param name	Description
page optional	Page index Validations: Must be a Integer
per optional	Items per page Validations: Must be a Integer
investor_id optional	Filter by investor UUID Validations: Must be a String

Examples

{
  'data': [
    {
  'id': 'beneficiary-uuid',
  'name': 'Nombre',
  'lastname': 'Apellido Paterno',
  'matriname': 'Apellido Materno',
  'nationality': null,
  'translated_nationality': null,
  'national_id_number': null,
  'phone_number': null,
  'phone_number_extension': null,
  'mobile_number': '5512345678',
  'dob': null,
  'email': 'ejemplo@correo.com',
  'kinship': 'spouse',
  'street': 'Av. Insurgentes Sur',
  'street_number': '453',
  'street_number_internal': null,
  'zip_code': '06600',
  'suburb': 'Hipódromo',
  'city': 'Ciudad de México',
  'state': 'CDMX',
  'country': 'MEX',
  'investor': {
    'id': 'investor-uuid',
    'sequential_id': 1,
    'code': null,
    'comment': null,
    'name': 'Nombre',
    'lastname': 'Apellido',
    'matriname': 'Materno',
    'full_name': 'Nombre Apellido Materno',
    'company': false,
    'company_name': null,
    'person_type': 'Persona física',
    'nationality': 'mexican',
    'translated_nationality': 'mexicano',
    'national_id_number': null,
    'phone_number': null,
    'phone_number_extension': null,
    'mobile_number': '5512345678',
    'gender': 'male',
    'dob': null,
    'human_readable_dob': null,
    'email': 'inversor@correo.com',
    'admission_date': '2024-01-15',
    'balance': { 'mxn': '500000.00', 'usd': '0.00' },
    'active_investment_amount': 1,
    'promoter_id': 'promoter-uuid',
    'created_at': '2024-01-15 - 10:00',
    'updated_at': '2025-01-01 - 09:00',
    'created_by_full_name': 'Administrador',
    'country': null,
    'country_translated': null,
    'is_financial_entity': false,
    'prospect_id': null,
    'user_id': null,
    'user_created': false,
    'document_type': null,
    'document_number': null,
    'marital_status': null,
    'account_statement_password': null,
    'access_keys_sent': false,
    'extra_fields_attributes': [],
    'subsidiary_id': null,
    'subsidiary_name': null,
    'deletable': false
  }
}
  ],
  'meta': {
    'count': 1
  }
}

Errors

Code	Description
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error