Home

This documentation provides a forecast of the upcoming changes to Broker API.

2025-Sprint04 (2025/03/19 - 2025/04/06) - Preliminary Information

Minor Added calculation for AmountApproved using MaxApprovedLoanAmount.

  • Versions: v3
  • Detail: In the Get Application Status endpoint, the calculation of the AmountApproved value has been improved to allow more flexibility in the returned values, accommodating situations where the approved amount is not always 120% of the funded amount.

2025-Sprint03 (2025/02/24 - 2025/03/19) - Preliminary Information

Minor Added validation to block invalid paperwork submissions.

  • Versions: v3
  • Detail: If the amount financed has changed since application submission, and the user does not get promotions with the new amount financed before submitting paperwork, the paperwork submission will be blocked in order to prevent incorrect paperwork.

2025-Sprint02 (2025/02/03 - 2025/02/23) - Preliminary Information

Minor Added In the Get Application Status endpoint, AmountApproved will be rounded up to 2 decimals

  • Versions: v3
  • Detail: Added In the Get Application Status endpoint, AmountApproved will be rounded up to 2 decimals

Minor Added DealerFee in the Get Promotion endpoints.

  • Versions: v3

  • Detail: The Get Promotions endpoints will now return the Dealer Fee associated with the promotion.

    Minor bugfix adding max length validation to CurrentEmployer field in Submit Loan application Endpoint.

  • Versions: v3
  • Detail: Now Submit Loan application Endpoint returns error message "Current employer can be maximum 40 characters long." when currentEmployer field exceeds maximum length of 40 characters

2025-Sprint01 (2024/12/15 - 2025/01/12) - Preliminary Information

Minor In the Get Application Status endpoint, AmountApproved will have a maximum value of 100,000.

  • Versions: v3
  • Detail: The value for AmountApproved will no longer return values over 100,000.

Sprint 94 (2024/11/25 - 2024/12/15) - Preliminary Information

Minor Modified validation for mailing and installation city when submitting loan application or paperwork.

  • Versions: v1/v2/v3
  • Detail: City can only contain characters A through Z, period, hyphen, space, or apostrophe.
  • Payloads and Responses: Payloads and Responses
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2024/11/26
  • ETA Prod: 2024/12/15

Sprint 92 (2024/10/07 - 2024/10/29) - Preliminary Information

Minor Added endpoint for stage funding.

  • Versions: v3
  • Detail: Added endpoint to stage fund an application.
  • Payloads and Responses:
  • ETA Stage: 2024/10/25
  • ETA Prod: 2024/10/29

Minor Added fields for future versions.

  • Versions: v3
  • Detail: Added more fields in various endpoint responses in preparation for future versions, such as the new DealerId(DealerNumber will be legacy), LongApplicationStatus(more detailed status of application), and adding more messages to the Status responses. When submitting requests, please continue to use the ID for the dealer provided by Aqua upon integration launch. The new DealerId does not replace the ID provided by Aqua for API requests, it replaces the DealerNumber field. These are only additional fields in responses. Data sent into endpoints will remain the same and changes from integrators will not be necessary.
  • Payloads and Responses:
  • ETA Stage: 2024/10/16
  • ETA Prod: 2024/10/29

Minor Default the ProductOrService on paperwork to the same value that was used during application creation.

  • Versions: v3
  • Detail: This will result in the product on paperwork documents to always be the value that was used during application creation.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2024/10/17
  • ETA Prod: 2024/10/29

Minor Added dealer validation for states.

  • Versions: v3
  • Detail: Validation message back to dealers when they select a state they cannot do business in.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2024/10/17
  • ETA Prod: 2024/10/29

Sprint 89 (2024/08/05 - 2024/09/03) - Preliminary Information

  • Versions: v1/v2/v3
  • Detail: Enter an install address when filling out an application if it is different than the applicant's mailing address.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2024/08/09
  • ETA Prod: 2024/09/03

Sprint 88 (2024/07/14 - 2024/08/04) - Preliminary Information

Minor Added AmountApproved the the application status calls.

  • Versions: v3
  • Detail: Added the approved amount to the Get Application Status and Get Application Statuses Since calls.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2024/07/16
  • ETA Prod: 2024/08/04

Minor Added FullTerms as a field in the Get Promotions(with parameters) response.

  • Versions: v3
  • Detail: Added field for FullTerms which indicates the full length of the promotion term. This field is differentiated from the Terms field as Terms can contain the value of the secondary promotion's terms if applicable. Note: The logic for Terms remains unchanged.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2024/07/16
  • ETA Prod: 2024/08/04

