Customer objects

Each account contains at least one customer. The customer object defines a person or company associated with an account. For example, a person, John Doe, may have a work telephone number associated with a corporate credit card and another phone number associated with a wallet.


No parameters are set at the customer level, but several account parameters use the isowner attribute for validation.

Applicant and document number

The applicant object represents the customer who is the account holder. It requires a document_number attribute, which is a unique number such as a government-issued tax ID.

The applicant object also requires either a personal or company object.

  • Use personal if a person legally holds the account
  • Use company if a company legally holds the account

Personal attributes

The personal object requires at least one of the following attributes:

  • name – person's legal name
  • social_name – person's nickname or other name
  • printed_name – person's display name

The personal object can have the following optional attributes.

  • external_id
  • email
  • gender
  • nickname
  • country_of_birth
  • state_of_birth
  • city_of_birth
  • education_degree
  • marital_status
  • fathers_name
  • mothers_name
  • nationality
  • other_id_number
  • document_type
  • document_issued_by
  • document_issued_at
  • occupation
  • assets
  • income
  • net_worth
  • pep
  • statutory

Company attributes

The company object only requires a name attribute.

The company object can receive the following optional attributes.

  • external_id
  • email
  • company_name
  • registration_number
  • activity
  • company_type
  • company_format
  • company_constitution_date
  • occupation
  • income
  • net_worth
  • annual_revenues
  • type
  • number_of_partners
  • perc_ownership
  • fiscal_situation
  • debt