Aqua Finance Broker API FAQs

This page contains frequently asked questions by consumers of the Broker API.

General

• DealerNumber and DealerID are different fields.
• ApplicationID and ApplicationNumber are not the same field.
• Specify application/json for the Content-Type in payload header.
• Are there any example request that we could use in Postman?
  • A Postman collection is available here

Dealers

• How do I retrieve a list of dealers that I have access to?
  • Send a get request to /v3/api/dealers
• What products does the requested dealer have available?
  • Send a get request to v3/api/dealers/{dealerNumber}/products
    • Substitute the dealer number for the {dealerNumber} parameter.
• Can I validate the dealer user’s email address?
  • Send a post request to /v3/api/dealers/{dealerId}/validateEmail
    • Substitute the dealer ID for the {dealerId} parameter.
• How do I get the attestation status of all the dealers that I have access to?
  • Send a get request to /v3/api/dealers/attestation
• Why are the NextAttestationDate and AttestWindowDays null for my dealer?
  • NextAttestationDate and AttestWindowDays are null when attestation is not applicable for the dealer.
• I need help with submitting dealer documents.
  • Send a post request to /v3/api/dealers/{dealerId}/dealerDocuments
    • Substitute the dealer ID for the {dealerId} parameter.

Loan Application

• How do we submit a loan application?
  • Send a post request to /v3/api/applications
• What are some common reasons loan application submissions fail?
  • Inputting wrong enumeration values:
    • IdentificationType
    • IdentificationState
    • EmploymentType
    • ResidenceType
    • Suffix
    • PrimaryPhoneType
    • ApplicantRelationship
    • AdditionalIncomeSource
    • CreditType
    • ContractState
    • ContractLanguage
    • RepaymentTerms
    • PaymentFactor
  • Overlooking required fields.
  • Submitting incorrect data type for the fields.
  • Submitting 0 for the down payment instead of null or omitting the down payment when there is no down payment.
  • Using the test account credentials when submitting real applications to production.
• I need to get the status of an application.
  • Send a get request to /v3/api/applications/status/{applicationId}
    • Substitute the application ID for the {applicationId} parameter.
• How do I change the user associated with an application?
  • Send a post request to /v3/api/applications/{applicationId}/reassign
    • Substitute the application ID for the {applicationId} parameter.
• Can we obtain the history with timeline of an application?
  • Send a get request to v3/api/applications/history/{applicationId:long}
    • Substitute the application ID for the {applicationId} parameter.
• Is there a way to group applications into a project or bucket?
  • Send a post request to /v3/api/applications/projectNumber/{applicationId:long}
    • Substitute the application ID for the {applicationId} parameter.
• I want to retrieve the application details for a loan.
  • Send a get request to /v3/api/applications/detail/{applicationId:long}

Paperwork

• How do I pull the latest application information to generate paperwork?
  • Send a get request to /v3/api/applications/paperwork/{LoanApplicationId}
    • Substitute the loan application ID for the {LoanApplicationId} parameter.
• Why doesn't my paperwork contain the latest application information?
  • Request the most recent application information from /v3/api/applications/paperwork/{LoanApplicationId} before submission.
• I need to submit paperwork for an application.
  • Send a post request to /v3/api/applications/paperwork/submit

• Common reasons why paperwork submissions fail:

  • Not calling the get promotions endpoint to get the promotion Id before generating the paperwork.
  • Failure to call /v3/api/applications/paperwork/{LoanApplicationId} to get latest application information.
    • Substitute the loan application ID for the {LoanApplicationId} parameter.
  • Not using the correct AnnualPercentageRate format (ex. 10.99)
  • Partially filling in the properties when submitting paperwork with ACH.
  • If printing or generating eSign ACH documents is not needed, then set the Payment object to null.
  • Forgetting to set TentativeCompletionDate to null when printing or generating eSign LCC documents is not required.
  • To submit full paperwork with LCC all properties must be completed and TentativeCompletionDate must be set as null.
  • Overlooking the Identification rules.

  • Failure to use the correct enumeration values:

    • Suffix
    • PrimaryPhoneType
    • IdentificationType
    • IdentificationState
    • State
    • CreditType
    • ContractState
    • ContractLanguage
    • RepaymentTerms
    • PaymentFactor
    • FeeType
    • PaymentFrequency
    • AccountType
    • ProductInstaller
    • ApplicationType
    • SignatureTypes

  • Incorrect IDs and values of a promotion.

  • Not filling in every ACH property.
• How do I download paperwork for an existing application?
• Use the DownloadURL provided in the response from the paperwork submission.
  • Send a get request to /v3/api/applications/paperwork/{applicationId}/download?documentType={PaperworkDocumentEnum}
    • Substitute the ApplicationID from the paperwork submission for the {applicationId} parameter.
    • Substitute the PaperworkDocumentEnum for the {PaperworkDocumentEnum} parameter.
• Why can’t I download paperwork?
  • Dealer, Applicant, CoApplicant and DocusignRedirectUrl properties must be set to null.
• Is there a way to get the signed status of documents?
  • Send a get request to /v3/api/applications/paperwork/{applicationId}/signed-status
    • Substitute the ApplicationID from the paperwork submission for the {applicationId} parameter.
  • The respone will return a list of paperwork submission items.
• I need to resend documents for an existing paperwork submission.
  • Send a post request to v3/api/applications/paperwork/{applicationId}/esign-resend
    • Substitute the ApplicationID from the paperwork submission for the {applicationId} parameter.

Promotions

• How do I get promotions applied to a specific loan application?
  • Send a get request to /v3/api/applications/promotions/{applicationId}
    • Substitute the ApplicationID from the loan application submission for the {applicationId} parameter.
• Can I search for promotions based off parameters?
  • Send a get request to GET /v3/api/applications/promotions?applicationId={applicationId}&amountFinanced={amountFinanced}&creditType={creditType}&stateCode={stateCode}
  • Parameter(s):
    • applicationId={applicationId}
    • amountFinanced={amountFinanced}
    • creditType={creditType}
    • stateCode={stateCode}
• I need to set promotions for a particular application.
  • Send a post request to /v3/api/applications/promotions/{applicationId}
    • Substitute the ApplicationID from the loan application submission for the {applicationId} parameter.

Supporting Document

• I need to submit some supporting documents for an application.
  • Send a post request to /v3/api/applications/{applicationId}/supportingDocuments
    • Substitute the ApplicationID from the loan application submission for the {applicationId} parameter.
• Is there a way to retrieve supporting documents for an application?
  • Send a get request to /v3/api/applications/{applicationId}/supportingDocuments
    • Substitute the ApplicationID from the loan application submission for the {applicationId} parameter.
• My supporting document upload failed.
  • Make sure the Content field of the Document object is Base64.
  • Enter a valid SupportingDocumentTypeEnum for the ViewDocumentType.

User Management

• How do I retrieve a list of users that I can manage?
  • Send a get request to /v3/api/users
• I need to get details for a particular user.
  • Send a get request to /v3/api/users/{Id}
    • Substitute the user’s ID for the {Id} parameter.
• What’s the best way to create a new Portal user?
  • Send a post request to /v3/api/users
• Why did my user create request fail?
  • Complete the Dealer object and all other required fields.
• Is there a way to update a user’s details?
  • Send a put request to /v3/api/users/{Id}
    • Substitute the user’s ID for the {Id} parameter.
• Can I use the API to delete a user?
  • Send a Delete request to /v3/api/users/{Id}
    • Substitute the user’s ID for the {Id} parameter.