Sprint 87 (2024/06/24 - 2024/07/14) - Preliminary Information

Minor Strengthened validation to Routing Number in ACH.

  • Versions: v3
  • Detail: The routing number in ACH cannot start with a 5.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2024/06/27
  • ETA Prod: 2024/07/14

Sprint 86 (2024/06/02 - 2024/06/23) - Preliminary Information

Minor Added FullTerms as a field in the Get Promotions response.

  • Versions: v3
  • Detail: Added field for FullTerms which indicates the full length of the promotion term. This field is differentiated from the Terms field as Terms can contain the value of the secondary promotion's terms if applicable. Note: The logic for Terms remains unchanged.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2024/06/17
  • ETA Prod: 2024/06/23

Sprint 85 (2024/05/13 - 2024/06/02) - Preliminary Information

Minor Added limitation for future dating signatures to a maximum of 15 days.

  • Versions: v1/v2/v3
  • Detail: Added limitation for future dating signatures to a maximum of 15 days. Users cannot backdate signatures and can only set the signature date up to 15 days in the future.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2024/05/22
  • ETA Prod: 2024/06/02

Sprint 83 (2024/04/01 - 2024/04/21) - Preliminary Information

Minor Added Amount Requested and Approved values to the application Detail endpoint response.

  • Versions: v1/v2/v3
  • Detail: Amount Requested and Approved are included in the payload response. The work is done as part of the 120% amount approved. The amount approved is 120% of the amount requested.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2024/04/09
  • ETA Prod: 2024/04/21

Minor Added risk tier value to the application status endpoint response.

Sprint 81 (2024/02/19 - 2024/03/09) - Preliminary Information

Minor Fixed bug in which RiskTier was not returning properly from the Application Detail endpoint.

  • Versions: v1/v2/v3
  • Detail: The RiskTier now returns an accurate value instead of null.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2024/02/27
  • ETA Prod: 2024/03/09

Sprint 80 (2024/01/29 - 2024/02/18) - Preliminary Information

Minor Revolving applications will not be created from 3/1.

  • Versions: v1/v2/v3
  • Detail: Revolving applications will not be created from 3/1, and defaults to ClosedEnd.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2024/02/12
  • ETA Prod: 2024/02/18

Sprint 79 (2024/01/08 - 2024/01/28) - Preliminary Information

Minor Strengthened validation for the Amount Financed in Financing Parameters during the submission of loan applications.

  • Versions: v3
  • Detail: The Amount Financed is now restricted to a minimum of $1000.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2024/01/11
  • ETA Prod: 2024/01/28

Sprint 78 (2023/12/11 - 2024/01/07) - Preliminary Information

Minor Strengthened validation for the Amount Financed in Financing Parameters during the submission of loan applications.

  • Versions: v3
  • Detail: The Amount Financed is now restricted to a maximum of $100,000.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2023/12/15
  • ETA Prod: 2024/01/07

Sprint 77 (2023/11/20 - 2023/12/10) - Preliminary Information

Minor Added field for YearsOfIncomeFromCurrentSources

  • Versions: v3
  • Detail: If there is no EmploymentType, either this field or a combination of EmploymentYear/EmploymentMonth is required. This field will override any data entered in to EmploymentYear/EmploymentMonth. Value must be between 0 and 99 years.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2023/12/1
  • ETA Prod: 2023/12/10

Minor Paperwork submission for a pending application is not permitted.

  • Versions: v3
  • Detail: Added a new rule to deny paperwork submission for any application in the pending status.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2023/12/5
  • ETA Prod: 2023/12/10

Minor Modified error message for occupation start date must be 16 years greater than the birth date.

  • Versions: v1/v2/v3
  • Detail: Years of Income must be 16 years greater than Birth Date.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2023/12/5
  • ETA Prod: 2023/12/10

Minor Update the Signature Date to the Current date or a future date; Backdating is not permissible.

Sprint 76 (2023/10/30 - 2023/11/19) - Preliminary Information

Minor Modified validation for username when creating or updating user.

  • Versions: v3
  • Detail: Username may consist of alphanumeric and period.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2023/11/13
  • ETA Prod: 2023/11/19

Sprint 74 (2023/09/18 - 2023/10/08) - Preliminary Information

Minor Update regarding deprecated fields for Sales Tax and TradeIn in loan applications or paperwork.

  • Versions: v1/v2/v3
  • Detail: For new loan applications, the Sales Tax and TradeIn fields are deprecated and should not be included in the payload. However, these fields can still be included if modifications to old applications require them.
  • Payloads and Responses: Payloads and Responses
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2023/09/27
  • ETA Prod: 2023/10/08

