Paperwork Data

Pulls the latest application information for accurate paperwork generation. Should be called before submitting paperwork.

GET /v3/api/applications/paperwork/{LoanApplicationId}

Request URL query parameters:

Property Required/Optional Type Description
applicationId Required Long Valid application Id that user has access to.

Response attributes:

Property Nullable Type Description
Dealer No Object
Applicant No Object
CoApplicant Yes Object Will be null if application has no co-applicant.
LoanParameters No Object
Signatures No List of Objects Will be [] if there is no signatures created for paperwork.
CompletionCertificate No Object

"Dealer" attributes:

Property Nullable Type Description
DealerId No Long Valid dealer id that the user has access to.
DealerNumber No String Valid dealer number that the user has access to.
DealerName No String Name of the dealer.
DealerAddress1 No String Field indicates the first address line for the dealer.
DealerAddress2 No String Field indicates the second address line for the dealer.
DealerCity No String Field indicates the city in which the dealer resides.
DealerState No DealerStateEnum Field indicates the state in which the dealer resides.
DealerZipCode No String Zip code of the dealer's address. Zip code must be 5 or 9 digits.
DealerPhoneNumber No String Phone number for the dealer.
DealerSignatureEmail Yes String Indicates the dealer's email used for signing.
DealerIncludeLcc No Boolean This is a Orbit portal field only. This is not applicable to Broker API.

"Applicant"/"CoApplicant" attributes:

Property Nullable Type Description
ApplicantId No Long Field must be a valid applicant Id.
FirstName No String First name of the applicant.
MiddleInitial No String Middle intial of the applicant.
LastName No String Last name of the applicant.
Suffix Yes ApplicantSuffixEnum Suffix of the applicant.
Address1 No String Address line 1 of the applicant's address.
Address2 Yes String Address line 2 of the applicant's address.
City No String City of the applicant's address
State No StateEnum State of the applicant's address.
PostalCode No String Zip code of the applicant's address. Zip code must be 5 or 9 digits.
EmailAddress Yes String Email address of the applicant.
PrimaryPhone Yes String Primary phone number of the applicant.
PrimaryPhoneType Yes PhoneNumberTypeEnum Phone type of the primary phone number for the applicant.
SecondaryPhone Yes String Secondary phone number of the applicant.
SecondaryPhoneType Yes PhoneNumberTypeEnum Phone type of the secondary phone number for the applicant.
RelationType Yes CoApplicantTypeEnum Field indicates the coapplicant's relation to the applicant. This is a coapplicant only field.
IdentificationType No LegalIdentificationTypeEnum Field indicates the legal identification type of the applicant's ID.
IdentificationNumber Yes String Field indicates the identification number for the applicant's ID.
IdentificationIssueDateNotPresent N/A Boolean Field indicates whether or the the issue date is present on the ID.
ExpirationDateUnavailable N/A Boolean Field indicates whether or not the expiration date is unavailable on the ID.
IdentificationIssueDate Yes Date Field indicates the issue date on the ID.
IdentificationExpirationDate Yes Date Field indicates the expiration date on the ID.
IdentificationIssueStateNotPresent N/A Boolean Field indicates whether or not the issue state is present on the ID.
IdentificationState Yes IdentificationStateEnum
SocialSecurityNumber No String Social security number of the applicant.
DateOfBirth No Date Date of the birth of the applicant.
EmploymentType No String The applicant's type of employment.
EmployerName No String Name of the applicant's employer.
EmployerPhoneNumber Yes String Phone number of the applicant's employer.
OccupationTitle No String Title of the applicant's occupation.
EmploymentStartDate Yes Date Start date of the applicant's employment.
EmploymentGrossMonthlyIncome No String Applicant's gross monthly income from employment.
OtherIncome No String When there is no other income: [].
ResidenceType No String Type of residence the applicant resides in.
ResidencePayment No String Monthly payment amount for the applicant's residence.
HomeValue No String Value of the applicant's home.
MonthsAtResidence No Integer The amount of months at residence leftover after YearsAtResidence is calculated.
YearsAtResidence No Integer The amount of years the applicant has lived at the thier residence.

"OtherIncome" attributes:

Property Nullable Type Description
SerializationVersion No Integer Aqua internal field. Please disregard.
Description Yes String Description of income.
Amount No Decimal Monthly amount of income.
IncomeType No ApplicantIncomeTypeEnum Type of income
IsNonTaxableIncome Yes Boolean Indicates whether or not the income is taxable.
OriginalAmount Yes Decimal

"LoanParameters" attributes:

Property Nullable Type Description
CreditType No CreditTypeEnum Indicates the credit type for the loan.
ContractState No StateEnum The contract state for the loan.
ContractLanguage No String The contract language for the loan.
CompletionPayment Yes Decimal The amount for the completion payment. Field is only applicable for loans with a ContractState of CA and when the dealer's major product line is home improvement.
ProductDescription Yes String Description of the product.
ItemNumber Yes String
ProductQuantity Yes String Quantity of products for the loan.
ProductPrice No String Price of the product for the loan.
AdditionalProduct Yes Object
IsProductHomeImprovement No Boolean Indicates whether or not the product is home improvement.
DownPayment Yes Decimal The down payment for the additional product.
AdditionalFees No Object When there is no additional Fees: [].
SalesTax Yes Decimal Indicates the amount of sales tax for the loan.
EnterTradeIn No Boolean Indicates whether or not there is a trade in for the loan.
TentativeCompletionDate No Date Tenative completion date of the project.
TradeInDescription Yes String Description of the trade in.
TradeInAmount Yes Decimal Indicates the trade in amount.
RepaymentTermsId Yes Long Indicates the RepaymentTermsId for the loan.
PaymentFactorId Yes Long Indicates the PaymentFactorId for the loan.
AnnualPercentageRate Yes Decimal Indicates the annual percentage rate for the loan.
PaymentFactor Yes String Indicates the payment factor for the loan.
PaymentFactorRaw Yes Decimal Indicates the payment factor for the loan.
PrimaryPromotionId Yes Long The ID of the primary promotion.
SecondaryPromotionId Yes Long The ID of the secondary promotion. Same as AddOnId value from Get Promotions
ClosedEndPaymentRateId Yes Long The ID of the closed end payment rate.
RTCDate Yes Date The right to cancel date.
OriginalCreditType Yes CreditTypeEnum The original credit type of the loan.

"AdditionalProduct" attributes:

Property Required/Optional Type Description
Description Optional String The description for the additional product.
ItemNumber Optional String The item number for the additional product.
Price Required Decimal The price of the additional product.
Quantity Required Integer The quantity of the additional product.

"AdditionalFees" attributes:

Property Nullable Type Description
AdjustmentType Yes AdjustmentTypeEnum The type of adjustment.
Amount No Decimal The amount of the additional fee.

"Signatures" attributes:

Property Nullable Type Description
SignatureDate Yes Date The date of signing for the paperwork.
ExcludeDatesOnPaperwork No Boolean Indicates whether or not the dates will be exluded on paperwork.
ApplicationType No LoanApplicationTypeEnum The type of loan.
Dealer Yes Object
Applicant Yes Object
CoApplicant Yes Object
Provider Yes Object
SignatureType No SignatureTypeEnum The type of signature for the paperwork.
PaperworkSignatureType No String Can be FULL, LCC or ACH.

"Dealer" attributes:

Property Nullable Type Description
SerializationVersion No Integer Aqua internal field. Please disregard.
Name No String Name of the dealer.
EmailAddress No String Email address for the dealer.
DateSent Yes Date The date paperwork was sent to the dealer for signing.
DateSigned Yes Date The date the paperwork was signed by the dealer.
Reviewed Yes Boolean This property is dedicated only to ACH email/electronic signature Type. It will be true if dealer reviewed documents, otherwise false. For any other type it always going to be null.

"Applicant"/"CoApplicant" attributes:

Property Nullable Type Description
SerializationVersion No Integer Aqua internal field. Please disregard.
EmailAddress No String The applicant's email for the signature.
IdentificationType No LegalIdentificationTypeEnum Identification type of the applicant.
IsUnitedStatesCitizen No Boolean Indicates whether or not the applicant is a U.S. citizen.
IsPrimaryApplicant No Boolean Indicates whether or not the signer is the Applicant or CoApplicant.
DateSent Yes Date The date the paperwork was sent to the applicant for signing.
DateSigned Yes Date The date the paperwork was signed by the applicant.

"Provider" attributes:

Property Nullable Type Description
SerializationVersion No Integer Aqua internal field. Please disregard.
Name No String Field indicates the name of the Provider.
EmailAddress No String Field indicates the email address of the Provider.
DateSent Yes Date Field indicates the date sent to the Provider.
DateSigned Yes Date Field indicates the date signed for the Provider.

"CompletionCertificate" attributes:

Property Nullable Type Description
CompletionDate No Date The date of project completion.
TentativeCompletionDate No Date If the project is not yet completed, this field indicates the projected completion date.
ProjectCompletedAtApplicantsAddress No Boolean Field indicates whether or not the project was completed at the applicant's address.
ProductInstaller No InstallerTypeEnum Field indicates the installer type.
Address Yes Object

"Address" attributes:

Property Nullable Type Description
SerializationVersion No Integer Aqua internal field. Please disregard.
Address1 No String Field indicates address line 1 of the address.
Address2 Yes String Field indicates address line 2 of the address.
City No String Field indicates the city of the address.
State No StateEnum Field indicates the state of the address.
PostalCode No String Field indicates the postal code of the address.

Example Response:


