npm.io
1.1.1 • Published 6 years ago

yl-third-party-onboarding-api-client

Licence
MT
Version
1.1.1
Deps
2
Size
310 kB
Vulns
0
Weekly
0
SummaryDependencyVersions

yl-third-party-onboarding-api-client

YouLendThirdPartyOnboardingApi - JavaScript client for Youlend Third Party Onboarding Api.

Through this API you can can initiate the process of onboarding a borrower with YouLend

This SDK is automatically generated by the OpenAPI Generator project:

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

Installation

For Node.js

npm

Then install it via:

npm install yl-third-party-onboarding-api-client --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 yl-third-party-onboarding-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build
git

The library is hosted at a git repository, e.g. https://github.com/YouLend/yl-third-party-onboarding-api-client.git then install it via:

    npm install https://github.com/YouLend/yl-third-party-prequalification-api-client.git --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 YlThirdPartyOnboardingApiClient = require('yl-third-party-onboarding-api-client');

var defaultClient = YlThirdPartyOnboardingApiClient.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN"

var api = new YlThirdPartyOnboardingApiClient.DocumentSigningApi()
var documentSigningId = null; // {String} GUID used to identify the document signing
var opts = {
  'apiVersion': "apiVersion_example" // {String} 

};
api.documentSigningDocumentSigningIdGet(documentSigningId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://dev.youlendapi.com/onboarding

Class Method HTTP request Description
YlThirdPartyOnboardingApiClient.DocumentSigningApi documentSigningDocumentSigningIdGet GET /DocumentSigning/{documentSigningId} Gets the document signing for specified document
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdAccountdetailsGet GET /Leads/{leadId}/accountdetails An endpoint for adding account details to a lead
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdAccountdetailsPut PUT /Leads/{leadId}/accountdetails An endpoint for adding account details to a lead
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdDetailsGet GET /Leads/{leadId}/details An endpoint for viewing the onboarding details of a lead
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdDocumentsBankstatementsPost POST /Leads/{leadId}/documents/bankstatements An endpoint for adding bank statements to a lead
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdDocumentsGet GET /Leads/{leadId}/documents An endpoint for getting kyc documents for a significant person
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdDocumentsPaymentdataPost POST /Leads/{leadId}/documents/paymentdata An endpoint for adding payment data documents to a lead
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdDocumentsSignificantpersonsSignificantPersonIdKycDocumentTypePost POST /Leads/{leadId}/documents/significantpersons/{significantPersonId}/{kycDocumentType} An endpoint for adding kyc documents for a significant person
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdKycquestionsGet GET /Leads/{leadId}/kycquestions An endpoint for viewing the kyc questions of a lead
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdKycquestionsPut PUT /Leads/{leadId}/kycquestions An endpoint for adding KYC question answers to a lead
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdOfferGet GET /Leads/{leadId}/offer An endpoint for getting the loan offer
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdOfferPost POST /Leads/{leadId}/offer An endpoint for creating the loan offer
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdOptionsGet GET /Leads/{leadId}/options An endpoint for getting the loan options for a lead
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdOrganisationdetailsPut PUT /Leads/{leadId}/organisationdetails An endpoint for adding organisation details
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdOrganisationsdetailsGet GET /Leads/{leadId}/organisationsdetails An endpoint for viewing the organisation details of a lead
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdPaymentdataGet GET /Leads/{leadId}/paymentdata An endpoint for viewing the payment data of a lead
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdPaymentgatewaysPost POST /Leads/{leadId}/paymentgateways An endpoint for adding a payment gateway to a lead
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdSignificantpersonsPut PUT /Leads/{leadId}/significantpersons An endpoint for updating significant persons for a lead
YlThirdPartyOnboardingApiClient.LeadsApi leadsLeadIdStatePut PUT /Leads/{leadId}/state An endpoint for updating the state of an onboarding
YlThirdPartyOnboardingApiClient.LeadsApi leadsPost POST /Leads Creates a Youlend Advance Lead

Documentation for Models

Documentation for Authorization

oauth2
  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A