v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Document Classification

post/v2/kyc/document_classification

Headers

client_idstring required

ID/identifier that is provided by Decentro to a specific client and environment. Please note, this may change based on the environment you are on.

client_secretstring required

The confidential credential provided by Decentro that is associated with the client_id

content-typestring

Request body

reference_idstring required

Any unique ID assigned by you for this API request.

document_typestring required

Only capital letters allowed.

consentstring required

Y/N based on the consent given by the customer. Mandatory as per regulation.

consent_purposestring required

The purpose of taking this consent from your customer. Mandatory as per regulation

documentstring binary

document_urlstring

Response

200

decentroTxnIdstring

statusstring

responseCodestring

messagestring

responseKeystring

Example response

{
  "decentroTxnId": "BC5CD047DB924564AD2B378F5B876963",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "ID classification successful. The document type matches with the document uploaded",
  "data": {
    "documentClassificationStatus": "SUCCESS",
    "idTypeClassified": "aadhaar"
  },
  "responseKey": "success_id_classification"
}