{
    "Dealer": {
        "DealerId": 15,
        "DealerNumber": "543210.000",
        "DealerName": "HOME IMPROVEMENT ORBIT TEST FILE",
        "DealerAddress1": "1 CORPORATE DRIVE STE 300",
        "DealerAddress2": "",
        "DealerCity": "WAUSAU",
        "DealerState": "WI",
        "DealerZipCode": "54401",
        "DealerPhoneNumber": "(715) 848-5423",
        "DealerSignatureEmail": null,
        "DealerIncludeLcc": false
    },
    "Applicant": {
        "Id": 78522,
        "FirstName": "TESTER",
        "MiddleInitial": "",
        "LastName": "TESTERSON",
        "Suffix": null,
        "Address1": "6500 ALDERSON STREET",
        "Address2": "",
        "City": "WESTON",
        "State": "WI",
        "ZipCode": "54476",
        "EmailAddress": "",
        "PrimaryPhoneNumber": "(520) 123-6655",
        "PrimaryPhoneType": "Cell",
        "SecondaryPhoneNumber": null,
        "SecondaryPhoneType": null,
        "RelationType": null,
        "IdentificationType": "DriversLicense",
        "IdentificationNumber": "9588888",
        "IdentificationIssueDateNotPresent": true,
        "ExpirationDateUnavailable": false,
        "IdentificationIssueDate": null,
        "IdentificationExpirationDate": "2029-09-25T05:00:00Z",
        "IdentificationIssueStateNotPresent": false,
        "IdentificationState": "KY",
        "SocialSecurityNumber": "100000102",
        "DateOfBirth": "2002-10-19T00:00:00",
        "EmploymentType": "Employed",
        "EmployerName": "HOT DIGGITY DOG",
        "EmployerPhoneNumber": "(521) 023-2222",
        "OccupationTitle": "owner",
        "EmploymentStartDate": "2010-02-19T13:08:17.88-06:00",
        "EmploymentGrossMonthlyIncome": "7500.0000",
        "OtherIncome": [],
        "ResidenceType": "Own",
        "ResidencePayment": "0.0",
        "HomeValue": "0.0",
        "MonthsAtResidence": 5,
        "YearsAtResidence": 9
    },
    "CoApplicant": null,
    "LoanParameters": {
        "CreditType": "Revolving",
        "ContractState": "WI",
        "ContractLanguage": "en-US",
        "CompletionPayment": 0.0,
        "ProductDescription": "testing",
        "ItemNumber": "",
        "ProductQuantity": "1",
        "ProductPrice": "15000.00",
        "AdditionalProduct": null,
        "IsProductHomeImprovement": true,
        "DownPayment": 0.0,
        "AdditionalFees": [],
        "SalesTax": null,
        "EnterTradeIn": true,
        "TentativeCompletionDate": "2020-10-19T00:00:00",
        "TradeInDescription": "",
        "TradeInAmount": 0.0,
        "RepaymentTermsId": null,
        "PaymentFactorId": 4,
        "AnnualPercentageRate": 13.99,
        "PaymentFactor": 4,
        "PaymentFactorRaw": 2.0,
        "PrimaryPromotionId": 1943,
        "SecondaryPromotionId": null,
        "ClosedEndPaymentRateId": null,
        "RTCDate": "2020-10-22T00:00:00",
        "OriginalCreditType": "Revolving"
    },
    "Signatures": [
        {
            "SignatureDate": "2020-10-19T00:00:00Z",
            "ExcludeDatesOnPaperwork": false,
            "ApplicationType": "Individual",
            "Dealer": {
                "SerializationVersion": 1,
                "Name": "HOME IMPROVEMENT ORBIT TEST FILE",
                "EmailAddress": "test@aquafinance.com",
                "DateSent": null,
                "DateSigned": null,
                "Reviewed": null
            },
            "Applicant": {
                "SerializationVersion": 1,
                "EmailAddress": "test@aquafinance.com",
                "IdentificationType": "DriversLicense",
                "IsUnitedStatesCitizen": true,
                "IsPrimaryApplicant": true,
                "DateSent": null,
                "DateSigned": null
            },
            "CoApplicant": null,
            "Provider": null,
            "SignatureType": "Electronic",
            "PaperworkSignatureType": "FULL"
        }
    ],
    "CompletionCertificate": {
        "CompletionDate": "2020-10-19T00:00:00",
        "TentativeCompletionDate": "2020-10-19T00:00:00",
        "ProjectCompletedAtApplicantsAddress": false,
        "ProductInstaller": "NotRequired",
        "Address": null
    }
}

Submit Full Paperwork

Submits paperwork for a loan application.

WARNING

IMPORTANT: To use the correct promotion, you MUST first call Promotions and use any promotion provided in that response payload. Since ALL provided Apr's are 0.xx something, for "AnnualPercentageRate" you need (0.xx*100), because we only accept values such as 10.99, 17.99.

POST /v3/api/applications/paperwork/submit

Request attributes:

Property Required/Optional Type Description
LoanApplicationId Required Long Must be a valid application id that the user has access to. Application must be in valid state.
Application Required Object
LoanParameters Required Object
Payment Optional Object Leave it as null if not required.
CompletionCertificate Required Object If even not required, empty Object must be present.
Signature Required Object Signature must be one of the three types: Download, e-sign and e-mail.
DocumentSelection Required Object

"Application" attributes:

Property Required/Optional Type Description
Applicant Required Object
CoApplicant Optional Object Required when an application has a co-appllicant.
Dealer Required Object

"Applicant/CoApplicant" attributes:

Property Required/Optional Type Description
FirstName Required String Must be valid for ^[a-zA-Z\s\-]*$. Maximum length is 40 characters.
MiddleInitial Optional String Must be valid for ^[a-zA-Z]*$. Maximum length is 1 characters.
LastName Required String Must be valid for ^[a-zA-Z\s\-]*$. Maximum length is 40 characters.
Suffix Optional ApplicantSuffixEnum Must be valid Enum value.
Address Required Object Address object for the applicant.
EmailAddress Optional String Must be valid e-mail address.
PrimaryPhone Optional String Must be valid for ^[2-9][0-9]*$.
PrimaryPhoneType Optional PhoneNumberTypeEnum Must have value if PrimaryPhone is present.
SecondaryPhone Optional String Must be valid for ^[2-9][0-9]*$. Cannot be the same as Primary phone number.
SecondaryPhoneType Optional String Must have value if SecondaryPhone is present.
IdentificationType No Required LegalIdentificationTypeEnum
IdentificationNumber Yes Required String
IsIssueDatePresent N/A Required Boolean
IdentificationIssueDate Yes Optional Date
IsIssueStatePresent N/A Required Boolean
IdentificationState Yes Optional IdentificationStateEnum
ExpirationDateUnavailable N/A Required Boolean
IdentificationExpirationDate Yes Optional Date

"Dealer" attributes:

Property Required/Optional Type Description
Name Required String Maximum length is 150 characters.
Address Required Object Address object for the dealer.
PhoneNumber Optional String Must be valid for ^[2-9][0-9]*$.

"Address" attributes:

Property Required/Optional Type Description
Address1 Required String Cannot be empty value.
Address2 Optional String This field indicates address line 2 for the address.
City Required String Cannot be empty value.
State Required DealerStateEnum Must be valid Enum value.
PostalCode Required String Must be valid for ^[0-9]{5}$ or ^[0-9]{5}-[0-9]{4}$.

"LoanParameters" attributes:

NOTE

Must have correct ids and values for promotion, otherwise Broker will throw a 400 Bad Request Exception. Check out the warning above on how to fill in the correct values.

Property Required/Optional Type Description
CreditType Required CreditTypeEnum Must have valid Enum value.
ContractState Required StateEnum Must have valid Enum value.
ContractLanguage Required LanguageTypeEnum Must have valid Enum value.
ProductLineItems Required List of Objects One item for Closed-End. One or two items for Revolving.
DownPayment Required Decimal Not negative number. Must be less than 100M. Max two numbers after decimal point.
CompletionPayment Optional Decimal Required when contract state is CA. Not allowed for states other than CA. Not negative number. Must be less than 100M. Max two numbers after decimal point.
Fees Required List of Objects When there are no Fees, send an empty List [].
SalesTax Optional Decimal Not negative number or zero. Must be less than 100M. Max two numbers after decimal point.
TradeInAmount Optional Decimal Not negative number or zero. Must be less than 100M. Max two numbers after decimal point.
TradeInDescription Optional String Maximum length is 11 characters.
RepaymentTerms Required CreditPaymentTermEnum Only for Closed-end. Must have valid Enum value.
PaymentFactor Optional CreditPaymentFactorEnum Only for Revolving. Must have valid Enum value.
AnnualPercentageRate Required Decimal Must be equal to or greater than 0.
PrimaryPromotionId Required Long Must be greater than 0.
SecondaryPromotionId Optional Long Must be greater than 0 when has value.
ClosedEndPaymentRateId Optional Long Only for Closed-end. Must be greater than 0.
AmountFinanced Required Decimal Must be same as calculated value. Must be greater than 0and should fall within the range of 1,000 to 100,000. Max two numbers after decimal point.

"ProductLineItems" attributes:

Property Required/Optional Type Description
Id Optional Long Unique identifier for the product.
Description Required String Cannot be empty. Maximum length is 52 characters.
ItemNumber Optional String Maximum length is 150 characters.
Quantity Required Integer Must be greater than 0 and less than or equal to 1000.
Price Required Decimal Must be greater than 0 and less than 100M. Max two numbers after decimal point.

"Fees" attributes:

