Comment on page

Documentation

KapedPartnerApi.RESTCallsApi
All URIs are relative to https://api.kaped.io/partner​
Method
HTTP request
Description
​activeCardGet​
GET /active-card
active-card
​applicationStatusUpdate​
POST /application-status-update
Application Status Update
​checkStatusGet​
GET /check-status
check-status
​editApplication​
POST /edit-application
Edit Application
​editB2B2CApplication​
POST /edit-b2b2c-application
Edit Application
​listApplicationGet​
GET /list-application
list-application
​loginTokenPost​
POST /login-token
Login
​resumeApplication​
POST /resume-application
Resume Application
​singleApplicationGet​
GET /single-application
single-application
​singleCardGet​
GET /single-card
single-card
​submitApplication​
POST /submit-application
Submit Application
​submitApplicationB2B2C​
POST /submit-b2b2c-application
Submit Application B2B2C
​viewCardDetail​
POST /view-card-detail
View card Detail
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
Name
Type
Description
Notes
apiKey
String
​
​
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
Name
Type
Description
Notes
body
​ApplicationStatusUpdate​
​
​
apiKey
String
​
​
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
Name
Type
Description
Notes
apiKey
String
​
​
applicationID
String
​
​
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
Name
Type
Description
Notes
applicationID
String
​
​
partnerBusinessName
String
​
​
partnerDateIncorporated
String
​
​
partnerBusinessType
​Business​
​
​
partnerBusinessAddress
String
​
​
partnerStreet2
String
​
​
partnerGeneralInformationCity
String
​
​
partnerGeneralInformationState
​States​
​
​
partnerGeneralInformationZip
Number
​
​
partnerWebsite
String
​
​
partnerSIC
​SIC​
​
​
partnerOwnership
​Ownership​
​
​
partnerBusinessDescription
String
​
​
partnerBusinessFax
Number
​
​
partnerInitialCreditLimit
Number
​
​
partnerCustomerInformationFirstName
String
​
​
partnerCustomerInformationLastName
String
​
​
partnerCustomerInformationHomeAddress
String
​
​
partnerCustomerInformationHomeStreet2
String
​
​
partnerCustomerInformationState
​States​
​
​
partnerCustomerInformationCity
String
​
​
partnercustomerInformationZip
Number
​
​
partnerCustomerInformationPercentOwnership
Number
​
​
partnerCustomerInformationDOB
String
​
​
haveInsurance
Boolean
​
​
gender
​Gender​
​
​
apiKey
String
​
​
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
Name
Type
Description
Notes
applicationID
String
​
​
partnerBusinessName
String
​
​
partnerDateIncorporated
String
​
​
partnerBusinessType
​Business​
​
​
partnerBusinessAddress
String
​
​
partnerStreet2
String
​
​
partnerGeneralInformationCity
String
​
​
partnerGeneralInformationState
​States​
​
​
partnerGeneralInformationZip
Number
​
​
partnerWebsite
String
​
​
partnerSIC
​SIC​
​
​
partnerOwnership
​Ownership​
​
​
partnerBusinessDescription
String
​
​
partnerBusinessFax
Number
​
​
partnerInitialCreditLimit
Number
​
​
partnerCustomerInformationFirstName
String
​
​
partnerCustomerInformationLastName
String
​
​
partnerCustomerInformationHomeAddress
String
​
​
partnerCustomerInformationHomeStreet2
String
​
​
partnerCustomerInformationState
​States​
​
​
partnerCustomerInformationCity
String
​
​
partnercustomerInformationZip
Number
​
​
partnerCustomerInformationPercentOwnership
Number
​
​
partnerCustomerInformationDOB
String
​
​
haveInsurance
Boolean
​
​
gender
​Gender​
​
​
apiKey
String
​
​
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
Name
Type
Description
Notes
apiKey
String
​
​
type
String
​
​
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
Name
Type
Description
Notes
username
String
​
​
apiKey
String
​
​
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
Name
Type
Description
Notes
body
​ResumeApplication​
​
​
apiKey
String
​
​
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
Name

Method	HTTP request	Description
activeCardGet	GET /active-card	active-card
applicationStatusUpdate	POST /application-status-update	Application Status Update
checkStatusGet	GET /check-status	check-status
editApplication	POST /edit-application	Edit Application
editB2B2CApplication	POST /edit-b2b2c-application	Edit Application
listApplicationGet	GET /list-application	list-application
loginTokenPost	POST /login-token	Login
resumeApplication	POST /resume-application	Resume Application
singleApplicationGet	GET /single-application	single-application
singleCardGet	GET /single-card	single-card
submitApplication	POST /submit-application	Submit Application
submitApplicationB2B2C	POST /submit-b2b2c-application	Submit Application B2B2C
viewCardDetail	POST /view-card-detail	View card Detail

Name	Type	Description	Notes
applicationID	String
partnerBusinessName	String
partnerDateIncorporated	String
partnerBusinessType	Business
partnerBusinessAddress	String
partnerStreet2	String
partnerGeneralInformationCity	String
partnerGeneralInformationState	States
partnerGeneralInformationZip	Number
partnerWebsite	String
partnerSIC	SIC
partnerOwnership	Ownership
partnerBusinessDescription	String
partnerBusinessFax	Number
partnerInitialCreditLimit	Number
partnerCustomerInformationFirstName	String
partnerCustomerInformationLastName	String
partnerCustomerInformationHomeAddress	String
partnerCustomerInformationHomeStreet2	String
partnerCustomerInformationState	States
partnerCustomerInformationCity	String
partnercustomerInformationZip	Number
partnerCustomerInformationPercentOwnership	Number
partnerCustomerInformationDOB	String
haveInsurance	Boolean
gender	Gender
apiKey	String

Name	Type	Description	Notes
applicationID	String
partnerBusinessName	String
partnerDateIncorporated	String
partnerBusinessType	Business
partnerBusinessAddress	String
partnerStreet2	String
partnerGeneralInformationCity	String
partnerGeneralInformationState	States
partnerGeneralInformationZip	Number
partnerWebsite	String
partnerSIC	SIC
partnerOwnership	Ownership
partnerBusinessDescription	String
partnerBusinessFax	Number
partnerInitialCreditLimit	Number
partnerCustomerInformationFirstName	String
partnerCustomerInformationLastName	String
partnerCustomerInformationHomeAddress	String
partnerCustomerInformationHomeStreet2	String
partnerCustomerInformationState	States
partnerCustomerInformationCity	String
partnercustomerInformationZip	Number
partnerCustomerInformationPercentOwnership	Number
partnerCustomerInformationDOB	String
haveInsurance	Boolean
gender	Gender
apiKey	String