Minor Update regarding fields for Employment and Income.

  • Versions: v1/v2/v3
  • Detail: Fields CurrentEmployer, EmploymentType are now optional. Going forward, we ask AdditionalIncomeSources amounts are included in the GrossMonthlyIncome rather than sending the object AdditionalIncomeSources, at this time the object AdditionalIncomeSources is still allowed.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2023/10/04
  • ETA Prod: 2023/10/08

Minor The IdentificationType, IdentificationNumber, IsIssueDatePresent, IdentificationIssueDate, IsIssueStatePresent, IdentificationState, ExpirationDateUnavailable and IdentificationExpirationDate from the applicant/co-applicant information will be optional.

Sprint 65 (2023/03/13 - 2023/04/02) - Preliminary Information

Minor The IsIssueDatePresent and IsIssueStatePresent from the applicant and co-applicant objects will be deprecated. There should be no changes to the current payload and the properties will be ignored on the backend server. Application and paperwork submitted with the Unavailable identification type will no longer by accepted. Application and paperwork submissions must have a nonexpired identification type.

  • Versions: v1/v2/v3
  • Detail: The specified properties will be removed from the applicant and co-applicant objects in a future release. The dealer portal system will not accepted any application or paperwork with an Unavailable identification type. The identification card must be nonexpired.
  • Payloads and Responses: Payloads and Responses
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2023/03/31
  • ETA Prod: 2023/04/02

Sprint 64 (2023/02/20 - 2023/03/12) - Preliminary Information

Minor Modified application detail to include the ACH only signature information.

  • Versions: v3
  • Detail: The ACH only signature information is included in the response.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2023/02/27
  • ETA Prod: 2023/03/12

Minor Allow null for AdditionalIncomeSources in the applicant and co-applicant(if applicable) objects.

  • Versions: v1/v2/v3
  • Detail: The [] or a null can be used for AdditionalIncomeSources when there is no other income.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2023/02/27
  • ETA Prod: 2023/03/12

Sprint 62 (2023/01/09 - 2023/01/29) - Preliminary Information

Minor Flag to allow Applicant or CoApplicant or Both to Sign the ACH Only eSign paperwork.

  • Versions: v3
  • Detail: The ApplicantSigningAch and CoApplicantSigningAch default to true for both, can be set to false for one or the other.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2023/01/19
  • ETA Prod: 2023/01/29

Minor The PaymentFrequency, PaymentAmount, DayOfMonthForFirstWithdrawal, DayOfMonthForSecondWithdrawal, and MonthToWithdrawFirstPayment from the payment information will be deprecated.

  • Versions: v3
  • Detail: The specified properties will be remove from the payment information in a future release.
  • Payloads and Responses: Payloads and Responses
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2023/01/19
  • ETA Prod: 2023/01/29

Minor The Name, Address, and AccountType from the bank information will be deprecated.

  • Versions: v3
  • Detail: The Name, Address, and AccountType properties will be remove from the bank information in a future release.
  • Payloads and Responses: Payloads and Responses
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2023/01/19
  • ETA Prod: 2023/01/29

Sprint 57 (2022/10/04 - 2022/10/24) - Preliminary Information

Minor New FAQs page.

  • Versions: v3
  • Detail: Addresses commonly asked questions and issues users may encounter while consuming the API.
  • New Page: FAQs
  • ETA Stage: 2022/10/17
  • ETA Prod: 2022/10/23

Sprint 56 (2022/09/12 - 2022/10/03) - Preliminary Information

Minor Fixed validation for Additional Income amount and Gross Monthly Income.

  • Versions: v1/v2/v3
  • Detail: Additional Income amount is now limited to $1,000,000 or less. New validation added to limit total income (Gross Monthly Income + Additional Incomes) to $1,000,000 or less when submitting a loan application.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/09/20
  • ETA Prod: 2022/10/03

Minor Added an optional 'IsNonTaxableIncome' field to the Additional Incomes when submitting a loan application.

  • Versions: v1/v2/v3
  • Detail: New field 'IsNonTaxableIncome' is introduced in AdditionalIncomeSources field which accepts true/false. The field is optional and defaults to false for backward compatability. The income amount is multiplied by 1.25 for furthur processing when the value is true.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/09/23
  • ETA Prod: 2022/10/03

Sprint 55 (2022/09/7 - 2022/09/11) - Preliminary Information

