Post-Offer KYC
curl --request POST \
--url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/post-offer-kyc \
--header 'apikey: <api-key>' \
--header 'x-carbon-key: <x-carbon-key>'const options = {
method: 'POST',
headers: {'x-carbon-key': '<x-carbon-key>', apikey: '<api-key>'}
};
fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/post-offer-kyc', 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}/post-offer-kyc",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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}/post-offer-kyc"
headers = {
"x-carbon-key": "<x-carbon-key>",
"apikey": "<api-key>"
}
response = requests.post(url, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/post-offer-kyc")
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>'
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/post-offer-kyc"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-carbon-key", "<x-carbon-key>")
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"status": "success",
"message": "Post-offer KYC initiated"
}Loans
Post-Offer KYC
Complete the post-offer KYC gate. Final step before loan disbursement.
POST
/
v1
/
loans
/
{applicationId}
/
post-offer-kyc
Post-Offer KYC
curl --request POST \
--url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/post-offer-kyc \
--header 'apikey: <api-key>' \
--header 'x-carbon-key: <x-carbon-key>'const options = {
method: 'POST',
headers: {'x-carbon-key': '<x-carbon-key>', apikey: '<api-key>'}
};
fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/post-offer-kyc', 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}/post-offer-kyc",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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}/post-offer-kyc"
headers = {
"x-carbon-key": "<x-carbon-key>",
"apikey": "<api-key>"
}
response = requests.post(url, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/post-offer-kyc")
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>'
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/{applicationId}/post-offer-kyc"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-carbon-key", "<x-carbon-key>")
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"status": "success",
"message": "Post-offer KYC initiated"
}Overview
Completes the post-offer KYC gate and triggers the disbursement eligibility check. All of the following must be true before this call succeeds:- Customer has agreed to terms of use (
POST /terms/agree) - Offer has been accepted (
POST /offer/accept) - Board resolution uploaded (non-sole-proprietor businesses only)
- Board resolution admin review is not
FAILED - Guarantor form admin review is not
FAILED(if a guarantor was added)
offerStatus transitions to POST_OFFER_KYC and the disbursement eligibility check fires automatically.
Request
Method:POSTURL:
/v1/loans/:applicationId/post-offer-kyc
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
x-carbon-key | Header | string | Yes | API key for authentication. |
applicationId | Path | string | Yes | Application ID. |
Response
200 OK
{
"status": "success",
"message": "Post-offer KYC saved",
"data": {}
}
Error Responses
| Status | Message | Cause |
|---|---|---|
| 400 | Application not found | Invalid applicationId |
| 422 | Application has no loan ID | Application not yet registered |
| 400 | Please agree to terms of use before proceeding | POST /terms/agree not yet called |
| 400 | Please accept your loan offer before proceeding | POST /offer/accept not yet called |
| 400 | Please upload your board resolution document before proceeding | Non-sole-proprietor missing board resolution |
| 400 | Please address the admin review feedback on your board resolution document | Board resolution admin review failed |
| 400 | Please address the admin review feedback on your guarantor document | Guarantor form admin review failed |