Property Required/Optional Type Description
FeeType Required AdjustmentTypeEnum Can only be Document, PublicOfficials, NonFilingInsurancePremium and ToOthers.
FeeAmount Required Decimal Not negative number. Must be less than 100M. Max two numbers after decimal point.

"Payment" attributes:

NOTE

If you don't want to print or generate eSign ACH documents then set the Payment object to null. In order to submit full paperwork with ACH you must fill in every property.

Property Required/Optional Type Description
PaymentFrequency Required PaymentFrequencyEnum Must be valid Enum value.
PaymentAmount Optional Decimal Not negative number. Must be less than 100M. Max two numbers after decimal point.
DayOfMonthForFirstWithdrawal Optional Integer Not negative number. 0 Is considered empty value. Max value is 31.
DayOfMonthForSecondWithdrawal Optional Integer Must be null for PaymentFrequency: OnceMonthly. For TwiceMonthly applies same rules as DayOfMonthForFirstWithdrawal.
MonthToWithdrawFirstPayment Optional Integer Not negative number. 0 Is considered empty value. Max value is 12.
BankInformation Required Object

"BankInformation" attributes:

Property Required/Optional Type Description
Name Optional String When has value maximum length is 150.
Address Optional Object All properties of Address are nullable. State must be valid StateEnum and PostalCode should match one of the following regex strings: ^[0-9]{5}$ or ^[0-9]{5}-[0-9]{4}$
RoutingNumber Required String Cannot be empty. Length is 9. Must be valid for regex: ^[0-9]+$.
AccountType Optional PaymentAccountTypeEnum
AccountNumber Required String Cannot be empty. Maximum length is 17. Must be valid for regex: ^[0-9]+$.

"CompletionCertificate" attributes:

NOTE

If you don't want to print or generate eSign LCC documents then have just one property filled TentativeCompletionDate or just leave all properties as null. In order to submit full paperwork with LCC you must fill in every property and leave TentativeCompletionDate as null.

Property Required/Optional Type Description
CompletionDate Optional Date Must be valid date. Date shouldn't be older than 50 years and greater than 3 years from today's date.
TentativeCompletionDate Optional Date Must be valid date. Date can be same as the one in application creation or today's and in the future. But not greater than 50 years from today's date.
ProductInstalledAtApplicantsAddress Optional Boolean
ProductInstaller Optional InstallerTypeEnum Must be valid Enum value.
Address Optional Object

"Address" attributes:

Property Required/Optional Type Description
Address1 Required String Cannot be empty value.
Address2 Optional String This field indicates address line 2 for the address.
City Required String Cannot be empty value.
State Required StateEnum Must be valid Enum value.
PostalCode Required String Must be valid for ^[0-9]{5}$ or ^[0-9]{5}-[0-9]{4}$.

"Signature" attributes:

NOTE

Dealer, Applicant, CoApplicant and DocusignRedirectUrl are only for esign/email. For download those properties must be null.

Property Required/Optional Type Description
SignatureTypes Required List of SignatureTypeEnum For download - only ["Written"]. For e-sign: ["Written", "Electronic"]. For e-mail: ["Written","Email"].
SignatureDate Optional Date Must be valid date. Cannot be greater than 50 years from today's date. Can be date from last paperwork submission or today and in the future.
ExcludeDatesOnPaperwork Required Boolean Field indicates whether or not to exlude dates on paperwork.
ApplicationType Required LoanApplicationTypeEnum For applications with no co-applicant, only Individual is allowed. For applications with co-applicant, only JointWithSpouse and JointWithNonSpouse are allowed.
Dealer Optional Object Has two properties. Name: which should be not empty and max length is 100. EmailAddress: not empty, valid email with max length of 100.
Applicant Optional Object Has three properties. EmailAddress: not empty, valid email with max length of 100. IsUnitedStatesCitizen: boolean. IdentificationType: LegalIdentificationTypeEnum
CoApplicant Optional Object Applies only when application has co-applicant. Has three properties. EmailAddress: not empty, valid email with max length of 100. IsUnitedStatesCitizen: boolean. IdentificationType: LegalIdentificationTypeEnum
DocusignRedirectUrl Optional String Must be valid URL only for e-sign option, otherwise null.

"DocumentSelection" attributes:

Property Required/Optional Type Description
ContractState Required StateEnum Must be valid Enum value.
ContractLanguage Required LanguageTypeEnum Must be valid Enum value.
DownloadHardCopies Required Boolean Can be true only for Download option, otherwise should be false.

Identification Rules:

IdentificationType IdentificationNumber IsIssueDatePresent IssueDate IsIssueStatePresent IssueState IdentificationExpirationDate ExpirationDateUnavailable
Unavailable Field should be null or not sent for Unavailable. Field should be null or not sent for Unavailable. Field should be null or not sent for Unavailable. Field should be null or not sent for Unavailable. Field should be null or not sent for Unavailable. Field should be null or not sent for Unavailable. Field should be null or not sent for Unavailable.
DriversLicense Field does not accept special characters and allows a max of 20 characters Field indicates whether the IssueDate is present on the applicant's ID. If true, IssueDate is required. IssueDate cannot be in the future. Field is required if IsIssueDatePresent is true, otherwise IssueDate must be null. Field indicates whether the IssueState is present on the applicant's ID. If true, IssueState is required. Field is required if IsIssueStatePresent is true, therfore it must be false. Field indicates the expiration date for the DriversLicense. Field is required. Field is not applicable for DriversLicense.
StateId Field does not accept special characters and allows a max of 20 characters Field indicates whether the IssueDate is present on the applicant's ID. If true, IssueDate is required. IssueDate cannot be in the future. Field is required if IsIssueDatePresent is true. Field indicates whether the IssueState is present on the applicant's ID. If true, IssueState is required. Field is required to be true for StateID Field indicates the expiration date for the StateID. Field can be null if ExpirationDateUnavailable is true. Field indicates whether or not the Expiration Date is available on the StateID.
UnitedStatesMilitaryId Field does not accept special characters and allows a max of 20 characters Field indicates whether the IssueDate is present on the applicant's ID. If true, IssueDate is required. IssueDate cannot be in the future. Field is required if IsIssueDatePresent is true. Field should be null or not sent for UnitedStatesMilitaryId. Field should be null or not sent for UnitedStatesMilitaryId. Field indicates the expiration date for the UnitedStatesMilitaryId. Field can be null if ExpirationDateUnavailable is true. Field indicates whether or not the Expiration Date is available on the UnitedStatesMilitaryId.
UnitedStatesPassport Field does not accept special characters and allows a max of 20 characters Field indicates whether the IssueDate is present on the applicant's ID. If true, IssueDate is required. IssueDate cannot be in the future. Field is required if IsIssueDatePresent is true. Field should be null or not sent for UnitedStatesPassport. Field should be null or not sent for UnitedStatesPassport. Field indicates the expiration date for the UnitedStatesPassport. Field is required to be false for UnitedStatesPassport.
PermanentResidencyCard Field does not accept special characters and allows a max of 20 characters IsIssueDatePresent is required to be true for PermanentResidencyCard IssueDate cannot be in the future. Field is required. Field should be null or not sent for PermanentResidencyCard. Field should be null or not sent for PermanentResidencyCard. Field indicates the expiration date for the PermanentResidencyCard. Field is required. Field is required to be false for PermanentResidencyCard.

Revolving request example for Download:


{
    "LoanApplicationId": 12345,
    "Application": {
        "Applicant": {
            "FirstName": "Test",
            "MiddleInitial": "",
            "LastName": "Tester",
            "Suffix": null,
            "Address": {
                "Address1": "3433 Broadway St NE",
                "Address2": "",
                "City": "Minneapolis",
                "State": "MN",
                "PostalCode": "55555"
            },
            "EmailAddress": "test@test.com",
            "PrimaryPhone": null,
            "PrimaryPhoneType": null,
            "SecondaryPhone": null,
            "SecondaryPhoneType": null,
            "IdentificationExpirationDate": "2022-01-01T00:00:00Z",
            "IdentificationIssuedDate": "2019-01-01T00:00:00Z",
            "IdentificationIssueState": "AL",
            "IdentificationNumber": "T23532525",
            "IdentificationType": "DriversLicense",
            "IsIssueDatePresent": true,
            "IsIssueStatePresent": true,
            "ExpirationDateUnavailable": null
        },
        "CoApplicant": null,
        "Dealer": {
            "Name": "Test Dealer",
            "Address": {
                "Address1": "801 I 45 SOUTH",
                "Address2": "",
                "City": "CONROE",
                "State": "TX",
                "PostalCode": "55555"
            },
            "PhoneNumber": "9999999999"
        }
    },
    "LoanParameters": {
        "AmountFinanced": 5750.15,
        "CreditType": "Revolving",
        "ContractState": "DE",
        "ContractLanguage": "English",
        "ProductLineItems": [{
                "Id": null,
                "Description": "Test",
                "ItemNumber": "",
                "Quantity": 1,
                "Price": 5000
            }, {
                "Id": null,
                "Description": "test2",
                "ItemNumber": "",
                "Quantity": 1,
                "Price": 1000
            }
        ],
        "DownPayment": 150.05,
        "CompletionPayment": null,
        "Fees": [],
        "SalesTax": 50.2,
        "TradeInAmount": null,
        "TradeInDescription": "",
        "PaymentFactor": "Two",
        "AnnualPercentageRate": 17.99,
        "PrimaryPromotionId": 2015,
        "SecondaryPromotionId": 1901,
        "ClosedEndPaymentRateId": 0,
        "RepaymentTerms": null
    },
    "CompletionCertificate": {
        "TentativeCompletionDate": "06/05/2020",
        "CompletionDate": null,
        "ProductInstalledAtApplicantsAddress": null,
        "ProductInstaller": null,
        "Address": null
    },
    "Payment": null,
    "Signature": {
        "SignatureTypes": [
            "Written"
        ],
        "SignatureDate": "01/17/2020",
        "ExcludeDatesOnPaperwork": false,
        "ApplicationType": "Individual",
        "Dealer": null,
        "Applicant": null,
        "CoApplicant": null,
        "DocusignRedirectUrl": null
    },
    "DocumentSelection": {
        "ContractState": "DE",
        "ContractLanguage": "English",
        "DownloadHardCopies": true
    }
}