Major Dealers can now upload documents.

  • Versions: v3
  • Detail: Dealers can now upload documents in a similar way to supporting document upload feature.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/09/07
  • ETA Prod: 2022/09/11

Minor Modified validation for Suffix when submitting loan application.

  • Versions: v1/v2/v3
  • Detail: Previously, the suffix takes any characters, but now it accepts only enum values and is case-sensitive.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/09/07
  • ETA Prod: 2022/09/11

Sprint 53 (2022/07/27 - 2022/08/14) - Preliminary Information

Minor Supporting document upload now will allow letters of any case for the file type.

  • Versions: v3
  • Detail: Previously, the file type characters were required to be lowercase. The file type is now case insensitive.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/08/06
  • ETA Prod: 2022/08/14

Sprint 52 (2022/07/06 - 2022/07/27) - Preliminary Information

Minor Improved validation for AssignedUserEmailAddress when submitting loan application.

  • Versions: v2/v3
  • Detail: Remove the built in email address validator. Added a custom email address validator to check for both parts username and domain.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/07/11
  • ETA Prod: 2022/07/27

Minor Modified validation for TradeInDescription when submitting loan application or paperwork.

Minor Modified validation for Dealer Name in the Signature object when submitting paperwork.

Sprint 51 (2022/06/13 - 2022/07/06) - Preliminary Information

Major Added signatures array to the application detail endpoint in which the Broker can receive paperwork signature information about a specified loan application.

  • Versions: v1/v2/v3
  • Detail: The loan application detail endpoint will retrieve all information about the specified loan application including the paperwork signatures.
  • V1 Payloads and Responses: Payloads and Responses
  • V2 Payloads and Responses: Payloads and Responses
  • V3 Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/06/27
  • ETA Prod: 2022/07/06

Minor Modified validation for Identification Issue Date when submitting loan application.

  • Versions: v1/v2/v3
  • Detail: Issue date must be after the date of birth.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/06/16
  • ETA Prod: 2022/07/06

Minor Modified validation for AssignedUserEmailAddress when submitting loan application.

  • Versions: v2/v3
  • Detail: Assigned user defaults to AFI User when Assigned User Email Address field is not sent in payload or is an empty string or is not found in the system. This will allow the application to be submitted and a super user or finance specialist to re-assign the application once the new user is created.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/06/27
  • ETA Prod: 2022/07/06

Sprint 50 (2022/05/23 - 2022/06/13) - Preliminary Information

Minor Modified the validation for HasCoApplicant when submitting application.

  • Versions: v1/v2/v3
  • Detail: CoApplicant object must be present if HasCoApplicant is true, otherwise false.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/05/30
  • ETA Prod: 2022/06/12

Sprint 49 (2022/05/02 - 2022/05/23) - Preliminary Information

Minor Added validation for AdditionalIncomeSources.Description in the AdditionalIncomeSources array when submitting loan application.

  • Versions: v1/v2/v3
  • Detail: The Description can be maximum 20 characters long.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/05/03
  • ETA Prod: 2022/05/24

Minor Applied validation for Home Value when submitting loan application.

  • Versions: v1/v2/v3
  • Detail: Home value not allowed when residence type is Rent.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/05/03
  • ETA Prod: 2022/05/24

Minor Flag to allow Applicant or CoApplicant or Both to Sign the LCC Only digital paperwork.

  • Versions: v3
  • Detail: Values default to true for both, can be set to false for one or the other.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/05/03
  • ETA Prod: 2022/05/24

Sprint 48 (2022/04/11 - 2022/05/02) - Preliminary Information

Minor Fixed bug in which the latest RTC date was not showing on the Get Status and Get Statuses Since endpoints.

  • Versions: v1/v2/v3
  • Detail: When paperwork is done and the signature date changes from the original loan application submission, the submission endpoints will now return the most recent RTC date.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/04/20
  • ETA Prod: 2022/05/01

Minor Modified validation for First Name when submitting loan application or paperwork.

Minor Modified validation for Last Name when submitting loan application or paperwork.

Minor Applied validation for Address1 when submitting loan application or paperwork.

Minor Applied validation for Address2 when submitting loan application or paperwork.

Minor Modified validation for City when submitting loan application or paperwork.

  • Versions: v1/v2/v3
  • Detail: City can only contain characters A through Z, period, hyphen, or space.
  • Payloads and Responses: Payloads and Responses
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/04/22
  • ETA Prod: 2022/05/01

Major Push Notification MVP.

  • Versions: Agnostic
  • Detail: Receive notification on Application or Signature updates.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/04/14
  • ETA Prod: 2022/05/01

