v2
Also see beneficiaries#index.

Params

Param name Description
id
required

Investor UUID

Validations:

  • Must be a String

page
optional

Page index

Validations:

  • Must be a Integer

per
optional

Items per page

Validations:

  • Must be a Integer

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': null,
      'street_number': null,
      'street_number_internal': null,
      'zip_code': null,
      'suburb': null,
      'city': null,
      'state': null,
      'country': null,
      'investor': { '...': 'see investors#show' }
    }
  ],
  'meta': { 'count': 1 }
}

Errors

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