Credit Application

Last updated 2 years ago

Was this helpful?

Credit Application

Get a single application

To fetch a single application, only the application ID is needed to be passed as the parameter in the API call

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
"https://api.kaped.io/partner/single-application?applicationID="

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.RESTCallsApi()
apiKey = apiKey_example # String | 
applicationID = applicationID_example # String | 

try: 
    # single-application
    api_instance.single_application_get(apiKey, applicationID)
except ApiException as e:
    print("Exception when calling RESTCallsApi->singleApplicationGet: %s\n" % e)

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RESTCallsApi;

import java.io.File;
import java.util.*;

public class RESTCallsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        RESTCallsApi apiInstance = new RESTCallsApi();
        String apiKey = apiKey_example; // String | 
        String applicationID = applicationID_example; // String | 
        try {
            apiInstance.singleApplicationGet(apiKey, applicationID);
        } catch (ApiException e) {
            System.err.println("Exception when calling RESTCallsApi#singleApplicationGet");
            e.printStackTrace();
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiRESTCallsApi();
$apiKey = apiKey_example; // String | 
$applicationID = applicationID_example; // String | 

try {
    $api_instance->singleApplicationGet($apiKey, $applicationID);
} catch (Exception $e) {
    echo 'Exception when calling RESTCallsApi->singleApplicationGet: ', $e->getMessage(), PHP_EOL;
}
?>

Listing all applications & their status

To fetch a full list of applications, make an API call to the list-applications endpoint.

If you're only looking for applications under a certain status, you will need to pass the correct status number will your API call.

Application Status Codes

{
"0" = pending at partner side,
"1" = sent to underwriting,
"2" = underwriting started,
"3" = need more information,
"4" = approved by admin,
"5" = rejected by admin,
"6" = rejected by partner,
"7" = started, not finished,
"8" = security deposit pending,
"9" = card issued
}

To display the status of an application to your end users, you will need to pass the applicationid as a parameter with your API call

If partner want to update the status of any application pending at their side. There are only two options available for the partner i.e. either partner can reject the application or can send the same to admin for underwriting. Partner need to pass the Boolean value in the key in the body of the API request.

{ 
"applicationID": "CCA20XXXX91", 
"sentToUnderwriting": true, 
"reject": true
 }

Both cannot be true or false at the same time

After viewing all listed applications, you are able to complete any unfinished ones and submit them for underwriting

Partner can send a resume application email to the end user to pay the application fee and to validate the banking details. Just the application ID is supposed to be passed in the body of the request and user will receive the email to resume the application.

Updating an application

More commonly there will instances where the end user submits an application with a small error. Instead of making them complete a new application, you can simply correct the error for them using this API

PreviousAPI Reference NextCards

Last updated 2 years ago

Was this helpful?

Get a single application

To fetch a single application, only the application ID is needed to be passed as the parameter in the API call

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
"https://api.kaped.io/partner/single-application?applicationID="

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = swagger_client.RESTCallsApi()
apiKey = apiKey_example # String | 
applicationID = applicationID_example # String | 

try: 
    # single-application
    api_instance.single_application_get(apiKey, applicationID)
except ApiException as e:
    print("Exception when calling RESTCallsApi->singleApplicationGet: %s\n" % e)

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RESTCallsApi;

import java.io.File;
import java.util.*;

public class RESTCallsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        RESTCallsApi apiInstance = new RESTCallsApi();
        String apiKey = apiKey_example; // String | 
        String applicationID = applicationID_example; // String | 
        try {
            apiInstance.singleApplicationGet(apiKey, applicationID);
        } catch (ApiException e) {
            System.err.println("Exception when calling RESTCallsApi#singleApplicationGet");
            e.printStackTrace();
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiRESTCallsApi();
$apiKey = apiKey_example; // String | 
$applicationID = applicationID_example; // String | 

try {
    $api_instance->singleApplicationGet($apiKey, $applicationID);
} catch (Exception $e) {
    echo 'Exception when calling RESTCallsApi->singleApplicationGet: ', $e->getMessage(), PHP_EOL;
}
?>

Listing all applications & their status

To fetch a full list of applications, make an API call to the list-applications endpoint.

If you're only looking for applications under a certain status, you will need to pass the correct status number will your API call.

Application Status Codes

{
"0" = pending at partner side,
"1" = sent to underwriting,
"2" = underwriting started,
"3" = need more information,
"4" = approved by admin,
"5" = rejected by admin,
"6" = rejected by partner,
"7" = started, not finished,
"8" = security deposit pending,
"9" = card issued
}

To display the status of an application to your end users, you will need to pass the applicationid as a parameter with your API call

{ 
"applicationID": "CCA20XXXX91", 
"sentToUnderwriting": true, 
"reject": true
 }

Both cannot be true or false at the same time

After viewing all listed applications, you are able to complete any unfinished ones and submit them for underwriting

Updating an application

single-application

GEThttps://api.kaped.io/partner/single-application

Authorization

Query parameters

Header parameters

Response

Successful response

Request

const response = await fetch('https://api.kaped.io/partner/single-application?applicationID=text', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "ApiKey": "text"
    },
});
const data = await response.json();

