Skip to main content
GET
Get KYC Status

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

Response

200 OK

Error Responses

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.