Credit Application

Request URL

POST /ibis/credit-card/application

Description

This endpoint initializes a credit card application for the indicated customer.

To check the KYC/KYB status of a customer before requesting an ibis debit card, you may use the /akepa/status endpoint and verify that the outcome for the KYC/KYB verification application is "Approved". Note that when using /akepa/status, every entityApplications object must have an "approved" status in order for the overall verification application outcome to resolve to "Approved". It is the client's responsibility to check the KYC/KYB status before requesting card or account products if necessary.

Note: It is possible to have multiple credit applications for the same customer. For example, the following requests may result in two separate credit applications.

{ //same customer data
    "customerId" : "cstap_1Vu13vFOsYLXR2Tsvm68jW",
    "employer" : "ABC123 Inc.",
    "totalAnnualIncome" : 50000,
    "totalAnnualIncomeCurrency" : "USD"
}
{ //same customer data
    "customerId" : "cstap_1Vu13vFOsYLXR2Tsvm68jW",
    "employer" : "ABC123 Inc.",
    "totalAnnualIncome" : 50000,
    "totalAnnualIncomeCurrency" : "USD"
}

Schema

Property table for ibis/credit-card/application

Property	Description	Required	Schema
customerId	Customer ID in connectFi	Yes	{   "type": "string",   "pattern": "^[0-9a-zA-Z_]+$",   "minLength": 1,   "maxLength": 36,   "description": "common-id" }
employer	The card or account holder's employer	Yes	{   "type": "string",   "pattern": "^((?![<>]).)*$",   "minLength": 1,   "maxLength": 50,   "isNotOnlyWhitespace": true,   "description": "common-commonStr50Req" }
totalAnnualIncome	The card holder's total annual income	Yes	{   "type": "number",   "exclusiveMinimum": 0,   "amountPrecision": 2,   "description": "common-amount" }
totalAnnualIncomeCurrency	A three character ISO alphabetic code to identify the currency	Yes	{   "type": "string",   "maxLength": 3,   "minLength": 3,   "pattern": "^[A-Z]+$",   "description": "common-currency" }

Request Body

{
    "customerId" : "cstap_7uvAC6nLftLGCq7yic3TfI",
    "employer" : "Amazon", 
    "totalAnnualIncome" : 50000, 
    "totalAnnualIncomeCurrency" : "USD"
}

Snippet Examples

javascript

const axios = require('axios');
const data = {
    "customerId" : "cstap_7uvAC6nLftLGCq7yic3TfI",
    "employer" : "Amazon", 
    "totalAnnualIncome" : 50000, 
    "totalAnnualIncomeCurrency" : "USD"
};
const config = {
  method: 'POST',
  url: '${CONNECTFI_BASE_URL}/ibis/credit-card/application',
  headers: {
    'Content-Type': "application/json",
    'x-connectfi-token': "A long random string token received from /auth/get-token request"
  },
  data
};

let result;
try {
  result = await axios.request(config);
  if (result.status === 200) {
    console.log(JSON.stringify(result.data));
  }
} catch (err) {
  console.log({
    errCode: err.code,
    responseStatus: err.response && err.response.status,
    data: err.response && JSON.stringify(err.response.data)
  });
}

cURL

curl --location "CONNECTFI_BASE_URL/ibis/credit-card/application" --data "{\"customerId\": \"cstap_7uvAC6nLftLGCq7yic3TfI\",   \"employer\": \"Amazon\",    \"totalAnnualIncome\": 50000,    \"totalAnnualIncomeCurrency\": \"USD\"}" --header "Content-Type: application/json" --header "x-connectfi-token: A long random string token received from /auth/get-token request" 

Successful Response Examples

200 SUCCESSFUL RESPONSE INDIVIDUAL

HEADERS

Header	Value
Content-Type	application/json
x-connectfi-token	A long random string token received from /auth/get-token request

REQUEST BODY

{
    "customerId" : "cstap_7uvAC6nLftLGCq7yic3TfI",
    "employer" : "Amazon", 
    "totalAnnualIncome" : 50000, 
    "totalAnnualIncomeCurrency" : "USD"
}

RESPONSE BODY

{
    "code": "0",
    "data": {
        "applicationId": "gsa_34doT0IgvGnvDgHEmsi54l",
        "customerId": "cstap_7uvAC6nLftLGCq7yic3TfI",
        "creditFreeze": false,
        "creditLimit": 2700,
        "creditLimitCurrency": "USD",
        "decision": "Approve",
        "adverseAction": []
    },
    "requestId": "64cd247078df11eeb5658f28ab5fe311"
}