This API update contains the following changes:

• New functionality for managing loan flags and flag priority has been introduced. With this update, the API’s now support configuring and managing loan flags at the portfolio level.
  • POST /api/v1/flags has been updated to support a flagType and flagPriority
  • PUT /api/v1/flags/{flagId} has been updated to support flagType and flagPriority and the label for this method has been renamed to “Update a flag” to more generically support both customer and loan flag changes. The duplicate logic has been updated to look for a unique flagName and flagType.
  • GET /api/v1/customers/{customerId}/flags has been updated return flagType and flagPriority in the model and flagPriority has been added as a new search filter
  • GET /api/v1/loans/{loanId}/flags has been added to support retrieving flags on a loan
  • PUT /api/v1/loans/{loanId}/flags/{flagId} has been added to support modifying flag status on a loan
• The ability to find loans by origination date has been added as a new filter on the existing GET /api/v1/loans method. Using a date format (“yyyy-mm-dd”) permits returning all loans where origination matches that date. This is useful when working with dashboard or external tools where finding all orginated loans is useful.
• PUT /api/v1/customers/{customerId} had an issue corrected where the employerPhone field was not saving correctly. This has been fixed.

This release contains two internal updates only. No customer impact:

• Cosmetic update to remove “NEW” labels from some methods
• Updated the internal libraries to prepare for some new functionality in an upcoming release

This release contains two changes:

• An issue was corrected with GET /loans where the withdraw reason on older loans was sometimes incorrect.
• An update was made to the payroll API methods to support a new daily frequency (frequency = 5)

Release 1.4.17 introduces two new API methods for Withdrawing a Loan and to see hardcoded and custom withdrawn reasons.

Features

Withdraw Loan: You can now withdraw a Pending Application via API.

PUT /api/v1/loans/[loanId]/withdraw

Withdrawn Reasons: This method displays all current withdrawn hard-coded and Lender created withdraw reasons.

GET /api/v1/config/withdrawnReasons

Release 1.4.16 introduces a new API method for Loan Origination and an enhancement to the GET Loan method.

Features

Loan Origination: You now have the ability to originate a Pending Application via API.

PUT /api/v1/loans/[loanId]/originate

Update to the Loan method: The ‘dateChanged’ filter now allows you to search using a date range. Prior to release 1.4.16, the Loan method only allowed filtering by a specific date/time.

GET /api/v1/loans

Release 1.4.15 introduces two updates to the customer GET and PUT methods — a new ability to search for customers by updated date range and a change to customer update to synchronize operational opt-in changes with Solutions by Text (SBT).

Features

API Operational SMS Change: When Lender changes the SMS Operational Opt-in status for a customer via an API, the system synchronizes that change with Solutions by Text (SBT) and updates the SBT SMS white list to ensure proper message delivery.

PUT /api/v1/customers/{customerId}

New filter retrieves customer records by updated date range: Searching for customers has been improved with a new filter permitting the retrieval of customer records by their updated date. A start and end timestamp can be provided to narrow the search to specific ranges.

GET /api/v1/customers

Release 1.4.14 introduces a new ability to move loans between collection queues.

NEW FEATURES

• Collection Queue Move. This method allows you to move a loan from any collections queue to any other collection queue. Please refer to the collectionQueueId enumeration for a list of value queue Id’s.

PUT/api/v1/loan/{loanId}/changequeue/{queueId}

Release 1.4.13 introduces one update to the Loan search.

NEW FEATURES

• Ability to find loans that have changed since a specific date and time. Finding changes in the loan records can be difficult, and many Lenders resorted to large data pulls and comparing the results to previous queries to find the differences. To help with identification of new or updated records, a new “datechanged” parameter has been added which permits retrieval of all loan records since a particular date and time.

The 1.4.12 release fixes an issue with the loan summary call.

UPDATE

• Corrected a bug with the loan summary call not returning the correct value for the drivers license state field.

Release 1.4.11 introduces two new API methods that focus on improving efficiency for customers pulling lots of data and enabling some additional self-service automation with a new ability to modify pending application loans.

NEW FEATURES