Major Added an application endpoint in which the Broker can recieve detailed information about a specificed loan application.

  • Versions: v1/v2/v3
  • Detail: The loan application detail endpoint will retreive all information about the specified loan application, essentially combining the loan application submission response, the get application status repsonse, and the get application history response. This is useful to detect changes in an application when utilizing the Push Notification system.
  • V1 Payloads and Responses: Payloads and Responses
  • V2 Payloads and Responses: Payloads and Responses
  • V3 Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/04/14
  • ETA Prod: 2022/05/01

Minor Applied validation for Home Value when submitting loan application or paperwork.

Minor Modified validation for Issued State when submitting loan application or paperwork.

  • Versions: v1/v2/v3
  • Detail: Identification Issued State is not allowed for a ID type of Unavailable.
  • Payloads and Responses: Payloads and Responses
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/04/14
  • ETA Prod: 2022/05/01

Minor Modified validation for Issued Date when submitting loan application or paperwork.

  • Versions: v1/v2/v3
  • Detail: Identification Issued Date is not allowed for a ID type of Unavailable.
  • Payloads and Responses: Payloads and Responses
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/04/14
  • ETA Prod: 2022/05/01

Minor Modified validation for Expiration Date when submitting loan application or paperwork.

  • Versions: v1/v2/v3
  • Detail: Expiration Date is not allowed for a ID type of Unavailable.
  • Payloads and Responses: Payloads and Responses
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/04/14
  • ETA Prod: 2022/05/01

Sprint 47 (2022/03/21 - 2022/04/11) - Preliminary Information

Minor Modified validation for Sales Tax when submitting loan application or paperwork.

  • Versions: v1/v2/v3
  • Detail: Sales Tax amount cannot be greater than the selling price
  • Payloads and Responses: Payloads and Responses
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/03/31
  • ETA Prod: 2022/04/10

Minor Modified validation for identification number when submitting loan application or paperwork.

  • Versions: v1/v2/v3
  • Detail: Field can contain alpha, numeric, hyphen or a space. The maximum length is reduced to 20 from 50 alphanumeric combination total. When the property is empty or null and the IdentificationType is anything besides Unavailable, Broker will return a 400 Bad Response stating: "ID Number is required.”
  • Payloads and Responses: Payloads and Responses
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/04/05
  • ETA Prod: 2022/04/10

Minor Fixed bug in which the dealer's docusign email preference was not being respected.

  • Versions: v3
  • Detail: The dealer's docusign email preference will now overwrite what is sent for Signature.Dealer.EmailAddress if a prefered docusign email is present.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/03/31
  • ETA Prod: 2022/04/10

Minor Modified validation for ProductLineItems.Description when submitting paperwork.

  • Versions: v3
  • Detail: ProductLineItems.Description must contain at least one alpha character. This validation applies for every object in the ProductLineItems array.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/03/31
  • ETA Prod: 2022/04/10

Sprint 46 (2022/02/21 - 2022/03/20) - Preliminary Information

Major Added validation to check a dealers preferences and see if they are able to submit paperwork or loan applications for loan types "Closed End" or "Revolving".

Minor Fixed a bug to address Non-serialized 500 error message

  • Versions: v3
  • Detail: Added/Updated rules to validate expired applications
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/03/04
  • ETA Prod: 2022/03/20

Major Fixed a bug to address Non-serialized 500 error message

  • Versions: v3
  • Detail: Added/Updated rules and validation messages for SSN, Employment Year, Residence Type, Primary/Secondary Phone Numbers, Issue State.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/02/25
  • ETA Prod: 2022/03/20

Major Added an endpoint in which the broker actor can submit a project number for an application.

  • Versions: v3
  • Detail: The submitted string must be 30 characters or less.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/02/24
  • ETA Prod: 2022/03/20

Major Added ProjectNumber field to Application Status and Application Statuses Since responses.

  • Versions: v3
  • Detail: If a value has not been set, ProjectNumber will be null.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/02/24
  • ETA Prod: 2022/03/20

Minor Fixed a bug in which the Broker actor could not disable a user with an invalid phone number.

  • Versions: v3
  • Detail: This is only possible if the user was created with our legacy system, which did not validate phone numbers as strictly.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/02/24
  • ETA Prod: 2022/03/20

Minor Modified validation for Identification State, Issue Date, Expiration Date when submitting loan application.

  • Versions: v1/v2/v3
  • Detail: Applicant has a (state, expiration, issue) and select "Not Present" that the validation does not allow invalid combinations.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/02/25
  • ETA Prod: 2022/03/20