Closed-End request example for Download:


{
    "LoanApplicationId": 12345,
    "Application": {
        "Applicant": {
            "FirstName": "Test",
            "MiddleInitial": "",
            "LastName": "Tester",
            "Suffix": null,
            "Address": {
                "Address1": "3433 Broadway St NE",
                "Address2": "",
                "City": "Minneapolis",
                "State": "MN",
                "PostalCode": "55555"
            },
            "EmailAddress": "test@test.com",
            "PrimaryPhone": null,
            "PrimaryPhoneType": null,
            "SecondaryPhone": null,
            "SecondaryPhoneType": null,
            "IdentificationExpirationDate": "2022-01-01T00:00:00Z",
            "IdentificationIssuedDate": "2019-01-01T00:00:00Z",
            "IdentificationIssueState": "AL",
            "IdentificationNumber": "T23532525",
            "IdentificationType": "DriversLicense",
            "IsIssueDatePresent": true,
            "IsIssueStatePresent": true,
            "ExpirationDateUnavailable": null
        },
        "CoApplicant": null,
        "Dealer": {
            "Name": "Test Dealer",
            "Address": {
                "Address1": "801 I 45 SOUTH",
                "Address2": "",
                "City": "CONROE",
                "State": "TX",
                "PostalCode": "55555"
            },
            "PhoneNumber": "9999999999"
        }
    },
    "LoanParameters": {
        "AmountFinanced": 5750.2,
        "CreditType": "ClosedEnd",
        "ContractState": "DE",
        "ContractLanguage": "English",
        "ProductLineItems": [{
            "Id": null,
            "Description": "test",
            "ItemNumber": "",
            "Quantity": 1,
            "Price": 5000.45
            }
        ],
        "DownPayment": 100.25,
        "CompletionPayment": null,
        "Fees": [{
                "FeeType": "PublicOfficials",
                "FeeAmount": 200
            }, {
                "FeeType": "NonFilingInsurancePremium",
                "FeeAmount": 150
            }
        ],
        "SalesTax": 500,
        "TradeInAmount": null,
        "TradeInDescription": "",
        "PaymentFactor": null,
        "AnnualPercentageRate": 17.99,
        "PrimaryPromotionId": 2029,
        "SecondaryPromotionId": null,
        "ClosedEndPaymentRateId": 5748,
        "RepaymentTerms": "FortyEightMonths"
    },
    "CompletionCertificate": {
        "TentativeCompletionDate": "06/05/2020",
        "CompletionDate": null,
        "ProductInstalledAtApplicantsAddress": null,
        "ProductInstaller": null,
        "Address": null
    },
    "Payment": null,
    "Signature": {
        "SignatureTypes": [
            "Written"
        ],
        "SignatureDate": "01/17/2020",
        "ExcludeDatesOnPaperwork": false,
        "ApplicationType": "Individual",
        "Dealer": null,
        "Applicant": null,
        "CoApplicant": null,
        "DocusignRedirectUrl": null
    },
    "DocumentSelection": {
        "ContractState": "DE",
        "ContractLanguage": "English",
        "DownloadHardCopies": true
    }
}

Submits paperwork for Download with ACH:


{
    "LoanApplicationId": 12345,
    "Application": {
        "Applicant": {
            "FirstName": "Test",
            "MiddleInitial": "",
            "LastName": "Tester",
            "Suffix": null,
            "Address": {
                "Address1": "3433 Broadway St NE",
                "Address2": "",
                "City": "Minneapolis",
                "State": "MN",
                "PostalCode": "55555"
            },
            "EmailAddress": "test@test.com",
            "PrimaryPhone": null,
            "PrimaryPhoneType": null,
            "SecondaryPhone": null,
            "SecondaryPhoneType": null,
            "IdentificationExpirationDate": "2022-01-01T00:00:00Z",
            "IdentificationIssuedDate": "2019-01-01T00:00:00Z",
            "IdentificationIssueState": "AL",
            "IdentificationNumber": "T23532525",
            "IdentificationType": "DriversLicense",
            "IsIssueDatePresent": true,
            "IsIssueStatePresent": true,
            "ExpirationDateUnavailable": null
        },
        "CoApplicant": null,
        "Dealer": {
            "Name": "Test Dealer",
            "Address": {
                "Address1": "801 I 45 SOUTH",
                "Address2": "",
                "City": "CONROE",
                "State": "TX",
                "PostalCode": "55555"
            },
            "PhoneNumber": "9999999999"
        }
    },
    "LoanParameters": {
        "AmountFinanced": 5750.15,
        "CreditType": "Revolving",
        "ContractState": "DE",
        "ContractLanguage": "English",
        "ProductLineItems": [{
                "Id": null,
                "Description": "Test",
                "ItemNumber": "",
                "Quantity": 1,
                "Price": 5000
            }, {
                "Id": null,
                "Description": "test2",
                "ItemNumber": "",
                "Quantity": 1,
                "Price": 1000
            }
        ],
        "DownPayment": 150.05,
        "CompletionPayment": null,
        "Fees": [],
        "SalesTax": 50.2,
        "TradeInAmount": null,
        "TradeInDescription": "",
        "PaymentFactor": "Two",
        "AnnualPercentageRate": 17.99,
        "PrimaryPromotionId": 2015,
        "SecondaryPromotionId": 1901,
        "ClosedEndPaymentRateId": 0,
        "RepaymentTerms": null
    },
    "CompletionCertificate": {
        "TentativeCompletionDate": "06/05/2020",
        "CompletionDate": null,
        "ProductInstalledAtApplicantsAddress": null,
        "ProductInstaller": null,
        "Address": null
    },
    "Payment":{
      "PaymentFrequency":"OnceMonthly",
      "PaymentAmount":50,
      "DayOfMonthForFirstWithdrawal":1,
      "DayOfMonthForSecondWithdrawal":null,
      "MonthToWithdrawFirstPayment":1,
      "BankInformation":{
         "Name":"Fake Bank",
         "Address":{
            "Address1":"123 Fake St.",
            "Address2":"",
            "City":"Saint Paul",
            "State":"MN",
            "PostalCode":"55117"
         },
         "RoutingNumber":"900000001",
         "AccountType":"Checking",
         "AccountNumber":"12345678"
      }
   },
    "Signature": {
        "SignatureTypes": [
            "Written"
        ],
        "SignatureDate": "01/17/2020",
        "ExcludeDatesOnPaperwork": false,
        "ApplicationType": "Individual",
        "Dealer": null,
        "Applicant": null,
        "CoApplicant": null,
        "DocusignRedirectUrl": null
    },
    "DocumentSelection": {
        "ContractState": "DE",
        "ContractLanguage": "English",
        "DownloadHardCopies": true
    }
}

Submits paperwork for Download with LCC:


{
    "LoanApplicationId": 12345,
    "Application": {
        "Applicant": {
            "FirstName": "Test",
            "MiddleInitial": "",
            "LastName": "Tester",
            "Suffix": null,
            "Address": {
                "Address1": "3433 Broadway St NE",
                "Address2": "",
                "City": "Minneapolis",
                "State": "MN",
                "PostalCode": "55555"
            },
            "EmailAddress": "test@test.com",
            "PrimaryPhone": null,
            "PrimaryPhoneType": null,
            "SecondaryPhone": null,
            "SecondaryPhoneType": null,
            "IdentificationExpirationDate": "2022-01-01T00:00:00Z",
            "IdentificationIssuedDate": "2019-01-01T00:00:00Z",
            "IdentificationIssueState": "AL",
            "IdentificationNumber": "T23532525",
            "IdentificationType": "DriversLicense",
            "IsIssueDatePresent": true,
            "IsIssueStatePresent": true,
            "ExpirationDateUnavailable": null
        },
        "CoApplicant": null,
        "Dealer": {
            "Name": "Test Dealer",
            "Address": {
                "Address1": "801 I 45 SOUTH",
                "Address2": "",
                "City": "CONROE",
                "State": "TX",
                "PostalCode": "55555"
            },
            "PhoneNumber": "9999999999"
        }
    },
    "LoanParameters": {
        "AmountFinanced": 5750.15,
        "CreditType": "Revolving",
        "ContractState": "DE",
        "ContractLanguage": "English",
        "ProductLineItems": [{
                "Id": null,
                "Description": "Test",
                "ItemNumber": "",
                "Quantity": 1,
                "Price": 5000
            }, {
                "Id": null,
                "Description": "test2",
                "ItemNumber": "",
                "Quantity": 1,
                "Price": 1000
            }
        ],
        "DownPayment": 150.05,
        "CompletionPayment": null,
        "Fees": [],
        "SalesTax": 50.2,
        "TradeInAmount": null,
        "TradeInDescription": "",
        "PaymentFactor": "Two",
        "AnnualPercentageRate": 17.99,
        "PrimaryPromotionId": 2015,
        "SecondaryPromotionId": 1901,
        "ClosedEndPaymentRateId": 0,
        "RepaymentTerms": null
    },
    "CompletionCertificate":{
      "CompletionDate":"09/26/2020",
      "ProductInstalledAtApplicantsAddress":true,
      "ProductInstaller":"Seller",
      "Address":{
         "Address1":"3433 BROADWAY STREET NORTHEAST",
         "Address2":"",
         "City":"MINNEAPOLIS",
         "State":"MN",
         "PostalCode":"55413"
      }
   },
    "Payment":null,
    "Signature": {
        "SignatureTypes": [
            "Written"
        ],
        "SignatureDate": "01/17/2020",
        "ExcludeDatesOnPaperwork": false,
        "ApplicationType": "Individual",
        "Dealer": null,
        "Applicant": null,
        "CoApplicant": null,
        "DocusignRedirectUrl": null
    },
    "DocumentSelection": {
        "ContractState": "DE",
        "ContractLanguage": "English",
        "DownloadHardCopies": true
    }
}