• New Loan Summary Method. Many customers are using the EPIC API’s to pull large amounts of data in real-time for offline processing or display. When working with quantities of loans, pulling down all the information for a loan requires multiple API calls and then client-side data assembly. To make the process more efficient, this release introduces a loan summary method that, when invoked, will retrieve loan, customer, signature, and payment information. This is on average a 4x reduction in the number of API calls required to retrieve the same data. Boolean flags are included to hide or show each section so you can choose what is most relevant to you.

  GET /api/v1/loans/{loanId}/summary

• Pending Application Loan Modification. We have added a new Loan API method that allows updating of a loan in a pending application status. This API call permits changing the program, principal amount, interest rate, and number of installments. All or some of the values can be updated and the system will automatically catch business rule violations and prevent any changes that would result in an invalid loan combination.

  PUT/api/v1/loans/{loanId}/pendingapplication/recalculation

UPDATES

• Internal changes to support future functionality
• Cosmetic updates to the API documentation page

The 1.4.9 release fixes an issue with changing the payment mode of a loan.

UPDATES

• Corrected a bug with the update payment mode payments method. When changing the payment mode via an API, the system was not voiding an existing e-signature on a loan causing the loan agreement to not match. This update will properly void the e-signature when a payment mode change occurs via an API method.

The 1.4.8 API release introduces four new customer reference calls.

List Reference

The List method will return a list of references for a particular customer.

GET /api/v1/customers/{customerId}/references

Update Reference

The Update method will permit updating a specific reference for a particular customer.

PUT /api/v1/customers/{customerId}/references/{referenceId}

Create Reference

The Create method will create (add) a new reference for a particular customer. Once added, the reference will immediately be available in the list of references for that customer.

POST /api/v1/customers/{customerId}/references

Delete Reference

The Delete method will remove a reference from a customer. Once removed the reference will no longer appear in the list of references on customer record.

DELETE /api/v1/customers/{customerId}/references/{referenceId}

The 1.4.6 release introduces new call to return status of an IBV request.

NEW FEATURE

• List IBV status is now available to return latest status of an IBV request for a customer for a specific IBV provider.
• Decision Logic is currently the only supported provider.
• This method returns status details of an IBV request when an underwriting request is initiated within the EPIC LMS system.

GET /api/v1/customers/{customerId}/underwriting/ibvStatus/{providerId}

The 7.38 release of the core LMS product introduced a new feature called custom fields. This feature permits saving additional ad-hoc data to a customer record and then surfacing that data via smart tags that can be used on marketing templates and loan agreements.

To set and manage the data for these custom fields, the 1.4.5 API Release introduces three new API methods for retrieving and changing the values for up to 10 custom fields.

NEW FEATURES

• Two new customer related methods were introduced to return data set for the custom fields associated with a specific customer record.
  • List all custom fields for a customer.  This method will return all configured custom field data for a specific customer.

    GET /api/v1/customers/{customerId}/customFields 

  • Return values for a specific custom field for a customer. This method will only return the values for a specific custom field for a given customer record.

    GET /api/v1/customers/{customerId}/customFields/{customFieldId}

• A new customer related method was introduced to update the values associated with custom fields.
  • Update custom field. This method will permit changing the value associated with a specific custom field associated with a specific customer.

  PUT /api/v1/customers/{customerId}/customFields/{customFieldId}

The 1.4.4 release introduces new functionality that rounds out working with customer records, a new feature for Lenders working with black boxes, and new agent assignment functions.

NEW FEATURES

• Two new customer related methods were introduced to CREATE and DELETE a customer record.
  • Create a customer. Create a new customer record in a portfolio.

    POST /api/v1/customers

• • Delete a customer. Delete a customer. Deleting a customer is only possible if no loans or notes exist for the customer.

    DEL /api/v1/customers/{customerId}

• Return details about an accepted lead.
  • Get customer and loan information for an accepted lead. This method will return details about a lead accepted into the system when a leadTokenId is available. By passing the leadTokenId into this method, it will currently return back a JSON structure with the customerId and loanId associated with the accepted lead. This is useful if external systems want to correlate a lead sent into the system and know the final specific records created within the EPIC LMS. Lead token’s must be enabled in the front-end portfolio first.

    GET /api/v1/leadTokens/leadTokenId

• Two new agent management methods are available for listing and updating the assigned agent.
  • Update current employee assignments on a loan. This method will permit changing the loan manager or assigned collector on a loan.

    PUT /api/v1/loans/{loanId}/agent

