Documentation

KapedPartnerApi.RESTCallsApi

All URIs are relative to https://api.kaped.io/partner

activeCardGet

activeCardGet(apiKey)

active-card

Example

import {KapedPartnerApi} from 'kaped_partner_api';
let defaultClient = KapedPartnerApi.ApiClient.instance;


let apiInstance = new KapedPartnerApi.RESTCallsApi();
let apiKey = "apiKey_example"; // String | 

apiInstance.activeCardGet(apiKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined

  • Accept: Not defined

applicationStatusUpdate

applicationStatusUpdate(body, apiKey)

Application Status Update

Example

import {KapedPartnerApi} from 'kaped_partner_api';
let defaultClient = KapedPartnerApi.ApiClient.instance;


let apiInstance = new KapedPartnerApi.RESTCallsApi();
let body = new KapedPartnerApi.ApplicationStatusUpdate(); // ApplicationStatusUpdate | 
let apiKey = "apiKey_example"; // String | 

apiInstance.applicationStatusUpdate(body, apiKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json

  • Accept: Not defined

checkStatusGet

checkStatusGet(apiKey, applicationID)

check-status

Example

import {KapedPartnerApi} from 'kaped_partner_api';
let defaultClient = KapedPartnerApi.ApiClient.instance;


let apiInstance = new KapedPartnerApi.RESTCallsApi();
let apiKey = "apiKey_example"; // String | 
let applicationID = "applicationID_example"; // String | 

apiInstance.checkStatusGet(apiKey, applicationID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined

  • Accept: Not defined

editApplication

EditApplication editApplication(applicationID, partnerBusinessName, partnerDateIncorporated, partnerBusinessType, partnerBusinessAddress, partnerStreet2, partnerGeneralInformationCity, partnerGeneralInformationState, partnerGeneralInformationZip, partnerWebsite, partnerSIC, partnerOwnership, partnerBusinessDescription, partnerBusinessFax, partnerInitialCreditLimit, partnerCustomerInformationFirstName, partnerCustomerInformationLastName, partnerCustomerInformationHomeAddress, partnerCustomerInformationHomeStreet2, partnerCustomerInformationState, partnerCustomerInformationCity, partnercustomerInformationZip, partnerCustomerInformationPercentOwnership, partnerCustomerInformationDOB, haveInsurance, gender, apiKey)

Edit Application

Example

import {KapedPartnerApi} from 'kaped_partner_api';
let defaultClient = KapedPartnerApi.ApiClient.instance;


let apiInstance = new KapedPartnerApi.RESTCallsApi();
let applicationID = "applicationID_example"; // String | 
let partnerBusinessName = "partnerBusinessName_example"; // String | 
let partnerDateIncorporated = "partnerDateIncorporated_example"; // String | 
let partnerBusinessType = new KapedPartnerApi.Business(); // Business | 
let partnerBusinessAddress = "partnerBusinessAddress_example"; // String | 
let partnerStreet2 = "partnerStreet2_example"; // String | 
let partnerGeneralInformationCity = "partnerGeneralInformationCity_example"; // String | 
let partnerGeneralInformationState = new KapedPartnerApi.States(); // States | 
let partnerGeneralInformationZip = 56; // Number | 
let partnerWebsite = "partnerWebsite_example"; // String | 
let partnerSIC = new KapedPartnerApi.SIC(); // SIC | 
let partnerOwnership = new KapedPartnerApi.Ownership(); // Ownership | 
let partnerBusinessDescription = "partnerBusinessDescription_example"; // String | 
let partnerBusinessFax = 56; // Number | 
let partnerInitialCreditLimit = 56; // Number | 
let partnerCustomerInformationFirstName = "partnerCustomerInformationFirstName_example"; // String | 
let partnerCustomerInformationLastName = "partnerCustomerInformationLastName_example"; // String | 
let partnerCustomerInformationHomeAddress = "partnerCustomerInformationHomeAddress_example"; // String | 
let partnerCustomerInformationHomeStreet2 = "partnerCustomerInformationHomeStreet2_example"; // String | 
let partnerCustomerInformationState = new KapedPartnerApi.States(); // States | 
let partnerCustomerInformationCity = "partnerCustomerInformationCity_example"; // String | 
let partnercustomerInformationZip = 56; // Number | 
let partnerCustomerInformationPercentOwnership = 56; // Number | 
let partnerCustomerInformationDOB = "partnerCustomerInformationDOB_example"; // String | 
let haveInsurance = true; // Boolean | 
let gender = new KapedPartnerApi.Gender(); // Gender | 
let apiKey = "apiKey_example"; // String | 

apiInstance.editApplication(applicationID, partnerBusinessName, partnerDateIncorporated, partnerBusinessType, partnerBusinessAddress, partnerStreet2, partnerGeneralInformationCity, partnerGeneralInformationState, partnerGeneralInformationZip, partnerWebsite, partnerSIC, partnerOwnership, partnerBusinessDescription, partnerBusinessFax, partnerInitialCreditLimit, partnerCustomerInformationFirstName, partnerCustomerInformationLastName, partnerCustomerInformationHomeAddress, partnerCustomerInformationHomeStreet2, partnerCustomerInformationState, partnerCustomerInformationCity, partnercustomerInformationZip, partnerCustomerInformationPercentOwnership, partnerCustomerInformationDOB, haveInsurance, gender, apiKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Return type

EditApplication

Authorization

bearerAuth

HTTP request headers

  • Content-Type: multipart/form-data

  • Accept: application/json

editB2B2CApplication

EditB2b2cApplication editB2B2CApplication(applicationID, partnerBusinessName, partnerDateIncorporated, partnerBusinessType, partnerBusinessAddress, partnerStreet2, partnerGeneralInformationCity, partnerGeneralInformationState, partnerGeneralInformationZip, partnerWebsite, partnerSIC, partnerOwnership, partnerBusinessDescription, partnerBusinessFax, partnerInitialCreditLimit, partnerCustomerInformationFirstName, partnerCustomerInformationLastName, partnerCustomerInformationHomeAddress, partnerCustomerInformationHomeStreet2, partnerCustomerInformationState, partnerCustomerInformationCity, partnercustomerInformationZip, partnerCustomerInformationPercentOwnership, partnerCustomerInformationDOB, haveInsurance, gender, apiKey)

Edit Application

Example

import {KapedPartnerApi} from 'kaped_partner_api';
let defaultClient = KapedPartnerApi.ApiClient.instance;


let apiInstance = new KapedPartnerApi.RESTCallsApi();
let applicationID = "applicationID_example"; // String | 
let partnerBusinessName = "partnerBusinessName_example"; // String | 
let partnerDateIncorporated = "partnerDateIncorporated_example"; // String | 
let partnerBusinessType = new KapedPartnerApi.Business(); // Business | 
let partnerBusinessAddress = "partnerBusinessAddress_example"; // String | 
let partnerStreet2 = "partnerStreet2_example"; // String | 
let partnerGeneralInformationCity = "partnerGeneralInformationCity_example"; // String | 
let partnerGeneralInformationState = new KapedPartnerApi.States(); // States | 
let partnerGeneralInformationZip = 56; // Number | 
let partnerWebsite = "partnerWebsite_example"; // String | 
let partnerSIC = new KapedPartnerApi.SIC(); // SIC | 
let partnerOwnership = new KapedPartnerApi.Ownership(); // Ownership | 
let partnerBusinessDescription = "partnerBusinessDescription_example"; // String | 
let partnerBusinessFax = 56; // Number | 
let partnerInitialCreditLimit = 56; // Number | 
let partnerCustomerInformationFirstName = "partnerCustomerInformationFirstName_example"; // String | 
let partnerCustomerInformationLastName = "partnerCustomerInformationLastName_example"; // String | 
let partnerCustomerInformationHomeAddress = "partnerCustomerInformationHomeAddress_example"; // String | 
let partnerCustomerInformationHomeStreet2 = "partnerCustomerInformationHomeStreet2_example"; // String | 
let partnerCustomerInformationState = new KapedPartnerApi.States(); // States | 
let partnerCustomerInformationCity = "partnerCustomerInformationCity_example"; // String | 
let partnercustomerInformationZip = 56; // Number | 
let partnerCustomerInformationPercentOwnership = 56; // Number | 
let partnerCustomerInformationDOB = "partnerCustomerInformationDOB_example"; // String | 
let haveInsurance = true; // Boolean | 
let gender = new KapedPartnerApi.Gender(); // Gender | 
let apiKey = "apiKey_example"; // String | 

apiInstance.editB2B2CApplication(applicationID, partnerBusinessName, partnerDateIncorporated, partnerBusinessType, partnerBusinessAddress, partnerStreet2, partnerGeneralInformationCity, partnerGeneralInformationState, partnerGeneralInformationZip, partnerWebsite, partnerSIC, partnerOwnership, partnerBusinessDescription, partnerBusinessFax, partnerInitialCreditLimit, partnerCustomerInformationFirstName, partnerCustomerInformationLastName, partnerCustomerInformationHomeAddress, partnerCustomerInformationHomeStreet2, partnerCustomerInformationState, partnerCustomerInformationCity, partnercustomerInformationZip, partnerCustomerInformationPercentOwnership, partnerCustomerInformationDOB, haveInsurance, gender, apiKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Return type

EditB2b2cApplication

Authorization

bearerAuth

HTTP request headers

  • Content-Type: multipart/form-data

  • Accept: application/json

listApplicationGet

listApplicationGet(apiKey, type)

list-application

Example

import {KapedPartnerApi} from 'kaped_partner_api';
let defaultClient = KapedPartnerApi.ApiClient.instance;


let apiInstance = new KapedPartnerApi.RESTCallsApi();
let apiKey = "apiKey_example"; // String | 
let type = "type_example"; // String | 

apiInstance.listApplicationGet(apiKey, type, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined

  • Accept: Not defined

loginTokenPost

Login loginTokenPost(username, apiKey)

Login

Example

import {KapedPartnerApi} from 'kaped_partner_api';

let apiInstance = new KapedPartnerApi.RESTCallsApi();
let username = "username_example"; // String | 
let apiKey = "apiKey_example"; // String | 

apiInstance.loginTokenPost(username, apiKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Return type

Login

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data

  • Accept: application/json

resumeApplication

resumeApplication(body, apiKey)

Resume Application

Example

import {KapedPartnerApi} from 'kaped_partner_api';
let defaultClient = KapedPartnerApi.ApiClient.instance;


let apiInstance = new KapedPartnerApi.RESTCallsApi();
let body = new KapedPartnerApi.ResumeApplication(); // ResumeApplication | 
let apiKey = "apiKey_example"; // String | 

apiInstance.resumeApplication(body, apiKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json

  • Accept: Not defined

singleApplicationGet

singleApplicationGet(apiKey, applicationID)

single-application

Example

import {KapedPartnerApi} from 'kaped_partner_api';
let defaultClient = KapedPartnerApi.ApiClient.instance;


let apiInstance = new KapedPartnerApi.RESTCallsApi();
let apiKey = "apiKey_example"; // String | 
let applicationID = "applicationID_example"; // String | 

apiInstance.singleApplicationGet(apiKey, applicationID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined

  • Accept: Not defined

singleCardGet

singleCardGet(apiKey, userUniqueId, month)

single-card

Example

import {KapedPartnerApi} from 'kaped_partner_api';
let defaultClient = KapedPartnerApi.ApiClient.instance;


let apiInstance = new KapedPartnerApi.RESTCallsApi();
let apiKey = "apiKey_example"; // String | 
let userUniqueId = "userUniqueId_example"; // String | 
let month = "month_example"; // String | 

apiInstance.singleCardGet(apiKey, userUniqueId, month, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined

  • Accept: Not defined

submitApplication

SubmitApplication submitApplication(applicationType, partnerBusinessName, partnerTaxID, partnerDateIncorporated, partnerBusinessType, partnerBusinessAddress, partnerStreet2, partnerGeneralInformationCity, partnerGeneralInformationState, partnerGeneralInformationZip, partnerWebsite, partnerSIC, partnerOwnership, partnerBusinessDescription, partnerBusinessPhone, partnerCustomerSupportEmail, partnerBusinessFax, partnerInitialCreditLimit, partnerCustomerInformationFirstName, partnerCustomerInformationLastName, partnerCustomerInformationHomeAddress, partnerCustomerInformationHomeStreet2, partnerCustomerInformationState, partnerCustomerInformationCity, partnercustomerInformationZip, partnerCustomerInformationPercentOwnership, partnerCustomerInformationDrivingLicenseNumber, partnerCustomerInformationLicenseDate, partnerCustomerInformationDOB, partnerCustomerInformationSSN, partnerTermsConditions, haveInsurance, gender, EIN, articles, sSNCard, dLFront, dLBack, apiKey)

Submit Application

Example

import {KapedPartnerApi} from 'kaped_partner_api';
let defaultClient = KapedPartnerApi.ApiClient.instance;


let apiInstance = new KapedPartnerApi.RESTCallsApi();
let applicationType = "applicationType_example"; // String | 
let partnerBusinessName = "partnerBusinessName_example"; // String | 
let partnerTaxID = 1.2; // Number | 
let partnerDateIncorporated = "partnerDateIncorporated_example"; // String | 
let partnerBusinessType = new KapedPartnerApi.Business(); // Business | 
let partnerBusinessAddress = "partnerBusinessAddress_example"; // String | 
let partnerStreet2 = "partnerStreet2_example"; // String | 
let partnerGeneralInformationCity = "partnerGeneralInformationCity_example"; // String | 
let partnerGeneralInformationState = new KapedPartnerApi.States(); // States | 
let partnerGeneralInformationZip = 56; // Number | 
let partnerWebsite = "partnerWebsite_example"; // String | 
let partnerSIC = new KapedPartnerApi.SIC(); // SIC | 
let partnerOwnership = new KapedPartnerApi.Ownership(); // Ownership | 
let partnerBusinessDescription = "partnerBusinessDescription_example"; // String | 
let partnerBusinessPhone = 56; // Number | 
let partnerCustomerSupportEmail = "partnerCustomerSupportEmail_example"; // String | 
let partnerBusinessFax = 56; // Number | 
let partnerInitialCreditLimit = 56; // Number | 
let partnerCustomerInformationFirstName = "partnerCustomerInformationFirstName_example"; // String | 
let partnerCustomerInformationLastName = "partnerCustomerInformationLastName_example"; // String | 
let partnerCustomerInformationHomeAddress = "partnerCustomerInformationHomeAddress_example"; // String | 
let partnerCustomerInformationHomeStreet2 = "partnerCustomerInformationHomeStreet2_example"; // String | 
let partnerCustomerInformationState = new KapedPartnerApi.States(); // States | 
let partnerCustomerInformationCity = "partnerCustomerInformationCity_example"; // String | 
let partnercustomerInformationZip = 56; // Number | 
let partnerCustomerInformationPercentOwnership = 56; // Number | 
let partnerCustomerInformationDrivingLicenseNumber = "partnerCustomerInformationDrivingLicenseNumber_example"; // String | 
let partnerCustomerInformationLicenseDate = "partnerCustomerInformationLicenseDate_example"; // String | 
let partnerCustomerInformationDOB = "partnerCustomerInformationDOB_example"; // String | 
let partnerCustomerInformationSSN = "partnerCustomerInformationSSN_example"; // String | 
let partnerTermsConditions = true; // Boolean | 
let haveInsurance = true; // Boolean | 
let gender = new KapedPartnerApi.Gender(); // Gender | 
let EIN = ["QmFzZTY0IGV4YW1wbGU="]; // [Blob] | 
let articles = ["QmFzZTY0IGV4YW1wbGU="]; // [Blob] | 
let sSNCard = ["QmFzZTY0IGV4YW1wbGU="]; // [Blob] | 
let dLFront = ["QmFzZTY0IGV4YW1wbGU="]; // [Blob] | 
let dLBack = ["QmFzZTY0IGV4YW1wbGU="]; // [Blob] | 
let apiKey = "apiKey_example"; // String | 

apiInstance.submitApplication(applicationType, partnerBusinessName, partnerTaxID, partnerDateIncorporated, partnerBusinessType, partnerBusinessAddress, partnerStreet2, partnerGeneralInformationCity, partnerGeneralInformationState, partnerGeneralInformationZip, partnerWebsite, partnerSIC, partnerOwnership, partnerBusinessDescription, partnerBusinessPhone, partnerCustomerSupportEmail, partnerBusinessFax, partnerInitialCreditLimit, partnerCustomerInformationFirstName, partnerCustomerInformationLastName, partnerCustomerInformationHomeAddress, partnerCustomerInformationHomeStreet2, partnerCustomerInformationState, partnerCustomerInformationCity, partnercustomerInformationZip, partnerCustomerInformationPercentOwnership, partnerCustomerInformationDrivingLicenseNumber, partnerCustomerInformationLicenseDate, partnerCustomerInformationDOB, partnerCustomerInformationSSN, partnerTermsConditions, haveInsurance, gender, EIN, articles, sSNCard, dLFront, dLBack, apiKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Return type

SubmitApplication

Authorization

bearerAuth

HTTP request headers

  • Content-Type: multipart/form-data

  • Accept: application/json

submitApplicationB2B2C

SubmitB2b2cApplication submitApplicationB2B2C(applicationType, customerCurrentCity, customerCurrentStreetAddress, customerFirstName, customerMiddleName, customerLastName, customerMaidenName, customerDateOfBirth, customerSSN, customerGender, customerEmail, customerDrivingLicenseNumber, customerCurrentState, customerCurrentZip, customerCurrentYears, customerPersonalPhone, customerHomeType, customerEmployerName, customerPosition, customerBusinessPhone, customerYearsInJob, customerMonthlyIncome, customerOtherIncome, customerSourceOtherIncome, customerHaveInsurance, customerTermsConditions, initialCreditLimit, dLFront, dLBack, apiKey)

Submit Application B2B2C

Example

import {KapedPartnerApi} from 'kaped_partner_api';
let defaultClient = KapedPartnerApi.ApiClient.instance;


let apiInstance = new KapedPartnerApi.RESTCallsApi();
let applicationType = "applicationType_example"; // String | 
let customerCurrentCity = "customerCurrentCity_example"; // String | 
let customerCurrentStreetAddress = "customerCurrentStreetAddress_example"; // String | 
let customerFirstName = "customerFirstName_example"; // String | 
let customerMiddleName = "customerMiddleName_example"; // String | 
let customerLastName = "customerLastName_example"; // String | 
let customerMaidenName = "customerMaidenName_example"; // String | 
let customerDateOfBirth = "customerDateOfBirth_example"; // String | 
let customerSSN = 56; // Number | 
let customerGender = new KapedPartnerApi.Gender(); // Gender | 
let customerEmail = "customerEmail_example"; // String | 
let customerDrivingLicenseNumber = 56; // Number | 
let customerCurrentState = new KapedPartnerApi.States(); // States | 
let customerCurrentZip = 56; // Number | 
let customerCurrentYears = 56; // Number | 
let customerPersonalPhone = 56; // Number | 
let customerHomeType = "customerHomeType_example"; // String | 
let customerEmployerName = "customerEmployerName_example"; // String | 
let customerPosition = "customerPosition_example"; // String | 
let customerBusinessPhone = 56; // Number | 
let customerYearsInJob = 56; // Number | 
let customerMonthlyIncome = 56; // Number | 
let customerOtherIncome = 56; // Number | 
let customerSourceOtherIncome = "customerSourceOtherIncome_example"; // String | 
let customerHaveInsurance = true; // Boolean | 
let customerTermsConditions = true; // Boolean | 
let initialCreditLimit = 56; // Number | 
let dLFront = ["QmFzZTY0IGV4YW1wbGU="]; // [Blob] | 
let dLBack = ["QmFzZTY0IGV4YW1wbGU="]; // [Blob] | 
let apiKey = "apiKey_example"; // String | 

apiInstance.submitApplicationB2B2C(applicationType, customerCurrentCity, customerCurrentStreetAddress, customerFirstName, customerMiddleName, customerLastName, customerMaidenName, customerDateOfBirth, customerSSN, customerGender, customerEmail, customerDrivingLicenseNumber, customerCurrentState, customerCurrentZip, customerCurrentYears, customerPersonalPhone, customerHomeType, customerEmployerName, customerPosition, customerBusinessPhone, customerYearsInJob, customerMonthlyIncome, customerOtherIncome, customerSourceOtherIncome, customerHaveInsurance, customerTermsConditions, initialCreditLimit, dLFront, dLBack, apiKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Return type

SubmitB2b2cApplication

Authorization

bearerAuth

HTTP request headers

  • Content-Type: multipart/form-data

  • Accept: application/json

viewCardDetailre

viewCardDetail(body, apiKey)

View card Detail

Example

import {KapedPartnerApi} from 'kaped_partner_api';
let defaultClient = KapedPartnerApi.ApiClient.instance;


let apiInstance = new KapedPartnerApi.RESTCallsApi();
let body = new KapedPartnerApi.ViewCardDetail(); // ViewCardDetail | 
let apiKey = "apiKey_example"; // String | 

apiInstance.viewCardDetail(body, apiKey, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json

  • Accept: Not defined

Last updated