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 is_owner 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 has many optional attributes and 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

Company attributes

The company object has many optional attributes but requires only the name attribute.