# yl-third-party-onboarding-api-client

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

Latest version **1.1.1** (published 2019-12-02) · MT license · 0 weekly downloads

## Install

```sh
npm install yl-third-party-onboarding-api-client
pnpm add yl-third-party-onboarding-api-client
yarn add yl-third-party-onboarding-api-client
bun add yl-third-party-onboarding-api-client
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2019-12-02 |
| First published | 2019-11-28 |
| Weekly downloads | 0 |
| License | MT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 310.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | aince07, danieldaraban, markstoner, oisinowen, tamas-kluber |

## Links

- npm: https://www.npmjs.com/package/yl-third-party-onboarding-api-client
- Repository: https://github.com/YouLend/yl-third-party-onboarding-api-client
- Homepage: https://github.com/YouLend/yl-third-party-onboarding-api-client#readme
- Issues: https://github.com/YouLend/yl-third-party-onboarding-api-client/issues
- npm.io page: https://npm.io/package/yl-third-party-onboarding-api-client

## Dependencies (2)

- [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.0.0
- [superagent](https://npm.io/package/superagent.md) 3.7.0

## Recent versions

- 1.1.1 (latest) — 2019-12-02
- 1.1.0 — 2019-12-02
- 1.0.1 — 2019-12-02
- 1.0.0 — 2019-11-28

## README

# 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](https://openapi-generator.tech) project:

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

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

Then install it via:

```shell
npm install yl-third-party-onboarding-api-client --save
```

Finally, you need to build the module:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
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:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
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:

```shell
    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](http://browserify.org/). 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):

```shell
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:

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

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
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**](docs/DocumentSigningApi.md#documentSigningDocumentSigningIdGet) | **GET** /DocumentSigning/{documentSigningId} | Gets the document signing for specified document
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdAccountdetailsGet**](docs/LeadsApi.md#leadsLeadIdAccountdetailsGet) | **GET** /Leads/{leadId}/accountdetails | An endpoint for adding account details to a lead
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdAccountdetailsPut**](docs/LeadsApi.md#leadsLeadIdAccountdetailsPut) | **PUT** /Leads/{leadId}/accountdetails | An endpoint for adding account details to a lead
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdDetailsGet**](docs/LeadsApi.md#leadsLeadIdDetailsGet) | **GET** /Leads/{leadId}/details | An endpoint for viewing the onboarding details of a lead
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdDocumentsBankstatementsPost**](docs/LeadsApi.md#leadsLeadIdDocumentsBankstatementsPost) | **POST** /Leads/{leadId}/documents/bankstatements | An endpoint for adding bank statements to a lead
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdDocumentsGet**](docs/LeadsApi.md#leadsLeadIdDocumentsGet) | **GET** /Leads/{leadId}/documents | An endpoint for getting kyc documents for a significant person
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdDocumentsPaymentdataPost**](docs/LeadsApi.md#leadsLeadIdDocumentsPaymentdataPost) | **POST** /Leads/{leadId}/documents/paymentdata | An endpoint for adding payment data documents to a lead
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdDocumentsSignificantpersonsSignificantPersonIdKycDocumentTypePost**](docs/LeadsApi.md#leadsLeadIdDocumentsSignificantpersonsSignificantPersonIdKycDocumentTypePost) | **POST** /Leads/{leadId}/documents/significantpersons/{significantPersonId}/{kycDocumentType} | An endpoint for adding kyc documents for a significant person
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdKycquestionsGet**](docs/LeadsApi.md#leadsLeadIdKycquestionsGet) | **GET** /Leads/{leadId}/kycquestions | An endpoint for viewing the kyc questions of a lead
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdKycquestionsPut**](docs/LeadsApi.md#leadsLeadIdKycquestionsPut) | **PUT** /Leads/{leadId}/kycquestions | An endpoint for adding KYC question answers to a lead
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdOfferGet**](docs/LeadsApi.md#leadsLeadIdOfferGet) | **GET** /Leads/{leadId}/offer | An endpoint for getting the loan offer
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdOfferPost**](docs/LeadsApi.md#leadsLeadIdOfferPost) | **POST** /Leads/{leadId}/offer | An endpoint for creating the loan offer
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdOptionsGet**](docs/LeadsApi.md#leadsLeadIdOptionsGet) | **GET** /Leads/{leadId}/options | An endpoint for getting the loan options for a lead
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdOrganisationdetailsPut**](docs/LeadsApi.md#leadsLeadIdOrganisationdetailsPut) | **PUT** /Leads/{leadId}/organisationdetails | An endpoint for adding organisation details
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdOrganisationsdetailsGet**](docs/LeadsApi.md#leadsLeadIdOrganisationsdetailsGet) | **GET** /Leads/{leadId}/organisationsdetails | An endpoint for viewing the organisation details of a lead
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdPaymentdataGet**](docs/LeadsApi.md#leadsLeadIdPaymentdataGet) | **GET** /Leads/{leadId}/paymentdata | An endpoint for viewing the payment data of a lead
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdPaymentgatewaysPost**](docs/LeadsApi.md#leadsLeadIdPaymentgatewaysPost) | **POST** /Leads/{leadId}/paymentgateways | An endpoint for adding a payment gateway to a lead
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdSignificantpersonsPut**](docs/LeadsApi.md#leadsLeadIdSignificantpersonsPut) | **PUT** /Leads/{leadId}/significantpersons | An endpoint for updating significant persons for a lead
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsLeadIdStatePut**](docs/LeadsApi.md#leadsLeadIdStatePut) | **PUT** /Leads/{leadId}/state | An endpoint for updating the state of an onboarding
*YlThirdPartyOnboardingApiClient.LeadsApi* | [**leadsPost**](docs/LeadsApi.md#leadsPost) | **POST** /Leads | Creates a Youlend Advance Lead


## Documentation for Models

 - [YlThirdPartyOnboardingApiClient.AccountDetailsModel](docs/AccountDetailsModel.md)
 - [YlThirdPartyOnboardingApiClient.AccountV2StepModel](docs/AccountV2StepModel.md)
 - [YlThirdPartyOnboardingApiClient.Address](docs/Address.md)
 - [YlThirdPartyOnboardingApiClient.AddressModel](docs/AddressModel.md)
 - [YlThirdPartyOnboardingApiClient.AdvanceSignUpData](docs/AdvanceSignUpData.md)
 - [YlThirdPartyOnboardingApiClient.CreateThirdPartyAdvanceOnboardingResultModel](docs/CreateThirdPartyAdvanceOnboardingResultModel.md)
 - [YlThirdPartyOnboardingApiClient.CreditRatingBandParameters](docs/CreditRatingBandParameters.md)
 - [YlThirdPartyOnboardingApiClient.DateModel](docs/DateModel.md)
 - [YlThirdPartyOnboardingApiClient.Document](docs/Document.md)
 - [YlThirdPartyOnboardingApiClient.DocumentMetadataModel](docs/DocumentMetadataModel.md)
 - [YlThirdPartyOnboardingApiClient.DocumentSigningViewModel](docs/DocumentSigningViewModel.md)
 - [YlThirdPartyOnboardingApiClient.FreeTextQuestionModel](docs/FreeTextQuestionModel.md)
 - [YlThirdPartyOnboardingApiClient.Industry](docs/Industry.md)
 - [YlThirdPartyOnboardingApiClient.InlineObject](docs/InlineObject.md)
 - [YlThirdPartyOnboardingApiClient.InlineObject1](docs/InlineObject1.md)
 - [YlThirdPartyOnboardingApiClient.InlineObject2](docs/InlineObject2.md)
 - [YlThirdPartyOnboardingApiClient.KycDocumentModel](docs/KycDocumentModel.md)
 - [YlThirdPartyOnboardingApiClient.KycDocumentsV2StepModel](docs/KycDocumentsV2StepModel.md)
 - [YlThirdPartyOnboardingApiClient.KycFreeTextQuestion](docs/KycFreeTextQuestion.md)
 - [YlThirdPartyOnboardingApiClient.KycQuestions](docs/KycQuestions.md)
 - [YlThirdPartyOnboardingApiClient.KycQuestionsModel](docs/KycQuestionsModel.md)
 - [YlThirdPartyOnboardingApiClient.KycQuestionsStepView](docs/KycQuestionsStepView.md)
 - [YlThirdPartyOnboardingApiClient.KycYesNoQuestion](docs/KycYesNoQuestion.md)
 - [YlThirdPartyOnboardingApiClient.LoanOptionModel](docs/LoanOptionModel.md)
 - [YlThirdPartyOnboardingApiClient.LoanSizingModel](docs/LoanSizingModel.md)
 - [YlThirdPartyOnboardingApiClient.MerchantIdsModel](docs/MerchantIdsModel.md)
 - [YlThirdPartyOnboardingApiClient.OfferStepModel](docs/OfferStepModel.md)
 - [YlThirdPartyOnboardingApiClient.OnboardingOfferModel](docs/OnboardingOfferModel.md)
 - [YlThirdPartyOnboardingApiClient.OnboardingOrganisationDetailsModel](docs/OnboardingOrganisationDetailsModel.md)
 - [YlThirdPartyOnboardingApiClient.OnboardingStateModel](docs/OnboardingStateModel.md)
 - [YlThirdPartyOnboardingApiClient.OnboardingV2View](docs/OnboardingV2View.md)
 - [YlThirdPartyOnboardingApiClient.OrganisationDetailsV3](docs/OrganisationDetailsV3.md)
 - [YlThirdPartyOnboardingApiClient.OrganisationDetailsV3StepView](docs/OrganisationDetailsV3StepView.md)
 - [YlThirdPartyOnboardingApiClient.PaymentDataStepView](docs/PaymentDataStepView.md)
 - [YlThirdPartyOnboardingApiClient.PaymentGatewayModel](docs/PaymentGatewayModel.md)
 - [YlThirdPartyOnboardingApiClient.ProblemDetails](docs/ProblemDetails.md)
 - [YlThirdPartyOnboardingApiClient.SaveBankStatementDocumentResultModel](docs/SaveBankStatementDocumentResultModel.md)
 - [YlThirdPartyOnboardingApiClient.SavePaymentDataDocumentResultModel](docs/SavePaymentDataDocumentResultModel.md)
 - [YlThirdPartyOnboardingApiClient.SaveSignficantPersonKycDocumentResultModel](docs/SaveSignficantPersonKycDocumentResultModel.md)
 - [YlThirdPartyOnboardingApiClient.SaveSignificantPersonsResultModel](docs/SaveSignificantPersonsResultModel.md)
 - [YlThirdPartyOnboardingApiClient.SignatorySigningViewModel](docs/SignatorySigningViewModel.md)
 - [YlThirdPartyOnboardingApiClient.SignificantPersonDocumentsModel](docs/SignificantPersonDocumentsModel.md)
 - [YlThirdPartyOnboardingApiClient.SignificantPersonModel](docs/SignificantPersonModel.md)
 - [YlThirdPartyOnboardingApiClient.SignificantPersonV2](docs/SignificantPersonV2.md)
 - [YlThirdPartyOnboardingApiClient.SignificantPersonsModel](docs/SignificantPersonsModel.md)
 - [YlThirdPartyOnboardingApiClient.ThirdPartyOnboardingModel](docs/ThirdPartyOnboardingModel.md)
 - [YlThirdPartyOnboardingApiClient.YesNoQuestionModel](docs/YesNoQuestionModel.md)


## Documentation for Authorization



### oauth2


- **Type**: OAuth
- **Flow**: application
- **Authorization URL**: 
- **Scopes**: N/A

---
_Source: https://npm.io/package/yl-third-party-onboarding-api-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._