Guides

Managing credit applications

How to manage credit applications for a customer.

Suggest Edits

Use the operations shown below to manage credit applications:

Retrieving credit applications

Retrieving all credit applications

To retrieve all credit applications, use the GET /credit/applications operation and provide the optional query parameters, as shown in the table below.

Query parameterTypeDescription
limitintegerNumber of applications to return per page, up to 50. Default is 50.
customer_idstringThe unique ID used to reference the customer resource.
starting_afterstringApplication_id after which to get a page of results, ordered by date created.
Note: Cannot be used at the same time as ending_before.
ending_beforestringApplication_id before which to get a page of results, ordered by date created.
Note: Cannot be used at the same time as starting_after.

An example of a request to retrieve all credit applications is shown below.

curl --request GET \
     --url 'https://sandbox.bond.tech/api/v0.1/credit/applications?limit=100&customer_id=55ad4182-3a22-4e31-9499-08cf30e15094' \
     --header 'Accept: application/json' \
     --header 'Authorization: YOUR-AUTHENTICATION' \
     --header 'Identity: YOUR-IDENTITY'

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://sandbox.bond.tech/api/v0.1/credit/applications?limit=100&customer_id=55ad4182-3a22-4e31-9499-08cf30e15094")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Identity"] = 'YOUR-IDENTITY'
request["Authorization"] = 'YOUR-AUTHENTICATION'

response = http.request(request)
puts response.read_body

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Identity: 'YOUR-IDENTITY',
    Authorization: 'YOUR-AUTHENTICATION'
  }
};

fetch('https://sandbox.bond.tech/api/v0.1/credit/applications?limit=100&customer_id=55ad4182-3a22-4e31-9499-08cf30e15094', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import requests

url = "https://sandbox.bond.tech/api/v0.1/credit/applications?limit=100&customer_id=55ad4182-3a22-4e31-9499-08cf30e15094"

headers = {
    "Accept": "application/json",
    "Identity": "YOUR-IDENTITY",
    "Authorization": "YOUR-AUTHENTICATION"
}

response = requests.get(url, headers=headers)

print(response.text)

var client = new RestClient("https://sandbox.bond.tech/api/v0.1/credit/applications?limit=100&customer_id=55ad4182-3a22-4e31-9499-08cf30e15094");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Identity", "YOUR-IDENTITY");
request.AddHeader("Authorization", "YOUR-AUTHENTICATION");
IRestResponse response = client.Execute(request);

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://sandbox.bond.tech/api/v0.1/credit/applications?limit=100&customer_id=55ad4182-3a22-4e31-9499-08cf30e15094")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("Identity", "YOUR-IDENTITY")
  .addHeader("Authorization", "YOUR-AUTHENTICATION")
  .build();

Response response = client.newCall(request).execute();

An example of a response to a successful request to retrieve all credit applications is shown below.

{
  "has_more": true,
  "data": [
    {
      "application_id": "2629182a-3aeb-4834-846a-1688d4649bb9",
      "program_id": "54f7882b-6b95-4cde-a7eb-775b9468bcb1",
      "date_created": "2021-11-15T00:17:56.842105Z",
      "date_updated": "2021-11-15T00:17:56.842105Z",
      "application_status": "created",
      "applicant": {
        "customer_id": "05a8054f-8259-4e30-8d1d-d286081987bd",
        "employment_status": "employed",
        "address_id": "bb5fa77d-fd66-4e31-81c0-eaf549b0c797",
        "total_annual_income": 5000050,
        "monthly_housing_payment": 1000,
        "terms_accepted": true,
        "currency": "USD",
        "first_name": "James",
        "middle_name": "Herbert",
        "last_name": "Bond",
        "date_of_birth": "1997-12-25",
        "street": "45 California St.",
        "street2": "Suite 600",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "zip_code": "94105",
        "ssn": "tok_sandbox_xoZzhoxaCXHb823bZp3x2e",
        "email": "[email protected]"
      },
      "accounts": {
        "security_deposit_account_id": null
      }
    },
    {
      "application_id": "7dc64eb2-a747-4c64-99bd-2a00834add7d",
      "program_id": "54f7882b-6b95-4cde-a7eb-775b9468bcb1",
      "date_created": "2021-11-15T00:17:56.842105Z",
      "date_updated": "2021-11-15T00:17:56.842105Z",
      "application_status": "created",
      "applicant": {
        "customer_id": "05a8054f-8259-4e30-8d1d-d286081987bd",
        "employment_status": "employed",
        "address_id": "06b0bebf-657c-4cbb-91aa-f829ec713be6",
        "total_annual_income": 5000050,
        "monthly_housing_payment": 1000,
        "terms_accepted": true,
        "currency": "USD",
        "first_name": "Money",
        "middle_name": "",
        "last_name": "Penny",
        "date_of_birth": "1997-12-25",
        "street": "45 California St.",
        "street2": "Suite 600",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "zip_code": "94105",
        "ssn": "tok_sandbox_xoZzhoxaCXHb823bZp3x2e",
        "email": "[email protected]"
      },
      "accounts": {
        "security_deposit_account_id": null
      }
    }
  ]
}

For a complete specification and interactive example, see Retrieving credit applications in the Bond API Reference.

Retrieving a specific credit application

To retrieve a specific credit application, use the GET /credit/applications/{application_id} operation with no further parameters.

An example of a request to retrieve a specific credit application is shown below.

curl --request GET \
     --url https://sandbox.bond.tech/api/v0.1/credit/applications/693a3106-8cf9-4d84-a4c7-381960c6f331 \
     --header 'Accept: application/json' \
     --header 'Authorization: YOUR-AUTHENTICATION' \
     --header 'Identity: YOUR-IDENTITY'

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://sandbox.bond.tech/api/v0.1/credit/applications/693a3106-8cf9-4d84-a4c7-381960c6f331")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Identity"] = 'YOUR-IDENTITY'
request["Authorization"] = 'YOUR-AUTHENTICATION'

response = http.request(request)
puts response.read_body

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Identity: 'YOUR-IDENTITY',
    Authorization: 'YOUR-AUTHENTICATION'
  }
};

