API Reference
APIs by Provider
>
LoanVantage
>
API Reference
{
"openapi": "3.0.1",
"info": {
"version": "1.0",
"title": "LoanVantage Open API",
"description": "A collection of services for integration with LoanVantage.",
"contact": {
"name": "LoanVantage Open API @ Jack Henry and Associates, inc. ",
"email": "LoanVantageOpenAPI@jackhenry.com"
}
},
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/v1/institutions/{InstitutionId}/environments/{EnvironmentId}/products/{ProductId}/Application/{Id}": {
"get": {
"tags": [
"Application"
],
"description": "API to retrieve metadata about an application record from the LoanVantage Application Staging tables. For security purposes, it returns limited applicant information",
"operationId": "ApplicationInquire",
"parameters": [
{
"name": "Content-Type",
"description": "The Content-Type entity header is used to indicate the media type of the resource. In responses, a Content-Type header tells the client what the content type of the returned content actually is. In requests, (such as POST or PUT), the client tells the server what type of data is actually sent.",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "X-Request-ID",
"in": "header",
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-Correlation-ID",
"in": "header",
"description": "Returned X-Request-ID",
"schema": {
"type": "string"
}
},
{
"name": "X-AuditUserId",
"in": "header",
"description": "This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information.",
"schema": {
"type": "string",
"example": "UserId/UserName"
}
},
{
"name": "X-AuditDeviceId",
"in": "header",
"description": "This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address.",
"schema": {
"type": "string",
"example": "192.168.0.101"
}
},
{
"name": "X-BusinessCorrelationId",
"in": "header",
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-WorkflowCorrelationId",
"in": "header",
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-AuthenticationUserCredential",
"in": "header",
"description": "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>`",
"schema": {
"type": "string",
"example": "jwt:<GeneratedOidcJwt>"
}
},
{
"name": "X-AuthenticationProductCredential",
"in": "header",
"description": "Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as \"Authorization\" jwt unless the message is sent \"on-behalf-of\" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>`",
"required": true,
"schema": {
"type": "string",
"example": "jwt:<GeneratedOidcJwt>"
}
},
{
"name": "X-FaultOverride",
"in": "header",
"description": "Determines if all faults should be override",
"schema": {
"type": "string",
"default": false
}
},
{
"name": "InstitutionId",
"in": "path",
"description": "The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. API usage requires a valid value that is recognized by the API Gateway and the provider of services. The value will be provided by Jack Henry personnel when granting API access to a consumer. <br>Example: `123456789`",
"required": true,
"schema": {
"type": "string",
"default": "",
"examples": [
"123456789"
]
}
},
{
"name": "EnvironmentId",
"in": "path",
"description": "Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.",
"required": true,
"schema": {
"type": "string",
"default": "PROD"
}
},
{
"name": "ProductId",
"in": "path",
"description": "Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-productname`",
"required": true,
"schema": {
"type": "string",
"example": "jha-loanvantage",
"default": "jha-loanvantage"
}
},
{
"name": "Id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. <br>Returns an application record",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Messages": {
"description": "Indicating messages/faults/errors returned",
"schema": {
"type": "boolean",
"default": false
}
},
"X-BusinessCorrelationId": {
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-WorkflowCorrelationId": {
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"MessageStatus": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
},
"IDApplication": {
"type": "string",
"format": "uuid"
},
"applicationNumber": {
"description": "Friendly non-UUID identifer for the application. Typically displayed for applicant reference.",
"type": "string"
},
"actionCode": {
"description": "Indicates type of action for loan, e.g., New, Refinance, etc.<BR><BR> Must match Action Code for a New Loan Request as set up in LoanVantage by FI.",
"maxLength": 5,
"type": "string"
},
"amountRequested": {
"description": "Amount of Loan Requested",
"pattern": "^\\$?([0-9]{1,3},([0-9]{3},)*[0-9]{3}|[0-9]+)(.[0-9][0-9])?$",
"type": "number",
"format": "double"
},
"productType": {
"description": "Must match valid Product Code in LoanVantage. <BR><BR> Products can be different per FI.",
"maxLength": 10,
"type": "string"
},
"purposeCode": {
"description": "Must match valid Purpose Code in LoanVantage. <BR><BR> Purposes Codes can be different per FI.",
"maxLength": 5,
"type": "string"
},
"specificPurpose": {
"description": "Free form description of purpose of loan",
"maxLength": 100,
"type": "string"
},
"partyApplicants": {
"description": "Contains limited information on the Applicants",
"type": "array",
"items": {
"required": [
"IDApplicant",
"partyType",
"roleType",
"fullName"
],
"type": "object",
"properties": {
"IDApplicant": {
"description": "Unique Identifier for the Applicant. <BR><BR>If not provided, LoanVantage will generate it and return in the response.",
"type": "string",
"format": "uuid"
},
"partyType": {
"description": "Indicates if the applicant is Personal or Business type.",
"enum": [
"Personal",
"Business"
],
"type": "string"
},
"roleType": {
"description": "Indicates the role of the applicant to the loan.",
"enum": [
"Borrower",
"CoBorrower",
"Guarantor"
],
"type": "string"
},
"personName": {
"description": "Parsed name of person",
"required": [
"firstName",
"lastName"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 30,
"type": "string"
},
"middleName": {
"maxLength": 30,
"type": "string"
},
"lastName": {
"maxLength": 30,
"type": "string"
},
"suffix": {
"maxLength": 12,
"type": "string"
},
"prefix": {
"maxLength": 6,
"type": "string"
}
},
"additionalProperties": false
},
"fullName": {
"type": "string"
}
},
"additionalProperties": false
}
}
}
}
}
}
},
"400": {
"description": "Bad Request<hr> The server could not understand the request due to invalid syntax.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Messages": {
"description": "Indicating messages/faults/errors returned",
"schema": {
"type": "boolean",
"default": false
}
},
"X-BusinessCorrelationId": {
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-WorkflowCorrelationId": {
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized<hr> Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"403": {
"description": "Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"404": {
"description": "Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"413": {
"description": "Request Too Large<hr> Request entity is larger than limits defined by server.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"422": {
"description": "Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"500": {
"description": "Generic Internal Error<hr> The server has encountered a situation it does not know how to handle.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
},
"/v1/institutions/{InstitutionId}/environments/{EnvironmentId}/products/{ProductId}/Application": {
"post": {
"tags": [
"Application"
],
"description": "API to create a new application record in the LoanVantage Application Staging tables. <br> <br> path.InstitutionId -> 123456789 <br> <br> path.InstitutionEnvironment -> PROD, TEST, QA post <br> path.ProductId -> [Identifies the product as part of the path. i.e., jha-loanvantage] <br> <br> **Request Behavior** <br> <br> The ProductId is required <br> <br> IDApplication is not required; if it is not provided, LoanVantage will generate it and return it in the response. <br> <br> RequestTypeCode is required and must match a valid Process Code for a New Loan Request in LoanVantage. <br> <br> If CreateLeadFlag is True then the Lead structure must be provided and LoanVantage will use the information to create a lead record for the application. <br> <br> ActionCode is required and must match a valid Action Code for a New Loan Request in LoanVantage. <br> <br> SecuredBy is required and must match one of the enumerations: Cash, SecuredOther, RealEstate, or Unsecured. <br>This field indicates if the loan is to be secured or not. <br>If the loan is not secured then set this to Unsecured. <br>If the value is Cash, SecuredOther, or RealEstate then the Collateral structure is required. <br> <br> ProductType is required and must match a valid Product Code in LoanVantage. <br> <br> PurposeCode is required and must match a valid Purpose Code in LoanVantage. <br> <br> One or more Applicants is required. <br> <br> IDApplicant is not required; if it is not provided, LoanVantage will generate it and return it in the response. <br> <br> IPAddress is is required. <br> <br> PartyType is required and indicates if the party is Business or Personal. <br>If Personal then the personalApplicant structure must be provided else the businessApplicant structure. <br> <br> If the personalApplicant structure is provided then noncitizenType must be provided if usCitizenFlag = False. <br> <br> The Collateral structure must be provided if the SecuredBy field is not equal to Unsecured. <br> The Collateral structure is a OneOf structure and only one item may be provided: <br>If SecuredBy = Cash then the depositAccount structure should be provided and the CollateralCategory must equal DepositAccount. <br>If SecuredBy = SecuredOther then the titled structure should be provided and the CollateralCategory must equal Titled. Note: In the future other types of collateral will be supported for SecuredOther but for now only titled collateral is supported. <br>If SecuredBy = RealEstate then the property structure should be provided and the CollateralCategory must equal Property. ",
"operationId": "ApplicationCreate",
"parameters": [
{
"name": "Content-Type",
"description": "The Content-Type entity header is used to indicate the media type of the resource. In responses, a Content-Type header tells the client what the content type of the returned content actually is. In requests, (such as POST or PUT), the client tells the server what type of data is actually sent.",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "X-Request-ID",
"in": "header",
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-Correlation-ID",
"in": "header",
"description": "Returned X-Request-ID",
"schema": {
"type": "string"
}
},
{
"name": "X-AuditUserId",
"in": "header",
"description": "This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information.",
"schema": {
"type": "string",
"example": "UserId/UserName"
}
},
{
"name": "X-AuditDeviceId",
"in": "header",
"description": "This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address.",
"schema": {
"type": "string",
"example": "192.168.0.101"
}
},
{
"name": "X-BusinessCorrelationId",
"in": "header",
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-WorkflowCorrelationId",
"in": "header",
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-AuthenticationUserCredential",
"in": "header",
"description": "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>`",
"schema": {
"type": "string",
"example": "jwt:<GeneratedOidcJwt>"
}
},
{
"name": "X-AuthenticationProductCredential",
"in": "header",
"description": "Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as \"Authorization\" jwt unless the message is sent \"on-behalf-of\" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>`",
"required": true,
"schema": {
"type": "string",
"example": "jwt:<GeneratedOidcJwt>"
}
},
{
"name": "X-FaultOverride",
"in": "header",
"description": "Determines if all faults should be override",
"schema": {
"type": "string",
"default": false
}
},
{
"name": "InstitutionId",
"in": "path",
"description": "The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. API usage requires a valid value that is recognized by the API Gateway and the provider of services. The value will be provided by Jack Henry personnel when granting API access to a consumer. <br>Example: `123456789`",
"required": true,
"schema": {
"type": "string",
"default": "",
"examples": [
"123456789"
]
}
},
{
"name": "EnvironmentId",
"in": "path",
"description": "Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.",
"required": true,
"schema": {
"type": "string",
"default": "PROD"
}
},
{
"name": "ProductId",
"in": "path",
"description": "Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-productname`",
"required": true,
"schema": {
"type": "string",
"example": "jha-loanvantage",
"default": "jha-loanvantage"
}
}
],
"requestBody": {
"description": "request for the application APIs",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"IDApplication": {
"type": "string",
"format": "uuid"
},
"requestTypeCode": {
"description": "Request Type Code identifies the type of LoanVantage process required to process this application type. <BR> <BR>This must match a valid LoanVantage New Loan Request Process Code set up by the FI.",
"type": "string"
},
"repaymentSources": {
"type": "object",
"description": "Indicates repayment sources for loan. Typically used for commercial loans. <BR><BR> Repayment Sources must match RepaymentSourceCodes as set up in LoanVantage by FI.",
"properties": {
"repaymentSource1": {
"type": "string"
},
"repaymentSource2": {
"type": "string"
},
"repaymentSource3": {
"type": "string"
}
},
"additionalProperties": false
},
"createLeadFlag": {
"description": "If a seperate lead record is to be created for this application then this should be true. <BR><BR> If true, then the Lead structure is required in the ApplicationAddRequest. ",
"type": "boolean"
},
"actionCode": {
"description": "Indicates type of action for loan, e.g., New, Refinance, etc.<BR><BR> Must match Action Code for a New Loan Request as set up in LoanVantage by FI.",
"maxLength": 5,
"type": "string"
},
"applicationNumber": {
"description": "Friendly non-UUID identifer for the application. Typically displayed for applicant reference.",
"type": "string"
},
"amountRequested": {
"description": "Amount of Loan Requested",
"pattern": "^\\$?([0-9]{1,3},([0-9]{3},)*[0-9]{3}|[0-9]+)(.[0-9][0-9])?$",
"type": "number",
"format": "double"
},
"securedBy": {
"description": "Indicates if the loan is to be secured or not. <BR><BR> If this field is not Unsecured then CollateralAdd structure is required.",
"enum": [
"Cash",
"SecuredOther",
"RealEstate",
"Unsecured"
],
"type": "string"
},
"termLengthinMonths": {
"description": "Indicates length of loan in months.",
"type": "integer",
"format": "int32"
},
"productType": {
"description": "Must match valid Product Code in LoanVantage. <BR><BR> Products can be different per FI.",
"maxLength": 10,
"type": "string"
},
"purposeCode": {
"description": "Must match valid Purpose Code in LoanVantage. <BR><BR> Purposes Codes can be different per FI.",
"maxLength": 5,
"type": "string"
},
"specificPurpose": {
"description": "Free form description of purpose of loan",
"maxLength": 100,
"type": "string"
},
"applicants": {
"description": "Contains information on the Applicants",
"type": "array",
"items": {
"required": [
"emailAddress",
"partyType",
"roleType",
"ipAddress"
],
"type": "object",
"properties": {
"IDApplicant": {
"description": "Unique Identifier for the Applicant. <BR><BR>If not provided, LoanVantage will generate it and return in the response.",
"type": "string",
"format": "uuid"
},
"IPAddress": {
"description": "IPAddress of computer used to submit the applciation.",
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"type": "string"
},
"partyType": {
"description": "Indicates if the applicant is Personal or Business type.",
"enum": [
"Personal",
"Business"
],
"type": "string"
},
"roleType": {
"description": "Indicates the role of the applicant to the loan.",
"enum": [
"Borrower",
"CoBorrower",
"Guarantor"
],
"type": "string"
},
"taxIdentifier": {
"type": "object",
"properties": {
"tinType": {
"description": "Indicates if the TIN is a Social Security Number or an Employer Identification Number.",
"enum": [
"SSN",
"EIN"
],
"type": "string"
},
"number": {
"description": "Tax identification number.",
"type": "string"
}
},
"additionalProperties": false
},
"emailAddress": {
"description": "Email address of the Applicant.",
"type": "string"
},
"preferredPhoneType": {
"description": "Identifies the preferred phone contact type of the applicant.",
"enum": [
"Personal",
"Business",
"Mobile",
"Home"
],
"type": "string"
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"phoneType": {
"description": "Identifies the preferred phone contact type of the applicant.",
"enum": [
"Personal",
"Business",
"Mobile",
"Home"
],
"type": "string"
},
"phoneNumber": {
"maxLength": 10,
"type": "string"
}
},
"additionalProperties": false
}
},
"addressess": {
"type": "array",
"items": {
"description": "Applicant Address",
"title": "ApplicantAddress",
"required": [
"addressBlock",
"addressType"
],
"type": "object",
"properties": {
"addressType": {
"description": "Indicates if the address is Current, Previous, or Mailing.",
"enum": [
"Current",
"Previous",
"Mailing"
],
"type": "string"
},
"addressBlock": {
"required": [
"city",
"stateProvince",
"street1",
"zipCode"
],
"type": "object",
"properties": {
"street1": {
"maxLength": 50,
"type": "string"
},
"street2": {
"maxLength": 50,
"type": "string"
},
"city": {
"maxLength": 50,
"type": "string"
},
"stateProvince": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"zipCode": {
"type": "integer",
"format": "int32"
},
"county": {
"maxLength": 50,
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"personalApplicant": {
"required": [
"usCitizenFlag"
],
"type": "object",
"properties": {
"personName": {
"description": "Parsed name of person",
"required": [
"firstName",
"lastName"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 30,
"type": "string"
},
"middleName": {
"maxLength": 30,
"type": "string"
},
"lastName": {
"maxLength": 30,
"type": "string"
},
"suffix": {
"maxLength": 12,
"type": "string"
},
"prefix": {
"maxLength": 6,
"type": "string"
}
},
"additionalProperties": false
},
"dateofBirth": {
"description": "Date of Birth of the Applicant.",
"type": "string",
"format": "date"
},
"usCitizenFlag": {
"description": "Indicates if the applicant is a US Citizen or not.",
"type": "boolean"
},
"noncitizenType": {
"description": "This field is required if the usCitizenFlag is false.",
"enum": [
"NonImmigrantAlien",
"Undocumented",
"Unknown",
"PermanentResidentAlien",
"NonPermanentResidentAlien",
"NonResidentAlien"
],
"type": "string"
},
"militaryCode": {
"description": "Indicates the type of military duty of the applicant.",
"enum": [
"ActiveDuty",
"ActiveReserve",
"NotActive",
"Dependent"
],
"type": "string"
},
"maritalStatus": {
"description": "Marital Status of the Applicant",
"enum": [
"Married",
"Separated",
"Unmarried",
"Unknown"
],
"type": "string"
},
"housingStatus": {
"description": "Indicates the housing status of the applicant.",
"enum": [
"LiveWithOthers",
"Other",
"Own",
"Rent"
],
"type": "string"
},
"identification": {
"required": [
"idNumber",
"issuer",
"typeCode",
"issueDate"
],
"type": "object",
"properties": {
"typeCode": {
"description": "Type of Identification",
"enum": [
"DL",
"Passport",
"StateId",
"USCIS",
"MilitaryId"
],
"type": "string"
},
"idNumber": {
"description": "Idenification Number",
"maxLength": 30,
"type": "string"
},
"issuer": {
"description": "Name of entity that issued the identification",
"maxLength": 30,
"type": "string"
},
"expireDate": {
"description": "Date Identification will expire.",
"type": "string",
"format": "date"
},
"issueDate": {
"description": "Date Identification was issued.",
"type": "string",
"format": "date"
}
},
"additionalProperties": false
},
"employments": {
"type": "array",
"items": {
"description": "Employment Information",
"required": [
"employerName",
"employerStatus"
],
"type": "object",
"properties": {
"IDEmployment": {
"description": "Unique Identifier UUID for the Employment Object. <BR><BR> If not provided, LoanVantage will generate it.",
"type": "string",
"format": "uuid"
},
"employerName": {
"description": "Name of Employer",
"maxLength": 30,
"type": "string"
},
"employerAddress": {
"required": [
"city",
"stateProvince",
"street1",
"zipCode"
],
"type": "object",
"properties": {
"street1": {
"maxLength": 50,
"type": "string"
},
"street2": {
"maxLength": 50,
"type": "string"
},
"city": {
"maxLength": 50,
"type": "string"
},
"stateProvince": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"zipCode": {
"type": "integer",
"format": "int32"
},
"county": {
"maxLength": 50,
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"jobTitle": {
"description": "Job Title",
"maxLength": 20,
"type": "string"
},
"phoneNumber": {
"maxLength": 10,
"type": "string"
},
"employerStatus": {
"description": "Indicates if Employer is Current, Previous, or Additional. Current should be the primary employer.",
"enum": [
"Current",
"Previous",
"Additional"
],
"type": "string"
},
"employmentStartDate": {
"description": "Date employment started with this employer.",
"type": "string",
"format": "date-time"
},
"employmentType": {
"description": "Indicates type of employment, e.g., Fulltime.",
"enum": [
"Fulltime",
"Parttime",
"SelfEmployed",
"Military"
],
"type": "string"
},
"grossAnnualBaseIncome": {
"description": "Annual Gross Income provided by this employer.",
"type": "number",
"format": "double"
},
"grossAnnualBonus": {
"description": "Annual Bonus Income provided by this employer. <BR><BR> This should only be provided if consistent income.",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
},
"otherIncome": {
"description": "Identifies other steady income unrelated to employment.",
"required": [
"annualIncome",
"incomeType"
],
"type": "object",
"properties": {
"incomeType": {
"description": "Identifies the type of Other Income.",
"enum": [
"Alimony",
"Annuity",
"ChildSupport",
"DeferredCompensation",
"Disability",
"DividendsInterest",
"Other",
"RentalIncome",
"Pension",
"SocialSecurity",
"Unemployment",
"VA"
],
"type": "string"
},
"incomeDescription": {
"maxLength": 30,
"type": "string"
},
"annualIncome": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"businessApplicant": {
"description": "BusinessParty",
"title": "BusinessParty",
"required": [
"fullName"
],
"type": "object",
"properties": {
"fullName": {
"maxLength": 90,
"type": "string"
},
"dba": {
"description": "Name party does business as.",
"maxLength": 50,
"type": "string"
},
"naics": {
"description": "Must be a valid NAICS code per Census.gov.",
"type": "string"
},
"timeInBusinessMonths": {
"description": "Indicates number of months the entity has been in business.",
"type": "integer",
"format": "int32"
},
"businessDescription": {
"description": "Free form text field to explain what the business does.",
"maxLength": 1000,
"type": "string"
},
"dateFormed": {
"description": "Date the business was formed with government.",
"type": "string",
"format": "date-time"
},
"numberOfEmployees": {
"description": "Indicates the number of employees in the business.",
"type": "integer",
"format": "int32"
},
"stateBusinessLocated": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"stateFormed": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
}
},
"additionalProperties": false
},
"userDefinedField": {
"type": "array",
"items": {
"type": "object",
"properties": {
"udfName": {
"maxLength": 10,
"type": "string"
},
"udfLabel": {
"maxLength": 30,
"type": "string"
},
"udfDataType": {
"enum": [
"Checkbox",
"Date",
"Memo",
"Money",
"Percent",
"PickList",
"Text"
],
"type": "string"
},
"udfValue": {
"maxLength": 1000,
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"collaterals": {
"description": "Contains information about the collateral",
"type": "array",
"items": {
"type": "object",
"properties": {
"collateralType": {
"maxLength": 10,
"type": "string"
},
"description": {
"maxLength": 150,
"type": "string"
},
"marketValue": {
"type": "number",
"format": "double"
},
"address": {
"required": [
"city",
"stateProvince",
"street1",
"zipCode"
],
"type": "object",
"properties": {
"street1": {
"maxLength": 50,
"type": "string"
},
"street2": {
"maxLength": 50,
"type": "string"
},
"city": {
"maxLength": 50,
"type": "string"
},
"stateProvince": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"zipCode": {
"type": "integer",
"format": "int32"
},
"county": {
"maxLength": 50,
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"IDCollateral": {
"description": "Unqiue Identifer UUID for the collateral. If not provided, LoanVantage will generate it.",
"type": "string",
"format": "uuid"
},
"ownerOccupancyFlag": {
"description": "Indicates if the collateral is owner-occupied.",
"type": "boolean"
},
"userDefinedField": {
"type": "array",
"items": {
"type": "object",
"properties": {
"udfName": {
"maxLength": 10,
"type": "string"
},
"udfLabel": {
"maxLength": 30,
"type": "string"
},
"udfDataType": {
"enum": [
"Checkbox",
"Date",
"Memo",
"Money",
"Percent",
"PickList",
"Text"
],
"type": "string"
},
"udfValue": {
"maxLength": 1000,
"type": "string"
}
},
"additionalProperties": false
}
},
"collateralCategory": {
"description": "High level categorization of the Collateral. <BR><BR> If = Titled, then the Titled structure should be provided; if = DepositAccount then the DepositAccount structure should be provided.",
"enum": [
"Property",
"Titled",
"DepositAccount"
],
"type": "string"
},
"collateralDetails": {
"type": "object",
"properties": {
"property": {
"type": "object",
"properties": {
"ownerOccupancyFlag": {
"type": "boolean"
}
},
"additionalProperties": false
},
"depositAccount": {
"description": "Deposit Account Collateral.",
"required": [
"accountNumber",
"accountType",
"bankName"
],
"type": "object",
"properties": {
"bankName": {
"description": "Name of Bank where deposit account is held.",
"maxLength": 50,
"type": "string"
},
"accountType": {
"description": "Type of deposit account.",
"maxLength": 20,
"type": "string"
},
"accountNumber": {
"description": "Number of deposit account.",
"maxLength": 30,
"type": "string"
}
},
"additionalProperties": false
},
"titled": {
"description": "Titled Collateral.",
"type": "object",
"properties": {
"titledType": {
"description": "Type of titled collateral.",
"enum": [
"Vehicle",
"RV"
],
"type": "string"
},
"newFlag": {
"description": "Indicates if collateral is new or used.",
"type": "boolean"
},
"ownerOccupancyFlag": {
"description": "Indicates if collateral owner-occupied. Relevant for RV collateral.",
"type": "boolean"
},
"vehicle": {
"description": "Details on vehicle collateral.",
"required": [
"make",
"model",
"year"
],
"type": "object",
"properties": {
"make": {
"maxLength": 20,
"type": "string"
},
"model": {
"maxLength": 20,
"type": "string"
},
"year": {
"type": "string"
},
"trim": {
"maxLength": 50,
"type": "string"
},
"color": {
"maxLength": 20,
"type": "string"
},
"vin": {
"maxLength": 50,
"type": "string"
},
"mileage": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"lead": {
"type": "object",
"properties": {
"leadTypeCode": {
"description": "Must match a valid LeadTypeCode in LoanVantage. <BR><BR> These can be different per FI. ",
"type": "string"
},
"leadCategoryCode": {
"description": "Must match a valid LeadCategoryCode in LoanVantage. <BR><BR> These can be different per FI. ",
"type": "string"
},
"leadStatusCode": {
"description": "Must match a valid LeadStatusCode in LoanVantage. <BR><BR> These can be different per FI. ",
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"RequestTypeCode",
"ActionCode",
"AmountRequested",
"ProductType",
"PurposeCode",
"SecuredBy",
"Applicants"
]
}
}
}
},
"responses": {
"200": {
"description": "OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. <br>Returns an application record",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Messages": {
"description": "Indicating messages/faults/errors returned",
"schema": {
"type": "boolean",
"default": false
}
},
"X-BusinessCorrelationId": {
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-WorkflowCorrelationId": {
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"MessageStatus": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
},
"IDApplication": {
"type": "string",
"format": "uuid"
},
"applicationNumber": {
"description": "Friendly non-UUID identifer for the application. Typically displayed for applicant reference.",
"type": "string"
},
"partyApplicants": {
"description": "Contains limited information on the Applicants",
"type": "array",
"items": {
"required": [
"IDApplicant",
"partyType",
"roleType",
"fullName"
],
"type": "object",
"properties": {
"IDApplicant": {
"description": "Unique Identifier for the Applicant. <BR><BR>If not provided, LoanVantage will generate it and return in the response.",
"type": "string",
"format": "uuid"
},
"partyType": {
"description": "Indicates if the applicant is Personal or Business type.",
"enum": [
"Personal",
"Business"
],
"type": "string"
},
"roleType": {
"description": "Indicates the role of the applicant to the loan.",
"enum": [
"Borrower",
"CoBorrower",
"Guarantor"
],
"type": "string"
},
"personName": {
"description": "Parsed name of person",
"required": [
"firstName",
"lastName"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 30,
"type": "string"
},
"middleName": {
"maxLength": 30,
"type": "string"
},
"lastName": {
"maxLength": 30,
"type": "string"
},
"suffix": {
"maxLength": 12,
"type": "string"
},
"prefix": {
"maxLength": 6,
"type": "string"
}
},
"additionalProperties": false
},
"fullName": {
"type": "string"
}
},
"additionalProperties": false
}
}
}
}
}
}
},
"400": {
"description": "Bad Request<hr> The server could not understand the request due to invalid syntax.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Messages": {
"description": "Indicating messages/faults/errors returned",
"schema": {
"type": "boolean",
"default": false
}
},
"X-BusinessCorrelationId": {
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-WorkflowCorrelationId": {
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized<hr> Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"403": {
"description": "Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"404": {
"description": "Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"413": {
"description": "Request Too Large<hr> Request entity is larger than limits defined by server.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"422": {
"description": "Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"500": {
"description": "Generic Internal Error<hr> The server has encountered a situation it does not know how to handle.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
},
"/v1/institutions/{InstitutionId}/environments/{EnvironmentId}/products/{ProductId}/Documents/{documentId}": {
"get": {
"tags": [
"Document"
],
"description": "API to retrieve a document record. <br>Note: This service does not return the actual document instance but rather metadata about the document such as status and due date. <br> Note: isPortalEnabled indicates whether the document is intended to be shown on a a customer-facing document portal. If this flag is False then the document record should not be displayed to an end-customer. <br>This service currently works to inquire on a document record that is linked to an Application or Applicant during the window when the application has not been converted to a New Loan Request file. <br>In the future, this service will be expanded to work with LoanVantage files and parties. <br> <br> path.InstitutionId -> 123456789 <br> <br> path.InstitutionEnvironment -> PROD, TEST, QA post <br> path.ProductId -> [Identifies the product as part of the path. i.e., jha-loanvantage] <br> <br> **Request Behavior** <br> <br> The ProductId is required <br> <br> idFile is only applicable if the application has been converted to a LoanVantage file; this feature is not supported yet.",
"operationId": "DocumentInquire",
"parameters": [
{
"name": "Content-Type",
"description": "The Content-Type entity header is used to indicate the media type of the resource. In responses, a Content-Type header tells the client what the content type of the returned content actually is. In requests, (such as POST or PUT), the client tells the server what type of data is actually sent.",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "X-Request-ID",
"in": "header",
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-Correlation-ID",
"in": "header",
"description": "Returned X-Request-ID",
"schema": {
"type": "string"
}
},
{
"name": "X-AuditUserId",
"in": "header",
"description": "This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information.",
"schema": {
"type": "string",
"example": "UserId/UserName"
}
},
{
"name": "X-AuditDeviceId",
"in": "header",
"description": "This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address.",
"schema": {
"type": "string",
"example": "192.168.0.101"
}
},
{
"name": "X-BusinessCorrelationId",
"in": "header",
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-WorkflowCorrelationId",
"in": "header",
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-AuthenticationUserCredential",
"in": "header",
"description": "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>`",
"schema": {
"type": "string",
"example": "jwt:<GeneratedOidcJwt>"
}
},
{
"name": "X-AuthenticationProductCredential",
"in": "header",
"description": "Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as \"Authorization\" jwt unless the message is sent \"on-behalf-of\" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>`",
"required": true,
"schema": {
"type": "string",
"example": "jwt:<GeneratedOidcJwt>"
}
},
{
"name": "X-FaultOverride",
"in": "header",
"description": "Determines if all faults should be override",
"schema": {
"type": "string",
"default": false
}
},
{
"name": "InstitutionId",
"in": "path",
"description": "The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. API usage requires a valid value that is recognized by the API Gateway and the provider of services. The value will be provided by Jack Henry personnel when granting API access to a consumer. <br>Example: `123456789`",
"required": true,
"schema": {
"type": "string",
"default": "",
"examples": [
"123456789"
]
}
},
{
"name": "EnvironmentId",
"in": "path",
"description": "Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.",
"required": true,
"schema": {
"type": "string",
"default": "PROD"
}
},
{
"name": "ProductId",
"in": "path",
"description": "Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-productname`",
"required": true,
"schema": {
"type": "string",
"example": "jha-loanvantage",
"default": "jha-loanvantage"
}
},
{
"name": "documentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. <br>Returns an application record",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Messages": {
"description": "Indicating messages/faults/errors returned",
"schema": {
"type": "boolean",
"default": false
}
},
"X-BusinessCorrelationId": {
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-WorkflowCorrelationId": {
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"MessageStatus": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
},
"documentRecord": {
"required": [
"docCategory",
"docDescription",
"docEntityType",
"docName",
"docTemplateType",
"idDoc",
"primaryEntities",
"requiredDocStatus"
],
"type": "object",
"description": "Contains information about a document",
"properties": {
"idDoc": {
"description": "Unique Document Identifier UUID",
"type": "string",
"format": "uuid"
},
"idFile": {
"description": "Unique File Identifier UUID",
"type": "string",
"format": "uuid"
},
"docTemplateType": {
"description": "Unique identifier for the document template; must match valid document template type in LoanVantage",
"type": "integer",
"format": "int32"
},
"docEntityType": {
"description": "Indicates whether the document primary linkage is to a Party or a Loan.",
"enum": [
"Party",
"Loan"
],
"type": "string"
},
"primaryEntities": {
"type": "array",
"items": {
"description": "Works in conjunction with the DocumentEntityType by providing more specific context.",
"required": [
"context",
"id"
],
"type": "object",
"properties": {
"id": {
"description": "This is the UUID for the specified DocumentEntity.",
"type": "string",
"format": "uuid"
},
"context": {
"description": "Currently, documents can only be linked to an Applicant or an Application; <BR><BR> Eventually documents may also be linked to a Party or a Loan.",
"enum": [
"Applicant",
"Application"
],
"type": "string"
}
},
"additionalProperties": false
}
},
"docCategory": {
"description": "Document Category, e.g., Financial Statements; Each FI can customize their categories.",
"type": "string"
},
"docName": {
"description": "Document Name. Set up in LoanVantage Admin and cannot be changed per document.",
"type": "string"
},
"docDescription": {
"description": "Document Description; may be customized per document instance by the FI.",
"type": "string"
},
"requiredType": {
"description": "Required Document Type <br> <br> Prerequisite Documents are associated with a File and generally must be provided prior to Closing. <br> Recurring Documents are collected after closing for commercial loans, generally on a periodic basis.",
"enum": [
"Prerequisite",
"Recurring"
],
"type": "string"
},
"subjectTo": {
"description": "Subject To Flag. If true, then loan cannot be closed without this condiition being met, e.g., Subject to Appraisal",
"type": "boolean"
},
"statementDate": {
"description": "Statement Date of document to be provided.<br> <br> A prerequisite document may not always have a statement date but a recurring document will.",
"type": "string",
"format": "date"
},
"dueDate": {
"description": "Due Date of the document<br> <br> A prerequisite document may not always have a due date but a recurring document will.",
"type": "string",
"format": "date"
},
"requestedDate": {
"description": "Date the document was requested",
"type": "string",
"format": "date"
},
"receivedDate": {
"description": "Date the Document was received",
"type": "string",
"format": "date-time"
},
"requiredDocStatus": {
"maxLength": 20,
"type": "string"
},
"isPastDue": {
"description": "If true, it indicates the documetn is past due.",
"type": "boolean"
},
"quality": {
"description": "Describes the quality of the financial statement required.",
"enum": [
"Audited",
"Compiled",
"CoPrepared",
"Qualified",
"Reviewed",
"Unqualified"
],
"type": "string"
},
"isPortalEnabled": {
"description": "Indicates if the document is portal-enabled. If it is not portal-enabled, then the document should not be displayed on the customer portal.",
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
}
}
},
"400": {
"description": "Bad Request<hr> The server could not understand the request due to invalid syntax.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Messages": {
"description": "Indicating messages/faults/errors returned",
"schema": {
"type": "boolean",
"default": false
}
},
"X-BusinessCorrelationId": {
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-WorkflowCorrelationId": {
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized<hr> Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"403": {
"description": "Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"404": {
"description": "Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"413": {
"description": "Request Too Large<hr> Request entity is larger than limits defined by server.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"422": {
"description": "Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"500": {
"description": "Generic Internal Error<hr> The server has encountered a situation it does not know how to handle.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
}
}
},
"put": {
"tags": [
"Document"
],
"description": "API to update a document record with the actual document instance if it was not provided on the Document Post operation. <br> This service is not intended to allow update of other document attributes such as status as the document record is managed by LoanVantage. <br> <br> path.InstitutionId -> 123456789 <br> <br> path.InstitutionEnvironment -> PROD, TEST, QA post <br> path.ProductId -> [Identifies the product as part of the path. i.e., jha-loanvantage] <br> <br> **Request Behavior** <br> <br> The ProductId is required",
"operationId": "DocumentPut",
"parameters": [
{
"name": "Content-Type",
"description": "The Content-Type entity header is used to indicate the media type of the resource. In responses, a Content-Type header tells the client what the content type of the returned content actually is. In requests, (such as POST or PUT), the client tells the server what type of data is actually sent.",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "X-Request-ID",
"in": "header",
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-Correlation-ID",
"in": "header",
"description": "Returned X-Request-ID",
"schema": {
"type": "string"
}
},
{
"name": "X-AuditUserId",
"in": "header",
"description": "This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information.",
"schema": {
"type": "string",
"example": "UserId/UserName"
}
},
{
"name": "X-AuditDeviceId",
"in": "header",
"description": "This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address.",
"schema": {
"type": "string",
"example": "192.168.0.101"
}
},
{
"name": "X-BusinessCorrelationId",
"in": "header",
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-WorkflowCorrelationId",
"in": "header",
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-AuthenticationUserCredential",
"in": "header",
"description": "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>`",
"schema": {
"type": "string",
"example": "jwt:<GeneratedOidcJwt>"
}
},
{
"name": "X-AuthenticationProductCredential",
"in": "header",
"description": "Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as \"Authorization\" jwt unless the message is sent \"on-behalf-of\" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>`",
"required": true,
"schema": {
"type": "string",
"example": "jwt:<GeneratedOidcJwt>"
}
},
{
"name": "X-FaultOverride",
"in": "header",
"description": "Determines if all faults should be override",
"schema": {
"type": "string",
"default": false
}
},
{
"name": "InstitutionId",
"in": "path",
"description": "The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. API usage requires a valid value that is recognized by the API Gateway and the provider of services. The value will be provided by Jack Henry personnel when granting API access to a consumer. <br>Example: `123456789`",
"required": true,
"schema": {
"type": "string",
"default": "",
"examples": [
"123456789"
]
}
},
{
"name": "EnvironmentId",
"in": "path",
"description": "Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.",
"required": true,
"schema": {
"type": "string",
"default": "PROD"
}
},
{
"name": "ProductId",
"in": "path",
"description": "Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-productname`",
"required": true,
"schema": {
"type": "string",
"example": "jha-loanvantage",
"default": "jha-loanvantage"
}
},
{
"name": "documentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "request for the application APIs",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fileContent": {
"description": "Actual Bytes of Document.",
"type": "string",
"format": "byte"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. <br>Returns an application record",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Messages": {
"description": "Indicating messages/faults/errors returned",
"schema": {
"type": "boolean",
"default": false
}
},
"X-BusinessCorrelationId": {
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-WorkflowCorrelationId": {
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"MessageStatus": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
},
"idDocument": {
"description": "Unique Application Identifier UUID",
"type": "string",
"format": "uuid"
}
}
}
}
}
},
"400": {
"description": "Bad Request<hr> The server could not understand the request due to invalid syntax.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Messages": {
"description": "Indicating messages/faults/errors returned",
"schema": {
"type": "boolean",
"default": false
}
},
"X-BusinessCorrelationId": {
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-WorkflowCorrelationId": {
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized<hr> Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"403": {
"description": "Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"404": {
"description": "Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"413": {
"description": "Request Too Large<hr> Request entity is larger than limits defined by server.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"422": {
"description": "Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"500": {
"description": "Generic Internal Error<hr> The server has encountered a situation it does not know how to handle.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
},
"/v1/institutions/{InstitutionId}/environments/{EnvironmentId}/products/{ProductId}/Document": {
"post": {
"tags": [
"Document"
],
"description": "API to create a new document record. This service currently works to link a document record to an Application or Applicant. <br>In the future, this service will be expanded to work with LoanVantage files and parties. <br>Note: The actual document file is an optional structure and thus this operation can be used to create a document record placeholder and the actual document can be provided later using the Loanvantage/updatedocuments operation. <br> <br> path.InstitutionId -> 123456789 <br> <br> path.InstitutionEnvironment -> PROD, TEST, QA post <br> path.ProductId -> [Identifies the product as part of the path. i.e., jha-loanvantage] <br> <br> **Request Behavior** <br> <br> The ProductId is required <br> <br> IDDocument is not required; if it is not provided, LoanVantage will generate it and return it in the response. <br> <br> DocumentTemplateType is required and must match a valid document template type in LoanVantage. <br> <br> DocumentEntityType is required and works in conjunction with DocumentEntityContext field. If linking a document to an Application then DocumentEntityType = Loan and DocumentEntityContext = Application. If linking a document to an Applicant then DocumentEntityType = Party and DocumentEntityContext = Applicant. <br> <br> RequiredDocumentType is required and should be set to Prerequisite if the document is being linked to an application or applicant.",
"operationId": "DocumentCreate",
"parameters": [
{
"name": "Content-Type",
"description": "The Content-Type entity header is used to indicate the media type of the resource. In responses, a Content-Type header tells the client what the content type of the returned content actually is. In requests, (such as POST or PUT), the client tells the server what type of data is actually sent.",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "application/json"
}
},
{
"name": "X-Request-ID",
"in": "header",
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-Correlation-ID",
"in": "header",
"description": "Returned X-Request-ID",
"schema": {
"type": "string"
}
},
{
"name": "X-AuditUserId",
"in": "header",
"description": "This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information.",
"schema": {
"type": "string",
"example": "UserId/UserName"
}
},
{
"name": "X-AuditDeviceId",
"in": "header",
"description": "This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address.",
"schema": {
"type": "string",
"example": "192.168.0.101"
}
},
{
"name": "X-BusinessCorrelationId",
"in": "header",
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-WorkflowCorrelationId",
"in": "header",
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
{
"name": "X-AuthenticationUserCredential",
"in": "header",
"description": "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>`",
"schema": {
"type": "string",
"example": "jwt:<GeneratedOidcJwt>"
}
},
{
"name": "X-AuthenticationProductCredential",
"in": "header",
"description": "Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as \"Authorization\" jwt unless the message is sent \"on-behalf-of\" this consumer product. <br>Format is `type:token`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>`",
"required": true,
"schema": {
"type": "string",
"example": "jwt:<GeneratedOidcJwt>"
}
},
{
"name": "X-FaultOverride",
"in": "header",
"description": "Determines if all faults should be override",
"schema": {
"type": "string",
"default": false
}
},
{
"name": "InstitutionId",
"in": "path",
"description": "The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. API usage requires a valid value that is recognized by the API Gateway and the provider of services. The value will be provided by Jack Henry personnel when granting API access to a consumer. <br>Example: `123456789`",
"required": true,
"schema": {
"type": "string",
"default": "",
"examples": [
"123456789"
]
}
},
{
"name": "EnvironmentId",
"in": "path",
"description": "Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.",
"required": true,
"schema": {
"type": "string",
"default": "PROD"
}
},
{
"name": "ProductId",
"in": "path",
"description": "Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-productname`",
"required": true,
"schema": {
"type": "string",
"example": "jha-loanvantage",
"default": "jha-loanvantage"
}
}
],
"requestBody": {
"description": "request for the application APIs",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"idDocument": {
"description": "Unique Application Identifier UUID",
"type": "string",
"format": "uuid"
},
"documentTemplateType": {
"description": "Unique identifier for the document template; must match valid document template type in LoanVantage.",
"type": "integer",
"format": "int32"
},
"documentEntityType": {
"description": "Indicates whether the document primary linkage is to a Party or a Loan.",
"enum": [
"Party",
"Loan"
],
"type": "string"
},
"documentEntity": {
"description": "Works in conjunction with the DocumentEntityType by providing more specific context.",
"required": [
"context",
"id"
],
"type": "object",
"properties": {
"id": {
"description": "This is the UUID for the specified DocumentEntity.",
"type": "string",
"format": "uuid"
},
"context": {
"description": "Currently, documents can only be linked to an Applicant or an Application; <BR><BR> Eventually documents may also be linked to a Party or a Loan.",
"enum": [
"Applicant",
"Application"
],
"type": "string"
}
},
"additionalProperties": false
},
"statementDate": {
"description": "Statement Date of document to be provided.<br> <br> A prerequisite document may not always have a statement date but a recurring document must have this field.",
"type": "string",
"format": "date"
},
"dueDate": {
"description": "Due Date of the document<br> <br> A prerequisite document may not always have a due date but a recurring document will.",
"type": "string",
"format": "date"
},
"requestedDate": {
"description": "Date the document was requested from the person/entity providing the document.",
"type": "string",
"format": "date"
},
"documentFile": {
"required": [
"fileContent",
"fileName"
],
"type": "object",
"properties": {
"fileName": {
"description": "File name the document should be saved as.",
"type": "string"
},
"fileContent": {
"description": "Actual Bytes of Document.",
"type": "string",
"format": "byte"
}
},
"additionalProperties": false
}
},
"required": [
"documentEntity",
"documentEntityType",
"documentTemplateType"
]
}
}
}
},
"responses": {
"200": {
"description": "OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. <br>Returns an application record",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Messages": {
"description": "Indicating messages/faults/errors returned",
"schema": {
"type": "boolean",
"default": false
}
},
"X-BusinessCorrelationId": {
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-WorkflowCorrelationId": {
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"MessageStatus": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
},
"idDocument": {
"description": "Unique Application Identifier UUID",
"type": "string",
"format": "uuid"
}
}
}
}
}
},
"400": {
"description": "Bad Request<hr> The server could not understand the request due to invalid syntax.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Messages": {
"description": "Indicating messages/faults/errors returned",
"schema": {
"type": "boolean",
"default": false
}
},
"X-BusinessCorrelationId": {
"description": "The correlation identification as related to business functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
},
"X-WorkflowCorrelationId": {
"description": "The correlation identification as related to workflow functions and activities. Generally expected to be a GUID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized<hr> Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"403": {
"description": "Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"404": {
"description": "Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"413": {
"description": "Request Too Large<hr> Request entity is larger than limits defined by server.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"422": {
"description": "Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors.",
"headers": {
"X-Request-ID": {
"description": "To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
},
"X-Correlation-ID": {
"description": "To support communications level tracking between the source and final destinations, a unique round-trip identifier (GUID) will be sent on every call from the caller and returned in the response by the service providers regardless of the final disposition of the request/message. The x-correlation-id can be re-used by intermediaries and/or service-providers to communicate beyond themselves indicating that the calls THEY are making are part of the same original message. (i.e. they are correlated)",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426655440000"
}
}
}
},
"500": {
"description": "Generic Internal Error<hr> The server has encountered a situation it does not know how to handle.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "`MessageStatus` is required/expected for non 2xx responses.",
"properties": {
"ResponseCode": {
"description": "The code related to message responses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"MessageSource": {
"description": "The source of the response to a message. This would represent the service provider that carry out the business service for the message",
"type": "string"
},
"MessageSourceResponse": {
"type": "object",
"additionalProperties": true
},
"Details": {
"description": "The array of details as related to a fault response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Code": {
"description": "The code assigned to a providers statuses",
"type": "string"
},
"Category": {
"description": "ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses",
"type": "string"
},
"Description": {
"description": "The description related to the status code in a human readable format",
"type": "string"
},
"Element": {
"description": "When an Error or Fault occurs this optional element will contain the element which is causing the condition",
"type": "string"
},
"ElementValue": {
"description": "When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition",
"type": "string"
},
"Location": {
"description": "This is typically the program that generated the status condition",
"type": "string"
}
}
}
},
"Logs": {
"description": "The array of logs as related to a response code",
"type": "array",
"items": {
"type": "object",
"properties": {
"Store": {
"description": "The store that retains log entries",
"type": "string"
},
"Key": {
"description": "The key related to a log entry specific to the log store",
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
},
"tags": [
{
"name": "Application",
"description": "Loanvantage service to create and get applications"
},
{
"name": "Document",
"description": "Loanvantage service to add, modify and get documents"
}
],
"servers": [
{
"url": "https://jxdmz.jackhenry.com/jx-api",
"description": "Corporate Test Server"
}
],
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
},
"parameters": {
"pProductId": {
"name": "ProductId",
"in": "path",
"description": "Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-productname`",
"required": true,
"schema": {
"type": "string",
"example": "jha-loanvantage",
"default": "jha-loanvantage"
}
},
"pId": {
"name": "Id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
"pdocumentId": {
"name": "documentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
},
"requestBodies": {
"ApplicationAddRequest": {
"description": "request for the application APIs",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"IDApplication": {
"type": "string",
"format": "uuid"
},
"requestTypeCode": {
"description": "Request Type Code identifies the type of LoanVantage process required to process this application type. <BR> <BR>This must match a valid LoanVantage New Loan Request Process Code set up by the FI.",
"type": "string"
},
"repaymentSources": {
"type": "object",
"description": "Indicates repayment sources for loan. Typically used for commercial loans. <BR><BR> Repayment Sources must match RepaymentSourceCodes as set up in LoanVantage by FI.",
"properties": {
"repaymentSource1": {
"type": "string"
},
"repaymentSource2": {
"type": "string"
},
"repaymentSource3": {
"type": "string"
}
},
"additionalProperties": false
},
"createLeadFlag": {
"description": "If a seperate lead record is to be created for this application then this should be true. <BR><BR> If true, then the Lead structure is required in the ApplicationAddRequest. ",
"type": "boolean"
},
"actionCode": {
"description": "Indicates type of action for loan, e.g., New, Refinance, etc.<BR><BR> Must match Action Code for a New Loan Request as set up in LoanVantage by FI.",
"maxLength": 5,
"type": "string"
},
"applicationNumber": {
"description": "Friendly non-UUID identifer for the application. Typically displayed for applicant reference.",
"type": "string"
},
"amountRequested": {
"description": "Amount of Loan Requested",
"pattern": "^\\$?([0-9]{1,3},([0-9]{3},)*[0-9]{3}|[0-9]+)(.[0-9][0-9])?$",
"type": "number",
"format": "double"
},
"securedBy": {
"description": "Indicates if the loan is to be secured or not. <BR><BR> If this field is not Unsecured then CollateralAdd structure is required.",
"enum": [
"Cash",
"SecuredOther",
"RealEstate",
"Unsecured"
],
"type": "string"
},
"termLengthinMonths": {
"description": "Indicates length of loan in months.",
"type": "integer",
"format": "int32"
},
"productType": {
"description": "Must match valid Product Code in LoanVantage. <BR><BR> Products can be different per FI.",
"maxLength": 10,
"type": "string"
},
"purposeCode": {
"description": "Must match valid Purpose Code in LoanVantage. <BR><BR> Purposes Codes can be different per FI.",
"maxLength": 5,
"type": "string"
},
"specificPurpose": {
"description": "Free form description of purpose of loan",
"maxLength": 100,
"type": "string"
},
"applicants": {
"description": "Contains information on the Applicants",
"type": "array",
"items": {
"required": [
"emailAddress",
"partyType",
"roleType",
"ipAddress"
],
"type": "object",
"properties": {
"IDApplicant": {
"description": "Unique Identifier for the Applicant. <BR><BR>If not provided, LoanVantage will generate it and return in the response.",
"type": "string",
"format": "uuid"
},
"IPAddress": {
"description": "IPAddress of computer used to submit the applciation.",
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"type": "string"
},
"partyType": {
"description": "Indicates if the applicant is Personal or Business type.",
"enum": [
"Personal",
"Business"
],
"type": "string"
},
"roleType": {
"description": "Indicates the role of the applicant to the loan.",
"enum": [
"Borrower",
"CoBorrower",
"Guarantor"
],
"type": "string"
},
"taxIdentifier": {
"type": "object",
"properties": {
"tinType": {
"description": "Indicates if the TIN is a Social Security Number or an Employer Identification Number.",
"enum": [
"SSN",
"EIN"
],
"type": "string"
},
"number": {
"description": "Tax identification number.",
"type": "string"
}
},
"additionalProperties": false
},
"emailAddress": {
"description": "Email address of the Applicant.",
"type": "string"
},
"preferredPhoneType": {
"description": "Identifies the preferred phone contact type of the applicant.",
"enum": [
"Personal",
"Business",
"Mobile",
"Home"
],
"type": "string"
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"phoneType": {
"description": "Identifies the preferred phone contact type of the applicant.",
"enum": [
"Personal",
"Business",
"Mobile",
"Home"
],
"type": "string"
},
"phoneNumber": {
"maxLength": 10,
"type": "string"
}
},
"additionalProperties": false
}
},
"addressess": {
"type": "array",
"items": {
"description": "Applicant Address",
"title": "ApplicantAddress",
"required": [
"addressBlock",
"addressType"
],
"type": "object",
"properties": {
"addressType": {
"description": "Indicates if the address is Current, Previous, or Mailing.",
"enum": [
"Current",
"Previous",
"Mailing"
],
"type": "string"
},
"addressBlock": {
"required": [
"city",
"stateProvince",
"street1",
"zipCode"
],
"type": "object",
"properties": {
"street1": {
"maxLength": 50,
"type": "string"
},
"street2": {
"maxLength": 50,
"type": "string"
},
"city": {
"maxLength": 50,
"type": "string"
},
"stateProvince": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"zipCode": {
"type": "integer",
"format": "int32"
},
"county": {
"maxLength": 50,
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"personalApplicant": {
"required": [
"usCitizenFlag"
],
"type": "object",
"properties": {
"personName": {
"description": "Parsed name of person",
"required": [
"firstName",
"lastName"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 30,
"type": "string"
},
"middleName": {
"maxLength": 30,
"type": "string"
},
"lastName": {
"maxLength": 30,
"type": "string"
},
"suffix": {
"maxLength": 12,
"type": "string"
},
"prefix": {
"maxLength": 6,
"type": "string"
}
},
"additionalProperties": false
},
"dateofBirth": {
"description": "Date of Birth of the Applicant.",
"type": "string",
"format": "date"
},
"usCitizenFlag": {
"description": "Indicates if the applicant is a US Citizen or not.",
"type": "boolean"
},
"noncitizenType": {
"description": "This field is required if the usCitizenFlag is false.",
"enum": [
"NonImmigrantAlien",
"Undocumented",
"Unknown",
"PermanentResidentAlien",
"NonPermanentResidentAlien",
"NonResidentAlien"
],
"type": "string"
},
"militaryCode": {
"description": "Indicates the type of military duty of the applicant.",
"enum": [
"ActiveDuty",
"ActiveReserve",
"NotActive",
"Dependent"
],
"type": "string"
},
"maritalStatus": {
"description": "Marital Status of the Applicant",
"enum": [
"Married",
"Separated",
"Unmarried",
"Unknown"
],
"type": "string"
},
"housingStatus": {
"description": "Indicates the housing status of the applicant.",
"enum": [
"LiveWithOthers",
"Other",
"Own",
"Rent"
],
"type": "string"
},
"identification": {
"required": [
"idNumber",
"issuer",
"typeCode",
"issueDate"
],
"type": "object",
"properties": {
"typeCode": {
"description": "Type of Identification",
"enum": [
"DL",
"Passport",
"StateId",
"USCIS",
"MilitaryId"
],
"type": "string"
},
"idNumber": {
"description": "Idenification Number",
"maxLength": 30,
"type": "string"
},
"issuer": {
"description": "Name of entity that issued the identification",
"maxLength": 30,
"type": "string"
},
"expireDate": {
"description": "Date Identification will expire.",
"type": "string",
"format": "date"
},
"issueDate": {
"description": "Date Identification was issued.",
"type": "string",
"format": "date"
}
},
"additionalProperties": false
},
"employments": {
"type": "array",
"items": {
"description": "Employment Information",
"required": [
"employerName",
"employerStatus"
],
"type": "object",
"properties": {
"IDEmployment": {
"description": "Unique Identifier UUID for the Employment Object. <BR><BR> If not provided, LoanVantage will generate it.",
"type": "string",
"format": "uuid"
},
"employerName": {
"description": "Name of Employer",
"maxLength": 30,
"type": "string"
},
"employerAddress": {
"required": [
"city",
"stateProvince",
"street1",
"zipCode"
],
"type": "object",
"properties": {
"street1": {
"maxLength": 50,
"type": "string"
},
"street2": {
"maxLength": 50,
"type": "string"
},
"city": {
"maxLength": 50,
"type": "string"
},
"stateProvince": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"zipCode": {
"type": "integer",
"format": "int32"
},
"county": {
"maxLength": 50,
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"jobTitle": {
"description": "Job Title",
"maxLength": 20,
"type": "string"
},
"phoneNumber": {
"maxLength": 10,
"type": "string"
},
"employerStatus": {
"description": "Indicates if Employer is Current, Previous, or Additional. Current should be the primary employer.",
"enum": [
"Current",
"Previous",
"Additional"
],
"type": "string"
},
"employmentStartDate": {
"description": "Date employment started with this employer.",
"type": "string",
"format": "date-time"
},
"employmentType": {
"description": "Indicates type of employment, e.g., Fulltime.",
"enum": [
"Fulltime",
"Parttime",
"SelfEmployed",
"Military"
],
"type": "string"
},
"grossAnnualBaseIncome": {
"description": "Annual Gross Income provided by this employer.",
"type": "number",
"format": "double"
},
"grossAnnualBonus": {
"description": "Annual Bonus Income provided by this employer. <BR><BR> This should only be provided if consistent income.",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
},
"otherIncome": {
"description": "Identifies other steady income unrelated to employment.",
"required": [
"annualIncome",
"incomeType"
],
"type": "object",
"properties": {
"incomeType": {
"description": "Identifies the type of Other Income.",
"enum": [
"Alimony",
"Annuity",
"ChildSupport",
"DeferredCompensation",
"Disability",
"DividendsInterest",
"Other",
"RentalIncome",
"Pension",
"SocialSecurity",
"Unemployment",
"VA"
],
"type": "string"
},
"incomeDescription": {
"maxLength": 30,
"type": "string"
},
"annualIncome": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"businessApplicant": {
"description": "BusinessParty",
"title": "BusinessParty",
"required": [
"fullName"
],
"type": "object",
"properties": {
"fullName": {
"maxLength": 90,
"type": "string"
},
"dba": {
"description": "Name party does business as.",
"maxLength": 50,
"type": "string"
},
"naics": {
"description": "Must be a valid NAICS code per Census.gov.",
"type": "string"
},
"timeInBusinessMonths": {
"description": "Indicates number of months the entity has been in business.",
"type": "integer",
"format": "int32"
},
"businessDescription": {
"description": "Free form text field to explain what the business does.",
"maxLength": 1000,
"type": "string"
},
"dateFormed": {
"description": "Date the business was formed with government.",
"type": "string",
"format": "date-time"
},
"numberOfEmployees": {
"description": "Indicates the number of employees in the business.",
"type": "integer",
"format": "int32"
},
"stateBusinessLocated": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"stateFormed": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
}
},
"additionalProperties": false
},
"userDefinedField": {
"type": "array",
"items": {
"type": "object",
"properties": {
"udfName": {
"maxLength": 10,
"type": "string"
},
"udfLabel": {
"maxLength": 30,
"type": "string"
},
"udfDataType": {
"enum": [
"Checkbox",
"Date",
"Memo",
"Money",
"Percent",
"PickList",
"Text"
],
"type": "string"
},
"udfValue": {
"maxLength": 1000,
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"collaterals": {
"description": "Contains information about the collateral",
"type": "array",
"items": {
"type": "object",
"properties": {
"collateralType": {
"maxLength": 10,
"type": "string"
},
"description": {
"maxLength": 150,
"type": "string"
},
"marketValue": {
"type": "number",
"format": "double"
},
"address": {
"required": [
"city",
"stateProvince",
"street1",
"zipCode"
],
"type": "object",
"properties": {
"street1": {
"maxLength": 50,
"type": "string"
},
"street2": {
"maxLength": 50,
"type": "string"
},
"city": {
"maxLength": 50,
"type": "string"
},
"stateProvince": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"zipCode": {
"type": "integer",
"format": "int32"
},
"county": {
"maxLength": 50,
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"IDCollateral": {
"description": "Unqiue Identifer UUID for the collateral. If not provided, LoanVantage will generate it.",
"type": "string",
"format": "uuid"
},
"ownerOccupancyFlag": {
"description": "Indicates if the collateral is owner-occupied.",
"type": "boolean"
},
"userDefinedField": {
"type": "array",
"items": {
"type": "object",
"properties": {
"udfName": {
"maxLength": 10,
"type": "string"
},
"udfLabel": {
"maxLength": 30,
"type": "string"
},
"udfDataType": {
"enum": [
"Checkbox",
"Date",
"Memo",
"Money",
"Percent",
"PickList",
"Text"
],
"type": "string"
},
"udfValue": {
"maxLength": 1000,
"type": "string"
}
},
"additionalProperties": false
}
},
"collateralCategory": {
"description": "High level categorization of the Collateral. <BR><BR> If = Titled, then the Titled structure should be provided; if = DepositAccount then the DepositAccount structure should be provided.",
"enum": [
"Property",
"Titled",
"DepositAccount"
],
"type": "string"
},
"collateralDetails": {
"type": "object",
"properties": {
"property": {
"type": "object",
"properties": {
"ownerOccupancyFlag": {
"type": "boolean"
}
},
"additionalProperties": false
},
"depositAccount": {
"description": "Deposit Account Collateral.",
"required": [
"accountNumber",
"accountType",
"bankName"
],
"type": "object",
"properties": {
"bankName": {
"description": "Name of Bank where deposit account is held.",
"maxLength": 50,
"type": "string"
},
"accountType": {
"description": "Type of deposit account.",
"maxLength": 20,
"type": "string"
},
"accountNumber": {
"description": "Number of deposit account.",
"maxLength": 30,
"type": "string"
}
},
"additionalProperties": false
},
"titled": {
"description": "Titled Collateral.",
"type": "object",
"properties": {
"titledType": {
"description": "Type of titled collateral.",
"enum": [
"Vehicle",
"RV"
],
"type": "string"
},
"newFlag": {
"description": "Indicates if collateral is new or used.",
"type": "boolean"
},
"ownerOccupancyFlag": {
"description": "Indicates if collateral owner-occupied. Relevant for RV collateral.",
"type": "boolean"
},
"vehicle": {
"description": "Details on vehicle collateral.",
"required": [
"make",
"model",
"year"
],
"type": "object",
"properties": {
"make": {
"maxLength": 20,
"type": "string"
},
"model": {
"maxLength": 20,
"type": "string"
},
"year": {
"type": "string"
},
"trim": {
"maxLength": 50,
"type": "string"
},
"color": {
"maxLength": 20,
"type": "string"
},
"vin": {
"maxLength": 50,
"type": "string"
},
"mileage": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"lead": {
"type": "object",
"properties": {
"leadTypeCode": {
"description": "Must match a valid LeadTypeCode in LoanVantage. <BR><BR> These can be different per FI. ",
"type": "string"
},
"leadCategoryCode": {
"description": "Must match a valid LeadCategoryCode in LoanVantage. <BR><BR> These can be different per FI. ",
"type": "string"
},
"leadStatusCode": {
"description": "Must match a valid LeadStatusCode in LoanVantage. <BR><BR> These can be different per FI. ",
"type": "string"
}
},
"additionalProperties": false
}
},
"required": [
"RequestTypeCode",
"ActionCode",
"AmountRequested",
"ProductType",
"PurposeCode",
"SecuredBy",
"Applicants"
]
}
}
}
},
"DocumentAddRequest": {
"description": "request for the application APIs",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"idDocument": {
"description": "Unique Application Identifier UUID",
"type": "string",
"format": "uuid"
},
"documentTemplateType": {
"description": "Unique identifier for the document template; must match valid document template type in LoanVantage.",
"type": "integer",
"format": "int32"
},
"documentEntityType": {
"description": "Indicates whether the document primary linkage is to a Party or a Loan.",
"enum": [
"Party",
"Loan"
],
"type": "string"
},
"documentEntity": {
"description": "Works in conjunction with the DocumentEntityType by providing more specific context.",
"required": [
"context",
"id"
],
"type": "object",
"properties": {
"id": {
"description": "This is the UUID for the specified DocumentEntity.",
"type": "string",
"format": "uuid"
},
"context": {
"description": "Currently, documents can only be linked to an Applicant or an Application; <BR><BR> Eventually documents may also be linked to a Party or a Loan.",
"enum": [
"Applicant",
"Application"
],
"type": "string"
}
},
"additionalProperties": false
},
"statementDate": {
"description": "Statement Date of document to be provided.<br> <br> A prerequisite document may not always have a statement date but a recurring document must have this field.",
"type": "string",
"format": "date"
},
"dueDate": {
"description": "Due Date of the document<br> <br> A prerequisite document may not always have a due date but a recurring document will.",
"type": "string",
"format": "date"
},
"requestedDate": {
"description": "Date the document was requested from the person/entity providing the document.",
"type": "string",
"format": "date"
},
"documentFile": {
"required": [
"fileContent",
"fileName"
],
"type": "object",
"properties": {
"fileName": {
"description": "File name the document should be saved as.",
"type": "string"
},
"fileContent": {
"description": "Actual Bytes of Document.",
"type": "string",
"format": "byte"
}
},
"additionalProperties": false
}
},
"required": [
"documentEntity",
"documentEntityType",
"documentTemplateType"
]
}
}
}
},
"DocumentPutRequest": {
"description": "request for the application APIs",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fileContent": {
"description": "Actual Bytes of Document.",
"type": "string",
"format": "byte"
}
}
}
}
}
}
},
"schemas": {
"partyApplicants": {
"description": "Applicant",
"title": "partyApplicants",
"properties": {
"partyApplicants": {
"description": "Contains limited information on the Applicants",
"type": "array",
"items": {
"required": [
"IDApplicant",
"partyType",
"roleType",
"fullName"
],
"type": "object",
"properties": {
"IDApplicant": {
"description": "Unique Identifier for the Applicant. <BR><BR>If not provided, LoanVantage will generate it and return in the response.",
"type": "string",
"format": "uuid"
},
"partyType": {
"description": "Indicates if the applicant is Personal or Business type.",
"enum": [
"Personal",
"Business"
],
"type": "string"
},
"roleType": {
"description": "Indicates the role of the applicant to the loan.",
"enum": [
"Borrower",
"CoBorrower",
"Guarantor"
],
"type": "string"
},
"personName": {
"description": "Parsed name of person",
"required": [
"firstName",
"lastName"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 30,
"type": "string"
},
"middleName": {
"maxLength": 30,
"type": "string"
},
"lastName": {
"maxLength": 30,
"type": "string"
},
"suffix": {
"maxLength": 12,
"type": "string"
},
"prefix": {
"maxLength": 6,
"type": "string"
}
},
"additionalProperties": false
},
"fullName": {
"type": "string"
}
},
"additionalProperties": false
}
}
}
},
"Applicant": {
"description": "Applicant",
"title": "Applicant",
"properties": {
"Applicant": {
"required": [
"emailAddress",
"partyType",
"roleType",
"ipAddress"
],
"type": "object",
"properties": {
"IDApplicant": {
"description": "Unique Identifier for the Applicant. <BR><BR>If not provided, LoanVantage will generate it and return in the response.",
"type": "string",
"format": "uuid"
},
"IPAddress": {
"description": "IPAddress of computer used to submit the applciation.",
"pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"type": "string"
},
"partyType": {
"description": "Indicates if the applicant is Personal or Business type.",
"enum": [
"Personal",
"Business"
],
"type": "string"
},
"roleType": {
"description": "Indicates the role of the applicant to the loan.",
"enum": [
"Borrower",
"CoBorrower",
"Guarantor"
],
"type": "string"
},
"taxIdentifier": {
"type": "object",
"properties": {
"tinType": {
"description": "Indicates if the TIN is a Social Security Number or an Employer Identification Number.",
"enum": [
"SSN",
"EIN"
],
"type": "string"
},
"number": {
"description": "Tax identification number.",
"type": "string"
}
},
"additionalProperties": false
},
"emailAddress": {
"description": "Email address of the Applicant.",
"type": "string"
},
"preferredPhoneType": {
"description": "Identifies the preferred phone contact type of the applicant.",
"enum": [
"Personal",
"Business",
"Mobile",
"Home"
],
"type": "string"
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"phoneType": {
"description": "Identifies the preferred phone contact type of the applicant.",
"enum": [
"Personal",
"Business",
"Mobile",
"Home"
],
"type": "string"
},
"phoneNumber": {
"maxLength": 10,
"type": "string"
}
},
"additionalProperties": false
}
},
"addressess": {
"type": "array",
"items": {
"description": "Applicant Address",
"title": "ApplicantAddress",
"required": [
"addressBlock",
"addressType"
],
"type": "object",
"properties": {
"addressType": {
"description": "Indicates if the address is Current, Previous, or Mailing.",
"enum": [
"Current",
"Previous",
"Mailing"
],
"type": "string"
},
"addressBlock": {
"required": [
"city",
"stateProvince",
"street1",
"zipCode"
],
"type": "object",
"properties": {
"street1": {
"maxLength": 50,
"type": "string"
},
"street2": {
"maxLength": 50,
"type": "string"
},
"city": {
"maxLength": 50,
"type": "string"
},
"stateProvince": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"zipCode": {
"type": "integer",
"format": "int32"
},
"county": {
"maxLength": 50,
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"personalApplicant": {
"required": [
"usCitizenFlag"
],
"type": "object",
"properties": {
"personName": {
"description": "Parsed name of person",
"required": [
"firstName",
"lastName"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 30,
"type": "string"
},
"middleName": {
"maxLength": 30,
"type": "string"
},
"lastName": {
"maxLength": 30,
"type": "string"
},
"suffix": {
"maxLength": 12,
"type": "string"
},
"prefix": {
"maxLength": 6,
"type": "string"
}
},
"additionalProperties": false
},
"dateofBirth": {
"description": "Date of Birth of the Applicant.",
"type": "string",
"format": "date"
},
"usCitizenFlag": {
"description": "Indicates if the applicant is a US Citizen or not.",
"type": "boolean"
},
"noncitizenType": {
"description": "This field is required if the usCitizenFlag is false.",
"enum": [
"NonImmigrantAlien",
"Undocumented",
"Unknown",
"PermanentResidentAlien",
"NonPermanentResidentAlien",
"NonResidentAlien"
],
"type": "string"
},
"militaryCode": {
"description": "Indicates the type of military duty of the applicant.",
"enum": [
"ActiveDuty",
"ActiveReserve",
"NotActive",
"Dependent"
],
"type": "string"
},
"maritalStatus": {
"description": "Marital Status of the Applicant",
"enum": [
"Married",
"Separated",
"Unmarried",
"Unknown"
],
"type": "string"
},
"housingStatus": {
"description": "Indicates the housing status of the applicant.",
"enum": [
"LiveWithOthers",
"Other",
"Own",
"Rent"
],
"type": "string"
},
"identification": {
"required": [
"idNumber",
"issuer",
"typeCode",
"issueDate"
],
"type": "object",
"properties": {
"typeCode": {
"description": "Type of Identification",
"enum": [
"DL",
"Passport",
"StateId",
"USCIS",
"MilitaryId"
],
"type": "string"
},
"idNumber": {
"description": "Idenification Number",
"maxLength": 30,
"type": "string"
},
"issuer": {
"description": "Name of entity that issued the identification",
"maxLength": 30,
"type": "string"
},
"expireDate": {
"description": "Date Identification will expire.",
"type": "string",
"format": "date"
},
"issueDate": {
"description": "Date Identification was issued.",
"type": "string",
"format": "date"
}
},
"additionalProperties": false
},
"employments": {
"type": "array",
"items": {
"description": "Employment Information",
"required": [
"employerName",
"employerStatus"
],
"type": "object",
"properties": {
"IDEmployment": {
"description": "Unique Identifier UUID for the Employment Object. <BR><BR> If not provided, LoanVantage will generate it.",
"type": "string",
"format": "uuid"
},
"employerName": {
"description": "Name of Employer",
"maxLength": 30,
"type": "string"
},
"employerAddress": {
"required": [
"city",
"stateProvince",
"street1",
"zipCode"
],
"type": "object",
"properties": {
"street1": {
"maxLength": 50,
"type": "string"
},
"street2": {
"maxLength": 50,
"type": "string"
},
"city": {
"maxLength": 50,
"type": "string"
},
"stateProvince": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"zipCode": {
"type": "integer",
"format": "int32"
},
"county": {
"maxLength": 50,
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"jobTitle": {
"description": "Job Title",
"maxLength": 20,
"type": "string"
},
"phoneNumber": {
"maxLength": 10,
"type": "string"
},
"employerStatus": {
"description": "Indicates if Employer is Current, Previous, or Additional. Current should be the primary employer.",
"enum": [
"Current",
"Previous",
"Additional"
],
"type": "string"
},
"employmentStartDate": {
"description": "Date employment started with this employer.",
"type": "string",
"format": "date-time"
},
"employmentType": {
"description": "Indicates type of employment, e.g., Fulltime.",
"enum": [
"Fulltime",
"Parttime",
"SelfEmployed",
"Military"
],
"type": "string"
},
"grossAnnualBaseIncome": {
"description": "Annual Gross Income provided by this employer.",
"type": "number",
"format": "double"
},
"grossAnnualBonus": {
"description": "Annual Bonus Income provided by this employer. <BR><BR> This should only be provided if consistent income.",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
},
"otherIncome": {
"description": "Identifies other steady income unrelated to employment.",
"required": [
"annualIncome",
"incomeType"
],
"type": "object",
"properties": {
"incomeType": {
"description": "Identifies the type of Other Income.",
"enum": [
"Alimony",
"Annuity",
"ChildSupport",
"DeferredCompensation",
"Disability",
"DividendsInterest",
"Other",
"RentalIncome",
"Pension",
"SocialSecurity",
"Unemployment",
"VA"
],
"type": "string"
},
"incomeDescription": {
"maxLength": 30,
"type": "string"
},
"annualIncome": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"businessApplicant": {
"description": "BusinessParty",
"title": "BusinessParty",
"required": [
"fullName"
],
"type": "object",
"properties": {
"fullName": {
"maxLength": 90,
"type": "string"
},
"dba": {
"description": "Name party does business as.",
"maxLength": 50,
"type": "string"
},
"naics": {
"description": "Must be a valid NAICS code per Census.gov.",
"type": "string"
},
"timeInBusinessMonths": {
"description": "Indicates number of months the entity has been in business.",
"type": "integer",
"format": "int32"
},
"businessDescription": {
"description": "Free form text field to explain what the business does.",
"maxLength": 1000,
"type": "string"
},
"dateFormed": {
"description": "Date the business was formed with government.",
"type": "string",
"format": "date-time"
},
"numberOfEmployees": {
"description": "Indicates the number of employees in the business.",
"type": "integer",
"format": "int32"
},
"stateBusinessLocated": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"stateFormed": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
}
},
"additionalProperties": false
},
"userDefinedField": {
"type": "array",
"items": {
"type": "object",
"properties": {
"udfName": {
"maxLength": 10,
"type": "string"
},
"udfLabel": {
"maxLength": 30,
"type": "string"
},
"udfDataType": {
"enum": [
"Checkbox",
"Date",
"Memo",
"Money",
"Percent",
"PickList",
"Text"
],
"type": "string"
},
"udfValue": {
"maxLength": 1000,
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
},
"PersonNames": {
"description": "PersonNames",
"title": "PersonNames",
"properties": {
"PersonNames": {
"description": "Parsed name of person",
"required": [
"firstName",
"lastName"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 30,
"type": "string"
},
"middleName": {
"maxLength": 30,
"type": "string"
},
"lastName": {
"maxLength": 30,
"type": "string"
},
"suffix": {
"maxLength": 12,
"type": "string"
},
"prefix": {
"maxLength": 6,
"type": "string"
}
},
"additionalProperties": false
}
}
},
"Identification": {
"description": "Identification",
"title": "Identification",
"properties": {
"Identification": {
"required": [
"idNumber",
"issuer",
"typeCode",
"issueDate"
],
"type": "object",
"properties": {
"typeCode": {
"description": "Type of Identification",
"enum": [
"DL",
"Passport",
"StateId",
"USCIS",
"MilitaryId"
],
"type": "string"
},
"idNumber": {
"description": "Idenification Number",
"maxLength": 30,
"type": "string"
},
"issuer": {
"description": "Name of entity that issued the identification",
"maxLength": 30,
"type": "string"
},
"expireDate": {
"description": "Date Identification will expire.",
"type": "string",
"format": "date"
},
"issueDate": {
"description": "Date Identification was issued.",
"type": "string",
"format": "date"
}
},
"additionalProperties": false
}
}
},
"Employment": {
"description": "Employment",
"title": "Employment",
"properties": {
"Employment": {
"description": "Employment Information",
"required": [
"employerName",
"employerStatus"
],
"type": "object",
"properties": {
"IDEmployment": {
"description": "Unique Identifier UUID for the Employment Object. <BR><BR> If not provided, LoanVantage will generate it.",
"type": "string",
"format": "uuid"
},
"employerName": {
"description": "Name of Employer",
"maxLength": 30,
"type": "string"
},
"employerAddress": {
"required": [
"city",
"stateProvince",
"street1",
"zipCode"
],
"type": "object",
"properties": {
"street1": {
"maxLength": 50,
"type": "string"
},
"street2": {
"maxLength": 50,
"type": "string"
},
"city": {
"maxLength": 50,
"type": "string"
},
"stateProvince": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"zipCode": {
"type": "integer",
"format": "int32"
},
"county": {
"maxLength": 50,
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"jobTitle": {
"description": "Job Title",
"maxLength": 20,
"type": "string"
},
"phoneNumber": {
"maxLength": 10,
"type": "string"
},
"employerStatus": {
"description": "Indicates if Employer is Current, Previous, or Additional. Current should be the primary employer.",
"enum": [
"Current",
"Previous",
"Additional"
],
"type": "string"
},
"employmentStartDate": {
"description": "Date employment started with this employer.",
"type": "string",
"format": "date-time"
},
"employmentType": {
"description": "Indicates type of employment, e.g., Fulltime.",
"enum": [
"Fulltime",
"Parttime",
"SelfEmployed",
"Military"
],
"type": "string"
},
"grossAnnualBaseIncome": {
"description": "Annual Gross Income provided by this employer.",
"type": "number",
"format": "double"
},
"grossAnnualBonus": {
"description": "Annual Bonus Income provided by this employer. <BR><BR> This should only be provided if consistent income.",
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
}
},
"BusinessParty": {
"description": "BusinessParty",
"title": "BusinessParty",
"properties": {
"BusinessParty": {
"description": "BusinessParty",
"title": "BusinessParty",
"required": [
"fullName"
],
"type": "object",
"properties": {
"fullName": {
"maxLength": 90,
"type": "string"
},
"dba": {
"description": "Name party does business as.",
"maxLength": 50,
"type": "string"
},
"naics": {
"description": "Must be a valid NAICS code per Census.gov.",
"type": "string"
},
"timeInBusinessMonths": {
"description": "Indicates number of months the entity has been in business.",
"type": "integer",
"format": "int32"
},
"businessDescription": {
"description": "Free form text field to explain what the business does.",
"maxLength": 1000,
"type": "string"
},
"dateFormed": {
"description": "Date the business was formed with government.",
"type": "string",
"format": "date-time"
},
"numberOfEmployees": {
"description": "Indicates the number of employees in the business.",
"type": "integer",
"format": "int32"
},
"stateBusinessLocated": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"stateFormed": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
}
},
"additionalProperties": false
}
}
},
"ApplicantAddress": {
"description": "ApplicantAddress",
"title": "ApplicantAddress",
"properties": {
"ApplicantAddress": {
"description": "Applicant Address",
"title": "ApplicantAddress",
"required": [
"addressBlock",
"addressType"
],
"type": "object",
"properties": {
"addressType": {
"description": "Indicates if the address is Current, Previous, or Mailing.",
"enum": [
"Current",
"Previous",
"Mailing"
],
"type": "string"
},
"addressBlock": {
"required": [
"city",
"stateProvince",
"street1",
"zipCode"
],
"type": "object",
"properties": {
"street1": {
"maxLength": 50,
"type": "string"
},
"street2": {
"maxLength": 50,
"type": "string"
},
"city": {
"maxLength": 50,
"type": "string"
},
"stateProvince": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"zipCode": {
"type": "integer",
"format": "int32"
},
"county": {
"maxLength": 50,
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"Collateral": {
"description": "Collateral",
"title": "Collateral",
"properties": {
"Collateral": {
"type": "object",
"properties": {
"collateralType": {
"maxLength": 10,
"type": "string"
},
"description": {
"maxLength": 150,
"type": "string"
},
"marketValue": {
"type": "number",
"format": "double"
},
"address": {
"required": [
"city",
"stateProvince",
"street1",
"zipCode"
],
"type": "object",
"properties": {
"street1": {
"maxLength": 50,
"type": "string"
},
"street2": {
"maxLength": 50,
"type": "string"
},
"city": {
"maxLength": 50,
"type": "string"
},
"stateProvince": {
"description": "Indicates the US state or territory in which the business was formed.",
"enum": [
"AK",
"AL",
"AR",
"AZ",
"CA",
"CO",
"CT",
"DC",
"DE",
"FL",
"GA",
"HI",
"IA",
"ID",
"IL",
"IN",
"KS",
"KY",
"LA",
"MA",
"MD",
"ME",
"MI",
"MN",
"MO",
"MS",
"MT",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NM",
"NV",
"NY",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VA",
"VT",
"WA",
"WI",
"WV",
"WY",
"AA",
"AE",
"AP",
"AS",
"FM",
"GU",
"MH",
"MP",
"PR",
"PW",
"VI"
],
"type": "string"
},
"zipCode": {
"type": "integer",
"format": "int32"
},
"county": {
"maxLength": 50,
"type": "string"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"IDCollateral": {
"description": "Unqiue Identifer UUID for the collateral. If not provided, LoanVantage will generate it.",
"type": "string",
"format": "uuid"
},
"ownerOccupancyFlag": {
"description": "Indicates if the collateral is owner-occupied.",
"type": "boolean"
},
"userDefinedField": {
"type": "array",
"items": {
"type": "object",
"properties": {
"udfName": {
"maxLength": 10,
"type": "string"
},
"udfLabel": {
"maxLength": 30,
"type": "string"
},
"udfDataType": {
"enum": [
"Checkbox",
"Date",
"Memo",
"Money",
"Percent",
"PickList",
"Text"
],
"type": "string"
},
"udfValue": {
"maxLength": 1000,
"type": "string"
}
},
"additionalProperties": false
}
},
"collateralCategory": {
"description": "High level categorization of the Collateral. <BR><BR> If = Titled, then the Titled structure should be provided; if = DepositAccount then the DepositAccount structure should be provided.",
"enum": [
"Property",
"Titled",
"DepositAccount"
],
"type": "string"
},
"collateralDetails": {
"type": "object",
"properties": {
"property": {
"type": "object",
"properties": {
"ownerOccupancyFlag": {
"type": "boolean"
}
},
"additionalProperties": false
},
"depositAccount": {
"description": "Deposit Account Collateral.",
"required": [
"accountNumber",
"accountType",
"bankName"
],
"type": "object",
"properties": {
"bankName": {
"description": "Name of Bank where deposit account is held.",
"maxLength": 50,
"type": "string"
},
"accountType": {
"description": "Type of deposit account.",
"maxLength": 20,
"type": "string"
},
"accountNumber": {
"description": "Number of deposit account.",
"maxLength": 30,
"type": "string"
}
},
"additionalProperties": false
},
"titled": {
"description": "Titled Collateral.",
"type": "object",
"properties": {
"titledType": {
"description": "Type of titled collateral.",
"enum": [
"Vehicle",
"RV"
],
"type": "string"
},
"newFlag": {
"description": "Indicates if collateral is new or used.",
"type": "boolean"
},
"ownerOccupancyFlag": {
"description": "Indicates if collateral owner-occupied. Relevant for RV collateral.",
"type": "boolean"
},
"vehicle": {
"description": "Details on vehicle collateral.",
"required": [
"make",
"model",
"year"
],
"type": "object",
"properties": {
"make": {
"maxLength": 20,
"type": "string"
},
"model": {
"maxLength": 20,
"type": "string"
},
"year": {
"type": "string"
},
"trim": {
"maxLength": 50,
"type": "string"
},
"color": {
"maxLength": 20,
"type": "string"
},
"vin": {
"maxLength": 50,
"type": "string"
},
"mileage": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"Titled": {
"description": "Titled",
"title": "Titled",
"properties": {
"Titled": {
"description": "Titled Collateral.",
"type": "object",
"properties": {
"titledType": {
"description": "Type of titled collateral.",
"enum": [
"Vehicle",
"RV"
],
"type": "string"
},
"newFlag": {
"description": "Indicates if collateral is new or used.",
"type": "boolean"
},
"ownerOccupancyFlag": {
"description": "Indicates if collateral owner-occupied. Relevant for RV collateral.",
"type": "boolean"
},
"vehicle": {
"description": "Details on vehicle collateral.",
"required": [
"make",
"model",
"year"
],
"type": "object",
"properties": {
"make": {
"maxLength": 20,
"type": "string"
},
"model": {
"maxLength": 20,
"type": "string"
},
"year": {
"type": "string"
},
"trim": {
"maxLength": 50,
"type": "string"
},
"color": {
"maxLength": 20,
"type": "string"
},
"vin": {
"maxLength": 50,
"type": "string"
},
"mileage": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"Document": {
"description": "Document",
"title": "Document",
"properties": {
"Document": {
"required": [
"fileContent",
"fileName"
],
"type": "object",
"properties": {
"fileName": {
"description": "File name the document should be saved as.",
"type": "string"
},
"fileContent": {
"description": "Actual Bytes of Document.",
"type": "string",
"format": "byte"
}
},
"additionalProperties": false
}
}
}
}
}
}
Have a Question?
- Have a how-to question? Seeing a weird error? Get help on StackOverflow.
- Register for the Developer Office Hours where we answer technical Q&A from the audience.
Did this page help you?
Why was this page helpful?
Why wasn't this page helpful?
Thank you for your feedback!
Last updated Tue Sep 9 2025