Response attributes from download option:

Property Nullable Type Description
DownloadUrl Yes String Returns URL that you must use to download generated documents
ESignUrl Yes String Returns null.

Example response:


{
  "DownloadUrl": "/api/applications/paperwork/{applicationId}/download?documentType=HardCopies",
  "ESignUrl": null
}

Submits paperwork for DocuSign eSigning.

Example request:


{
   "LoanApplicationId":12345,
   "Application":{
      "Applicant":{
         "FirstName":"BROKER",
         "MiddleInitial":"",
         "LastName":"TEST",
         "Suffix":"",
         "Address":{
            "Address1":"3433 BROADWAY STREET NORTHEAST",
            "Address2":"",
            "City":"MINNEAPOLIS",
            "State":"MN",
            "PostalCode":"55413"
         },
         "EmailAddress":"",
         "PrimaryPhone":"6511234567",
         "PrimaryPhoneType":"Cell",
         "SecondaryPhoneType":null,
         "IdentificationExpirationDate":"2022-01-01T06:00:00Z",
         "IdentificationIssuedDate":"2019-01-01T06:00:00Z",
         "IdentificationIssueState":"MN",
         "IdentificationNumber":"T23532525",
         "IdentificationType":"DriversLicense",
         "IsIssueDatePresent":true,
         "IsIssueStatePresent":true,
         "ExpirationDateUnavailable":false
      },
      "CoApplicant":null,
      "Dealer":{
         "Name":"WATER TEST FILE",
         "Address":{
            "Address1":"111 ROAD-STREET",
            "Address2":"",
            "City":"ROME",
            "State":"WY",
            "PostalCode":"77456"
         },
         "PhoneNumber":"8002343663"
      }
   },
   "LoanParameters":{
      "AmountFinanced":5000,
      "CreditType":"Revolving",
      "ContractState":"MN",
      "ContractLanguage":"English",
      "ProductLineItems":[
         {
            "Id":null,
            "Description":"Test",
            "ItemNumber":"",
            "Quantity":1,
            "Price":5000
         }
      ],
      "DownPayment":0,
      "CompletionPayment":null,
      "Fees":[

      ],
      "SalesTax":null,
      "TradeInAmount": null,
      "TradeInDescription": "",
      "PaymentFactor":"OnePointZero",
      "AnnualPercentageRate":5.9,
      "PrimaryPromotionId":2233,
      "SecondaryPromotionId":null,
      "ClosedEndPaymentRateId":0,
      "RepaymentTerms":null
   },
   "CompletionCertificate":{
        "TentativeCompletionDate": "06/05/2020",
        "CompletionDate": null,
        "ProductInstalledAtApplicantsAddress": null,
        "ProductInstaller": null,
        "Address": null
   },
   "Payment":null,
   "Signature":{
      "SignatureTypes":[
         "Written",
         "Electronic"
      ],
      "SignatureDate":"10/06/2020",
      "ExcludeDatesOnPaperwork":false,
      "ApplicationType":"Individual",
      "Dealer":{
         "Name":"Water Dealer",
         "EmailAddress":"water@hotmail.com"
      },
      "Applicant":{
         "EmailAddress":"test@hotmail.com",
         "IdentificationType":"DriversLicense",
         "IsUnitedStatesCitizen":true
      },
      "CoApplicant": null,
      "DocusignRedirectUrl": "https://www.redirect-url.com"
   },
   "DocumentSelection":{
      "ContractState":"MN",
      "ContractLanguage":"English",
      "DownloadHardCopies":false
   }
}

Submits paperwork for DocuSign eSigning with ACH.

Example request:


{
   "LoanApplicationId":12345,
   "Application":{
      "Applicant":{
         "FirstName":"BROKER",
         "MiddleInitial":"",
         "LastName":"TEST",
         "Suffix":"",
         "Address":{
            "Address1":"3433 BROADWAY STREET NORTHEAST",
            "Address2":"",
            "City":"MINNEAPOLIS",
            "State":"MN",
            "PostalCode":"55413"
         },
         "EmailAddress":"",
         "PrimaryPhone":"6511234567",
         "PrimaryPhoneType":"Cell",
         "SecondaryPhoneType":null,
         "IdentificationExpirationDate":"2022-01-01T06:00:00Z",
         "IdentificationIssuedDate":"2019-01-01T06:00:00Z",
         "IdentificationIssueState":"MN",
         "IdentificationNumber":"T23532525",
         "IdentificationType":"DriversLicense",
         "IsIssueDatePresent":true,
         "IsIssueStatePresent":true,
         "ExpirationDateUnavailable":false
      },
      "CoApplicant":null,
      "Dealer":{
         "Name":"WATER TEST FILE",
         "Address":{
            "Address1":"111 ROAD-STREET",
            "Address2":"",
            "City":"ROME",
            "State":"WY",
            "PostalCode":"77456"
         },
         "PhoneNumber":"8002343663"
      }
   },
   "LoanParameters":{
      "AmountFinanced":5000,
      "CreditType":"Revolving",
      "ContractState":"MN",
      "ContractLanguage":"English",
      "ProductLineItems":[
         {
            "Id":null,
            "Description":"Test",
            "ItemNumber":"",
            "Quantity":1,
            "Price":5000
         }
      ],
      "DownPayment":0,
      "CompletionPayment":null,
      "Fees":[

      ],
      "SalesTax":null,
      "TradeInAmount": null,
      "TradeInDescription": "",
      "PaymentFactor":"OnePointZero",
      "AnnualPercentageRate":5.9,
      "PrimaryPromotionId":2233,
      "SecondaryPromotionId":null,
      "ClosedEndPaymentRateId":0,
      "RepaymentTerms":null
   },
   "CompletionCertificate":{
        "TentativeCompletionDate": "06/05/2020",
        "CompletionDate": null,
        "ProductInstalledAtApplicantsAddress": null,
        "ProductInstaller": null,
        "Address": null
   },
   "Payment":{
      "PaymentFrequency":"OnceMonthly",
      "PaymentAmount":50,
      "DayOfMonthForFirstWithdrawal":1,
      "DayOfMonthForSecondWithdrawal":null,
      "MonthToWithdrawFirstPayment":1,
      "BankInformation":{
         "Name":"Fake Bank",
         "Address":{
            "Address1":"123 Fake St.",
            "Address2":"",
            "City":"Saint Paul",
            "State":"MN",
            "PostalCode":"55117"
         },
         "RoutingNumber":"900000001",
         "AccountType":"Checking",
         "AccountNumber":"12345678"
      }
   },
   "Signature":{
      "SignatureTypes":[
         "Written",
         "Electronic"
      ],
      "SignatureDate":"10/06/2020",
      "ExcludeDatesOnPaperwork":false,
      "ApplicationType":"Individual",
      "Dealer":{
         "Name":"Water Dealer",
         "EmailAddress":"water@hotmail.com"
      },
      "Applicant":{
         "EmailAddress":"test@hotmail.com",
         "IdentificationType":"DriversLicense",
         "IsUnitedStatesCitizen":true
      },
      "CoApplicant": null,
      "DocusignRedirectUrl": "https://www.redirect-url.com"
   },
   "DocumentSelection":{
      "ContractState":"MN",
      "ContractLanguage":"English",
      "DownloadHardCopies":false
   }
}

Submits paperwork for DocuSign eSigning with LCC.

Example request:


