principal
The principal section captures details of the individual responsible for card processing services on behalf of the merchant’s business.
principal elements
Top Level - Various identifiers regarding the principal’s properties.
| Element | Description |
|---|---|
| responsibleParty | Determines who is in charge of the day-to-day business operations. Boolean true if yes, false if no. |
| positions | Required. Boolean map denoting the positions that an individual holds in the applying company. Beneficial Ownership = 25% or greater ownership (all Beneficial Owners must be listed and include required information: name, address, ID Number, and date of birth.) Authorized Signer can be an authorized signer or if ownership is less than 25% Boolean true if yes, false/not present if no. Populated from a list of positions that can be found in the eBoarding OpenAPI. |
| ownershipPct | Required if there is an Intermediary Owner. Percentage an individual owns of the business. Can be 0% for principal, all additional shareholders should be at least 25%. |
| primaryNationality | Required. Country of principal’s primary nationality. Use ISO 3166-1 alpha-3 standard (3 letter country code). |
| secondaryNationality | Optional. Country of principal’s secondary nationality. Use ISO 3166-1 alpha-3 standard (3 letter country code). |
| residingCountry | The principal’s country of residence. Use ISO 3166-1 alpha-3 standard (3 letter country code). |
| signingPersonalGuarantee | Required. Used to determine if this person should be regarded as being expected to sign a personal guarantee in addition to their normal documents. NOT required for Sole Proprietors. Boolean true if yes, false for no. Default to ‘yes’ for Sole Proprietors. |
| signingAgreement | Required. Boolean denoting whether a person is signing the application’s agreement. Boolean true if yes, false for no. |
| usPerson | Boolean denoting whether a person is a U.S. citizen. Boolean true if yes, false for no. It is derived from primaryNationality and secondaryNationality if nothing is provided in this field. |
| title | Required only in cases where titleType is OTHER. Free text description of a person’s title, to be used when the correct option is not provided by titleType. |
| titleType | Required. The person’s job title. Populated from a list of accepted titles. |
name - A recurring section that identifies individuals to eBoarding Partner API.
| Element | Description |
|---|---|
| firstName | Required. An individual’s first name. |
| middleName | Optional. An individual’s middle name. |
| lastName | Required. An individual’s last name. |
contactInfo - Includes details for identifying how to contact the individual identified in this nested section, such as contacting the principal or additional shareholders.
address - Refers to an individual’s mailing address, either primary residence or business address. This data can be used to send printed materials to anyone being identified.
| Element | Description |
|---|---|
| streetName | Required. Line one of individual’s address. |
| lineTwo | Optional. Line two of individual’s address. |
| state | Required. State/Province of individual’s address. Populated from a list of states, territories, and provinces. |
| city | Required. The city of an individual. |
| postcode | Required. The zip/postal code of an individual. |
| country | Required. The country of an individual. Use ISO 3166-1 alpha-3 standard (3 letter country code). |
| classification | Required for business, principal, and additional shareholder addresses. This field denotes whether the address is business ( BUSINESS_STREET_ADDRESS) or residential (PHYSICAL_RESIDENTIAL_ADDRESS). |
phone - The phone section contains all elements of a phone number, including the international code which is populated by enums found in the reference section.
| Element | Description |
|---|---|
| intlCode | International Dialing Code used before a telephone number to call a specific country. Populated from a list of International phone codes. |
| areaCode | Required. The area code within a country. |
| number | Required. An individual’s phone number. |
emailAddress - Collecting this data ensures that contact information is complete; use the email address of the principal, contact, or additionalShareholders to send bills, updates, and any other correspondence that is time sensitive.
| Element | Description |
|---|---|
| emailAddress | Required for all signers, including the principal. Applicant’s email address. |
dob - Collects the date of birth of an individual or additional shareholders. This is generally required unless the signer falls under AML exception.
note
This field is optional for principals when the Customer Identification Program (CIP) exemption type (exemptionType field located in businessInfo) is chosen.
| Element | Description |
|---|---|
| year | Required. The year an individual was born. |
| month | Required. The month an individual was born. The month is encoded using the first three letters of the month. |
| day | Required. An individual’s birthdate. |
id - The id section identifies which document validates the identity of the applicant, for example: SSN, ITIN, government issued id. This information is generally required unless the signer falls under AML exception.
| Element | Description |
|---|---|
| idType | Required. The type of identification used, such as passport, driver’s license, etc. Populated from a list of accepted ID types. |
| idNumber | Required. The number of the identification used. |
| expiryDate/issueDate | |
| year | Required. The year that the ID defined above expires/was issued. |
| month | Required. The month that the ID defined above expires/was issued. The month is encoded using the first three letters of the month. |
| day | Required. The day that the ID defined above expires/was issued. |
documentaryInfo
Principal(s) information can be validated through documentary or non-documentary means. If documentary (Sales_Team), the information from that document must be provided. If non-documentary, the principal(s) are validated internally. This information is generally required unless the signer falls under AML exception.
| Element | Description |
|---|---|
| documentary | Required. This element describes whether documentary information is given. Boolean true for yes, false for no. If true, additional fields (documentaryIssuer, documentaryType, documentaryVerifier) are required. |
| documentaryIssuer | Required. Country of document issuance. Use ISO 3166-1 alpha-3 standard (3 letter country code). |
| documentaryType | Required. Type of document. Populated from the documentaryType list. |
| documentaryVerifier | Required. Verifier of document, either the sales team (SALES_TEAM) or unverified (NOT_VERIFIED). |
| idNumber | Required. Identifier of document. |
| issuingState | Required. State/Province of document issuance. Populated from a list of states, territories, and provinces. |
| expiryDate/issueDate | |
| year | Required. The year that the ID defined above expires/was issued. |
| month | Required. The month that the ID defined above expires/was issued. The month is encoded using the first three letters of the month. |
| day | Required. The day the ID defined above expires/was issued. |
alternateAddressInfo
Optional; specifies alternate verification of document.
| Element | Description |
|---|---|
| documentNeeded | Required. Describes if alternative information is needed or not. Boolean true for yes, false for no. |
| documentVerified | Required if an alternateAddressDocumentType is given. Describes if a submitted document is verified. Boolean true for yes, false for no. |
| alternateAddressDocumentType | Optional. Type of document given for address verification, such as a bank statement (BANK_STATEMENT), utility bill (UTILITY_BILL), or other (OTHER) valid form of documentation. |