Release Notes

What's new in Version 2.5

Learn about eBoarding's new Guided Flow on the Getting Started page.

Partners can request Push notifications for status updates.

What's new in Version 2.4

Tips for troubleshooting Boarding Timeouts after application submission have been added.

A new sequence diagram shows the proper order for making documents API calls.

An eBoarding API Reference has been added.

What's new in Version 2.3

The format of this document has been modified to explain at high level of the functionality of the APIs with references to Swagger for details of the data elements.

New APIs are available for document generation and signing and to receive Converge credentials.

What has changed from Version 2.2

New API call

Canadian Code of Conduct document can now be retrieved via an API call. 

The request and response are detailed in the Complimentary API Calls section.

What has changed from Version 2.1

In light of ongoing Anti-Money Laundering (AML) requirement implementation, some fields may be subject to change and removal.

Added Fields

The following fields are new to the request model.

Parent Element(s) Element Description
equipmentPricing startMonth New optional field for purchase type RENT. Represents rental start month. Field startYear is required if startMonth is populated. Both startMonth and startYear cannot be a month/year in the past. This option will be populated by Month codes
equipmentPricing startYear New optional field for purchase type RENT. Represents rental start year. Field startMonth is required if startYear is populated. Both startMonth and startYear cannot be a month/year in the past.
equipmentPricing leaseTerm New optional field. Required when purchaseType is INSTALLMENT and must be populated with 3.
equipmentPricing INSTALLMENT New possible enum for purchaseType.

Removed Fields

Parent Element(s) Element Description
verifications LEGAL Legal verification information, twin construct to BUSINESS key-value pair.
Any prior requirement that makes legal verification mandatory should be ignored.
Any defaulting based on it should be replaced with business verification.

What has changed from Version 1.0

For those already using the previous version of the API, the following section highlights the request model changes.

The data additions will also be mentioned in the main body of the documentation itself.

Removed Fields

The following fields were collected and sent in requests for the previous version, but are not collected and sent in the current version.

Parent Element(s) Element Description
businessInfo businessVerification Document information regarding validation of business. Succeeded by verifications.

Added Fields

The following fields are new to the request model.

Parent Element(s) Element Description
principal/shareholder usPerson Boolean denoting whether a person is a US citizen. Boolean true if yes, false for no.
principal/shareholder titleType Enum representation of possible title a person holds.
intermediaryOwner ownershipPct Ownership percent of intermediary owner. Cannot exceed 100% when summed with principal/shareholder amounts.
principal/shareholder signingAgreement Required. Boolean denoting whether a person is signing the application\'s agreement. Boolean true if yes, false for no.
businessInfo ownerExemptionType Enum representing beneficial owner exemption statuses.
businessInfo verifications Map of BUSINESS to its respective document verification information.
principal/shareholder positions SOLE_PROP New possible boolean entry for the positions map.
cardPricing OMNICOMMERCE New possible enum for pricingCategory.

Altered Fields

The following fields have slightly different rules governing their usage compared to previous versions

Parent Element(s) Element Description
businessVerification bearerShares Boolean describes if the business has bearer shares. Boolean true if yes, false for no. Moved from businessVerification, which has been removed, to businessInfo.
businessVerification legalStatus Enum describing document of legal status. Moved from businessVerification, which has been removed, to businessInfo.
principal/shareholder Title Free text description of person's title. Previously the only entry field for a person's title. Now a free text field only to be used when titleType is OTHER.