EBOA.WebApi
Object
applicationId
string
uuid
Example:
00000000-0000-0000-0000-000000000000
externalReferenceId
string
External partner id to reference an application.
referenceNumber
integer
int64
applicationStatus
string
Enumeration:
new
prequalified
approved
transferredToLender
referToLender
documentDeliveryMethod
string
Enumeration:
deliveredToContractor
electronic
paper
programPhoneNumber
string
loanCode
string
contractorNumber
integer
int32
applicant
coApplicant
disbursements
Array
number
double
lastContactDate
string
date-time
nextContactDate
string
date-time
Object
firstName
string
lastName
string
suffix
string
birthDate
string
date-time
socialSecurityNumber
string
phoneNumber
string
emailAddress
string
employmentStatus
string
Enumeration:
employed
selfEmployedUnder2Years
selfEmployedOver2Years
unemployed
retired
employerName
string
employerPhone
string
employerPhoneExtension
string
annualIncome
number
double
ownership
string
Enumeration:
occupant
owner
mailingAddress
consentReceived
boolean
Object
address
propertyType
string
Enumeration:
singleFamily
multiFamily
townhouse
condominium
mobile
acquisitionType
string
Acquisition type of property.
Work in progress. Note that the actual posted value may not be returned for this field. This field has value of Purchase for applications created with an acquisition type of Purchase and a solar project.
Enumeration:
purchase
lease
estimatedCost
number
double
monthlyMortgagePayment
number
double
projectType
Object
externalReferenceId
string
callbackUrl
string
programPhoneNumber
string
required
loanCode
string
required
contractorNumber
integer
int32
required
applicant
coApplicant
documentDeliveryMethod
string
Enumeration:
deliveredToContractor
electronic
paper
nextContactDate
string
date-time
disbursements
Array
number
double
Object
firstName
string
required
lastName
string
required
suffix
string
birthDate
string
date-time
socialSecurityNumber
string
phoneNumber
string
required
emailAddress
string
employerName
string
employerPhone
string
employerPhoneExtension
string
employedByContractor
boolean
mailingAddress
annualIncome
number
double
employmentStatus
string
Enumeration:
employed
selfEmployedUnder2Years
selfEmployedOver2Years
unemployed
retired
ownership
string
required
Enumeration:
occupant
owner
consentReceived
boolean
Object
projectTypeId
integer
int32
brandId
integer
int32
acquisitionType
string
Enumeration:
purchase
lease
address
propertyType
string
Enumeration:
singleFamily
multiFamily
townhouse
condominium
mobile
estimatedCost
number
double
monthlyMortgagePayment
number
double
Application status information
Object
applicationId
string
uuid
Example:
00000000-0000-0000-0000-000000000000
status
string
Enumeration:
new
prequalified
approved
transferredToLender
referToLender
applicationNumber
integer
int64
loanAmount
number
double
Object
totalItems
integer
int32
Total number of items found for the given resource
pageNumber
integer
int32
Current paged result page number
pageSize
integer
int32
Current paged result page size
results
Curent paged result page of results
totalPages
integer
int32
Total number of paged result pages for given resource
Object
errors
Object
totalItems
integer
int32
Total number of items found for the given resource
pageNumber
integer
int32
Current paged result page number
pageSize
integer
int32
Current paged result page size
results
Curent paged result page of results
totalPages
integer
int32
Total number of paged result pages for given resource
Object
results
Object
service
string
database
applicantVerification
creditReport
status
string
healthy
boolean
timestamp
string
date-time
Object
programPhone
string
loanCode
string
contractorNumber
integer
int32
sponsorProgramID
integer
int32
sponsorID
integer
int32
contractorID
integer
int32
isDefaultProduct
boolean
requestedAmountOK
boolean
maxApproval
boolean
comboProducts
disbursementRule
projectTypes
documentDeliveryMethods
Array
string
Enumeration:
deliveredToContractor
electronic
paper
salespersons
propertyTypeCreditParams
Object
projectTypeId
integer
int32
name
string
leasable
boolean
brands
Object
totalItems
integer
int32
Total number of items found for the given resource
pageNumber
integer
int32
Current paged result page number
pageSize
integer
int32
Current paged result page size
results
Curent paged result page of results
totalPages
integer
int32
Total number of paged result pages for given resource
Settings model
Object
service
string
Which service the settings came from
configuration
Object
isDefaultProduct
boolean
requestedAmountOK
boolean
maxApproval
boolean
comboProducts
disbursementRule
projectTypes
documentDeliveryMethods
Array
string
Enumeration:
deliveredToContractor
electronic
paper
salespersons
GET
/api/health
Request parameters
api-version
string
optional
The requested API version
Default:
1.0
Request body
Responses
200
200
OK
503
503
ServiceUnavailable
GET
/api/health/database
Request parameters
api-version
string
optional
The requested API version
Default:
1.0
Request body
Responses
200
200
OK
GET
/api/settings
Request parameters
api-version
string
optional
The requested API version
Default:
1.0
Request body
Responses
200
200
OK
GET
/api/v1/applications
Request parameters
applicationNumber
string
optional
firstName
string
optional
lastName
string
optional
socialSecurityNumber
string
optional
phoneNumber
string
optional
applicationStatus
string
optional
sortParameters
string
optional
pageNumber
integer
int32
optional
Default:
1
pageSize
integer
int32
optional
Default:
30
Request body
Responses
200
200
OK
Body
application/json
text/json
400
400
BadRequest
POST
/api/v1/applications
This method allows for and checks for a null input object. The expectation (which is questionably sound) is to return a “new” empty unpersisted application.
Request body
application/json
text/json
application/x-www-form-urlencoded
Responses
200
200
OK
GET
/api/v1/applications/
{id}Path variables
id
string
uuid
required
Request body
Responses
200
200
OK
PUT
/api/v1/applications/
{id}Path variables
id
string
uuid
required
Request body
application/json
text/json
application/x-www-form-urlencoded
Responses
200
200
OK
POST
/api/v1/applications/
{id}/idverificationPath variables
id
string
uuid
required
Request body
application/json
text/json
application/x-www-form-urlencoded
Responses
200
200
OK
POST
/api/v1/applications/
{id}/offerselectionPath variables
id
string
uuid
required
Request body
application/json
text/json
application/x-www-form-urlencoded
Responses
200
200
OK
GET
/api/v1/applications/
{id}/statusPath variables
id
string
uuid
required
Request body
Responses
200
200
OK
POST
/api/v1/applications/
{id}/submissionPath variables
id
string
uuid
required
Request body
application/json
text/json
application/x-www-form-urlencoded
Responses
200
200
OK
GET
/api/v1/brands
Request parameters
pageNumber
integer
int32
optional
Default:
1
pageSize
integer
int32
optional
Default:
30
Request body
Responses
200
200
OK
GET
/api/v1/loanproducts
Request parameters
programPhone
string
required
loanCode
string
required
loanAmount
number
double
required
contractorNumber
integer
int32
required
Request body
Responses
200
200
OK
404
404
NotFound
GET
/api/v1/projecttypes
Request parameters
pageNumber
integer
int32
optional
Default:
1
pageSize
integer
int32
optional
Default:
30
Request body
Responses
200
200
OK
GET
/api/v1/propertytypecreditparameters
Request body
Responses
200
200
OK
Body
application/json
text/json
GET
/api/v1/settings
Request body
Responses
200
200
OK
GET
/api/v1/sponsorprograms/
{programphonenumber}/{loancode}/{contractornumber}Path variables
programPhoneNumber
string
required
Sponsor program phone number
loanCode
string
required
Sponsor program loan code
contractorNumber
integer
int32
required
Contractor number, associated with identified sponsor
Request parameters
estimatedProjectCost
number
double
optional
Optional estimated project cost to validate
Request body
Responses
200
200
OK
404
404
NotFound