principal

The Principal array captures the details of the individual responsible for card processing services on behalf of the merchant’s business.

Top-Level Principal Keys and Arrays

Notes:

  1. In the API Reference, keys that apply only to North American regions are annotated with "NA".
  2. The table is a guide. Always refer to the API Reference.

Top-level keys and arrays capturing a principal's properties.

Element

Description

Criterion

Notes

alternateAddressInfo

The principal's alternative business address.

 

 

contactInfo

A wrapper identifying how best to contact the Principal.

Array

The array is described in the following contactInfo table.

directionalOwnershipType

Indicates if the Principal has direct or indirect ownership of the business.

 

Enum of "DIRECT_OWNERSHIP" or "INDIRECT_OWNERSHIP"

dob

A wrapper forming the principal's date of birth.

Array

The array is described in the following dob table.

ids

A principle's identity document information.

Array

The array is described in the following id table.

isNewOwner

A flag indicating if the Principal is a new owner of the business.

 

Use Boolean true if yes, false if no.

name

An array identifying individual principals.

Array

The array is described in the following name table.

ownershipPct

The percentage of the business the Principal owns.

Required

It can be 0% for the principal, any additional shareholders with 25% or greater ownership must be included.

positions

Boolean map denoting the positions that the Principal holds in the applying company.

Required

primaryNationality

Country of Principal's primary nationality.

 

Use ISO 3166-1 alpha-3.

residingCountry

The Principal's current country of residence.

 

Use ISO 3166-1 alpha-3.

responsibleParty

Determines who is responsible for the day to day operations.

Required

Boolean true if yes, false if no.

secondaryNationality

Country of Principal's secondary nationality.

Optional

Use ISO 3166-1 alpha-3.

signingAgreement

A flag indicating if the Principal is the person signing the agreement.

 

Use Boolean true if yes, false if no.

name

An array within principal. that identifies individuals.

name keys

Element

Description

Criterion

Notes

salutation

Used to reference the individual’s title or salutation.

Required

See General Element Codes > salutation.

firstName

An individual's first or given name.

Required

 

middleName

An individual's middle name, if available. This option decides the credit check response in the certification environment.

Optional

“F” returns a failure response, “E” returns an error response.

See General Element Codes > CreditCheckResponse.

lastName

An individual’s last name or surname

Required

 

 

Back to Top

contactInfo

An array within principal identifying how to contact the Principal.

address

Note: Use email when correspondence is time-sensitive such as bills and updates, etc.

The address array.

Element

Description

Criterion

Notes

streetName

The street name the residence is located on.

Required

Additional lines are optionally available.

streetNumber

The residence name or number.

Optional

 

city

The city on which the residence is located.

Required

 

county

The county.

Optional

 

postCode

The zip or postal code of the residence.

Optional

 

country

Country of address

Required

Use the ISO 3166-1 alpha-3 standard.

contactName

Details of the contact at the address.

Optional

 

additionalAddresses

The contact's additional address details and verification.

Optional

 

phone, mobile, and fax arrays

The phone, mobile, and fax arrays capture the elements of a phone number populated by enums.

The phone array.

Element

Description

Criterion

Notes

intlCode

The International Dialling Code.

Optional

See General Element Codes > phone.

areaCode

The area or STD code prefix.

Required

 

Number

The identifying line number.

Required

 

extension

An extension number if required.

Optional

 

emailAddress

Note: Use email when correspondence is time-sensitive such as bills and updates, etc.

The emailAddress key.

Element

Description

Criterion

Notes

emailAddress

A valid contact email address.

Required

40 characters maximum.

 

Back to Top

dob      

An array within principal forming an individual’s Date of Birth.

Data captured for dob (date of birth).

Element

Description

Criterion

Notes

year

The year of birth.

Required

Integer

month

The month of birth.

Required

A three character string. See General Element Codes > month.

day

The day of the month of birth.

Required

Integer

 

Back to Top

id

An array within principal capturing the personal identity document (ID) used to validate the credentials of an applicant.

The id array.

Element

Description

Criterion

Notes

idType

The type of ID presented.

Required

Enum examples include "PASSPORT", "DRIVER_LICENSE", etc.

idNumber

The identifying number on the ID.

Required

 

issue Date and expiryDate

year

The ID issue or expiry year.

Optional

Integer

issue Date and expiryDate

month

The ID issue or expiry month.

Optional

Three characters. See General Element Codes > month.

issue Date and expiryDate

day

The ID issue or expiry day of the month.

Optional

Integer

issuingCountry

 

Optional

ISO 3166-1 alpha-3 standard applies.

idName

 

Optional

 

issuingAgency

 

Optional

 

 

Back to Top

 

❮ Back to Top Level Credit Check Tags   Next:  businessInfo ❯