Postman

The Broker API utilizes Postman significantly for API exploration and testing, including support for multiple environments, access to all endpoints, and just-in-time encryption/decryption. This will be the primary means by which you interact with the Broker API to test and validate your implementations. To setup your Postman workspace to use the Broker API you will have to import the environment and collection postman files that will be provided to you by Aqua Finance. Once those files have been imported you will have the ability to use the Broker API.

Environments

The Broker API collection contains two distinct environments, though you can and should duplicate them for your own uses.

Environment	Purpose
Broker API :: Stage	A pre-production testing environment. All implementations must be tested and validated in this environment prior to production use.
Broker API :: Production	A production environment. All implementations must be tested and validated in your Broker API :: Stage environment prior to use in production.

Variables

The Broker API collection makes extensive use of Postman variables. These are typically set at the "Environment" level and can be used in the GET/POST URL, example URL variables are: serviceBasePath and uriAuthority. You should not have a need to update these values; they will be substituted at runtime to construct the appropriate request URL. In the event you need to update a variable, this is done by clicking the eye icon that is next to the environment drop down, this will open a window with the variable names and the Initial Value, and the current value. Should you wish to change a variables value, you can change the Current Value by selecting the edit icon for that variable this will then update that variables value.

Sending Requests

Once you have imported the Broker API Postman collection file you will have three folders under the "Broker API" collection. The Applications folder contains endpoints for submitting an application and getting an application status. The Dealers folder contains an endpoint for getting Dealers. The Testing folder contains endpoints for encoding/encrypting application submissions (JWE format) and for decoding/decrypting JWEs. Please note that when sending a POST request, the body must have a Content-Type of JSON and be set to raw in the Postman body options.

IMPORTANT: Broker API :: Stage environment and any Testing endpoints must be used with non-PII data only..

Payload

In order to send a valid "Submit An Application" payload, Applicant and LoanParameters must be included with their required fields.

Applicant Fields

Note: All of these fields apply for Applicant as well. However, Application Relationship is exclusive to CoApplicant and cannot be used for Applicant. Bold fields indicate required fields for the minimum payload to be sent. CoApplicant is not required in the payload.

ApplicantRelationship (Co-Applicant Only)
IdentificationType 
IdentificationNumber   
IsIssueDatePresent       
IsIssueStatePresent  
ExpirationDateUnavailable     
IdentificationExpirationDate       
IdentificationIssueState       
EmploymentType       
CurrentEmployer      
CurrentEmployerPhoneNumber      
Occupation      
EmploymentMonth     
EmploymentYear      
GrossMonthlyIncome       
AdditionalIncomeSources        
    AdditionalIncomeSource           
    Description            
    Source            
    Amount
    IsNonTaxableIncome     
ResidenceType       
Payment       
HasCoApplicant       
HomeValue       
FirstName     
MiddleInitial       
LastName       
Address1       
Address2     
City      
State     
PostalCode       
EmailAddress       
PrimaryPhone      
PrimaryPhoneType      
SecondaryPhone       
SecondaryPhoneType       
SocialSecurityNumber       
DateOfBirth

Loan Parameter Fields

Note: All fields mentioned below are required for a valid payload.

CreditType
ContractState
ContractLanguage
ProductOrService
SellingPrice
AmountFinanced
PaymentFactor (Revolving only)
RepaymentTerms (ClosedEnd only)
DealerId

Versioning

Additionally, the feature folders are nested with version folders. The current version is v2. As new versions are added they will appear within the feature folders.

Tests

All requests include tests that execute with every request. Your responses should pass all tests before being promoted to the Production environment.