Release Notes - November 2014 Update A

November 12, 2014

In this release we have added a new Account Ownership Verification service for retrieving an account's monthly statement as a PDF document.

We also added a form to request support for new financial institutions, replaced the old v1 versions of two authentication endpoints with an improved v2, and introduced a type property for customer records, with an endpoint for adding each type of customer. Each of these changes is summarized below.

See Active Docs for detailed API specifications.

Account Ownership Verification Service

This is a new service, distinct from our aggregation services. Partners subscribed to this service can create temporary customers and accounts for a one-time download of an account's monthly statement as a PDF document, and/or a one-time pull of transaction history.

Request for New FI

We have added a secure form to request support for a new financial institution, for cases where you cannot find the institution using Get Institutions. You can access the form by clicking Help > Request a New FI from the Developer Portal.

Partner Authentication v2
POST /v2/partners/authentication

The new version requires a partnerId in addition to the partnerSecret. Both of these values are available in the Developer Portal.

Modify Partner Secret v2
PUT /v2/partners/authentication

The new version requires a partnerId in addition to the partnerSecret. Both of these values are available in the Developer Portal.

Add Testing Customer
POST /v1/customers/testing

New endpoint to enroll a testing customer. A testing customer may only register accounts with FinBank (institution ID 101732). See Testing Accounts for more information.

This endpoint is available from all service plans.

Add Active Customer
POST /v1/customers/active

New endpoint to enroll an active customer (the actual owner of one or more real-world accounts). The customer's account transactions will be refreshed every night.

This endpoint is available from all Agg Service plans except the Test Drive.

Add Temporary Customer
POST /v1/customers/temporary

New endpoint to enroll a temporary customer (the actual owner of one or more real-world accounts). A temporary customer does not participate in the daily aggregation process. This kind of customer is intended for short-term charge-per-use invocations of endpoints such as Get Customer Account Statement, Refresh Customer Account, and Get Customer Account Transactions. The customer and all associated accounts will be deleted from the database after 7 days.

This endpoint is available only from the Account Ownership Verification service.

Deprecated Endpoints

The following endpoints have been deprecated, and will be removed from the API in our next release:

  • Partner Authentication v1 -- Use Partner Authentication v2 instead.
  • Modify Partner Secret v1 -- Use Modify Partner Secret v2 instead.
  • Add Customer -- Use one of Add Testing Customer, Add Active Customer, or Add Temporary Customer instead.

 

 

 

 

Have more questions? Submit a request

Comments

Powered by Zendesk