Web API Endpoints
For info on how to setup Postman to send requests like these, check out the Postman section.
Submit Loan Application
POST /v2/api/applications
Submits an application.
Example request:
{
"Applicant": {
"IdentificationType": "UnitedStatesMilitaryId", // LegalIdentificationTypeEnum
"IdentificationNumber": "1234567890",
"IsIssueDatePresent": true,
"IsIssueStatePresent": true,
"ExpirationDateUnavailable": false,
"IdentificationIssuedDate": "2015-11-15",
"IdentificationExpirationDate": "2027-11-15",
"IdentificationIssueState": "MN", // StateEnum
"EmploymentType": "Employed", // EmploymentTypeEnum
"CurrentEmployer": "Oscorp",
"CurrentEmployerPhoneNumber": "8230986874",
"Occupation": "Systems Analyst",
"EmploymentMonth": 2,
"EmploymentYear": 1959,
"GrossMonthlyIncome": 26000,
"AdditionalIncomeSources": [
{
"AdditionalIncomeSource": "Other", // ApplicantIncomeTypeEnum
"Description": "Unobtainium mining outfit",
"Source": "Pandora",
"Amount": 500000,
"IsNonTaxableIncome": false
}
],
"ResidenceType": "Own", // ApplicantResidenceTypeEnum
"Payment": 1,
"HasCoApplicant": true,
"HomeValue": 7984000,
"FirstName": "string",
"MiddleInitial": "s",
"LastName": "BROKERAPI",
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "MN",
"PostalCode": "55414",
"EmailAddress": "user@example.com",
"PrimaryPhone": "8231231234",
"PrimaryPhoneType": "Cell", // PhoneNumberTypeEnum
"SecondaryPhone": null,
"SecondaryPhoneType": null, // PhoneNumberTypeEnum
"SocialSecurityNumber": "100000104",
"DateOfBirth": "1917-11-15"
},
"CoApplicant": {
"ApplicantRelationship": "Spouse", // CoApplicantTypeEnum
"IdentificationType": "StateId", // LegalIdentificationTypeEnum
"IdentificationNumber": "1234567890",
"IsIssueDatePresent": false,
"IsIssueStatePresent": false,
"IdentificationIssuedDate": "1963-11-15",
"IdentificationExpirationDate": "2043-11-15",
"IdentificationIssueState": "MN", // StateEnum
"EmploymentType": "Retired", // EmploymentTypeEnum
"CurrentEmployer": null,
"CurrentEmployerPhoneNumber": null,
"Occupation": null,
"EmploymentMonth": null,
"EmploymentYear": null,
"GrossMonthlyIncome": null,
"AdditionalIncomeSources": [],
"ResidenceType": "Own", // ApplicantResidenceTypeEnum
"Payment": 5000,
"HasCoApplicant": true,
"HomeValue": 0,
"FirstName": "BrokerAPISpouse",
"MiddleInitial": "s",
"LastName": "string",
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "MN", // StateEnum
"PostalCode": "55414",
"EmailAddress": "user@example.com",
"PrimaryPhone": "7231231234",
"PrimaryPhoneType": "Cell", // PhoneNumberTypeEnum
"SecondaryPhone": "9879879876",
"SecondaryPhoneType": "Home", // PhoneNumberTypeEnum
"SocialSecurityNumber": "100000105",
"DateOfBirth": "1917-11-15"
},
"LoanParameters": {
"CreditType": "Revolving", // CreditTypeEnum
"ContractState": "CA", // StateEnum
"ContractLanguage": "English",
"ProductOrService": "WATERTREAT",
"SellingPrice": 1000,
"DownPayment": 100,
"SalesTaxIncluded": true,
"SalesTax": 1,
"HasTradeIn": false,
"AmountFinanced": 901,
"PaymentFactor": "Two", // CreditPaymentFactorEnum
"CompletionDate": "2099-11-15",
"DealerId": 6
},
"AssignedUserEmailAddress": "support@aquafinance.com"
}Example response:
{
"Content": null,
"Id": 46887,
"ApplicationNumber": null,
"LoanType": "Revolving", // CreditTypeEnum
"Dealer": {
"Id": 7,
"Name": "WATER TEST FILE",
"DealerNumber": "XXXXXX.XXX",
"EntityId": "XXXXXX",
"IsOpenOnSaturday": false,
"IsRetailDealer": false,
"Address": {
"SerializationVersion": 1,
"Address1": "111 ROAD-STREET",
"Address2": "",
"City": "GILLETTE",
"State": "WY", // StateEnum
"PostalCode": "82718"
},
"PhoneNumber": null,
"MajorProductLine": "MISC WATER",
"Nickname": null,
"AffiliateName": null,
"Products": [
{
"SerializationVersion": 1,
"Name": "Water Treatment System",
"Code": "WATERTREAT",
"IsHomeImprovement": false,
"IsMajorProduct": true
}
],
"Options": [
{
"SerializationVersion": 1,
"Code": "STDRVPROMO",
"Description": "STDREVPROMO"
},
//...
],
"Verticals": [
{
"SerializationVersion": 1,
"Value": "WATERTREAT"
}
]
},
"Applicant": {
"Id": 42313,
"FirstName": "string",
"MiddleInitial": "s",
"LastName": "BROKERAPI",
"EmailAddress": "user@example.com",
"DateOfBirth": "1917-11-15T00:00:00",
"SocialSecurityNumber": "100000104",
"MonthlyIncome": 26000,
"CoApplicantType": null, // CoApplicantTypeEnum
"LoanApplicationId": 46887,
"IsPrimary": true,
"Identification": {
"SerializationVersion": 1,
"LegalIdentificationType": "UnitedStatesMilitaryId", // LegalIdentificationTypeEnum
"Number": "1234567890",
"ExpirationDate": "2027-11-15T00:00:00-06:00",
"IssueDate": "2015-11-15T00:00:00-06:00",
"IssueDateIsPresentOnId": true,
"StateOfIssuance": "MN", // StateEnum
"IssuanceStateIsPresentOnId": true
},
"EmploymentHistory": [
{
"SerializationVersion": 1,
"Name": "Oscorp",
"PhoneNumber": {
"SerializationVersion": 1,
"PhoneNumberType": "Work", // PhoneNumberTypeEnum
"AreaCode": "823",
"CentralOfficeCode": "098",
"StationNumber": "6874",
"IsPrimary": true
},
"Title": "Systems Analyst",
"EmploymentType": "Employed", // EmploymentTypeEnum
"StartDate": "1959-02-01T00:00:00-06:00"
}
],
"Incomes": [
{
"SerializationVersion": 1,
"Description": "Unobtainium mining outfit",
"Amount": 500000,
"IncomeType": "Other" // ApplicantIncomeTypeEnum,
"IsNonTaxableIncome": false
}
],
"PhoneNumbers": [
{
"SerializationVersion": 1,
"PhoneNumberType": "Cell", // PhoneNumberTypeEnum
"AreaCode": "823",
"CentralOfficeCode": "123",
"StationNumber": "1234",
"IsPrimary": true
}
],
"Residences": [
{
"SerializationVersion": 1,
"ResidenceType": "Own", // ApplicantResidenceTypeEnum
"MonthlyPaymentAmount": 1,
"PropertyValue": 7984000
}
],
"Address": {
"SerializationVersion": 1,
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "MN", // StateEnum
"PostalCode": "55414"
},
"Is65OrOlder": true
},
"CoApplicant": {
"Id": 42314,
"FirstName": "BrokerAPISpouse",
"MiddleInitial": "s",
"LastName": "string",
"EmailAddress": "user@example.com",
"DateOfBirth": "1917-11-15T00:00:00",
"SocialSecurityNumber": "100000105",
"MonthlyIncome": null,
"CoApplicantType": "Spouse", // CoApplicantTypeEnum
"LoanApplicationId": 46887,
"IsPrimary": false,
"Identification": {
"SerializationVersion": 1,
"LegalIdentificationType": "StateId", // LegalIdentificationTypeEnum
"Number": "1234567890",
"ExpirationDate": "2043-11-15T00:00:00-06:00",
"IssueDate": "1963-11-15T00:00:00-06:00",
"IssueDateIsPresentOnId": false,
"StateOfIssuance": "MN", // StateEnum
"IssuanceStateIsPresentOnId": false
},
"EmploymentHistory": [
{
"SerializationVersion": 1,
"Name": null,
"PhoneNumber": null,
"Title": null,
"EmploymentType": "Retired",
"StartDate": null
}
],
"Incomes": [],
"PhoneNumbers": [
{
"SerializationVersion": 1,
"PhoneNumberType": "Cell", // PhoneNumberTypeEnum
"AreaCode": "823",
"CentralOfficeCode": "123",
"StationNumber": "1234",
"IsPrimary": true
},
{
"SerializationVersion": 1,
"PhoneNumberType": "Home", // PhoneNumberTypeEnum
"AreaCode": "987",
"CentralOfficeCode": "987",
"StationNumber": "9876",
"IsPrimary": false
}
],
"Residences": [
{
"SerializationVersion": 1,
"ResidenceType": "Own", // ApplicantResidenceTypeEnum
"MonthlyPaymentAmount": 5000,
"PropertyValue": 0
}
],
"Address": {
"SerializationVersion": 1,
"Address1": "string",
"Address2": "string",
"City": "string",
"State": "MN", // StateEnum
"PostalCode": "55414"
},
"Is65OrOlder": true
},
"Context": {
"SerializationVersion": 1,
"State": "CA", // StateEnum
"Language": {
"LanguageType": "English",
"Name": "en-US",
"Id": 1
}
},
"FinancialInformation": {
"SerializationVersion": 1,
"ProductCode": "WATERTREAT",
"SellingPrice": 1000,
"DownPayment": 100,
"DocumentFee": 0,
"CompletionPayment": 0,
"SalesTax": {
"SerializationVersion": 1,
"IsIncluded": true,
"TaxAmount": 1
},
"TotalAmountFinanced": 901
},
"TradeIns": [],
"Terms": {
"SerializationVersion": 1,
"CreditType": "Revolving", // CreditTypeEnum
"PaymentTerm": null, // CreditPaymentTermEnum
"PaymentFactor": "Two", // CreditPaymentFactorEnum
"PaymentFactorReal": 0.02,
"CompletionDate": "2099-11-15T00:00:00"
},
"CustomDealerInformation": null,
"SubmitNumber": "E000046887",
"AssignedUserId": XXX,
"AssignedSalesRepresentativeName": null,
"Status": "Processing", // LoanApplicationStatusEnum
"CreateDateUtc": "2019-05-23T16:36:50.103",
"ModifyDateUtc": "2019-05-23T16:36:50.103",
"DeleteDateUtc": null,
"IsActive": false,
"PromotionId": null,
"HistoryItems": [],
"Events": []
}Get Application Status
GET /v2/api/applications/status/{applicationId}
Gets the status of a specific application.
Example response:
{
"LoanApplicationId": 123,
"LoanApplicationNumber": 123456789,
"LoanApplicationStatus": "Approved", // LoanApplicationStatusEnum
"DealerId": 1,
"AssignedToUserId": 1,
"Messages": [
{
"SerializationVersion": 1,
"MessageType": "Hint",
"IsMet": false,
"Label": "Additional Messages ",
"Text": "Example Message."
},
{
"SerializationVersion": 1,
"MessageType": "Hint",
"IsMet": false,
"Label": "Additional Messages ",
"Text": "Thank You for your Business!!"
}
],
"DispositionCode": null,
"BuyRate": "100.00%",
"AmountFinanced": 2700
}GET /v2/api/applications/statuses-since/{timestamp}
Gets the statuses of all applications that have been updated since a specific date and time.
Example response:
[
{
"LoanApplicationId": 123,
"LoanApplicationNumber": 123456789,
"LoanApplicationStatus": "Approved", // LoanApplicationStatusEnum
"DealerId": 1,
"AssignedToUserId": 1,
"Messages": [
{
"SerializationVersion": 1,
"MessageType": "Condition",
"IsMet": false,
"Label": "Additional Messages ",
"Text": "Thank You for your Business!!"
},
{
"SerializationVersion": 1,
"MessageType": "Hint",
"IsMet": false,
"Label": "Additional Messages ",
"Text": "Thank You for your Business!!"
}
],
"DispositionCode": null,
"BuyRate": "100.00%",
"AmountFinanced": 2700
},
//...
]Get Authorized Dealers
GET /v2/api/dealers
Gets the list of dealers that the requesting user has access to.
Example response:
[
{
"Id": 7,
"Name": "WATER TEST FILE",
"DealerNumber": "XXXXXX.XXX",
"EntityId": "XXXXX",
"IsOpenOnSaturday": false,
"IsRetailDealer": false,
"Address": {
"SerializationVersion": 1,
"Address1": "111 ROAD-STREET",
"Address2": "",
"City": "GILLETTE",
"State": "WY",
"PostalCode": "82718"
},
"PhoneNumber": null,
"MajorProductLine": "MISC WATER",
"Nickname": null,
"AffiliateName": null,
"NextAttestationDate": null,
"Products": [
{
"SerializationVersion": 1,
"Name": "Water Treatment System",
"Code": "WATERTREAT",
"IsHomeImprovement": false,
"IsMajorProduct": true
}
],
"Options": [
{
"SerializationVersion": 1,
"Code": "STDRVPROMO",
"Description": "STDREVPROMO"
},
{
"SerializationVersion": 1,
"Code": "STDCEPROMO",
"Description": "STDCEPROMO"
},
//...
]
},
//...
]Get Promotions for Application
GET /v2/api/applications/promotions/{applicationId}
Gets valid promotion(s) for the specified loan application ID.
EstimatedMonthlyPayment = AmountFinanced * PaymentFactor
If the loan type is Revolving, EstimatedMonthlyPayment is rounded up the next integer.
Example response:
[
{
"Id": 1234,
"Name": "Promo Name",
"PromoCode": "promocode",
"AddOnId": null,
"ClosedEndPaymentRateId": 0,
"Apr": X.XXXX,
"PaymentFactor": X.XX,
"Terms": 12,
"EstimatedMonthlyPayment": X.XX
},
{
"Id": 9876,
"Name": "Promo Name",
"PromoCode": "promocode",
"AddOnId": 4321,
"ClosedEndPaymentRateId": 0,
"Apr": X.XXXX,
"PaymentFactor": X.XXXX,
"Terms": 0,
"EstimatedMonthlyPayment": X.XX
},
//...
]Set Promotion for Application
POST /v2/api/applications/promotions/{applicationId}
Submits a promotion.
Example request:
{
"PromotionId": 1234,
"ClosedEndPaymentRateId": 0,
"Apr": X.XXX,
"PaymentFactor": X.XX,
"Terms": 12
}
Get Products for Dealer
GET /v2/api/dealers/{dealerId}/products
Gets the list of products for a dealer that the requesting user has access to.
Example response:
{
"ProductOrService": "MARINE"
}
Validate Email for Dealer
POST /v2/api/dealers/{dealerId}/validateEmail
Validates the submitted email is valid for that dealer's user.
Example request:
{
"EmailAddress": "support@aquafinance.com"
}
Example response:
{
"DealerId": 7,
"EmailAddress": "support@aquafinance.com"
}
Loan Application Detail
GET /v2/api/applications/detail/{applicationId:long}
Gets the loan application detail for the specified application.
Request URL query parameters:
| Property | Required/Optional | Type | Description |
|---|---|---|---|
| applicationId | Required | Long | Valid application Id that user has access to. |
Example response:
{
"Content": null,
"Messages": [
{
"SerializationVersion": 1,
"MessageType": "Hint",
"IsMet": false,
"Label": "Additional Messages ",
"Text": "ACH REMINDER: A completed customer AUTO-PAY Form earns you a 2% BONUS paid on all loans (maximum of $200). Voided check and completed Customer AUTO-PAY Form REQUIRED at time of funding! Bonus to be paid regardless of bid amount (can exceed 100%)."
},
{
"SerializationVersion": 1,
"MessageType": "Hint",
"IsMet": false,
"Label": "Additional Messages ",
"Text": "Call 1-800-234-3663 #4 X6904 or 6098 or 6096 with questions.\n Thank you for your Business!!"
}
],
"DispositionCode": null,
"BuyRate": "100.00%",
"HistoryItems": [
{
"Message": "Application reassigned to Test User2",
"Date": "2022-04-01T14:10:03.51"
},
{
"Message": "Application reassigned to Test User1",
"Date": "2022-04-01T14:10:38.033"
},
{
"Message": "Application submitted by Test User",
"Date": "2022-04-04T12:06:24.69"
},
{
"Message": "Credit application created by Test User",
"Date": "2022-04-04T12:06:24.72"
}
],
"Signatures": [
{
"SignatureInformation": [
{
"SigneeType": "Applicant",
"DateSent": null,
"DateSigned": null,
"EmailAddress": "test@test.com",
"AccessCode": null,
"Reviewed": null
},
{
"SigneeType": "CoApplicant",
"DateSent": null,
"DateSigned": null,
"EmailAddress": "test@test.com",
"AccessCode": null,
"Reviewed": null
},
{
"SigneeType": "Dealer",
"DateSent": null,
"DateSigned": null,
"EmailAddress": "test@test.com",
"AccessCode": "000123.000PC",
"Reviewed": null
}
],
"SignatureType": "FULL"
}
],
"Id": 109654,
"ApplicationNumber": 1111111344,
"LoanType": "ClosedEnd",
"Dealer": {
"Id": 15,
"Name": "HOME IMPROVEMENT ORBIT TEST FILE",
"DealerNumber": "543210.000",
"EntityId": "100855",
"IsOpenOnSaturday": true,
"IsRetailDealer": false,
"Address": {
"SerializationVersion": 1,
"Address1": "1 CORPORATE DRIVE STE 300",
"Address2": "",
"City": "WAUSAU",
"State": "WI",
"PostalCode": "54401"
},
"PhoneNumber": {
"SerializationVersion": 1,
"PhoneNumberType": "Home",
"AreaCode": "715",
"CentralOfficeCode": "555",
"StationNumber": "5555",
"IsPrimary": true
},
"MajorProductLine": "HOMEIMPROV",
"Nickname": null,
"AffiliateName": null,
"NextAttestationDate": "2099-01-01T00:00:00",
"AttestWindowDays": 60,
"IncludeLcc": false,
"Status": "Approved",
"Products": [
{
"SerializationVersion": 1,
"Name": "Remodeling/Addition",
"Code": "REMODELING",
"IsHomeImprovement": true,
"IsMajorProduct": false
},
{
"SerializationVersion": 1,
"Name": "Doors",
"Code": "DOORS",
"IsHomeImprovement": true,
"IsMajorProduct": false
},
{
"SerializationVersion": 1,
"Name": "Roof",
"Code": "ROOF",
"IsHomeImprovement": true,
"IsMajorProduct": false
}
],
"Options": [
{
"SerializationVersion": 1,
"Code": "180APSTOVR",
"Description": "APPSTATUSDAYSOVERRIDE=180"
},
{
"SerializationVersion": 1,
"Code": "HIMPSTND",
"Description": "HIMPSTNDPROMO"
},
{
"SerializationVersion": 1,
"Code": "PLATINM650",
"Description": "PLATINUMBASE=650"
}
],
"Verticals": [
{
"SerializationVersion": 1,
"Value": "HOMEIMPROV"
}
],
"SalesRepresentatives": [
{
"SerializationVersion": 1,
"Initials": "TSR",
"FirstName": "Test",
"LastName": "SalesRep",
"Title": "Sales Rep",
"PhoneNumber": "7155555555",
"Email": "testsalesrep@aquafinance.com",
"PhotoUrl": null,
"SalesRepresentativeType": "SR",
"IsInternalTeam": false
},
{
"SerializationVersion": 1,
"Initials": "TSU",
"FirstName": "Test",
"LastName": "SuperUser",
"Title": "Account Manager",
"PhoneNumber": "5555555555",
"Email": "testsuperuser@AQUAFINANCE.COM",
"PhotoUrl": null,
"SalesRepresentativeType": "DSR",
"IsInternalTeam": true
}
]
},
"Applicant": {
"Id": 114310,
"FirstName": "TEST",
"MiddleInitial": null,
"LastName": "TESTER",
"EmailAddress": "test@test.com",
"DateOfBirth": "2000-04-01T14:09:39.9204559",
"SocialSecurityNumber": "XXX-XX-0103",
"MonthlyIncome": 1000000.0,
"CoApplicantType": null,
"LoanApplicationId": 109654,
"IsPrimary": true,
"FicoScore": null,
"Suffix": "SR",
"Identification": {
"SerializationVersion": 1,
"LegalIdentificationType": "DriversLicense",
"Number": "1234567890",
"ExpirationDate": "2023-01-01T00:00:00Z",
"IssueDate": "2019-01-01T00:00:00Z",
"IssueDateIsPresentOnId": true,
"StateOfIssuance": "MN",
"IssuanceStateIsPresentOnId": true,
"ExpirationDateUnavailable": false
},
"EmploymentHistory": [
{
"SerializationVersion": 1,
"Name": "Aqua Finance",
"PhoneNumber": {
"SerializationVersion": 1,
"PhoneNumberType": "Work",
"AreaCode": "999",
"CentralOfficeCode": "123",
"StationNumber": "4567",
"IsPrimary": true
},
"Title": "Automation",
"EmploymentType": "Employed",
"StartDate": "2019-01-01T06:00:00Z"
}
],
"Incomes": [],
"PhoneNumbers": [
{
"SerializationVersion": 1,
"PhoneNumberType": "Cell",
"AreaCode": "999",
"CentralOfficeCode": "123",
"StationNumber": "4567",
"IsPrimary": true
}
],
"Residences": [
{
"SerializationVersion": 1,
"ResidenceType": "Own",
"MonthlyPaymentAmount": 2000.0,
"PropertyValue": 200000.0,
"MonthsAt": 2,
"YearsAt": 2
}
],
"Address": {
"SerializationVersion": 1,
"Address1": "1 Corporate Dr",
"Address2": "Apt 123",
"City": "Wausau",
"State": "WI",
"PostalCode": "54401"
},
"Is65OrOlder": false
},
"CoApplicant": null,
"Context": {
"SerializationVersion": 1,
"State": "AL",
"Language": {
"LanguageType": "English",
"Name": "en-US",
"Id": 1
}
},
"FinancialInformation": {
"SerializationVersion": 1,
"ProductCode": "WATERTREAT",
"SellingPrice": 10000.0,
"DownPayment": 1000.0,
"DocumentFee": null,
"CompletionPayment": 0.0,
"SalesTax": {
"SerializationVersion": 1,
"IsIncluded": false,
"TaxAmount": null
},
"TotalAmountFinanced": 9000.0
},
"TradeIns": [],
"Terms": {
"SerializationVersion": 1,
"CreditType": "ClosedEnd",
"PaymentTerm": "TwentyFourMonths",
"PaymentFactor": null,
"PaymentFactorReal": null,
"CompletionDate": "2022-04-12T00:00:00",
"TentativeCompletionDate": "2022-04-06T00:00:00"
},
"CustomDealerInformation": {
"SerializationVersion": 1,
"SourceDealerId": 99,
"Name": "HOME IMPROVEMENT ORBIT TEST FILE",
"Address": {
"SerializationVersion": 1,
"Address1": "1 CORPORATE DRIVE STE 300",
"Address2": "",
"City": "WAUSAU",
"State": "WI",
"PostalCode": "54401"
},
"Phone": {
"SerializationVersion": 1,
"PhoneNumberType": "Home",
"AreaCode": "715",
"CentralOfficeCode": "555",
"StationNumber": "5555",
"IsPrimary": true
},
"IsOpenSaturday": false
},
"SubmitNumber": "E000109654",
"AssignedUserId": 9,
"AssignedSalesRepresentativeName": null,
"Status": "Approved",
"CreateDateUtc": "2022-04-01T14:09:39.92",
"ModifyDateUtc": "2022-04-12T21:31:55.24",
"DeleteDateUtc": null,
"IsActive": false,
"RtcDate": "2022-04-19T21:31:55.24",
"RiskTier": 1,
"OriginalCreditType": null,
"ProjectNumber": "123abc",
"Events": []
}Endpoint Access
Users must require permission to access Broker API endpoints due to a recently implemented security model. If a response is incorrectly stating:
"Endpoint has been disabled for the current user" please contact the Aqua Finance Web Development team.