fetch('https://sandbox.bond.tech/api/v0.1/credit/applications/693a3106-8cf9-4d84-a4c7-381960c6f331', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import requests

url = "https://sandbox.bond.tech/api/v0.1/credit/applications/693a3106-8cf9-4d84-a4c7-381960c6f331"

headers = {
    "Accept": "application/json",
    "Identity": "YOUR-IDENTITY",
    "Authorization": "YOUR-AUTHENTICATION"
}

response = requests.get(url, headers=headers)

print(response.text)

var client = new RestClient("https://sandbox.bond.tech/api/v0.1/credit/applications/693a3106-8cf9-4d84-a4c7-381960c6f331");
var request = new RestRequest(Method.GET);
request.AddHeader("Accept", "application/json");
request.AddHeader("Identity", "YOUR-IDENTITY");
request.AddHeader("Authorization", "YOUR-AUTHENTICATION");
IRestResponse response = client.Execute(request);

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://sandbox.bond.tech/api/v0.1/credit/applications/693a3106-8cf9-4d84-a4c7-381960c6f331")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("Identity", "YOUR-IDENTITY")
  .addHeader("Authorization", "YOUR-AUTHENTICATION")
  .build();

Response response = client.newCall(request).execute();

An example of a response to a successful request to retrieve a specific credit application is shown below.

{
  "application_id": "2629182a-3aeb-4834-846a-1688d4649bb9",
  "program_id": "54f7882b-6b95-4cde-a7eb-775b9468bcb1",
  "date_created": "2021-11-15T00:17:56.842105Z",
  "date_updated": "2021-11-15T00:17:56.842105Z",
  "application_status": "created",
  "applicant": {
    "customer_id": "05a8054f-8259-4e30-8d1d-d286081987bd",
    "employment_status": "employed",
    "address_id": "bb5fa77d-fd66-4e31-81c0-eaf549b0c797",
    "total_annual_income": 5000050,
    "monthly_housing_payment": 1000,
    "terms_accepted": true,
    "currency": "USD",
    "first_name": "James",
    "middle_name": "Herbert",
    "last_name": "Bond",
    "date_of_birth": "1997-12-25",
    "street": "45 California St.",
    "street2": "Suite 600",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "zip_code": "94105",
    "ssn": "tok_sandbox_xoZzhoxaCXHb823bZp3x2e",
    "email": "[email protected]"
  },
  "accounts": {
    "security_deposit_account_id": null
  }
}

For a complete specification and interactive example, see Retrieving a credit application in the Bond API Reference.

Updating a credit application

To update a credit application, use the PATCH /credit/applications/{application_id} operation and provide the applicant object parameters, as shown in the tables below.

ParameterTypeDescription
application_id
required		stringUnique ID that identifies the credit application.
applicantobjectDetails of the customer as shown in the Applicant object table below.

The Applicant object has the following structure. Enter the detail(s) of the credit application that you want to update.

applicant ObjectTypeDescription
employment_statusstringOne of; employed, self_employed, unemployed, retired, student, or other`.
total_annual_incomeintegerTotal annual income in cents, for example 12000000 being $120,000.
monthly_housing_paymentintegerMonthly housing payment in cents, for example 136000 being $1360.

An example of a request to update a credit application is shown below.

curl --request PATCH \
     --url https://sandbox.bond.tech/api/v0.1/credit/applications/693a3106-8cf9-4d84-a4c7-381960c6f331 \
     --header 'Accept: application/json' \
     --header 'Authorization: YOUR-AUTHENTICATION' \
     --header 'Content-Type: application/json' \
     --header 'Identity: YOUR-IDENTITY' \
     --data '
{
     "applicant": {
          "employment_status": "self_employed",
          "total_annual_income": 4300000,
          "monthly_housing_payment": 36500
     }
}
'

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://sandbox.bond.tech/api/v0.1/credit/applications/693a3106-8cf9-4d84-a4c7-381960c6f331")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Accept"] = 'application/json'
request["Content-Type"] = 'application/json'
request["Identity"] = 'YOUR-IDENTITY'
request["Authorization"] = 'YOUR-AUTHENTICATION'
request.body = "{\"applicant\":{\"employment_status\":\"self_employed\",\"total_annual_income\":4300000,\"monthly_housing_payment\":38900}}"

response = http.request(request)
puts response.read_body

const options = {
  method: 'PATCH',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json',
    Identity: 'YOUR-IDENTITY',
    Authorization: 'YOUR-AUTHENTICATION'
  },
  body: JSON.stringify({
    applicant: {
      employment_status: 'self_employed',
      total_annual_income: 4300000,
      monthly_housing_payment: 38900
    }
  })
};

fetch('https://sandbox.bond.tech/api/v0.1/credit/applications/693a3106-8cf9-4d84-a4c7-381960c6f331', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import requests

url = "https://sandbox.bond.tech/api/v0.1/credit/applications/693a3106-8cf9-4d84-a4c7-381960c6f331"

payload = {"applicant": {
        "employment_status": "self_employed",
        "total_annual_income": 4300000,
        "monthly_housing_payment": 38900
    }}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json",
    "Identity": "YOUR-IDENTITY",
    "Authorization": "YOUR-AUTHENTICATION"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

var client = new RestClient("https://sandbox.bond.tech/api/v0.1/credit/applications/693a3106-8cf9-4d84-a4c7-381960c6f331");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Accept", "application/json");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Identity", "YOUR-IDENTITY");
request.AddHeader("Authorization", "YOUR-AUTHENTICATION");
request.AddParameter("application/json", "{\"applicant\":{\"employment_status\":\"self_employed\",\"total_annual_income\":4300000,\"monthly_housing_payment\":38900}}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"applicant\":{\"employment_status\":\"self_employed\",\"total_annual_income\":4300000,\"monthly_housing_payment\":38900}}");
Request request = new Request.Builder()
  .url("https://sandbox.bond.tech/api/v0.1/credit/applications/693a3106-8cf9-4d84-a4c7-381960c6f331")
  .patch(body)
  .addHeader("Accept", "application/json")
  .addHeader("Content-Type", "application/json")
  .addHeader("Identity", "YOUR-IDENTITY")
  .addHeader("Authorization", "YOUR-AUTHENTICATION")
  .build();

Response response = client.newCall(request).execute();

An example of a response to a successful request to update a credit application is shown below.

{
  "application_id": "2629182a-3aeb-4834-846a-1688d4649bb9",
  "program_id": "54f7882b-6b95-4cde-a7eb-775b9468bcb1",
  "date_created": "2021-11-15T00:17:56.842105Z",
  "date_updated": "2021-11-15T00:17:56.842105Z",
  "application_status": "created",
  "applicant": {
    "customer_id": "05a8054f-8259-4e30-8d1d-d286081987bd",
    "employment_status": "employed",
    "address_id": "bb5fa77d-fd66-4e31-81c0-eaf549b0c797",
    "total_annual_income": 5000050,
    "monthly_housing_payment": 1000,
    "terms_accepted": true,
    "currency": "USD",
    "first_name": "James",
    "middle_name": "Herbert",
    "last_name": "Bond",
    "date_of_birth": "1997-12-25",
    "street": "45 California St.",
    "street2": "Suite 600",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "zip_code": "94105",
    "ssn": "tok_sandbox_xoZzhoxaCXHb823bZp3x2e",
    "email": "[email protected]"
  },
  "accounts": {
    "security_deposit_account_id": null
  }
}

For a complete specification and interactive examples, see Updating a credit application in the Bond API Reference.

Updated over 2 years ago

Next Steps