API Changelog
2025/03/19
Minor Changes
Added validation to block invalid paperwork submissions. If the amount financed has changed since application submission, and the user does not get promotions with the new amount financed before submitting paperwork, the paperwork submission will be blocked in order to prevent incorrect paperwork.
Versions: v3
Payloads and Responses: Payloads and Responses
2025/02/23
Minor Changes
Added In the Get Application Status endpoint, AmountApproved will be rounded up to 2 decimals.
Versions: v3
Payloads and Responses: Payloads and Responses
Minor Changes
Added DealerFee in the Get Promotion endpoints.
Versions: v3
Payloads and Responses: Payloads and Responses
Minor Changes
Bugfix adding max length validation to CurrentEmployer field in Submit Loan application Endpoint.
Versions: v3
Payloads and Responses: Payloads and Responses
2025-01-12
Minor Changes
In the Get Application Status endpoint, AmountApproved now has a maximum value of 100,000.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2024-12-16
Minor Changes
Modified validation for mailing and installation city when submitting loan application or paperwork. City can only contain characters A through Z, period, hyphen, space, or apostrophe.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
2024-10-30
Minor Changes
Added endpoint to stage fund an application.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
Added more fields in various endpoint responses in preparation for future versions, such as the new DealerId(DealerNumber will be legacy), LongApplicationStatus(more detailed status of application), and adding more messages to the Status responses. When submitting requests, please continue to use the ID for the dealer provided by Aqua upon integration launch. The new DealerId does not replace the ID provided by Aqua for API requests, it replaces the DealerNumber field. These are only additional fields in responses. Data sent into endpoints will remain the same and changes from integrators will not be necessary.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Default the ProductOrService on paperwork to the same value that was used during application creation.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
Added dealer validation for states.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2024-09-04
Minor Changes
Added installation address fields to the Applicant when submitting a loan application.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
2024-08-05
Minor Changes
Added the approved amount to the Get Application Status and Get Application Statuses Since requests.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
Added field for FullTerms which indicates the full length of the promotion term. This field is differentiated from the Terms field as Terms can contain the value of the secondary promotion's terms if applicable.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2024-07-15
Minor Changes
The routing number in ACH cannot start with a number 5.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2024-06-24
Minor Changes
Added field for FullTerms which indicates the full length of the promotion term. This field is differentiated from the Terms field as Terms can contain the value of the secondary promotion's terms if applicable.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2024-06-03
Minor Changes
The signature date will be limited to a maximum of 15 days into the future and user can't backfill.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
2024-04-22
Minor Changes
Amount Requested and Approved are included in the payload response. The work is done as part of the 120% amount approved. The amount approved is 120% of the amount requested.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Minor Changes
Added risk tier value to the application status endpoint response.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
2024-03-11
Minor Changes
Fixed the risk tier in the application detail endpoint response.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
2024-02-19
Minor Changes
Revolving applications will not be accepted going forward. Any revolving application submitted will be converted to a closedend.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
2024-01-29
Minor Changes
Modified validation for the Amount Financed in Financing Parameters during the submission of loan applications. The Amount Financed must be equal to or less than $1,000.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2024-01-08
Minor Changes
Modified validation for the Amount Financed in Financing Parameters during the submission of loan applications. The Amount Financed must be equal to or less than $100,000.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2023-12-11
Minor Changes
Added new YearsOfIncomeFromCurrentSources field to loan application. This field will override any data entered in to EmploymentYear/EmploymentMonth. Value must be between 0 and 99 years.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
Paperwork submission for a pending application is not permitted.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
Modified error message for occupation start date must be 16 years greater than the birth date. Years of Income must be 16 years greater than Birth Date.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Minor Changes
A past date for signature date is not permitted when submitting a paperwork. The signature date must be the current or a future date.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
2023-11-20
Minor Changes
Modified validation for username when creating or updating user. Username may consist of alphanumeric and period.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2023-10-09
Minor Changes
The Sales Tax and Tradein from the LoanParameters information are deprecated but can be included as optional properties.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
The CurrentEmployer and EmploymentType from the Applicant/CoApplicant information are deprecated but can be included as optional properties. The AdditionalIncomeSources amounts will be combine with the GrossMonthlyIncome.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Minor Changes
The IdentificationType, IdentificationNumber, IsIssueDatePresent, IdentificationIssueDate, IsIssueStatePresent, IdentificationState, ExpirationDateUnavailable and IdentificationExpirationDate from the Applicant/CoApplicant information are optional.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
2023-04-03
Minor Changes
The IsIssueDatePresent and IsIssueStatePresent from the applicant and co-applicant objects are deprecated and will be remove in a future release. The Unavailable identification is no longer accepted. Application and paperwork submissions must have a nonexpired identification type.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
2023-03-13
Minor Changes
Added ACH only signature information to application detail response.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
The [] or a null can be used for AdditionalIncomeSources when there is no other income.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
2023-01-30
Minor Changes
Added new flags to allow Applicant or CoApplicant or Both to Sign the ACH Only eSign paperwork.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
The PaymentFrequency, PaymentAmount, DayOfMonthForFirstWithdrawal, DayOfMonthForSecondWithdrawal, and MonthToWithdrawFirstPayment from the payment information are deprecated and will be remove in a future release.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
The Name, Address, and AccountType from the bank information are deprecated and will be remove in a future release.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
2022-10-24
Minor Changes
Added a new FAQ page to address commonly asked questions and issues users may encounter while consuming the API.
Versions: v3 only
New Page: FAQs
2022-10-03
Minor Changes
Modified the validation for Additional Income amount and Gross Monthly Income. Additional Income amount is now limited to $1,000,000 or less. The total income (Gross Monthly Income + Additional Incomes) is limited to $1,000,000 or less when submitting a loan application.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Minor Changes
Added a new IsNonTaxableIncome property to the Income array object when submitting a loan application. The IsNonTaxableIncome property can accept either a true or false value. The default is false. When the value is true, the income amount is multiplied by 1.25. The property is optional and backward compatible with earlier versions.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
2022-09-12
Major Changes
Added new dealer document upload endpoint so dealers can now upload documents in a similar way to supporting document upload feature.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for Suffix when submitting loan application. In the past, the dealer can enter any character but now it accepts only enum values and is case-sensitive.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
2022-08-15
Minor Changes
Supporting document upload will now allow letters of any case for the file type. In the past, the file type characters were required to be all lowercase.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2022-07-27
Minor Changes
Improved validation for AssignedUserEmailAddress when submitting loan application. Remove the built in email address validator and replace with a custom one to check for both parts username and domain.
Versions: v2/v3
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for TradeInDescription when submitting loan application or paperwork. The maximum length is reduced to 10 from 11.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for Dealer Name in the Signature object when submitting paperwork. The maximum length is reduced to 100 from 150. This is a requirement from Docusign.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
2022-07-06
Major Changes
Added signatures array to the application detail endpoint in which the Broker can receive paperwork signature information.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for Identification Issue Date when submitting loan application. The issue date must be after the date of birth.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for AssignedUserEmailAddress when submitting loan application. Assigned user defaults to AFI User when AssignedUserEmailAddress field is not sent in payload or is an empty string or is not found in the system.
Versions: v2/v3
Payloads and Responses: Payloads and Responses
2022-06-13
Minor Changes
Modified the validation for HasCoApplicant when submitting application. CoApplicant object must be present if HasCoApplicant is true, otherwise false.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
2022-05-24
Minor Changes
Added validation for AdditionalIncomeSources.Description in the AdditionalIncomeSources array when submitting loan application. The Description can be maximum 20 characters long.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Minor Changes
Added validation for Home Value when submitting loan application. The home value is not allowed when residence type is Rent.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Minor Changes
Added flag to allow Applicant or CoApplicant or Both to Sign the LCC Only digital paperwork. The values default to true for both, but can be set to false for one or the other.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2022-05-02
Major Changes
Added push notification for dealer integrators to receive notification on Application or Signature updates.
Versions: Agnostic
Payloads and Responses: Payloads and Responses
Major Changes
Added an application endpoint in which the Broker can recieve detailed information about a specificed loan application. The loan application detail endpoint will retreive all information about the specified loan application, essentially combining the loan application submission response, the get application status repsonse, and the get application history response. This is useful to detect changes in an application when utilizing the Push Notification system.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Fixed bug in which the latest RTC date was not showing on the Get Status and Get Statuses Since endpoints.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for First Name when submitting loan application or paperwork. First name cannot contain all hyphens.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for Last Name when submitting loan application or paperwork. Last name cannot contain all hyphens.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Applied validation for Address1 when submitting loan application or paperwork. Address1 cannot contain all hyphens.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Applied validation for Address2 when submitting loan application or paperwork. Address2 cannot contain all hyphens.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for City when submitting loan application or paperwork. City can only contain characters A through Z, period, hyphen, or space.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Applied validation for Home Value when submitting loan application or paperwork. Home value must be greater than zero.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for Issued State when submitting loan application or paperwork. Identification Issued State is not allowed for a ID type of Unavailable.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for Issued Date when submitting loan application or paperwork. Identification Issued Date is not allowed for a ID type of Unavailable.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for Expiration Date when submitting loan application or paperwork. Expiration Date is not allowed for a ID type of Unavailable.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
2022-04-11
Minor Changes
Modified validation for Sales Tax when submitting loan application or paperwork. The Sales Tax amount cannot be greater than the selling price.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for identification number when submitting loan application or paperwork. The field can contain alpha, numeric, hyphen or a space. The maximum length is reduced to 20 from 50 alphanumeric combination total. When the property is empty or null and the IdentificationType is anything besides Unavailable, Broker will return a 400 Bad Response stating: "ID Number is required.”
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Fixed bug in which the dealer's docusign email preference was not being respected. The dealer's docusign email preference will now overwrite what is sent for Signature.Dealer.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for ProductLineItems.Description when submitting paperwork. ProductLineItems.Description must contain at least one alpha character. This validation applies for every object in the ProductLineItems array.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2022-03-21
Major Changes
Added validation to check a dealers preferences and see if they are able to submit paperwork or loan applications for loan types "Closed End" or "Revolving". Must specify a loan type that is valid for the dealers preferences when creating paperwork or loan application.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Major Changes
Added/Updated rules and validation messages for SSN, Employment Year, Residence Type, Primary/Secondary Phone Numbers, Issue State.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Major Changes
Added an endpoint in which the broker actor can submit a project number for an application. The submitted string must be 30 characters or less.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Major Changes
Added ProjectNumber field to Application Status and Application Statuses Since responses. If a value has not been set, ProjectNumber will be null.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
Fixed a bug in which the Broker actor could not disable a user with an invalid phone number.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for Identification State, Issue Date, Expiration Date when submitting loan application. Applicant has a (state, expiration, issue) and select "Not Present" that the validation does not allow invalid combinations.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Minor Changes
Modified validation for completion date when submitting loan application. Completion Date can't be in the past.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Minor Changes
Added/Updated rules to validate expired applications.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2022-02-21
Major Changes
A valid PaperworkDocumentEnum must be provided in the body of the request to denote which documents will be resent.
Versions: v3 only
Endpoints affected: Payloads and Responses
Major Changes
Added new endpoint for getting the attestation status for all of the requested user's dealers.
Versions: v3 only
Endpoints affected: Payloads and Responses
Minor Changes
First or last names must consist only of characters (a-z, A-Z), hyphen, or space.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2022-01-31
Major Changes
Addition of Application History endpoint.
Versions: v3 only
Endpoints affected: Payloads and Responses
Minor Changes
Ability to disable the Welcome Email upon user creation.
Versions: v3 only
Payloads and Responses: No change.
Minor Changes
Improved validation for dealer role when creating or updating a user.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
Returns a 400 status if applicationId is invalid format.
Versions: v1 only
Payloads and Responses: Payloads and Responses
Minor Changes
Remove the built in email address validator. Added a custom email address validator to check for both parts username and domain.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
Minor Changes
First or last names must consist only of characters (a-z, A-Z) or a space.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2022-01-09
Minor Changes
Improved validation for date of birth when submitting loan application. Occupation Start date must be 16 years greater than Birth Date.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
2021-12-05
Major Changes
Addition of Resend Documents endpoint for paperwork.
Versions: v3 only
Endpoints affected: Payloads and Responses
Minor Changes
Validation to prevent performing paperwork operations on a Cancelled application.
Versions: v3 only
Payloads and Responses: No change.
Minor Changes
Update to LoanApplication documentation format.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
Addition of RTC Date (Right to Cancel) on the application status response.
Versions: v3 only
Payloads and Responses: Response 1 Response 2
Minor Changes
Allow ExpirationDateUnavailable to be set to true when the Identification Type is 'StateID'.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2021-10-24
Minor Changes
Improved validation for city in the applicant and co-applicant addresses when submitting loan application. City can only contain characters A through Z, period, hyphen, or space. City can be maximum 25 characters long.
Versions: v1/v2/v3
Endpoints affected: Payloads and Responses
Minor Changes
Improved validation for city in the applicant, co-applicant, dealer, payment bank, and loan completion certificate addresses when submitting paperwork. City can only contain characters A through Z, period, hyphen, or space. City can be maximum 25 characters long.
Versions: v3 only
Endpoints affected: Payloads and Responses
Minor Changes
During the submission of paperwork, Canadian addresses are now allowed(For the Dealer only). The Dealer address can now be a Canadian address. The state must be one of the Canadian province's abbreviations and the PostalCode must be a valid Canadian postal code.
Versions: v3 only
Endpoints affected: Payloads and Responses
2021-07-15
Minor Changes
Corrected an issue with special APRs in certain cases for Closed End paperwork.
Versions: v3 only
Endpoints affected: Paperwork Submission (v3 only)
2021-07-07
Minor Changes
Users can now use the AssignedUserEmailAddress field in any case. Previously the case had to match the user's email during the initial user's creation.
Versions: v2/v3
Endpoint affected: Application Submission
Payloads and Responses: Payloads and Responses
2021-05-23
Minor Changes
Users will no longer be able to interact with dealers that are not in an Approved or Hold status.
Versions: v1/v2/v3
Endpoints affected:
- Get All Dealers will no longer return dealers that are not in an
ApprovedorHoldstatus. - The following endpoints will return a 401 Unauthorized Exception instead of a successful payload when using a non-approved dealer.
- Application Submission
- Paperwork Submission (v3 only)
- Get Products for Dealer
- Validate Email For Dealer (v2/v3 only)
2021-03-29
Minor Changes
Improved validation for primary and secondary phone numbers. Phone number must not start with 0 or 1, and must not contain special characters. Must be valid for "^[2-9][0-9]*$.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
2021-03-08
Major Changes
When submitting full paperwork the Tradeins array has be removed and replace with TradeInAmount and TradeInDescription properties.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
New validation for middle initial. Must be valid for ^[a-zA-Z]*$. Maximum length is 1 character.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Minor Changes
New validation for Primary and secondary phone numbers. Primary and secondary phone numbers cannot be the same.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Minor Changes
New validation for Primary and secondary phone numbers. Primary and secondary phone numbers cannot be the same.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2021-02-22
Minor Changes
New validation for first and last name. Must be valid for ^[a-zA-Z\s\-]*$. Maximum length is 40 characters.
Versions: v1/v2/v3
Payloads and Responses: Payloads and Responses
Minor Changes
Improved validation for first and last name. Max length updated from 100 to 40 characters.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2021-02-11
Minor Changes
New optional response property for ACH signature type that indicates if dealer reviewed documents.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Payloads and Responses: Payloads and Responses
2020-12-06
Major Changes
Endpoint to return promotion(s) based on query parameters.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2020-11-03
Major Changes
Endpoint to return current information about an Application for Paperwork purpose.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
Various validation enforcements for paperwork submission.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2020-10-08
Major Changes
Allow Broker agent to download submitted/generated paperwork from AFI systems.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Minor Changes
Allow Broker agent to retrieve document signing status for paperwork submissions through Broker. Our signing mechanism is Docusign.
Versions: v3 only
Major Changes
Allow Broker agent to retrieve Docusign linkage and SSO through AFI Docusign so that users can complete document signing.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Major Changes
Allow Broker agent to submit paperwork on behalf of a user for an approved loan application.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Major Changes
Allow Broker agent to retrieve the list of uploaded supporting documents.
Versions: v3 only
Payloads and Responses: Payloads and Responses
Major Changes
Allow Broker agent to upload supporting documents.
Versions: v3 only
Payloads and Responses: Payloads and Responses
2020-09-17
Minor Changes
Allow Broker clients to reassign applications through Broker similar to how a privileged portal user can.
2020-08-16
Major Changes
Clients can now Create/Read/Update/Delete Orbit user. This is new functionality associated with only v3 that replaces and expands upon the CSV upload process for interacting with Orbit users.
Minor Changes
When submitting an application with an applicant that is in any status but employed, the employment fields must be null. This clears up the issue where if the user was unemployed, retired etc. To submit additional income such as Retirement/SSI or others, please provide that information in the defined AdditionalIncome payload block. These changes apply to all versions.
Exception: For self-employed, GrossMonthlyIncome must be greater than 0.
- Changes to Payload: When submitting an employment status of SelfEmployed
"CurrentEmployer": null, "CurrentEmployerPhoneNumber": null
When submitting an employment status of Unemployed or Retired"CurrentEmployer": null, "CurrentEmployerPhoneNumber": null, "Occupation": null, "EmploymentMonth": null, "EmploymentYear": null, "GrossMonthlyIncome": null