Skip to main content

The KycDocument object

Represents an uploaded KYC document. Contains information about the document and its verification status.

Fields

FieldTypeDescription
id
REQUIRED
stringUnique identifier for the document
merchantId
REQUIRED
stringID of the merchant who uploaded the document
type
REQUIRED
KycDocumentTypeType of document KycDocumentType
fileName
REQUIRED
stringOriginal filename
fileSize
REQUIRED
numberFile size in bytes
mimeType
REQUIRED
stringMIME type of the file
status
REQUIRED
'pending'| 'approved'| 'rejected'Verification status
rejectionReason
OPTIONAL
stringReason for rejection (if rejected)
uploadedAt
REQUIRED
stringISO 8601 timestamp when the document was uploaded
reviewedAt
OPTIONAL
stringISO 8601 timestamp when the document was reviewed

Example

{
"id": "obj_1a2b3c",
"merchantId": "merchant_1a2b3c",
"type": "id_card",
"fileName": "string",
"fileSize": 1,
"mimeType": "string",
"status": "pending",
"rejectionReason": "string",
"uploadedAt": "2026-01-15T09:30:00Z"
}