Skip to main content
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>'
{
  "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)
On success, the offerStatus transitions to POST_OFFER_KYC and the disbursement eligibility check fires automatically.

Request

Method: POST
URL: /v1/loans/:applicationId/post-offer-kyc

Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
applicationIdPathstringYesApplication ID.
No request body required.

Response

200 OK

{
  "status": "success",
  "message": "Post-offer KYC saved",
  "data": {}
}

Error Responses

StatusMessageCause
400Application not foundInvalid applicationId
422Application has no loan IDApplication not yet registered
400Please agree to terms of use before proceedingPOST /terms/agree not yet called
400Please accept your loan offer before proceedingPOST /offer/accept not yet called
400Please upload your board resolution document before proceedingNon-sole-proprietor missing board resolution
400Please address the admin review feedback on your board resolution documentBoard resolution admin review failed
400Please address the admin review feedback on your guarantor documentGuarantor form admin review failed

Authorizations

apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

x-carbon-key
string
required

Path Parameters

applicationId
string
required

Response

200 - application/json

Successful response

The response is of type object.