Minor Modified validation for completion date when submitting loan application.

  • Versions: v1/v2/v3
  • Detail: Completion Date can't be in the past.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/02/24
  • ETA Prod: 2022/03/20

Sprint 45 (2022/01/31 - 2022/02/20) - Preliminary Information

Minor Modified validation for first and last names when creating or updating user.

  • Versions: v3
  • Detail: First or last names must consist only of characters (a-z, A-Z), hyphen, or space.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/02/10
  • ETA Prod: 2022/02/20

Major Enhanced the resend paperwork endpoint to send multiple types of documents.

  • Versions: v3
  • Detail: A valid PaperworkDocumentEnum must be provided in the body of the request to denote which documents will be resent.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/02/02
  • ETA Prod: 2022/02/20

Major Added new endpoint for getting the attestation status for all of the requested user's dealers.

  • Versions: v3
  • Detail: This endpoint is only available for the requesting broker user.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/02/08
  • ETA Prod: 2022/02/20

Sprint 44 (2022/01/10 - 2022/01/31) - Preliminary Information

Major Addition of Application History endpoint.

  • Versions: v3
  • Detail: This endpoint provides a history actions, and action times for each application.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/01/17
  • ETA Prod: 2022/01/30

Minor Ability to disable the Welcome Email upon user creation.

  • Versions: v3
  • Detail: To have this feature disabled, please contact Aqua Finance's Development Team.
  • ETA Stage: 2022/01/14
  • ETA Prod: 2022/01/30

Minor Improved validation for dealer role when creating or updating a user.

Minor Application status

  • Versions: v1
  • Detail: Returns a 400 status if applicationId is invalid format.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/01/14
  • ETA Prod: 2022/01/30

Minor Improved validation for email address.

  • Versions: v1/v2/v3
  • Detail: Remove the built in email address validator. Added a custom email address validator to check for both parts username and domain.
  • Payloads and Responses: Payloads and Responses
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/01/21
  • ETA Prod: 2022/01/30

Minor Modified validation for first and last names when creating or updating user.

  • Versions: v3
  • Detail: First or last names must consist only of characters (a-z, A-Z) or a space.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2022/01/21
  • ETA Prod: 2022/01/30

Sprint 43 (2021/12/06 - 2022/01/10) - Preliminary Information

Minor Improved validation for date of birth when submitting loan application.

  • Versions: v1/v2/v3
  • Detail: Occupation Start date must be 16 years greater than Birth Date.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/12/21
  • ETA Prod: 2022/01/09

Sprint 42 (2021/11/15 - 2021/12/05) - Preliminary Information

Major Addition of Resend Documents endpoint for paperwork.

  • Versions: v3
  • Detail: The ability to resend already existing electronic paperwork documents.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/11/26
  • ETA Prod: 2021/12/05

Minor Validation to prevent performing paperwork operations on a Cancelled application.

  • Versions: v3
  • Detail: A Cancelled application will now return an error message when trying to perform paperwork.
  • Payloads and Responses: No change.
  • ETA Stage: 2021/11/26
  • ETA Prod: 2021/12/05

Minor Update to LoanApplication format.

  • Versions: v3
  • Detail: Format update to make it more readable and give better detail.

Minor Addition of RTC Date (Right to Cancel) on the application status response.

  • Versions: v3
  • Detail: Nullable Date field RTCDate.
  • Payloads and Responses: Response 1 Response 2
  • ETA Stage: 2021/11/19
  • ETA Prod: 2021/12/05

Minor Allow ExpirationDateUnavailable to be set to true when the Identification Type is 'StateID'.

  • Versions: v3
  • Detail: Allow null Date and ExpirationDateUnavailable on Identification of type 'StateID'.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/11/19
  • ETA Prod: 2021/12/05

Sprint 40 (2021/10/04 - 2021/10/24) - Preliminary Information

Minor Improved validation for city in the applicant and co-applicant addresses when submitting loan application.

  • Versions: v1/v2/v3
  • Detail: City can only contain characters A through Z, period, hyphen, or space. City can be maximum 25 characters long.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/10/13
  • ETA Prod: 2021/10/24

Minor Improved validation for city in the applicant, co-applicant, dealer, payment bank, and loan completion certificate addresses when submitting paperwork.

  • Versions: v3 only
  • Detail: City can only contain characters A through Z, period, hyphen, or space. City can be maximum 25 characters long.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/10/13
  • ETA Prod: 2021/10/24