{
   "LoanApplicationId":12345,
   "Application":{
      "Applicant":{
         "FirstName":"BROKER",
         "MiddleInitial":"",
         "LastName":"TEST",
         "Suffix":"",
         "Address":{
            "Address1":"3433 BROADWAY STREET NORTHEAST",
            "Address2":"",
            "City":"MINNEAPOLIS",
            "State":"MN",
            "PostalCode":"55413"
         },
         "EmailAddress":"",
         "PrimaryPhone":"6511234567",
         "PrimaryPhoneType":"Cell",
         "SecondaryPhoneType":null,
         "IdentificationExpirationDate":"2022-01-01T06:00:00Z",
         "IdentificationIssuedDate":"2019-01-01T06:00:00Z",
         "IdentificationIssueState":"MN",
         "IdentificationNumber":"T23532525",
         "IdentificationType":"DriversLicense",
         "IsIssueDatePresent":true,
         "IsIssueStatePresent":true,
         "ExpirationDateUnavailable":false
      },
      "CoApplicant":null,
      "Dealer":{
         "Name":"WATER TEST FILE",
         "Address":{
            "Address1":"111 ROAD-STREET",
            "Address2":"",
            "City":"ROME",
            "State":"WY",
            "PostalCode":"77456"
         },
         "PhoneNumber":"8002343663"
      }
   },
   "LoanParameters":{
      "AmountFinanced":5000,
      "CreditType":"Revolving",
      "ContractState":"MN",
      "ContractLanguage":"English",
      "ProductLineItems":[
         {
            "Id":null,
            "Description":"Test",
            "ItemNumber":"",
            "Quantity":1,
            "Price":5000
         }
      ],
      "DownPayment":0,
      "CompletionPayment":null,
      "Fees":[

      ],
      "SalesTax":null,
      "TradeInAmount": null,
      "TradeInDescription": "",
      "PaymentFactor":"OnePointZero",
      "AnnualPercentageRate":5.9,
      "PrimaryPromotionId":2233,
      "SecondaryPromotionId":null,
      "ClosedEndPaymentRateId":0,
      "RepaymentTerms":null
   },
   "CompletionCertificate":{
      "CompletionDate":"09/26/2020",
      "ProductInstalledAtApplicantsAddress":true,
      "ProductInstaller":"Seller",
      "Address":{
         "Address1":"3433 BROADWAY STREET NORTHEAST",
         "Address2":"",
         "City":"MINNEAPOLIS",
         "State":"MN",
         "PostalCode":"55413"
      }
   },
   "Payment":null,
   "Signature":{
      "SignatureTypes":[
         "Written",
         "Electronic"
      ],
      "SignatureDate":"10/06/2020",
      "ExcludeDatesOnPaperwork":false,
      "ApplicationType":"Individual",
      "Dealer":{
         "Name":"Water Dealer",
         "EmailAddress":"water@hotmail.com"
      },
      "Applicant":{
         "EmailAddress":"test@hotmail.com",
         "IdentificationType":"DriversLicense",
         "IsUnitedStatesCitizen":true
      },
      "CoApplicant": null,
      "DocusignRedirectUrl": "https://www.redirect-url.com"
   },
   "DocumentSelection":{
      "ContractState":"MN",
      "ContractLanguage":"English",
      "DownloadHardCopies":false
   }
}

Response attributes from esign option:

Property Nullable Type Description
DownloadUrl Yes String Returns null.
ESignUrl Yes String Returns URL for esigning.

Example response:


{
    "DownloadUrl": null,
    "ESignUrl": "https://demo.docusign.net/Signing/MTRedeem/v1/6c61406d-40a4-49b5-b560-e9e9c26303a5?slt=eyJ0eXAiOiJNVCIsImFsZyI6IlJTMjU2Iiwia2lkIjoiNjgxODVmZjEtNGU1MS00Y2U5LWFmMWMtNjg5ODEyMjAzMzE3In0.AQUAAAABAAMABwCAxevwS2rYSAgAgCO8o0xq2EgYAAEAAAAAAAAAIQCCAgAAeyJUb2tlbklkIjoiYzMyZjkwZDAtOGYyMy00MzZhLWFlNTctN2Q1MDgxZGRkZjAxIiwiRXhwaXJhdGlvbiI6IjIwMjAtMTAtMDZUMjM6MDc6NDcrMDA6MDAiLCJJc3N1ZWRBdCI6IjIwMjAtMTAtMDZUMjM6MDI6NDcuODA2NTMwNiswMDowMCIsIlJlc291cmNlSWQiOiI5Y2NhNTc1Yy0zYWQ0LTQ0NDctYWI2NC1lNzQ3YTVhODMwNzEiLCJSZXNvdXJjZXMiOiJ7XCJFbnZlbG9wZUlkXCI6XCI5Y2NhNTc1Yy0zYWQ0LTQ0NDctYWI2NC1lNzQ3YTVhODMwNzFcIixcIkFjdG9yVXNlcklkXCI6XCI0YWQ2YmNjMi1jOTE0LTQwOGQtYWRjYi1mMzViM2U0MWFjMjNcIixcIlJlY2lwaWVudElkXCI6XCIwNTY4NzI4Zi1hN2RjLTQ5YTktODc0YS1mYmZlYzkwNTAwMzVcIixcIkZha2VRdWVyeVN0cmluZ1wiOlwidD01M2Q0YWRmNy1hMDI3LTRkYzEtYWI0My1jODg1MjY3NDJmMmZcIn0iLCJUb2tlblR5cGUiOjEsIkF1ZGllbmNlIjoiMjVlMDkzOTgtMDM0NC00OTBjLThlNTMtM2FiMmNhNTYyN2JmIiwiUmVkaXJlY3RVcmkiOiJodHRwczovL2RlbW8uZG9jdXNpZ24ubmV0L1NpZ25pbmcvU3RhcnRJblNlc3Npb24uYXNweCIsIkhhc2hBbGdvcml0aG0iOjAsIkhhc2hSb3VuZHMiOjAsIlRva2VuU3RhdHVzIjowLCJJc1NpbmdsZVVzZSI6ZmFsc2V9.TGvYaZR9QZvjJOodXLrHSI34N7w1sbb5EHF9wLr_yFYiG000nfoIvD2dlYWlw-L4epUsqCFVLu2ZxHnn__2OU9mSKs1M31b-T9LWmAsPx5d64YvtES6oyXzu-lX5KSZfYayOhoHxqtqGKTK8JJoKnZIp25x8pEZ4meaykNUqIwIznSpVOxCoAXkyR8o0WvHzahsUaDDHYKwSmKCNAuJmITc7y8amdUkXOkZhjEMBT7TsUgXDbmyOgAZV_rg4zTZLk3GYvFDCPWWNavBMczdcJmD-ZjHbhJ3UySucDbcBPA6-x6rCISdGwufBTKvwSss0-nhtBB2cYIp6eSpx6dQk6g"
}

Response attributes from email option:

Property Nullable Type Description
DownloadUrl Yes String Returns null.
ESignUrl Yes String Returns empty string.

Example response:


{
    "DownloadUrl": null,
    "ESignUrl": ""
}

Submit LCC Only Paperwork

Submits paperwork (Lcc only) for a loan application.

POST /v3/api/applications/paperwork/submit/lcc

Request attributes:

Property Required/Optional Type Description
LoanApplicationId Required Long Must be a valid application id that the user has access to. Application must be in valid state.
CompletionCertificate Required Object
Signature Required Object Signature must be one of the three types: Download, e-sign and e-mail.
DocumentSelection Required Object

"CompletionCertificate" attributes:

Property Required/Optional Type Description
CompletionDate Required Date Must be valid date. Date shouldn't be older than 50 years and greater than 3 years from today's date.
ProductInstalledAtApplicantsAddress Required Boolean This field indicates whether or not the product was installed at the applicant's address.
ProductInstaller Required InstallerTypeEnum Must be valid Enum value.
Address Required Object

"Address" attributes:

Property Required/Optional Type Description
Address1 Required String Cannot be empty value.
Address2 Optional String This field indicates address line 2 for the address.
City Required String Cannot be empty value.
State Required StateEnum Must be valid Enum value.
PostalCode Required String Must be valid for ^[0-9]{5}$ or ^[0-9]{5}-[0-9]{4}$.

"Signature" attributes:

NOTE

Dealer, Applicant, CoApplicant and DocusignRedirectUrl are only for esign/email. For download those properties must be null.

Property Required/Optional Type Description
SignatureTypes Required List of SignatureTypeEnum For download - only ["Written"]. For e-sign: ["Written", "Electronic"]. For e-mail: ["Written","Email"].
SignatureDate Optional Date If there is no Full paperwork done on this application then date should be null. Otherwise date must equal the same date from full paperwork SignatureDate.
ExcludeDatesOnPaperwork Required Boolean This field indicates whether or not to exlude dates on paperwork.
ApplicationType Required LoanApplicationTypeEnum For applications with no co-applicant only Individual allowed. For applications with co-applicant only JointWithSpouse and JointWithNonSpouse allowed.
Dealer Optional Object Has two properties. Name: which should be not empty and max length is 100. EmailAddress: not empty, valid email with max length of 100.
Applicant Optional Object Has four properties. EmailAddress: not empty, valid email with max length of 100. IsUnitedStatesCitizen: boolean. ApplicantSigningLcc: Defaults to true. Is the applicant signing the LCC document. IdentificationType: LegalIdentificationTypeEnum
CoApplicant Optional Object Applies only when application has co-applicant. Has four properties. EmailAddress: not empty, valid email with max length of 100. IsUnitedStatesCitizen: boolean. CoApplicantSigningLcc: Defaults to true. Is the co-applicant signing the LCC document. IdentificationType: LegalIdentificationTypeEnum
DocusignRedirectUrl Optional String Must be valid URL only for e-sign option, otherwise null.

"DocumentSelection" attributes:

Property Required/Optional Type Description
ContractState Required StateEnum Must be valid Enum value.
ContractLanguage Required LanguageTypeEnum Must be valid Enum value.
DownloadHardCopies Required Boolean Can be true only for Download option, otherwise should be false.

Example request for download:


{
    "LoanApplicationId": 12345,
    "CompletionCertificate": {
        "TentativeCompletionDate": null,
        "CompletionDate": "08/18/2020",
        "ProductInstalledAtApplicantsAddress": false,
        "ProductInstaller": "NotRequired",
        "Address": {
            "Address1": "123 Main St",
            "Address2": null,
            "City": "Duluth",
            "State": "MN",
            "PostalCode": "55555"
        }
    },
    "Signature": {
        "SignatureTypes": [
            "Written"
        ],
        "SignatureDate": "09/16/2020",
        "ExcludeDatesOnPaperwork": false,
        "ApplicationType": "Individual",
        "Dealer": null,
        "Applicant": null,
        "CoApplicant": null,
        "DocusignRedirectUrl": null
    },
    "DocumentSelection": {
        "ContractState": "DE",
        "ContractLanguage": "English",
        "DownloadHardCopies": true
    }
}