list-application

GEThttps://api.kaped.io/partner/list-application

Authorization

Query parameters

Header parameters

Response

Successful response

Request

const response = await fetch('https://api.kaped.io/partner/list-application?type=text', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "ApiKey": "text"
    },
});
const data = await response.json();

check-status

GEThttps://api.kaped.io/partner/check-status

Authorization

Query parameters

Header parameters

Response

Successful response

Request

const response = await fetch('https://api.kaped.io/partner/check-status?applicationID=text', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "ApiKey": "text"
    },
});
const data = await response.json();

Application Status Update

POSThttps://api.kaped.io/partner/application-status-update

Authorization

Header parameters

Body

applicationIDstring

sentToUnderwritingboolean

rejectboolean

Response

Successful Response

Request

const response = await fetch('https://api.kaped.io/partner/application-status-update', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "ApiKey": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "applicationID": "CCA202211246",
      "sentToUnderwriting": true,
      "reject": false
    }),
});
const data = await response.json();

Resume Application

POSThttps://api.kaped.io/partner/resume-application

Authorization

Header parameters

Body

applicationIDstring

Response

Successful Response

Request

const response = await fetch('https://api.kaped.io/partner/resume-application', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "ApiKey": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "applicationID": "CCA202211246"
    }),
});
const data = await response.json();

Submit Application B2B2C

POSThttps://api.kaped.io/partner/submit-b2b2c-application

Authorization

Header parameters

Body

applicationType*enum

B2B2C

customerCurrentCity*string

customerCurrentStreetAddress*string

customerFirstName*string

customerMiddleName*string

customerLastName*string

customerMaidenNamestring

customerDateOfBirth*string

YYYY-MM-DD

customerSSN*integer

customerGender*enum

Select Gender

MaleFemaleTransgender

customerEmail*string

customerDrivingLicenseNumber*integer

customerCurrentState*enum

Select State

ALAKAZARCACOCTDEDCFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWYPRVIAEAAAPASGUPWFMMPMH

customerCurrentZip*integer

customerCurrentYears*integer

customerPersonalPhone*integer

customerHomeType*enum

Select Home Type

OwnRent

customerEmployerName*string

customerPosition*string

customerBusinessPhone*integer

customerYearsInJob*integer

customerMonthlyIncome*integer

customerOtherIncomeinteger

customerSourceOtherIncomestring

customerHaveInsurance*boolean

customerTermsConditions*boolean

initialCreditLimit*integer

DL_Front*array of string (binary)

DL_Back*array of string (binary)

Response

Successful Response

Body

applicationType*enum

B2B2C

customerCurrentCity*string

customerCurrentStreetAddress*string

customerFirstName*string

customerMiddleName*string

customerLastName*string

customerMaidenNamestring

customerDateOfBirth*string

YYYY-MM-DD

customerSSN*integer

customerGender*enum

Select Gender

MaleFemaleTransgender

customerEmail*string

customerDrivingLicenseNumber*integer

customerCurrentState*enum

Select State

ALAKAZARCACOCTDEDCFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWYPRVIAEAAAPASGUPWFMMPMH

customerCurrentZip*integer

customerCurrentYears*integer

customerPersonalPhone*integer

customerHomeType*enum

Select Home Type

OwnRent

customerEmployerName*string

customerPosition*string

customerBusinessPhone*integer

customerYearsInJob*integer

customerMonthlyIncome*integer

customerOtherIncomeinteger

customerSourceOtherIncomestring

customerHaveInsurance*boolean

customerTermsConditions*boolean

initialCreditLimit*integer

DL_Front*array of string (binary)

DL_Back*array of string (binary)

Request