Minor During the submission of paperwork, Canadian addresses are now allowed(For the Dealer only).

  • Versions: v3 only
  • Detail: The Dealer address can now be a Canadian address. The state must be one of the Canadian province's abbreviations and the PostalCode must be a valid Canadian postal code.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/10/13
  • ETA Prod: 2021/10/24

Hotfix (2021/07/01 - 2021/07/07) - Preliminary Information

Major Fixed a case senstive issue for the AssignedUserEmailAddress field for application submission.

  • Versions: v2/v3
  • Detail: Users can now use the AssignedUserEmailAddress field in any case. Previously the case had to match the user's email during the initial user's creation.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/07/02
  • ETA Prod: 2021/07/07

Sprint 38 (2021/05/24 - 2021/06/20) - Preliminary Information

Minor Improved validation for dealers and roles when creating or updating a user.

  • Versions: v3 only
  • Detail: The dealer or role values can not be null or empty string. There can not be any duplicate dealer ids in the list.
  • Payloads and Responses: Payloads and Responses
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/06/10
  • ETA Prod: 2021/06/20

Sprint 37 (2021/05/10 - 2021/05/23) - Preliminary Information

Minor Modifications to dealers in non-approved statuses

  • Versions: v1/v2/v3
  • Detail: Users will no longer be able to interact with dealers that are not in an Approved or Hold status.
  • Endpoints affected:
    • Get All Dealers will no longer return dealers that are not in an Approved or Hold status.
    • The following endpoints will return a 401 Unauthorized Exception instead of a successful payload when using a non-approved dealer.
      • Application Submission
      • Paperwork Submission (v3 only)
      • Get Products for Dealer
      • Validate Email For Dealer (v2/v3 only)
  • ETA Stage: 2021/05/19
  • ETA Prod: 2021/05/23

Sprint 34 (2021/03/08 - 2021/03/29) - Preliminary Information

Minor Improved validation for primary and secondary phone numbers.

  • Versions: v1/v2/v3
  • Detail: Phone number must not start with 0 or 1, and must not contain special characters. Must be valid for "^[2-9][0-9]*$.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/03/16
  • ETA Prod: 2021/03/29

Sprint 33 (2021/02/22 - 2021/03/08) - Preliminary Information

Major When submitting full paperwork the Tradeins array has be removed and replace with TradeInAmount and TradeInDescription properties. TradeInAmount must be greater than zero or null. Negative and zero values are not allowed.

  • Versions: v3 only
  • Detail: New properties TradeInAmount and TradeInDescription.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/02/24
  • ETA Prod: 2021/03/08

Minor New validation for SalesTax.

  • Versions: v3 only
  • Detail: Must be greater than zero or null. Negative or zero values are not allowed.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/02/24
  • ETA Prod: 2021/03/08

Minor New validation for middle initial.

  • Versions: v1/v2/v3
  • Detail: Must be valid for ^[a-zA-Z]*$. Maximum length is 1 character.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/02/24
  • ETA Prod: 2021/03/08

Minor New validation for Primary and secondary phone numbers.

  • Versions: v1/v2/v3
  • Detail: Primary and secondary phone numbers cannot be the same.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/03/01
  • ETA Prod: 2021/03/08

Minor New validation for Primary and secondary phone numbers.

  • Versions: v3 only
  • Detail: Primary and secondary phone numbers cannot be the same.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/03/01
  • ETA Prod: 2021/03/08

Sprint 32 (2021/02/08 - 2021/02/22) - Preliminary Information

Minor New validation for first and last name.

  • Versions: v1/v2/v3
  • Detail: Must be valid for ^[a-zA-Z\s\-]*$. Maximum length is 40 characters.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/02/17
  • ETA Prod: 2021/02/22

Minor Improved validation for first and last name.

  • Versions: v3 only
  • Detail: Max length updated from 100 to 40 characters.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/02/17
  • ETA Prod: 2021/02/22

Sprint 31 (2021/01/11 - 2021/02/08) - Preliminary Information

Minor New optional response property for endpoint.

  • Versions: v3 only
  • Detail: New optional response property for ACH signature type that indicates if dealer reviewed documents.
  • Payloads and Responses: Payloads and Responses
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2021/02/08
  • ETA Prod: 2021/02/11

Sprint 29 (2020/11/09 - 2020/11/22) - Preliminary Information

Major Endpoint to return promotion(s) based on query parameters.

  • Versions: v3 only
  • Detail: Allows end user to pull promotion(s) based on various parameters. It is good use if you want to make changes in the paperwork submission.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2020/11/09
  • ETA Prod: 2020/11/19

