v2

POST /promoters
Create a new promoter

Params

Param name Description
promoter
required

Promoter attributes

Validations:

  • Must be a Hash
promoter[name]
required

First name

Validations:

  • Must be a String
promoter[lastname]
required

Last name

Validations:

  • Must be a String
promoter[matriname]
optional

Second last name

Validations:

  • Must be a String
promoter[company]
optional

Whether the promoter is a company

Validations:

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

Company name (required when company is true)

Validations:

  • Must be a String
promoter[email]
optional

Email address

Validations:

  • Must be a String
promoter[phone_number]
optional

Phone number

Validations:

  • Must be a String
promoter[phone_number_extension]
optional

Phone extension

Validations:

  • Must be a String
promoter[mobile_number]
optional

Mobile number

Validations:

  • Must be a String
promoter[gender]
optional

Gender

Validations:

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

Date of birth (YYYY-MM-DD)

Validations:

  • Must be a String
promoter[nationality]
optional

Nationality key (e.g. mexican)

Validations:

  • Must be a String
promoter[tax_number]
optional

RFC / tax number

Validations:

  • Must be a String
promoter[base_commission]
optional

Base commission percentage

Validations:

  • Must be a String
promoter[country]
optional

Country code

Validations:

  • Must be a String
promoter[subsidiary_id]
required

Associated subsidiary UUID (required)

Validations:

  • Must be a String
promoter[is_financial_entity]
optional

Whether the promoter is a financial entity

Validations:

  • Must be one of: true, false, 1, 0.

Examples

# Request body:
{
  'promoter': {
    'name': 'Test',
    'lastname': 'Ramirez',
    'matriname': 'Torres',
    'company': false,
    'email': 'test.ramirez@example.com',
    'mobile_number': '5591234567',
    'phone_number': '5512345678',
    'gender': 'male',
    'dob': '1980-06-15',
    'nationality': 'mexican',
    'tax_number': 'RATC800615ABC',
    'base_commission': '2.5',
    'country': 'MEX',
    'subsidiary_id': 'subsidiary-uuid',
    'is_financial_entity': false
  }
}

# Response (201 Created):
{
  'data': {
    'id': 'promoter-uuid',
    'sequential_id': 80,
    'name': 'Test',
    'lastname': 'Ramirez',
    'matriname': 'Torres',
    'full_name': 'Test Ramirez Torres',
    'company': false,
    'company_name': null,
    'person_type': 'Persona fisica',
    'email': 'test.ramirez@example.com',
    'phone_number': '5512345678',
    'mobile_number': '5591234567',
    'gender': 'male',
    'dob': '1980-06-15',
    'tax_number': 'RATC800615ABC',
    'base_commission': '2.5',
    'organization_id': 'org-uuid',
    'investors_attracted': 0,
    'nationality': 'mexican',
    'translated_nationality': 'mexicano',
    'active_investors_amount': { 'mxn': '0.00', 'usd': '0.00' },
    'country': 'mexico',
    'is_financial_entity': false,
    'subsidiary_id': 'subsidiary-uuid',
    'subsidiary_name': 'Terranova'
  }
}

Errors

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