const response = await fetch('https://api.kaped.io/partner/submit-b2b2c-application', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "ApiKey": "text",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "applicationType": "B2B2C",
      "customerCurrentCity": "text",
      "customerCurrentStreetAddress": "text",
      "customerFirstName": "text",
      "customerMiddleName": "text",
      "customerLastName": "text",
      "customerDateOfBirth": "text",
      "customerSSN": 1,
      "customerGender": "Male",
      "customerEmail": "text",
      "customerDrivingLicenseNumber": 1,
      "customerCurrentState": "AL",
      "customerCurrentZip": 1,
      "customerCurrentYears": 1,
      "customerPersonalPhone": 1,
      "customerHomeType": "Own",
      "customerEmployerName": "text",
      "customerPosition": "text",
      "customerBusinessPhone": 1,
      "customerYearsInJob": 1,
      "customerMonthlyIncome": 1,
      "customerHaveInsurance": true,
      "customerTermsConditions": true,
      "initialCreditLimit": 1,
      "DL_Front": [
        null
      ],
      "DL_Back": [
        null
      ]
    }),
});
const data = await response.json();

Response

{
  "applicationType": "B2B2C",
  "customerCurrentCity": "text",
  "customerCurrentStreetAddress": "text",
  "customerFirstName": "text",
  "customerMiddleName": "text",
  "customerLastName": "text",
  "customerMaidenName": "text",
  "customerDateOfBirth": "text",
  "customerSSN": 1,
  "customerGender": "Male",
  "customerEmail": "text",
  "customerDrivingLicenseNumber": 1,
  "customerCurrentState": "AL",
  "customerCurrentZip": 1,
  "customerCurrentYears": 1,
  "customerPersonalPhone": 1,
  "customerHomeType": "Own",
  "customerEmployerName": "text",
  "customerPosition": "text",
  "customerBusinessPhone": 1,
  "customerYearsInJob": 1,
  "customerMonthlyIncome": 1,
  "customerOtherIncome": 1,
  "customerSourceOtherIncome": "text",
  "customerHaveInsurance": true,
  "customerTermsConditions": true,
  "initialCreditLimit": 1,
  "DL_Front": [
    "text"
  ],
  "DL_Back": [
    "text"
  ]
}

Edit Application

POSThttps://api.kaped.io/partner/edit-b2b2c-application

Authorization

Header parameters

Body

applicationID*string

partnerBusinessName*string

partnerDateIncorporated*string

YYYY-MM-DD

partnerBusinessType*enum

Select Business

LLCCorporationNon ProfitSole ProprietorGovernment

partnerBusinessAddress*string

partnerStreet2string

partnerGeneralInformationCity*string

partnerGeneralInformationState*enum

Select State

ALAKAZARCACOCTDEDCFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWYPRVIAEAAAPASGUPWFMMPMH

partnerGeneralInformationZip*integer

partnerWebsite*string

partnerSIC*enum

Select SIC

1002007008009001000104010901220122113111381138213891400152015311540160016231700173120002011201320152020202420302033204020502052206020702080208220862090209221002111220022112221225022532273230023202330234023902400242124302451245225102511252025222531254025902600261126212631265026702673271127212731273227412750276127712780279028002810282028212833283428352836284028422844285128602870289028912911295029903011302130503060308030813086308931003140321132203221323132413250326032703272328132903310331233173320333033343341335033573360339034113412342034303433344034423443344434483451345234603470348034903510352335243530353135323533353735403541355035553559356035613562356435673569357035713572357535763577357835793580358535903600361236133620362136303634364036513652366136633669367036723674367736783679369036953711371337143715371637203721372437283730374337513760379038123821382238233824382538263827382938413842384338443845385138613873391039113931394239443949395039603990401140134100421042134220423144004412451245134522458146104700473148124813482248324833484148994900491149224923492449314932494149504953495549614991500050105013502050305031504050455047505050515063506450655070507250805082508450905094509951105122513051405141515051605171517251805190520052115271531153315399540054115412550055315600562156515661570057125731573457355810581259005912594059445945596059615990602160226029603560366099611161416153615961626163617261896199620062116221628263116321632463316351636163996411650065106512651365196531653265526770679267946795679867997000701172007310731173207330733173407350735973617363737073717372737373747377738073817384738573897500751076007812781978227829783078417900794879907997800080118050805180608062807180828090809381118200830083518600870087118731873487418742874488808888890097219995

