Skip to main content
GET
/
v1
/
loans
/
customers
/
{customerId}
/
kyc-status
Get KYC Status
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/loans/customers/{customerId}/kyc-status \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
{
  "status": "success",
  "data": {
    "customer_id": "1732ca47-42b2-4990-a65d-c369e934eed3",
    "kyc_status": "VERIFIED",
    "verified_at": "2024-05-15T10:05:00Z",
    "rejection_reason": null
  }
}

​
Overview

Returns the current KYC status for a customer. Poll this endpoint after calling POST /v1/loans/customers/:customerId/verify-kyc until kyc_status is VERIFIED. The customer must be VERIFIED before a loan application can be submitted.

​
Request

Method: GET
URL: /v1/loans/customers/:customerId/kyc-status

​
Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
customerIdPathstringYesUUID of the customer.

​
Response

​
200 OK

{
  "status": "success",
  "message": "KYC status fetched",
  "data": {
    "customer_id": "1732ca47-42b2-4990-a65d-c369e934eed3",
    "kyc_status": "VERIFIED"
  }
}
kyc_statusMeaning
NOT_ENROLLEDCustomer has not been enrolled for lending
PENDINGBVN verification in progress
VERIFIEDKYC passed — loan application allowed
REJECTEDKYC failed — customer cannot apply for a loan

​
Error Responses

StatusMessageCause
400Customer not foundcustomerId not found

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Path Parameters

​
customerId
string
required

Response

200 - application/json

Successful response

The response is of type object.