Submit Underwriting
curl --request POST \
--url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/submit-underwriting \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--header 'x-carbon-key: <x-carbon-key>' \
--data '
{
"monthly_revenue": 5000000,
"years_in_business": 3,
"num_employees": 10,
"business_sector": "RETAIL"
}
'const options = {
method: 'POST',
headers: {
'x-carbon-key': '<x-carbon-key>',
apikey: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
monthly_revenue: 5000000,
years_in_business: 3,
num_employees: 10,
business_sector: 'RETAIL'
})
};
fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/submit-underwriting', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/submit-underwriting",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'monthly_revenue' => 5000000,
'years_in_business' => 3,
'num_employees' => 10,
'business_sector' => 'RETAIL'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>",
"x-carbon-key: <x-carbon-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/submit-underwriting"
payload = {
"monthly_revenue": 5000000,
"years_in_business": 3,
"num_employees": 10,
"business_sector": "RETAIL"
}
headers = {
"x-carbon-key": "<x-carbon-key>",
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/submit-underwriting")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-carbon-key"] = '<x-carbon-key>'
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"monthly_revenue\": 5000000,\n \"years_in_business\": 3,\n \"num_employees\": 10,\n \"business_sector\": \"RETAIL\"\n}"
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/submit-underwriting"
payload := strings.NewReader("{\n \"monthly_revenue\": 5000000,\n \"years_in_business\": 3,\n \"num_employees\": 10,\n \"business_sector\": \"RETAIL\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-carbon-key", "<x-carbon-key>")
req.Header.Add("apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"status": "success",
"message": "Underwriting data submitted"
}Loans
Submit Underwriting Data
Submit business profile information required for credit decisioning.
POST
/
v1
/
loans
/
{applicationId}
/
submit-underwriting
Submit Underwriting
curl --request POST \
--url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/submit-underwriting \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--header 'x-carbon-key: <x-carbon-key>' \
--data '
{
"monthly_revenue": 5000000,
"years_in_business": 3,
"num_employees": 10,
"business_sector": "RETAIL"
}
'const options = {
method: 'POST',
headers: {
'x-carbon-key': '<x-carbon-key>',
apikey: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
monthly_revenue: 5000000,
years_in_business: 3,
num_employees: 10,
business_sector: 'RETAIL'
})
};
fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/submit-underwriting', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/submit-underwriting",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'monthly_revenue' => 5000000,
'years_in_business' => 3,
'num_employees' => 10,
'business_sector' => 'RETAIL'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>",
"x-carbon-key: <x-carbon-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/submit-underwriting"
payload = {
"monthly_revenue": 5000000,
"years_in_business": 3,
"num_employees": 10,
"business_sector": "RETAIL"
}
headers = {
"x-carbon-key": "<x-carbon-key>",
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/submit-underwriting")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-carbon-key"] = '<x-carbon-key>'
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"monthly_revenue\": 5000000,\n \"years_in_business\": 3,\n \"num_employees\": 10,\n \"business_sector\": \"RETAIL\"\n}"
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/submit-underwriting"
payload := strings.NewReader("{\n \"monthly_revenue\": 5000000,\n \"years_in_business\": 3,\n \"num_employees\": 10,\n \"business_sector\": \"RETAIL\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-carbon-key", "<x-carbon-key>")
req.Header.Add("apikey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"status": "success",
"message": "Underwriting data submitted"
}Overview
Sends business structure, address, and profile data required by the credit decision engine. Must be called afterPOST /v1/loans/apply. The optional userIdentity object provides additional KYC data.
Request
Method:POSTURL:
/v1/loans/:applicationId/submit-underwriting
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
x-carbon-key | Header | string | Yes | API key for authentication. |
applicationId | Path | string | Yes | Application ID from apply step. |
Request Body
{
"structure": {
"hasWebsite": true,
"hasSocialMediaHandles": true,
"hasAuditedFinancialStatement": false,
"payPension": false,
"hasPayeeReceipt": false,
"hasBusinessInsurance": false,
"hasTaxClearanceCert": false,
"hasManagementAccounts": false,
"hasAccountant": true,
"hasStaffHealthCare": false,
"ownProperty": false,
"payRent": true
},
"address": {
"lga": "Lagos Island",
"city": "Lagos Island",
"state": "LAGOS",
"country": "Nigeria",
"addressVerificationType": "POWER_BILL"
},
"profile": {
"yearsInBusiness": "TWO_TO_FIVE",
"numberOfLocations": "ONE",
"numberOfStaff": "ONE_TO_FIVE",
"grossProfitMargin": 35,
"operatingExpenses": 150000,
"businessRole": "OWNER",
"averageDailyCustomers": "FIVE_TO_FOURTEEN",
"businessStartDate": "2022-01-15"
},
"userIdentity": {
"idType": "NIN",
"idNumber": "11111111111"
}
}
structure — all boolean:
hasWebsite · hasSocialMediaHandles · hasAuditedFinancialStatement · payPension · hasPayeeReceipt · hasBusinessInsurance · hasTaxClearanceCert · hasManagementAccounts · hasAccountant · hasStaffHealthCare · ownProperty · payRent
address:
| Field | Required | Allowed values |
|---|---|---|
lga | Yes | Local government area string |
city | No | |
state | No | |
country | No | |
addressVerificationType | No | POWER_BILL · INTERNET_BILL · WATER_CORPORATION_BILL · WASTE_MANAGEMENT_BILL · STAMPED_RENT_RECEIPT |
profile:
| Field | Required | Allowed values |
|---|---|---|
yearsInBusiness | Yes | ONE · TWO_TO_FIVE · SIX_OR_MORE |
numberOfLocations | Yes | ONE · TWO_TO_FIVE · SIX_OR_MORE |
numberOfStaff | Yes | ONE_TO_FIVE · SIX_TO_FIFTEEN · SIXTEEN_OR_MORE |
grossProfitMargin | Yes | Number between 1 and 100 |
operatingExpenses | Yes | Positive number (kobo) |
businessRole | Yes | OWNER · PARTNER |
averageDailyCustomers | Yes | ONE_TO_FOUR · FIVE_TO_FOURTEEN · FIFTEEN_TO_TWENTYFOUR · TWENTYFIVE_TO_FORTYNINE · FIFTY_OR_MORE |
businessStartDate | Yes | YYYY-MM-DD |
userIdentity — optional. Both fields required if the object is included:
| Field | Description |
|---|---|
idType | e.g. NIN, DRIVERS_LICENSE, PASSPORT |
idNumber | The identity number |
Response
200 OK
{
"status": "success",
"message": "Underwriting data submitted"
}
Error Responses
| Status | Message | Cause |
|---|---|---|
| 400 | Application not found | Invalid applicationId |
| 400 | structure is required | Missing structure object |
| 400 | address.lga is required | Missing lga in address |
| 400 | profile.yearsInBusiness must be one of: ... | Invalid enum |
| 400 | profile.grossProfitMargin must be a number between 1 and 100 | Out of range |
| 400 | userIdentity.idType is required when userIdentity is provided | Incomplete identity object |
| 422 | Application has no loan ID | Application not yet registered in lending engine |
Authorizations
Provide your API key in the 'apikey' header.
Headers
Path Parameters
Body
application/json
Provide the required values for the request body.
Response
200 - application/json
Successful response
The response is of type object.
⌘I