partnerOwnership*enum

Select

publicprivate

partnerBusinessDescription*string

partnerBusinessFaxinteger

partnerInitialCreditLimit*integer

partnerCustomerInformationFirstName*string

partnerCustomerInformationLastName*string

partnerCustomerInformationHomeAddress*string

partnerCustomerInformationHomeStreet2string

partnerCustomerInformationState*enum

Select State

ALAKAZARCACOCTDEDCFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWYPRVIAEAAAPASGUPWFMMPMH

partnerCustomerInformationCity*string

partnercustomerInformationZip*integer

partnerCustomerInformationPercentOwnership*integer

partnerCustomerInformationDOB*string

YYYY-MM-DD

haveInsuranceboolean

gender*enum

Select Gender

MaleFemaleTransgender

Response

Successful Response

Body

applicationID*string

partnerBusinessName*string

partnerDateIncorporated*string

YYYY-MM-DD

partnerBusinessType*enum

Select Business

LLCCorporationNon ProfitSole ProprietorGovernment

partnerBusinessAddress*string

partnerStreet2string

partnerGeneralInformationCity*string

partnerGeneralInformationState*enum

Select State

ALAKAZARCACOCTDEDCFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWYPRVIAEAAAPASGUPWFMMPMH

partnerGeneralInformationZip*integer

partnerWebsite*string

partnerSIC*enum

Select SIC

partnerOwnership*enum

Select

publicprivate

partnerBusinessDescription*string

partnerBusinessFaxinteger

partnerInitialCreditLimit*integer

partnerCustomerInformationFirstName*string

partnerCustomerInformationLastName*string

partnerCustomerInformationHomeAddress*string

partnerCustomerInformationHomeStreet2string

partnerCustomerInformationState*enum

Select State

ALAKAZARCACOCTDEDCFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWYPRVIAEAAAPASGUPWFMMPMH

partnerCustomerInformationCity*string

partnercustomerInformationZip*integer

partnerCustomerInformationPercentOwnership*integer

partnerCustomerInformationDOB*string

YYYY-MM-DD

haveInsuranceboolean

gender*enum

Select Gender

MaleFemaleTransgender

Request

const response = await fetch('https://api.kaped.io/partner/edit-b2b2c-application', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "ApiKey": "text",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "applicationID": "text",
      "partnerBusinessName": "text",
      "partnerDateIncorporated": "text",
      "partnerBusinessType": "LLC",
      "partnerBusinessAddress": "text",
      "partnerGeneralInformationCity": "text",
      "partnerGeneralInformationState": "AL",
      "partnerGeneralInformationZip": 1,
      "partnerWebsite": "text",
      "partnerSIC": 100,
      "partnerOwnership": "public",
      "partnerBusinessDescription": "text",
      "partnerInitialCreditLimit": 1,
      "partnerCustomerInformationFirstName": "text",
      "partnerCustomerInformationLastName": "text",
      "partnerCustomerInformationHomeAddress": "text",
      "partnerCustomerInformationState": "AL",
      "partnerCustomerInformationCity": "text",
      "partnercustomerInformationZip": 1,
      "partnerCustomerInformationPercentOwnership": 1,
      "partnerCustomerInformationDOB": "text",
      "gender": "Male"
    }),
});
const data = await response.json();

Response

{
  "applicationID": "text",
  "partnerBusinessName": "text",
  "partnerDateIncorporated": "text",
  "partnerBusinessType": "LLC",
  "partnerBusinessAddress": "text",
  "partnerStreet2": "text",
  "partnerGeneralInformationCity": "text",
  "partnerGeneralInformationState": "AL",
  "partnerGeneralInformationZip": 1,
  "partnerWebsite": "text",
  "partnerSIC": 100,
  "partnerOwnership": "public",
  "partnerBusinessDescription": "text",
  "partnerBusinessFax": 1,
  "partnerInitialCreditLimit": 1,
  "partnerCustomerInformationFirstName": "text",
  "partnerCustomerInformationLastName": "text",
  "partnerCustomerInformationHomeAddress": "text",
  "partnerCustomerInformationHomeStreet2": "text",
  "partnerCustomerInformationState": "AL",
  "partnerCustomerInformationCity": "text",
  "partnercustomerInformationZip": 1,
  "partnerCustomerInformationPercentOwnership": 1,
  "partnerCustomerInformationDOB": "text",
  "haveInsurance": true,
  "gender": "Male"
}