Sprint 28 (2020/10/12 - 2020/10/29) - Preliminary Information

Major Endpoint to return current information about an Application for Paperwork purpose

  • Versions: v3 only
  • Detail: Allows end user to pull updated customer information in order to produce accurate paperwork.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2020/10/20
  • ETA Prod: 2020/11/03

Minor Various validation enforcements for paperwork submission.

  • Versions: v3 only
  • Detail: Enhacement to the validation of paperwork submission data.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2020/10/20
  • ETA Prod: 2020/11/03

Sprint 27 (2020/09/18 - 2020/10/08) - Preliminary Information

Major Allow Broker user to download my submitted paperwork

  • Versions: v3 only
  • Detail: Allows end user to download submitted/generated paperwork from AFI systems.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2020/09/24
  • ETA Prod: 2020/10/08

Minor Allow Broker agent to retrieve status of document signings for paperwork submissions

  • Versions: v3 only
  • Detail: Allows Broker agent to retrieve document signing status for paperwork submissions through Broker. Our signing mechanism is Docusign.
  • Response
  • ETA Stage: 2020/09/24
  • ETA Prod: 2020/10/08

Major Allow Broker agent to retrieve Docusign linkage and SSO through AFI Docusign so that users can complete document signing.

  • Versions: v3 only
  • Detail: Allow Broker agent to retrieve Docusign linkage and SSO through AFI Docusign so that users can complete document signing. Document signing must go through AFI's Docusign integration and this feature update will facilitate that communication
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2020/09/24
  • ETA Prod: 2020/10/08

Major Allow Broker agent to submit paperwork on behalf of a user for an approved loan application

  • Versions: v3 only
  • Detail: Allow Broker agent to submit paperwork on behalf of a user for an approved loan application. Get/set promotion call that exists in v2/v3 is a prerequisite operation.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2020/09/24
  • ETA Prod: 2020/10/08

Major Allow Broker agent to retrieve the list of uploaded supporting documents

  • Versions: v3 only
  • Detail: Allow Broker agent to retrieve the list of uploaded supporting documents for an application.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2020/09/24
  • ETA Prod: 2020/10/08

Major Allow Broker agent to upload supporting document

  • Versions: v3 only
  • Detail: Allow Broker agent to upload supporting document for an application.
  • Payloads and Responses: Payloads and Responses
  • ETA Stage: 2020/09/24
  • ETA Prod: 2020/10/08

No Planned Changes to V1/V2

Sprint 26 (2020/08/18 - 2020/09/17)

Minor Allow Broker user to reassign applications

  • Versions: v3 only
  • Detail: Allows Broker agent to reassign applications through Broker in a similar fashion as how a privileged user can in portal today.
  • Changes to Payload: Payload
  • Changes to Response: Response
  • ETA Stage: 2020/09/08
  • ETA Prod: 2020/09/17

No Planned Changes to V1/V2

Sprint 25 (2020/08/01 - 2020/08/17)

Minor When submitting an application with an applicant that is in any status but employed, the employment fields must be null.

Exception: For self-employed, GrossMonthlyIncome must be greater than 0.

  • Versions: v1/v2/v3
  • Detail: When submitting an application with an applicant that is in any status but employed, the employment fields must be null (See Exception above). This clears up a long standing issue where if the user was unemployed, retired etc. It was still possible to submit employer information and income. To submit additional income such as Retirement/SSI or others, please provide that information in the defined AdditionalIncome payload block.
  • Changes to Payload: When submitting an employment status of SelfEmployed 
    "CurrentEmployer": null,
"CurrentEmployerPhoneNumber": null
    When submitting an employment status of Unemployed or Retired 
    "CurrentEmployer": null,
"CurrentEmployerPhoneNumber": null,
"Occupation": null,
"EmploymentMonth": null,
"EmploymentYear": null,
"GrossMonthlyIncome": null
  • Changes to Response: Added failure scenarios based around this requirement. (e.g., Employment month must be null when employment type is retired or unemployed)
  • ETA Stage: 2020/08/11
  • ETA Prod: 2020/08/16

Major Allow Broker client to Create/Read/Update/Delete Orbit user.

  • Versions: v3 only
  • Detail: This is new functionality associated with only v3 that replaces and expands upon the CSV upload process for interacting with Orbit users. Until V3 is complete, the csv functionality will still be operational.
  • Changes to Payload: Payloads
  • Changes to Response: Responses
  • ETA Stage: 2020/08/06
  • ETA Prod: 2020/08/16