Response attributes from download option:

Property Nullable Type Description
DownloadUrl Yes String Returns URL that you must use to download generated documents
ESignUrl Yes String Returns null.

Example response:


{
  "DownloadUrl": "/api/applications/paperwork/{applicationId}/download?documentType=CompletionCertificate",
  "ESignUrl": null
}

Example request for DocuSign eSigning.

Example request:


{
    "LoanApplicationId":12345,
    "CompletionCertificate": {
        "TentativeCompletionDate": null,
        "CompletionDate":"10/06/2020",
        "ProductInstalledAtApplicantsAddress":false,
        "ProductInstaller":"NotRequired",
        "Address": {
             "Address1":"3433 Broadway St NE",
             "Address2":null,
             "City":"Minneapolis",
             "State":"MN",
             "PostalCode":"55413"
        }
    },
    "Signature": {
        "SignatureTypes": [
             "Written",
             "Electronic"
        ],
        "SignatureDate":"09/16/2020",
        "ExcludeDatesOnPaperwork":false,
        "ApplicationType":"Individual",
        "Dealer": {
             "Name":"Water Dealer",
             "EmailAddress":"water@hotmail.com"
        },
        "Applicant": {
             "EmailAddress":"test@hotmail.com",
             "IdentificationType":"DriversLicense",
             "IsUnitedStatesCitizen":true
        },
        "CoApplicant": null,
        "DocusignRedirectUrl": "https://www.redirect-url.com"
    },
    "DocumentSelection": {
        "ContractState":"MN",
        "ContractLanguage":"English",
        "DownloadHardCopies":false
    }
}

Response attributes from esign option:

Property Nullable Type Description
DownloadUrl Yes String Returns null.
ESignUrl Yes String Returns URL for esigning.

Example response:


{
    "DownloadUrl": null,
    "ESignUrl": "https://demo.docusign.net/Signing/MTRedeem/v1/6c61406d-40a4-49b5-b560-e9e9c26303a5?slt=eyJ0eXAiOiJNVCIsImFsZyI6IlJTMjU2Iiwia2lkIjoiNjgxODVmZjEtNGU1MS00Y2U5LWFmMWMtNjg5ODEyMjAzMzE3In0.AQUAAAABAAMABwCAxevwS2rYSAgAgCO8o0xq2EgYAAEAAAAAAAAAIQCCAgAAeyJUb2tlbklkIjoiYzMyZjkwZDAtOGYyMy00MzZhLWFlNTctN2Q1MDgxZGRkZjAxIiwiRXhwaXJhdGlvbiI6IjIwMjAtMTAtMDZUMjM6MDc6NDcrMDA6MDAiLCJJc3N1ZWRBdCI6IjIwMjAtMTAtMDZUMjM6MDI6NDcuODA2NTMwNiswMDowMCIsIlJlc291cmNlSWQiOiI5Y2NhNTc1Yy0zYWQ0LTQ0NDctYWI2NC1lNzQ3YTVhODMwNzEiLCJSZXNvdXJjZXMiOiJ7XCJFbnZlbG9wZUlkXCI6XCI5Y2NhNTc1Yy0zYWQ0LTQ0NDctYWI2NC1lNzQ3YTVhODMwNzFcIixcIkFjdG9yVXNlcklkXCI6XCI0YWQ2YmNjMi1jOTE0LTQwOGQtYWRjYi1mMzViM2U0MWFjMjNcIixcIlJlY2lwaWVudElkXCI6XCIwNTY4NzI4Zi1hN2RjLTQ5YTktODc0YS1mYmZlYzkwNTAwMzVcIixcIkZha2VRdWVyeVN0cmluZ1wiOlwidD01M2Q0YWRmNy1hMDI3LTRkYzEtYWI0My1jODg1MjY3NDJmMmZcIn0iLCJUb2tlblR5cGUiOjEsIkF1ZGllbmNlIjoiMjVlMDkzOTgtMDM0NC00OTBjLThlNTMtM2FiMmNhNTYyN2JmIiwiUmVkaXJlY3RVcmkiOiJodHRwczovL2RlbW8uZG9jdXNpZ24ubmV0L1NpZ25pbmcvU3RhcnRJblNlc3Npb24uYXNweCIsIkhhc2hBbGdvcml0aG0iOjAsIkhhc2hSb3VuZHMiOjAsIlRva2VuU3RhdHVzIjowLCJJc1NpbmdsZVVzZSI6ZmFsc2V9.TGvYaZR9QZvjJOodXLrHSI34N7w1sbb5EHF9wLr_yFYiG000nfoIvD2dlYWlw-L4epUsqCFVLu2ZxHnn__2OU9mSKs1M31b-T9LWmAsPx5d64YvtES6oyXzu-lX5KSZfYayOhoHxqtqGKTK8JJoKnZIp25x8pEZ4meaykNUqIwIznSpVOxCoAXkyR8o0WvHzahsUaDDHYKwSmKCNAuJmITc7y8amdUkXOkZhjEMBT7TsUgXDbmyOgAZV_rg4zTZLk3GYvFDCPWWNavBMczdcJmD-ZjHbhJ3UySucDbcBPA6-x6rCISdGwufBTKvwSss0-nhtBB2cYIp6eSpx6dQk6g"
}

Response attributes from email option:

Property Required/Optional Type Description
DownloadUrl Optional String Returns null.
ESignUrl Optional String Returns empty string.

Example response:


{
    "DownloadUrl": null,
    "ESignUrl": ""
}

Submit ACH Only Paperwork

Submits paperwork (Ach only) for a loan application.

POST /v3/api/applications/paperwork/submit/ach

Request attributes:

Property Required/Optional Type Description
LoanApplicationId Required Long Must be a valid application id that the user has access to. Application must be in valid state.
Payment Required Object
Signature Required Object Signature must be one of the three types: Download, e-sign and e-mail.
DocumentSelection Required Object

"Payment" attributes:

Property Required/Optional Type Description
PaymentFrequency Required PaymentFrequencyEnum Must be valid Enum value.
PaymentAmount Optional Decimal Not negative number. Must be less than 100M. Max two numbers after decimal point.
DayOfMonthForFirstWithdrawal Optional Integer Not negative number. "0" Is considered empty value. Max value is 31.
DayOfMonthForSecondWithdrawal Optional Integer Must be null for PaymentFrequency: OnceMonthly. For TwiceMonthly applies same rules as DayOfMonthForFirstWithdrawal.
MonthToWithdrawFirstPayment Optional Integer Not negative number. "0" Is considered empty value. Max value is 12.
BankInformation Required Object

"BankInformation" attributes:

Property Required/Optional Type Description
Name Optional String When has value maximum length is 150.
Address Optional Object All properties of Address are nullable. State must be valid StateEnum and PostalCode should match those one of those regex strings: ^[0-9]{5}$ or ^[0-9]{5}-[0-9]{4}$
RoutingNumber Required String Cannot be empty. Length is 9. Must be valid for regex: ^[0-9]+$.
AccountType Optional PaymentAccountTypeEnum Must be valid Enum value.
AccountNumber Required String Cannot be empty. Maximum length is 17. Must be valid for regex: ^[0-9]+$.

"Signature" attributes:

NOTE

Dealer, Applicant, CoApplicant and DocusignRedirectUrl are only for esign/email. For download those properties must be null.

Property Required/Optional Type Description
SignatureTypes Required List of SignatureTypeEnum For download - only ["Written"]. For e-sign: ["Written", "Electronic"]. For e-mail: ["Written","Email"].
SignatureDate Optional Date If there is no Full paperwork done on this application then date should be null. Otherwise date must equal the same date from full paperwork SignatureDate.
ExcludeDatesOnPaperwork Required Boolean
ApplicationType Required LoanApplicationTypeEnum For applications with no co-applicant only Individual allowed. For applications with co-applicant only JointWithSpouse and JointWithNonSpouse allowed.
Dealer Optional Object Has two properties. Name: which should be not empty and max length is 100. EmailAddress: not empty, valid email with max length of 100.
Applicant Optional Object Has four properties. EmailAddress: not empty, valid email with max length of 100. IsUnitedStatesCitizen: boolean. ApplicantSigningAch: Defaults to true. Is the applicant signing the ACH document. IdentificationType: LegalIdentificationTypeEnum
CoApplicant Optional Object Applies only when application has co-applicant. Has four properties. EmailAddress: not empty, valid email with max length of 100. IsUnitedStatesCitizen: boolean. CoApplicantSigningAch: Defaults to false. Is the co-applicant signing the ACH document. IdentificationType: LegalIdentificationTypeEnum
DocusignRedirectUrl Optional String Must be valid URL only for e-sign option, otherwise null.

"DocumentSelection" attributes:

Property Required/Optional Type Description
ContractState Required StateEnum Must be valid Enum value.
ContractLanguage Required LanguageTypeEnum Must be valid Enum value.
DownloadHardCopies Required Boolean Can be true only for Download option, otherwise should be false.

Example request for download:


