fincura_api

fincura_api

FincuraApi - JavaScript client for fincura_api This REST API allows you to interact with the Fincura processing and insights engine.

Authentication

This API uses API keys generated from a Fincura User account. To get access to your User account, speak with you Fincura account manager.

Accepted Media Types

File Type	Extension(s)	Content-Type(s)
PDF File	.pdf	application/pdf , application/x-pdf
Excel File	.xls	application/vnd.ms-excel
Excel File	.xlsx	application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Excel File	.xlsm	application/vnd.ms-excel.sheet.macroEnabled.12
PNG Image	.png	image/png
GIF Image	.gif	image/gif
JPG Image	.jpg, .jpeg	image/jpeg
GIF Image	.gif	image/gif

Getting Started

1. Create a Borrower
2. Add a file for that Borrower.
3. Analyze in the Fincura App

---

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.3.0
• Package version: 1.3.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install fincura_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your fincura_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var FincuraApi = require('fincura_api');

var defaultClient = FincuraApi.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: API_Key
var API_Key = defaultClient.authentications['API_Key'];
API_Key.accessToken = "YOUR ACCESS TOKEN"

var api = new FincuraApi.ApiKeyApi()
var opts = {
  'apiKey': new FincuraApi.ApiKey() // {ApiKey} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.refreshApiKey(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
FincuraApi.ApiKeyApi	refreshApiKey	POST /v1/api-key/refresh	Refresh Api Key
FincuraApi.BorrowersApi	createBorrower	POST /v1/borrower	Create a new Borrower
FincuraApi.BorrowersApi	listBorrowers	GET /v1/borrower	List Borrowers
FincuraApi.BorrowersApi	partialUpdateBorrower	PATCH /v1/borrower/{uuid}	Update a Borrower
FincuraApi.BorrowersApi	portalLinkBorrower	POST /v1/borrower/{uuid}/portal_link	Generate a Borrower portal link
FincuraApi.BorrowersApi	retrieveBorrower	GET /v1/borrower/{uuid}	Retrieve a Borrower
FincuraApi.CustomAttributesApi	createCustomAttributeDefinition	POST /v1/custom-attribute-definition	Create a CustomAttributeDefinition
FincuraApi.CustomAttributesApi	destroyCustomAttributeDefinition	DELETE /v1/custom-attribute-definition/{uuid}	Delete a CustomAttributeDefinition
FincuraApi.CustomAttributesApi	listCustomAttributeDefinitions	GET /v1/custom-attribute-definition	List CustomAttributeDefinitions
FincuraApi.CustomAttributesApi	retrieveCustomAttributeDefinition	GET /v1/custom-attribute-definition/{uuid}	Get CustomAttributeDefinition info
FincuraApi.DataViewsApi	retrieveDataViewFromDocumentFile	GET /v1/data-view/from_document_file/{document_file_uuid}	Get DataView from a DocumentFile
FincuraApi.DataViewsApi	retrieveMostRecentDataView	GET /v1/data-view/most_recent/{borrower_uuid}	Get the most recent period of data for a Borrower
FincuraApi.EmbeddedWorkflowsApi	createEmbeddedWorkflow	POST /v1/embedded-workflow
FincuraApi.EmbeddedWorkflowsApi	retrieveEmbeddedWorkflow	GET /v1/embedded-workflow/{uuid}
FincuraApi.FilesApi	createBulkFile	POST /v1/bulk-file	Submit a new BulkFile
FincuraApi.FilesApi	createDocumentFile	POST /v1/document-file	Submit a new DocumentFile
FincuraApi.FilesApi	destroyDocumentFile	DELETE /v1/document-file/{uuid}	Delete a DocumentFile
FincuraApi.FilesApi	listDocumentFiles	GET /v1/document-file	List DocumentFile records
FincuraApi.FilesApi	retrieveBulkFile	GET /v1/bulk-file/{uuid}	Retrieve a BulkFile
FincuraApi.FilesApi	retrieveDocumentFile	GET /v1/document-file/{uuid}	Get a DocumentFile
FincuraApi.LoansApi	createLoan	POST /v1/loan	Create a new Loan
FincuraApi.LoansApi	destroyLoan	DELETE /v1/loan/{uuid}	Delete a Loan
FincuraApi.LoansApi	listLoans	GET /v1/loan	List Loans
FincuraApi.LoansApi	partialUpdateLoan	PATCH /v1/loan/{uuid}	Update a Loan
FincuraApi.LoansApi	retrieveLoan	GET /v1/loan/{uuid}	Retrieve a Loan
FincuraApi.PortfoliosApi	createPortfolio	POST /v1/portfolio	Create a new Portfolio
FincuraApi.PortfoliosApi	listPortfolios	GET /v1/portfolio	List Portfolios
FincuraApi.PortfoliosApi	partialUpdatePortfolio	PATCH /v1/portfolio/{uuid}	Update a Portfolio
FincuraApi.RequirementsApi	createFinancialRequirement	POST /v1/financial-requirement	Create a new FinancialRequirement
FincuraApi.RequirementsApi	listFinancialRequirements	GET /v1/financial-requirement	List FinancialRequirements
FincuraApi.RequirementsApi	partialUpdateFinancialRequirement	PATCH /v1/financial-requirement/{uuid}	Update a FinancialRequirement
FincuraApi.RequirementsApi	retrieveFinancialRequirement	GET /v1/financial-requirement/{uuid}	Retrieve a FinancialRequirement
FincuraApi.TenantSettingsApi	readTenantSettings	GET /v1/tenant-settings/read	Get Tenant Settings
FincuraApi.WebhooksApi	createWebhook	POST /v1/webhook	Create a webhook
FincuraApi.WebhooksApi	destroyWebhook	DELETE /v1/webhook/{uuid}	Delete a webhook
FincuraApi.WebhooksApi	listWebhooks	GET /v1/webhook	List webhooks
FincuraApi.WebhooksApi	retrieveWebhook	GET /v1/webhook/{uuid}	Get webhook info

Documentation for Models

• FincuraApi.ApiKey
• FincuraApi.Borrower
• FincuraApi.BulkFileCreate
• FincuraApi.BulkFileRead
• FincuraApi.CustomAttributeDefinition
• FincuraApi.DataView
• FincuraApi.DataViewCalculatedValue
• FincuraApi.DataViewCalculatedValueLineItem
• FincuraApi.DataViewCellFormat
• FincuraApi.DataViewCells
• FincuraApi.DataViewColumns
• FincuraApi.DataViewRowFormat
• FincuraApi.DataViewRows
• FincuraApi.DocumentFileCreate
• FincuraApi.DocumentFileCreateStatements
• FincuraApi.DocumentFileRead
• FincuraApi.EmbeddedWorkflow
• FincuraApi.EmbeddedWorkflowUiControls
• FincuraApi.FinancialRequirement
• FincuraApi.FinancialRequirementRules
• FincuraApi.InlineResponse200
• FincuraApi.InlineResponse2001
• FincuraApi.InlineResponse2002
• FincuraApi.InlineResponse2003
• FincuraApi.InlineResponse2004
• FincuraApi.InlineResponse2005
• FincuraApi.InlineResponse2006
• FincuraApi.Loan
• FincuraApi.LoanBorrowerInfo
• FincuraApi.LoanComplianceInfo
• FincuraApi.LoanDocuments
• FincuraApi.LoanFinancials
• FincuraApi.LoanFinancialsCalculatedValue
• FincuraApi.LoanFinancialsCells
• FincuraApi.LoanFinancialsDataColumns
• FincuraApi.LoanFinancialsTemplateItems
• FincuraApi.LoanGuarantors
• FincuraApi.LoanPeriods
• FincuraApi.LoanPriorYearFinancials
• FincuraApi.PortalLink
• FincuraApi.PortalLinkStatementTypes
• FincuraApi.Portfolio
• FincuraApi.TenantSettings
• FincuraApi.Webhook

Documentation for Authorization

API_Key

• Type: Bearer authentication (JWT)