• • List current employee assignments on a loan. This method will return employee assignment information on a loan. The response JSON structure will return the assigned loan manager and the assigned collector agent for the specified loan.

    GET /api/v1/loans/{loanId}/agent

UPDATES

• Minor formatting adjustments to release notes and enumerations page to keep focus on expanded content to prevent content from scrolling up off the top of the page.
• Removed “NEW” flag for posting a debit payment method.

The 1.4.3 release introduces a new payment call.

NEW FEATURES

• Post a debit payment is now available. This method permits posting of a non-ach debit payment in the system. This is intended to mark an existing scheduled non-ACH debit payment as paid.

PUT /api/v1/loans/{loanId}/payments/{paymentId}/postpayment

The 1.4.2 release fixes an issue with changing stores.

UPDATES

• Corrected a bug with the change store API method. The change store method was incorrectly keeping the program for the source store. This update will now select the most appropriate program for the target store.
• Removed “NEW” flag from older API methods.

The 1.4.1 release introduces new functionality around flags management at both the portfolio and customer level. The management methods provide all the core operations for working with flags at the portfolio level such as listing, adding, updating, and deleting flags. To work with customers, methods are now available to list flags that have been enabled for a customer and a method for toggling the status of a flag.

NEW FEATURES

• Portfolio level management flag functions:
  • List flags for a portfolio. Return a list of all the flags currently configured in the portfolio.

GET /api/v1/flags

• • Add a new flag. Create a new flag in the portfolio.

POST /api/v1/flags

• • Update a flag name. Change the name of an existing flag.

PUT /api/v1/flags/{flagId}

• • Delete a flag. Remove a flag from use across the portfolio.

DEL /api/v1/flags/{flagId}

• Customer level management flag functions:
  • List enabled flags for a customer. This method returns all the flags currently set for a customer with the date of activation.

GET /api/v1/customers/{customerId}/flags

• • Update flag status for a customer. This method permits turning a flag on or off for a customer.

PUT /api/v1/customers/{customerId}/flags/{flagId}

The 1.4.0 release introduces updates related payments.

NEW FEATURES

• Schedule a payoff for a loan is now available. This method permits scheduling a final payoff to transition a loan to closed status.

POST /api/v1/loans/{loanId}/payoff

• Rollback a scheduled payoff is now available. This method provides the ability remove a previously scheduled payoff that has not been processed. Removing a scheduled payoff will restore the previous payment schedule.

DEL /api/v1/loans/{loanId}/payoff

• Void a loan is now available. This method permits voiding a new loan.

PUT /api/v1/loans/{loanId}/void

The 1.3.7 release introduces several updates related to loans, Veritec support, and other updates related to general API usage.

NEW FEATURES

• Get rescind information for a loan is now available. This method provides information on how many calendar days are available for a rescind to occur on an installment loan.

GET /api/v1/loans/{loanId}/rescind

• Rescind a loan is now available. This method provides the ability to rescind a loan. A rescind is only available for installment loans and can only occur before the first payment and must be within the maximum number of days for rescind defined in the state regulations.

PUT /api/v1/loans/{loanId}/rescind

• Change loan due date is now available. This method permits consumers to repay their flexpay or payday loan on a different day than scheduled.

PUT /api/v1/loans/{loanId}/dueDate

• Renew a loan is now available. This method provides the ability to renew a flexpay or payday loan.

PUT /api/v1/loans/{loanId}/renew

• Veritec support has been enabled for customer updates. If Veritec is enabled in the portfolio for a particular store, API updates will also report changes.
• Note searching by date has been expanded to support full UTC time format searching. Range searching now supports exact ranges such as:

2018-03-16T17:25:22.7950064Z,2018-03-16T19:25:22.7950064Z

UPDATES

• • Fixed a typo in the payment json structure for paymentModeId in example “Add a makeup payment applied to fees and principal”
  • Updated note documentation to correctly indicate that employeeId is a required field
  • Fixed incompatibilities in online documentation causing external swagger validation badge to fail
  • Updated documentation timeout when logging in to use the system token expiration time instead of a hard-coded time
  • Added a pop-up to indicate when an interactive documentation session time has expired

The 1.3.6 release introduces two more notes related API methods, a new element for the loan object, and some other updates related to general API usage.

NEW FEATURES

• Edit a note is now available. This method permits editing of the note subject or body for notes entered by agents. System notes are still read-only.

PUT /api/v1/customers/{customerId}/notes

• Delete a note is now available. This method permits deleting notes entered by agents. System notes are still read-only. This method requires passing in a unique customerId and noteDate to identify an individual note for removal.

DEL /api/v1/customers/{customerId}/notes

• A new element called expeditedPaymentType has been added to the loan object. This enumeration indicates if the loan payments are funded as Wire Transfer or Same Day ACH. This replaces the soon to be deprecated issueByWireTransfer field.

UPDATES

• Clarifications were made in the documentation and models to indicate when CST vs UTC is used for datetime fields. By default, all activities are CST unless explicitly stated as UTC. The existing token and notes methods utilize UTC, everything else is CST.
• An update was made the interactive documentation site to update the login status indicator when a token session expires. The menu will not correctly show when you are logged out after a session expiration.
• Fixed an issue when trying to update the payment mode on a payment for a loan in pending renewal status. Pending renewal status is not a valid status for updating the payment mode and a proper error is now returned if that activity is attempted.

The 1.3.5 release addresses a bug impacting the ability to sign a loan on a weekend.

UPDATES

• An issue preventing signing on the weekends has been corrected for the PUT /api/v1/loans/{loanId}/signature method.

The 1.3.4 release introduces two more payments related API methods.

NEW FEATURES

• Delete a payment is now available.This method provides the ability to delete an unprocessed additional or makeup payment on an installment loan. It is necessary to supply the authorizationType as a query parameter to record the authorization obtained with the delete.

DEL /api/v1/loans/{loanId}/payments/{paymentId}

• Change payment due date is now available. This method provides the ability to push a regularly scheduled date forward into the future up to
  one business day before the next scheduled payment. This method works with installment loans and is only applicable to regularly scheduled payments.

PUT /api/v1/loans/{loanId}/payments/{paymentId}/dueDate

• The payment model in /loans/{loanId}/payments and /loans/{loanId}/payments/{paymentId} has been updated to support the following elements:
  • authorizationType : Enumeration indicating the authorization provided by the customer
  • serviceFee : Amount of the service fee
  • serviceFeeInterest : Amount of the service fee interest
  • managementFee : Amount of the management feemaintenanceFee : Amount of the maintenance fee
  • originationFee : Amount of the origination fee

UPDATES

• The feesAmount value in /loans/{loanId}/payments and /loans/{loanId}/payments/{paymentId} has been updated to properly sum the following fields:
  • financeFee
  • lateFee
  • nsfFee
  • serviceFee
  • serviceFeeInterest
  • managementFee
  • maintenanceFee
  • originationFee

The 1.3.3 release introduces another payments related API method.

NEW FEATURE

• Scheduling an additional or makeup payment is now available.
  • An additional payment (paymentType=1) is used to schedule an additional payment towards the loan balance.
  • A makeup payment (paymentType=2) is used to schedule full or partial past due amounts for processing. When creating a makeup payment the ability to specify amounts for associated fees is available.
  • This method operates at a payment level and is only available for installment loans.

• POST /api/v1/loans/{loanId}/payments

UPDATES

• Fixed an issue with payment pagination that prevented retrieving all results.
• The token expiration time has been updated to 60m in duration.

The 1.3.2 release introduces another loans related API method.

NEW FEATURES

• Obtain loan balance details provides balances on a loan to determine what is owed at this point in time. The resulting structure returns a breakdown of the loan into the following sections:
  • outstandingAmount : Breakdown of principal and fees that makes up the totalOutstandingAmount
  • pastDueAmount : Breakdown of principal and fees that makes up the totalPastDueAmount
  • makeupAmount : Breakdown of principal and fees that makes up the totalMakeupAmount
  • totalOutstandingAmount : This is the money that is expected to be received from the customer as payment on the loan
  • totalPastDueAmount : The total amount of missed payments that have not been paid including any associated fees
  • totalMakeupAmount : Unscheduled past due amounts

  GET /api/v1/loans/{loanId}/balance

The 1.3.1 release introduces another payments related API method.

NEW FEATURES

