v2

POST /investors
Create a new investor

Params

Param name Description
investor
required

Investor attributes

Validations:

  • Must be a Hash
investor[name]
required

First name

Validations:

  • Must be a String
investor[lastname]
required

Last name

Validations:

  • Must be a String
investor[matriname]
optional

Second last name

Validations:

  • Must be a String
investor[company]
optional

Whether the investor is a company

Validations:

  • Must be one of: true, false, 1, 0.
investor[company_name]
optional

Company name (required when company is true)

Validations:

  • Must be a String
investor[nationality]
optional

Nationality key (e.g. mexican)

Validations:

  • Must be a String
investor[national_id_number]
optional

CURP or national ID number

Validations:

  • Must be a String
investor[gender]
optional

Gender

Validations:

  • Must be one of: male, female, other.
investor[dob]
optional

Date of birth (YYYY-MM-DD)

Validations:

  • Must be a String
investor[email]
optional

Email address

Validations:

  • Must be a String
investor[phone_number]
optional

Phone number

Validations:

  • Must be a String
investor[phone_number_extension]
optional

Phone extension

Validations:

  • Must be a String
investor[mobile_number]
optional

Mobile number

Validations:

  • Must be a String
investor[country]
optional

Country code

Validations:

  • Must be a String
investor[marital_status]
optional

Marital status

Validations:

  • Must be a String
investor[promoter_id]
optional

Associated promoter UUID

Validations:

  • Must be a String
investor[admission_date]
optional

Admission date (YYYY-MM-DD)

Validations:

  • Must be a String
investor[document_type]
optional

ID document type (e.g. ine)

Validations:

  • Must be a String
investor[document_number]
optional

ID document number

Validations:

  • Must be a String
investor[is_financial_entity]
optional

Whether the investor is a financial entity

Validations:

  • Must be one of: true, false, 1, 0.
investor[prospect_id]
optional

Associated prospect UUID

Validations:

  • Must be a String
investor[code]
optional

Internal code

Validations:

  • Must be a String
investor[account_statement_password]
optional

Password for account statements

Validations:

  • Must be a String

Examples

# Request body:
{
  'investor': {
    'name': 'Test',
    'lastname': 'Martinez',
    'matriname': 'Lopez',
    'company': false,
    'nationality': 'mexican',
    'gender': 'female',
    'dob': '1985-01-01',
    'email': 'test.martinez@example.com',
    'phone_number': '5512345678',
    'mobile_number': '5598765432',
    'country': 'MEX',
    'marital_status': 'single',
    'promoter_id': 'promoter-uuid',
    'admission_date': '2026-05-07',
    'document_type': 'ine',
    'document_number': '123456789',
    'is_financial_entity': false
  }
}

# Response (201 Created):
{
  'data': {
    'id': 'investor-uuid',
    'sequential_id': 187,
    'name': 'Test',
    'lastname': 'Martinez',
    'matriname': 'Lopez',
    'full_name': 'Test Martinez Lopez',
    'company': false,
    'company_name': null,
    'person_type': 'Persona fisica',
    'nationality': 'mexican',
    'translated_nationality': 'mexicano',
    'national_id_number': null,
    'phone_number': '5512345678',
    'mobile_number': '5598765432',
    'gender': 'female',
    'dob': '1985-01-01',
    'email': 'test.martinez@example.com',
    'admission_date': '2026-05-07',
    'balance': { 'mxn': '0.00', 'usd': '0.00' },
    'active_investment_amount': 0,
    'promoter_id': 'promoter-uuid',
    'country': 'mexico',
    'is_financial_entity': false,
    'prospect_id': null,
    'user_created': false,
    'document_type': 'ine',
    'document_number': '123456789',
    'marital_status': 'single',
    'promoter': { ... },
    'contacts': []
  }
}

Errors

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