v2

POST /beneficiaries
Create a new beneficiary

Params

Param name Description
beneficiary
required

Beneficiary attributes

Validations:

  • Must be a Hash
beneficiary[name]
required

First name

Validations:

  • Must be a String
beneficiary[lastname]
required

Last name

Validations:

  • Must be a String
beneficiary[matriname]
optional

Second last name

Validations:

  • Must be a String
beneficiary[dob]
optional

Date of birth (YYYY-MM-DD)

Validations:

  • Must be a String
beneficiary[email]
optional

Email address

Validations:

  • Must be a String
beneficiary[nationality]
optional

Nationality key (e.g. mexican)

Validations:

  • Must be a String
beneficiary[national_id_number]
optional

CURP or national ID number

Validations:

  • Must be a String
beneficiary[phone_number]
optional

Phone number

Validations:

  • Must be a String
beneficiary[phone_number_extension]
optional

Phone extension

Validations:

  • Must be a String
beneficiary[mobile_number]
optional

Mobile number

Validations:

  • Must be a String
beneficiary[investor_id]
required

Associated investor UUID

Validations:

  • Must be a String
beneficiary[kinship]
optional

Kinship relationship (e.g. spouse, child, parent)

Validations:

  • Must be a String
beneficiary[street]
optional

Street name

Validations:

  • Must be a String
beneficiary[street_number]
optional

Street number

Validations:

  • Must be a String
beneficiary[street_number_internal]
optional

Interior unit number

Validations:

  • Must be a String
beneficiary[zip_code]
optional

ZIP / postal code

Validations:

  • Must be a String
beneficiary[suburb]
optional

Suburb / neighborhood

Validations:

  • Must be a String
beneficiary[city]
optional

City

Validations:

  • Must be a String
beneficiary[state]
optional

State / province

Validations:

  • Must be a String
beneficiary[country]
optional

Country code (e.g. MEX)

Validations:

  • Must be a String

Examples

# Request body:
{
  'beneficiary': {
    'name': 'Juan',
    'lastname': 'Perez',
    'matriname': 'Torres',
    'dob': '1985-06-20',
    'email': 'ejemplo@correo.com',
    'nationality': 'mexican',
    'phone_number': '5512345678',
    'mobile_number': '5598765432',
    'investor_id': 'investor-uuid',
    'kinship': 'spouse',
    'street': 'Av. Insurgentes Sur',
    'street_number': '453',
    'zip_code': '06600',
    'suburb': 'Hipódromo',
    'city': 'Ciudad de México',
    'state': 'CDMX',
    'country': 'MEX'
  }
}

# Response (201 Created): same structure as GET /beneficiaries/:id

Errors

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