LoanVantage Actions
1. Getting the Application
To obtain the application from LoanVantage, you must provide the following:
- Institution ID: The unique identifier assigned to a financial institution within LoanVantage's system, used to retrieve applications specific to that institution.
- Environment ID: The identifier representing the environment or system in which LoanVantage operates, allowing access to applications in a specific environment
- Product ID: The unique identifier for a specific product or service offered by the financial institution, used to filter applications related to that particular product.
- Application ID: The unique identifier assigned to an individual application within LoanVantage's platform, used to retrieve specific details and data associated with that application.
- X-Request-ID: A custom header used to uniquely identify individual API requests. It is an optional header that clients can include in their API requests to provide a specific request identifier.
Override properties
The above connector properties can be overridden by the following message poroperties, if provided:
- Institution ID: msg.config.institution_id
- Environment ID: msg.config.environment_id
- Product ID: msg.config.product_id
- Application ID: msg.config.application_id
- X-Request-ID: msg.config.x_request_id
Sample msg.model:
msg.config = {
base_url : <base url>,
institution_id : <institution id>,
environment_id : <environment id>,
product_id: <product id>,
application_id: <application id>,
token: <Bearer token obtained from Get Token connector>
}
2. Getting Document
To obtain document from LoanVantage, you must provide the following:
- Institution ID: The unique identifier assigned to a financial institution within LoanVantage's system, used to retrieve applications specific to that institution.
- Environment ID: The identifier representing the environment or system in which LoanVantage operates, allowing access to applications in a specific environment
- Product ID: The unique identifier for a specific product or service offered by the financial institution, used to filter applications related to that particular product.
- Document ID: The unique identifier assigned to an individual document within LoanVantage's platform, used to retrieve specific details and data associated with that document.
- X-Request-ID: A custom header used to uniquely identify individual API requests. It is an optional header that clients can include in their API requests to provide a specific request identifier.
Override properties
The above connector properties can be overridden by the following message poroperties, if provided:
- Institution ID: msg.config.institution_id
- Environment ID: msg.config.environment_id
- Product ID: msg.config.product_id
- Document ID: msg.config.document_id
- X-Request-ID: msg.config.x_request_id
Sample msg.model:
msg.event = {
base_url : <base url>,
institution_id : <institution id>,
environment_id : <environment id>,
product_id: <product id>,
document_id: <document id>,
token: <Bearer token obtained from Get Token connector>
}
3. Obtaining the Auth Token for LoanVantage API
To obtain the access token for LoanVantage, you must provide the following:
Client ID: The unique identifier assigned to your application by LoanVantage for OAuth 2.0 authentication.
Client Secret: A secret key known only to your application and LoanVantage, used to authenticate your application during the OAuth 2.0 token request.
Grant Type: The type of grant being used for authentication, usually set to "client_credentials" for server-to-server communication.
Scope: The set of permissions or access rights requested by your application from LoanVantage's OAuth 2.0 authorization server.
Override properties
The above connector properties can be overridden by the following message poroperties, if provided:
- Client ID: msg.config.client_id
- Client Secret: msg.config.client_secret
- Grant Type: msg.config.grant_type
- Scope: msg.config.scop
Sample msg.model:
msg.event = {
client_id : <YOUR CLIENT ID>,
client_secret : <YOUR CLIENT SECRET>,
grant_type: <GRANT TYPE>,
scope: <SCOPE>
}
4. Posting the Application
To post the application using LoanVantage, you must provide the following:
- Institution ID: The unique identifier assigned to a financial institution within LoanVantage's system, used to post applications specific to that institution.
- Environment ID: The identifier representing the environment or system in which LoanVantage operates, allowing to post applications in a specific environment
- Product ID: The unique identifier for a specific product or service offered by the financial institution, used to post applications related to that particular product.
- X-Request-ID: A custom header used to uniquely identify individual API requests. It is an optional header that clients can include in their API requests to provide a specific request identifier.
Override properties
The above connector properties can be overridden by the following message poroperties, if provided:
- Institution ID: msg.config.institution_id
- Environment ID: msg.config.environment_id
- Product ID: msg.config.product_id
- X-Request-ID: msg.config.x_request_id
Sample msg.model:
msg.event = {
base_url : <base url>,
institution_id : <institution id>,
environment_id : <environment id>,
product_id: <product id>,
token: <Bearer token obtained from Get Token connector>
}
5. Adding Document
To add document using LoanVantage, you must provide the following:
- Institution ID: The unique identifier assigned to a financial institution within LoanVantage's system, used to add document specific to that institution.
- Environment ID: The identifier representing the environment or system in which LoanVantage operates, allowing to add document in a specific environment
- Product ID: The unique identifier for a specific product or service offered by the financial institution, used to add documents related to that particular product. -X-Request-ID: A custom header used to uniquely identify individual API requests. It is an optional header that clients can include in their API requests to provide a specific request identifier.
Override properties
The above connector properties can be overridden by the following message poroperties, if provided:
- Institution ID: msg.config.institution_id
- Environment ID: msg.config.environment_id
- Product ID: msg.config.product_id
- X-Request-ID: msg.config.x_request_id
Sample msg.model:
msg.event = {
base_url : <base url>,
institution_id : <institution id>,
environment_id : <environment id>,
product_id: <product id>,
token: <Bearer token obtained from Get Token connector>
}
6. Updating Document
To update document using LoanVantage, you must provide the following:
- Institution ID: The unique identifier assigned to a financial institution within LoanVantage's system, used to add document specific to that institution.
- Environment ID: The identifier representing the environment or system in which LoanVantage operates, allowing to add document in a specific environment
- Product ID: The unique identifier for a specific product or service offered by the financial institution, used to add documents related to that particular product.
- Document ID: Document ID is a unique identifier assigned to each document record in LoanVantage, allowing precise identification and retrieval of specific documents within the system.
- X-Request-ID: A custom header used to uniquely identify individual API requests. It is an optional header that clients can include in their API requests to provide a specific request identifier.
Override properties
The above connector properties can be overridden by the following message poroperties, if provided:
- Institution ID: msg.config.institution_id
- Environment ID: msg.config.environment_id
- Product ID: msg.config.product_id
- Document ID: msg.config.document_id
- X-Request-ID: msg.config.x_request_id
Sample msg.model:
msg.event = {
base_url : <base url>,
institution_id : <institution id>,
environment_id : <environment id>,
product_id: <product id>,
document_id: <document_id>,
token: <Bearer token obtained from Get Token connector>
}
For more information on the Loan Vantage API, please refer to the LOAN VANTAGE API DOCUMENTATION