Interface PrincipalCreateParams

Export

PrincipalCreateParams

Hierarchy

  • PrincipalCreateParams

Properties

address date_of_birth email first_name id? id_number? is_applicant is_control_prong? job_title last_name middle_name? percent_ownership phone previous_address? years_at_address? years_at_previous_address?

Properties

address

address: OnboardingAddress

Registered residential address for this person

Memberof

PrincipalCreateParams

date_of_birth

date_of_birth: string

This person's date of birth. Format must be ISO8601 (e.g. '2000-01-25'; format 'YYYY-MM-DD'). Currently the person must be older than 18 years of age.

Memberof

PrincipalCreateParams

email

email: string

This person's email address

Memberof

PrincipalCreateParams

first_name

first_name: string

First name of the principal.

Memberof

PrincipalCreateParams

Optional id

id?: string

The unique identifier for this principal. It is not required upon initial submission. The id_number property is redacted in any responses, so if the principal needs to be updated then provide this identifier that was generated during the initial request.

Memberof

PrincipalCreateParams

Optional id_number

id_number?: string

Social Security Number (US) or Social Insurance Number (CA). Optional when business structure is government. Expected format: 9-digit string of numbers (e.g. "111444777"). Optional in CA.

Memberof

PrincipalCreateParams

is_applicant

is_applicant: boolean

Indicates whether this person is the applicant for the merchant account. For US merchant accounts (region = US) it is required that exactly one of the principals is specified as the applicant.

Memberof

PrincipalCreateParams

Optional is_control_prong

is_control_prong?: boolean

This indicates whether the person is the Control Prong. Control Prong is an individual with significant responsibility for managing the legal entity customer (e.g., a CEO, CFO, COO, Managing Member, General Partner, President, Vice-President, or Treasurer). For US merchant accounts (region = US) it is required that exactly one of the principals is specified as the Control Prong.

Memberof

PrincipalCreateParams

job_title

job_title: PrincipalCreateParamsJobTitle

Job title of the person

Memberof

PrincipalCreateParams

last_name

last_name: string

This person's last name.

Memberof

PrincipalCreateParams

Optional middle_name

middle_name?: string

This person's middle name

Memberof

PrincipalCreateParams

percent_ownership

percent_ownership: number

Percentage of ownership of the company.

Memberof

PrincipalCreateParams

phone

phone: string

This person's phone number

Memberof

PrincipalCreateParams

Optional previous_address

previous_address?: OnboardingAddress

Previous registered residential address for this principal. Require for Canadian principals and have lived at their current address for fewer than 3 years.

Memberof

PrincipalCreateParams

Optional years_at_address

years_at_address?: number

Years at given address. Required for CA merchant accounts (region = CA).

Memberof

PrincipalCreateParams

Optional years_at_previous_address

years_at_previous_address?: number

Years at given previous address. Required for CA merchant accounts (region = CA).

Memberof

PrincipalCreateParams

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc