Versioning#
LoanStreet handles all versioning through the URI path.
GET https://external-api.loan-street.com/api/{version_id}/cls/balances
When backwards-incompatible changes are made to the API, a new version is released. Incompatibility can occur when the following changes are made to an endpoint payload:
Removal of an endpoint
Changes to existing permission definitions
Removal of an allowed parameter, request field or response field
Addition of a required parameter or request field without default values
Changes to the intended functionality or behavior of an endpoint. For example, if a DELETE request previously used to archive the resource but now hard deletes the resource.
Introduction of a new validation
The most recent version will always be deployed with a version_id of latest
GET https://external-api.loan-street.com/api/latest/cls/balances
Deprecating Versions#
API versions may have an end of life which allows LoanStreet to improve the quality and performance of the API. LoanStreet will notify customers who use an API version scheduled for deprecation.
LoanStreet API Versions |
Version Support Status |
Version Retirement Info |
|---|---|---|
latest |
Supported |
Never |
v1 |
Supported |
N/A |