Release Notes

What’s New in Release Notes

Here you can find current and previous versions of eBoarding’s Release Notes.

What’s New in the eBoarding Guide

New and Improved Version 2.5

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

Partners can now request Push notifications for status updates.

New and Improved Version 2.4

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

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

An eBoarding API Reference has been added.

New and Improved Version 2.3

Documentation has been reformatted to explain high level functionality of eBoarding APIs, using Swagger for data element details.

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

New and Improved 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 Complementary API Calls section.

New and Improved 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)ElementDescription
equipmentPricingstartMonthNew 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
equipmentPricingstartYearNew 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.
equipmentPricingleaseTermNew optional field. Required when purchaseType is INSTALLMENT and must be populated with 3.
equipmentPricingINSTALLMENTNew possible enum for purchaseType.

Removed Fields

The following fields were removed.

Parent Element(s)ElementDescription
verificationsLEGALLegal 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.

New and Improved Version 2.0

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)ElementDescription
businessInfobusinessVerificationDocument information regarding validation of business. Succeeded by verifications.

Added Fields

The following fields are new to the request model.

Parent Element(s)ElementDescription
principal/shareholderusPersonBoolean denoting whether a person is a US citizen. Boolean true if yes, false for no.
principal/shareholdertitleTypeEnum representation of possible title a person holds.
intermediaryOwnerownershipPctOwnership percent of intermediary owner. Cannot exceed 100% when summed with principal/shareholder amounts.
principal/shareholdersigningAgreementRequired. Boolean denoting whether a person is signing the application's agreement. Boolean true if yes, false for no.
businessInfoownerExemptionTypeEnum representing beneficial owner exemption statuses.
businessInfoverificationsMap of BUSINESS to its respective document verification information.
principal/shareholder positionsSOLE_PROPNew possible boolean entry for the positions map.
cardPricingOMNICOMMERCENew possible enum for pricingCategory.

Altered Fields

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

Parent Element(s)ElementDescription
businessVerificationbearerSharesBoolean describes if the business has bearer shares. Boolean true if yes, false for no. Moved from businessVerification, which has been removed, to businessInfo.
businessVerificationlegalStatusEnum describing document of legal status. Moved from businessVerification, which has been removed, to businessInfo.
principal/shareholderTitleFree 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.