• Changing the payment method on a loan to update how money is collected from the customer is now available. Changing the payment mode requires indicating the new payment mode (paymentModeId) and the authorization type provided by the end user (authorizationType). This method operates at the loan level and is useful when a customer wants to make a change to a loan (payday, flexpay) or all payments in a loan (installment).

  PUT /api/v1/loans/{loanId}/paymentMode

UPDATES

• Expanded the documentation for updating the payment mode on a payment to provide additional details on conditions of use.
• Added new enumeration descriptions for payrollType, dayOfWeek, frequency

The 1.3 release is the first of several upcoming updates centered around our new payments functionality.

NEW FEATURES

• Changing the payment method on a payment to update how money is collected from the customer is now available. Changing the payment mode requires indicating the new payment mode (paymentModeId) and the authorization type provided by the end user (authorizationType) and will work on all non-originated installment loans.

  PUT /api/v1/loans/{loanId}/payments/{paymentId}/paymentMode

UPDATES

• Released details on new payments related API calls in payments section of documentation
• Various internal business layer optimizations

NEW FEATURES

• A new method permits changing the effective date on a loan:

  PUT /api/v1/loans/{loanId}/effectiveDate

• GET /api/v1/loans/{loanId}/payments will now list payments in pending status that have not yet been originated

UPDATES

• Fixed an issue with notes that could prevent signing a pending application that was in a not-signed status
• Upgraded to the next generation Windows 2016 API server and .NET framework for improved performance and maintainability

UPDATES

• Updated customer search to handle customers with special characters in name
• Updated document upload to retain original filename and not append an automatic extension to the file
• Internal changes to improve data retrieval on GET requests
• Additional documentation provided with examples for document upload

We are pleased to present v 1.2.2 of the EPIC API’s. This major release contains numerous feature enhancements and a complete overhaul of the underlying API architecture for upcoming functionality.

HIGHLIGHTS

• Improved API Engine
• Interactive API Documentation
• Changing a store for a loan
• Customer payroll management
• Obtaining a payoff amount for a loan
• Retrieve signature status for a loan
• Ability to sign a loan
• Return HTML for agreement
• Additional changes and fixes

Improved API Engine

This release contains some major changes to the underlying API engine that give us some performance changes and set up a framework for launching some exciting new functionality in the future.

100% average faster response time : We’ve made internal changes how logging works on each API call and migrated to an asynchronous process for logging. Our internal tests show that on average this will result in 100% average faster response time for API calls.

Business layer upgrade : The internal business layer has been upgraded and is now shared between the API and our core UI product. This major change was significant behind-the-scenes work, but moving forward this will give us the ability to use a “write-once” methodology where new functionality is automatically made available to the API and UI at the same time. This unification of internal application architecture will give us the ability to introduce desired functionality faster and is the foundation for some exciting new features planned for the near future.

Interactive API Documentation

We spent a lot of time improving our documentation to make it easier for you to utilize our API’s. This release has three changes that we are excited to talk with you about.

Removed API whitelist : We’ve removed the API whitelist restriction on our API documentation. It is no longer required to work with our client services team to pre-approve every location that needed to see the documentation. With this release all API documentation is now 100% publicly accessible.