{
    "LoanApplicationId": 12345,
    "Payment": {
        "PaymentFrequency": "OnceMonthly",
        "PaymentAmount": 2,
        "DayOfMonthForFirstWithdrawal": 1,
        "DayOfMonthForSecondWithdrawal": null,
        "MonthToWithdrawFirstPayment": 1,
        "BankInformation": {
            "Name": "Test Bank",
            "Address": {
                "Address1": "123 Main St",
                "Address2": "",
                "City": "Duluth",
                "State": "MN",
                "PostalCode": "55555"
            },
            "RoutingNumber": "123456789",
            "AccountType": "Checking",
            "AccountNumber": "987654321"
        }
    },
    "Signature": {
        "SignatureTypes": [
            "Written"
        ],
        "SignatureDate": "09/16/2020",
        "ExcludeDatesOnPaperwork": false,
        "ApplicationType": "Individual",
        "Dealer": null,
        "Applicant": null,
        "CoApplicant": null,
        "DocusignRedirectUrl": null
    },
    "DocumentSelection": {
        "ContractState": "DE",
        "ContractLanguage": "English",
        "DownloadHardCopies": true
    }
}

Response attributes from download option:

Property Nullable Type Description
DownloadUrl Yes String Returns URL that you must use to download generated documents
ESignUrl Yes String Returns null.

Example response:


{
  "DownloadUrl": "/api/applications/paperwork/{applicationId}/download?documentType=HardCopies",
  "ESignUrl": null
}

Example request for DocuSign eSigning.


{
    "LoanApplicationId":12345,
    "Payment": {
        "PaymentFrequency":"OnceMonthly",
        "PaymentAmount":50,
        "DayOfMonthForFirstWithdrawal":15,
        "DayOfMonthForSecondWithdrawal":null,
        "MonthToWithdrawFirstPayment":1,
        "BankInformation": {
            "Name":"Wellsfargo",
            "Address": {
                "Address1":"123 Fake St.",
                "Address2":"",
                "City":"Saint Paul",
                "State":"MN",
                "PostalCode":"55103"
            },
            "RoutingNumber":"100000009",
            "AccountType":"Checking",
            "AccountNumber":"10001000"
        }
    },
    "Signature":{
        "SignatureTypes": [
            "Written",
            "Electronic"
        ],
        "SignatureDate":"09/16/2020",
        "ExcludeDatesOnPaperwork":false,
        "ApplicationType":"Individual",
        "Dealer": {
            "Name":"Water Dealer",
            "EmailAddress":"water@hotmail.com"
        },
        "Applicant": {
            "EmailAddress":"test@hotmail.com",
            "IdentificationType":"DriversLicense",
            "IsUnitedStatesCitizen":true
        },
        "CoApplicant": null,
        "DocusignRedirectUrl": "https://www.redirect-url.com"
    },
    "DocumentSelection": {
        "ContractState":"MN",
        "ContractLanguage":"English",
        "DownloadHardCopies":false
    }
}

Response attributes from esign option:

Property Nullable Type Description
DownloadUrl Yes String Returns null.
ESignUrl Yes String Returns URL for esigning.

Example response:


{
    "DownloadUrl": null,
    "ESignUrl": "https://demo.docusign.net/Signing/MTRedeem/v1/6c61406d-40a4-49b5-b560-e9e9c26303a5?slt=eyJ0eXAiOiJNVCIsImFsZyI6IlJTMjU2Iiwia2lkIjoiNjgxODVmZjEtNGU1MS00Y2U5LWFmMWMtNjg5ODEyMjAzMzE3In0.AQUAAAABAAMABwCAxevwS2rYSAgAgCO8o0xq2EgYAAEAAAAAAAAAIQCCAgAAeyJUb2tlbklkIjoiYzMyZjkwZDAtOGYyMy00MzZhLWFlNTctN2Q1MDgxZGRkZjAxIiwiRXhwaXJhdGlvbiI6IjIwMjAtMTAtMDZUMjM6MDc6NDcrMDA6MDAiLCJJc3N1ZWRBdCI6IjIwMjAtMTAtMDZUMjM6MDI6NDcuODA2NTMwNiswMDowMCIsIlJlc291cmNlSWQiOiI5Y2NhNTc1Yy0zYWQ0LTQ0NDctYWI2NC1lNzQ3YTVhODMwNzEiLCJSZXNvdXJjZXMiOiJ7XCJFbnZlbG9wZUlkXCI6XCI5Y2NhNTc1Yy0zYWQ0LTQ0NDctYWI2NC1lNzQ3YTVhODMwNzFcIixcIkFjdG9yVXNlcklkXCI6XCI0YWQ2YmNjMi1jOTE0LTQwOGQtYWRjYi1mMzViM2U0MWFjMjNcIixcIlJlY2lwaWVudElkXCI6XCIwNTY4NzI4Zi1hN2RjLTQ5YTktODc0YS1mYmZlYzkwNTAwMzVcIixcIkZha2VRdWVyeVN0cmluZ1wiOlwidD01M2Q0YWRmNy1hMDI3LTRkYzEtYWI0My1jODg1MjY3NDJmMmZcIn0iLCJUb2tlblR5cGUiOjEsIkF1ZGllbmNlIjoiMjVlMDkzOTgtMDM0NC00OTBjLThlNTMtM2FiMmNhNTYyN2JmIiwiUmVkaXJlY3RVcmkiOiJodHRwczovL2RlbW8uZG9jdXNpZ24ubmV0L1NpZ25pbmcvU3RhcnRJblNlc3Npb24uYXNweCIsIkhhc2hBbGdvcml0aG0iOjAsIkhhc2hSb3VuZHMiOjAsIlRva2VuU3RhdHVzIjowLCJJc1NpbmdsZVVzZSI6ZmFsc2V9.TGvYaZR9QZvjJOodXLrHSI34N7w1sbb5EHF9wLr_yFYiG000nfoIvD2dlYWlw-L4epUsqCFVLu2ZxHnn__2OU9mSKs1M31b-T9LWmAsPx5d64YvtES6oyXzu-lX5KSZfYayOhoHxqtqGKTK8JJoKnZIp25x8pEZ4meaykNUqIwIznSpVOxCoAXkyR8o0WvHzahsUaDDHYKwSmKCNAuJmITc7y8amdUkXOkZhjEMBT7TsUgXDbmyOgAZV_rg4zTZLk3GYvFDCPWWNavBMczdcJmD-ZjHbhJ3UySucDbcBPA6-x6rCISdGwufBTKvwSss0-nhtBB2cYIp6eSpx6dQk6g"
}

Response attributes from email option:

Property Nullable Type Description
DownloadUrl Yes String Returns null.
ESignUrl Yes String Returns empty string.

Example response:


{
    "DownloadUrl": null,
    "ESignUrl": ""
}

Download Paperwork

Downloads paperwork for an existing, approved application.

The response for this payload is a PDF via application/octet-stream.

NOTE

Paperwork must be submitted to an endpoint with download option configured and the direct URL for the download will be returned in the response field DownloadUrl.

GET /v3/api/applications/paperwork/{applicationId}/download?documentType={PaperworkDocumentEnum}

Request URL query parameters:

Property Required/Optional Type Description
applicationId Required Long Use value from response of paperwork submission.
PaperworkDocumentEnum Required String Use value from response of paperwork submission.

Document's Signed Status

Retrieves a document's signed status for a specified application with paperwork already completed. This will return the signed document status for any and all documents for a specified application. Our signing mechanism is DocuSign.

GET /v3/api/applications/paperwork/{applicationId}/signed-status

Request URL query parameters:

Property Required/Optional Type Description
applicationId Required Long Valid application Id that user has access to.
NOTE

Response is an List of paperwork submission items: FULL, ACH, LCC.

Response attributes:

Property Nullable Type Description
SignatureInformation No List of Objects
SignatureType No String Type of paperwork submission: FULL, ACH, LCC.

"SignatureInformation" attributes:

Property Nullable Type Description
SigneeType No String Indicates the type of signee.
DateSent Yes Date The date paperwork was sent.
DateSigned Yes Date The date the paperwork was signed.
EmailAddress Yes String Email address for the signee.
AccessCode Yes String Acces code to access DocuSign paperwork.
Reviewed Yes Boolean This property is dedicated only to ACH email/electronic signature Type. It will be true if dealer reviewed documents, otherwise false. For any other type it always going to be null.

Example response:


[
    {
        "SignatureInformation": [
            {
                "SigneeType": "Applicant",
                "DateSent": "2020-09-22T16:02:44.66Z",
                "DateSigned": "2020-09-23T14:06:03.943Z",
                "EmailAddress": "support@aquafinance.com",
                "AccessCode": null,
                "Reviewed": null
            },
            {
                "SigneeType": "CoApplicant",
                "DateSent": "2020-09-22T14:07:44.017Z",
                "DateSigned": "2020-09-23T14:07:44.017Z",
                "EmailAddress": "support@aquafinance.com",
                "AccessCode": null,
                "Reviewed": null
            },
            {
                "SigneeType": "Dealer",
                "DateSent": "2020-09-22T14:09:18.68Z",
                "DateSigned": "2020-09-23T14:09:18.68Z",
                "EmailAddress": "support@aquafinance.com",
                "AccessCode": "000123.000DT",
                "Reviewed": null
            }
        ],
        "SignatureType": "FULL"
    }
]

Resend Documents

Resends documents for already existing electronic paperwork.

POST v3/api/applications/paperwork/{applicationId}/esign-resend

Request URL query parameters:

Property Required/Optional Type Description
applicationId Required Long Valid application Id that user has access to.
Property Required/Optional Type Description
DocumentTypes Required Array Array of valid PaperworkDocumentEnum strings

Example request:


{
    "DocumentTypes": [
            "FULL",
            "LCC",
            "ACH"
        ]
}

Example response: 200 OK