Interactive documentation : One of the more exciting changes with this release is the ability to interact with the API documentation and perform live API queries right from the documentation website. A new login in the top right of the site permits you to sign in with any valid access key and secret key. Once authenticated, the documentation will update to permit you perform API calls from each method by completing the necessary required fields and pressing the “Try it out!” button. The resulting response body will be the same as if you invoked the API from your own code. (Note: These are live calls that will work for both sandbox (https://api.sandbox.epicloansystems.com) and production (https://api.epicloansystems.com) credentials.)

Organizational layout : We’ve introduced many new API methods and to avoid scrolling through one long list we are now presenting functionality by subject area. We hope this will make it easier for you to find what you are looking for.

Changing a store for a loan

One of the features commonly asked for was the ability to change the store for a loan. We now have two new API calls to help with this process.

• To obtain the current store information for a loan, a new API method is available (GET /api/v1/loans/{loanId}/store) which returns the following data points:
  • storeId : Unique store ID
  • loanType : The type of loans that this store accepts (Payday, Flexpay, Installment)
  • maxLoanTransfer : The maximum dollar amount that will be accepted for a loan being transferred into this store
  • storeKey : Store key for lead providers to send leads to this store
  • storeName : Store name
• For loans in a Pending Application status only, the store of the loan can be changed using the change store API (PUT /api/v1/loans/{loanId}/changestore/{storeId}). There is the ability to optionally perform underwriting during this change store transfer.

Customer payroll management

A new suite of payroll API calls are available with this release permitting the ability to perform the following functions on customer payroll records:

• List all the payroll information for a customer
• Add a new payroll record for a customer
• Update an existing payroll record
• Delete a payroll record
• Ability to quickly retrieve primary payroll record for a customer

The first payroll record submitted will automatically be set as the primary payroll record. When multiple payroll records are present, the ability to change the default payroll record for a customer is possible using the update method.

Creating payroll records supports the following frequency types:

• Weekly Frequency
• Bi-Weekly Frequency
• Semi-Monthly Frequency – Specific Two Days of Month
• Semi-Monthly Frequency – Relative Two Days of Month
• Monthly Frequency – Specific Day of Month
• Monthly Frequency – Relative Day of Month
• Monthly Frequency – Day of Month After a Relative Day

Obtaining a payoff amount for a loan

The ability to dynamically obtain the payoff information for a loan for a specific date is now available (GET /api/v1/loans/{loanId}/payoff). When provided a loan, the payoff API call will return the payoff amount for the provided date along with principal, any fees, and fee types.

Retrieve signature status for a loan

Obtaining the signature status and other details for a loan is now available via the signature status API method (GET /api/v1/loans/{loanId}/signature). For a given loan, the system will return the following information:

• Signature provided by the customer (if signed)
• The signature status of the loan
• The signed date and time of the loan (if signed)
• The IP address provided at the time of signing (if signed)
• Reference to the system generated loan agreement (if signed and generated by EPIC can be retrieve with the GET /api/v1/customers/{customerId}/documents/{documentId} method)

Ability to sign a loan

For Lenders working with external portals and managing loan agreements externally, we now offer the ability to mark a loan agreement as signed (PUT /api/v1/loans/{loanId}/signature). Once signed, the loan will continue through its normal workflow. This signing process requires sending in the customer signature and the signer ip address.

When using this signing API method, there are two important usage notes:

1. It is assumed that presentation and collection of any agreement is handled externally and when using this API call no PDF loan agreement will be generated by EPIC. Lenders can utilize the document upload API method to submit a PDF of the externally signed loan agreement if desired.
2. The signing process will use the settings of the existing loan in the system as what is signed. Any adjustments to the loan should be performed prior to signing.

Return HTML for agreement

To assist Lenders with rendering a loan agreement outside the EPIC system, two new API calls are available to retrieve a processed loan agreement template.

GET /api/v1/loans/{loanId}/loanagreement

GET /api/v1/loans/{loanId}/preloanagreement

These calls will return a URLENCODED version of the agreement template associated with these loans with all smart tags pre-evaluated. This permits parsing and rendering the agreement in an external portal. All HTML form elements are removed, so any interactive components of the agreement would need to be added separately.

Additional changes and fixes

• Removed future placeholder for fraud status; will be re-introduced in the future.
• Update various descriptions for fields in the online documentation for clarity.
• Updated the date format returned in holiday API calls to conformed to YYYY-MM-DD.
• Unused holidayIgnoreYear element was removed from holiday related API methods.
• Various internal security improvements for SOC1 compliance.
• Fixed error message response when using offset filter with no value.

NEW FEATURES

• New delete method allows you to remove a document that was previously uploaded (not system documents)

  DEL /customers/{customerId}/documents/{documentId}

• The loan schedule (scheduleFrequency) is now available in the loan model. See the enumerations page for details on the valid values for this field.
• The employee login name (employeeLogin) is now available in the employee model.
• The ability to search for a loan by display number has been added. Display numbers must be in the format nnnnnnnnn-nn or nnnnnnnnn

UPDATES

• Corrected documentation for /customers model which incorrectly showed some properties as being required when they were optional.
• Added description for GET /customers/{customerId}/documents which was previously missing from the online documentation
• Updated swagger documentation warnings related to document API calls

• Ability to upload documents into the EPIC system for a specific customer
  POST /api/v1/customers/{customerId}/documents

This is a multi part form data post. Below is an example using cURL:
% curl POST -H "Authorization: Token 99f66a84dcf847079a1e9d14492f8875" -H "Content-Type: multipart/form-data" -F "test=@/usr/bin/images/test.PNG" "https://api.epicloansystems.com/api/v1/customers/{customerId}/documents?documentName=test&documentType=99"

• New notes method allows you to obtain a collection of notes associated with a customer matching the search criteria provided.
  GET /customers/{customerId}/notes
• New method allowing you to add a note into the system for a specific customer.
  POST /customers/{customerId}/notes
• New documentType property exposed in the documents model. See enumerations.
• New isPrivate property exposed in the documents model. Will allow you to set a document attribute indicating it is private.
• New isDeletable property exposed in the documents model. This attribute lets you know if this is a document that can be deleted.
• New filter parameter: documentType on the documents resource. Allows you to filter results of a specific document type
  GET /api/v1/customers/{customerId}/documents?documentType=1

• Ability to obtain all documents for a specific customer
  GET /customers/{customerId}/documents
• Ability to obtain a specific document for a specific customer
  GET /api/v1/customers/{customerId}/documents/{documentId}
• Ability to obtain a document download URL
  GET /api/v1/customers/{customerId}/documents/{documentId}/url

• Fixed bug with returned GenderId of value 0 should be returned as 3 “unknown”
• Improved validation on bankRoutingTransitNumber for PUT /customers/{customerId}
• Improved validation on bankAccountNumber for PUT /customers/{customerId}
• Corrected error message for bankAccountNumber to display “BankAccountNumber is invalid, must be 4-17 alphanumeric characters only.”
• Corrected error message for bankRoutingTransitNumber to display “BankRoutingTransitNumber is invalid, must be 9 digits only” and “BankRoutingTransitNumber is invalid, does not pass checksum algorithm validation”

Features

• A new API resource is available for updating a customer record (PUT /customers/{customerId}).
  • Overview
    • With this new resource, the following properties are available for update:
      • Name
      • Address
      • SSN
      • Email address
      • Phone Numbers
      • Bank Account Information
      • Driver’s License Information
      • Employer Information
      • Opt-in / Opt-Out Status for Email and SMS
      • etc… (see documentation for complete list)
  • Usage
    • The system will attempt to update only the fields that were passed in. It is not required to pass in properties where the data value remains unchanged.
    • All updated fields must pass validation before the record will be updated. Upon any validation failure, no update will occur and the error messages will indicate which property failed validation.
  • Implementation Notes
    • There are no restrictions on changing the values for optInSmsMarketing and optInSmsOperational . It is advised that before changing either of these statuses to true that the necessary authorizations are obtained from customers to gain permission to send SMS to the mobile number on the account.
    • Updating the ssn and emailAddress will only be possible if the new values do not already exist within the portfolio.
    • There are four customer properties that cannot be changed: customerId, dateChanged, dateCreated, isReturning. Trying to update those properties will respond with error.
    • Unlike the EPIC user interface, updates to the customer record does not automatically generate a system note. If a note is required for any purpose (ie, to track what data values were updated), then this needs to be performed by the user via a separate note update API call (POST /customers/{customerId}/notes) [coming soon]

Bug Fixes

• When performing a loans request, the status field was not returning the correct values for the status enumerations. This has been updated to return the correct values in the loans resource.

• The online documentation for the API has been updated to include two new sections:
  • Release Notes
    • The online release notes provides a historical view of each API update with a listing of all the changes that have been made available.
    • See Release Notes
  • Enumeration Types
    • A complete list of the enumeration types and values used throughout the API are now available online.
    • The enumeration list is in alphabetical order and includes the mappings between the integer and string values.
    • See Enumerations
• The field level descriptions for enumerations have been updated to display the proper integer values. Refer to the new enumerations page for mappings.
• Field level descriptions have been added for the PaymentUIModel used by /loans/{loanid}/payments and /loans/{loanid}/payments/{paymentid}
• Field level descriptions have been added for the TokenUIModel used by /token

• Fixed a redirect problem on /help site when a trailing “/” was present in the URL.
• Implemented the “Strict-Transport-Security” response HTTP header to force all communication over HTTPS.
• All elements in object JSON responses will now have the primary ID first and all other elements in alphabetical order for readability.
• The performance of /loans/{loanid}/loansequence has been improved to respond back 96% faster.

• A new API documentation site is available. This new help site includes richer details on each method with full model schemas, field descriptions and data types, and sample structures. This new site is IP whitelist protected so please contact EPIC Support if you are unable to access it.
• With this Version 1.0.0 release, our extended beta period ends and the following methods have been officially released into production:
  • Config – Resources related to lists and other portfolio configuration
    • GET /api/v1/config/holidays – Retrieve current holiday list
    • GET /api/v1/config/holidays/{holidayId} – Returns a Holiday object for the provided holidayId
    • GET /api/v1/config/holidays/setting – Returns the current settings for pay action on a holiday (shift forward or back)
    • GET /api/v1/config/departments – Returns a collection of DepartmentID’s for every department in the portfolio matching search criteria provided
    • GET /api/v1/config/departments/{departmentId} – Returns details about a particular department
    • GET /api/v1/config/departments/{departmentId}/employees – Returns a collection of EmployeeId’s assigned to department matching search criteria provided
    • GET /api/v1/config/departments/{departmentId}/employees/{employeeId} – Returns a collection of EmployeeId’s assigned to department matching search criteria provided
    • GET /api/v1/config/badZipCodes – Retrieve current BAD ZIP CODE list
    • GET /api/v1/config/badZipCodes/{badZipCodeid} – Returns a BadZipCode object for the provided badZipCodeId
    • GET /api/v1/config/badSsns – Retrieve current BAD SSN list
    • GET /api/v1/config/badSsns/{badSsnId} – Returns a BadSsn object for the provided badSsnId
    • GET /api/v1/config/badEmployers – Retrieve current BAD EMPLOYMENT list
    • GET /api/v1/config/badEmployers/{badEmployerId} – Returns a BadEmployer object for the provided bademployerId
    • GET /api/v1/config/badRoutingNumbers – Retrieve current BAD ABA list
    • GET /api/v1/config/badRoutingNumbers/{badRoutingNumberId} – Returns a BadRoutingNumber object for the provided badRoutingNumberId
    • GET /api/v1/config/employees – Returns a collection of EmployeeId ‘s for every employee in the portfolio matching search criteria provided
    • GET /api/v1/config/employees/{employeeId} – List employee details
    • GET /api/v1/config/programs – Returns a collection of ProgramID ‘s configured in the portfolio. Installment loans only.
    • GET /api/v1/config/programs/{programId} – Returns details about a particular program (installment loans only)
    • GET /api/v1/config/leadProviders – Returns a collection of LeadProviderID ‘s for every lead provider in the portfolio matching search criteria provided
    • GET /api/v1/config/leadProviders/{leadProviderId} – Obtain a specific lead provider status and other details
    • GET /api/v1/config/stores – Returns a collection of StoreID ‘s for every store in the portfolio matching search criteria provided
    • GET /api/v1/config/stores/{storeId} – Returns details about a particular store
  • Customers – Resources related to working with the customer record
    • GET /api/v1/customers – Returns a collection of CustomerID ‘s for every customer in the portfolio matching search criteria provided
    • GET /api/v1/customers/{customerId} – Returns a customer object for the provided CustomerID
    • GET /api/v1/customers/{customerId}/contactStatus – Returns phone, SMS, and email status for the provided CustomerID
    • GET /api/v1/customers/{customerId}/loans – Returns a collection of LoanID ‘s associated with a customer matching the search criteria provided
  • Loans – Resources related to working with loans and payments
    • GET /api/v1/loans – Returns a collection of LoanID ‘s for every loan in the portfolio matching search criteria provided
    • GET /api/v1/loans/{loanId} – Returns a loan object for the provided LoanID
    • GET /api/v1/loans/{loanId}/loanSequence – Returns a list of loan sequence numbers for a given LoanID (Flexpay/Payday)
    • GET /api/v1/loans/{loanId}/store – Returns the current StoreID for the provided LoanID
    • GET /api/v1/loans/{loanId}/payments – Returns a collection of PaymentID ‘s for every payment associated with the provided loan. If an installment loan returns all payments otherwise returns the one payment associated with that sequence.
    • GET /api/v1/loans/{loanId}/payments/{paymentId} – Returns the current payment details for the provided PaymentID
  • Token – Ability to obtain a token for API usage
    • GET /api/v1/token