Skip to main content
Available in🇮🇳 India
A document is a KYC file stored for an account. The Documents APIs return it as below. It is either a file you uploaded with Upload a Document or the Aadhaar that Razorpay downloaded from the Central KYC Records Registry (CKYC).
The Document entity has the following parameters:
string
Unique identifier for the file, file_ followed by 14 letters or digits.
string
Always document.
string
The document type of the file. See Document Types.
string
A signed link to download the file. Set only by Fetch One Document with include_signed_url=true. Otherwise null. It is also null when Razorpay could not create the link.
object
About the stored file.
string
Where the file came from. Possible values:
  • upload: You uploaded it.
  • ckyc: Razorpay downloaded it from the CKYC record.
string
The file name as you sent it.
string
The format Razorpay detected from the file content, such as image/jpeg. It can be null.
integer
File size in bytes. It can be null.

Document Types

Upload a Document accepts these 186 values for type. The person’s PAN card is individual_pan_document. individual_pan is the PAN number, sent in identity_numbers.

Documents on the Account

An upload alone does not attach the file. To attach it, send its id in the matching documents key with Update an Account, such as { "id": "file_Qx7Lm2Kd9Tz4Ab" }. To share a document as a link instead, send its url in that key. Razorpay downloads the file and keeps its own copy. The Documents APIs never take a link. Once attached, the document appears in the account’s documents maps, such as business_profile.documents. It also appears in supporting_document. There, Razorpay also returns its check:
object
The document’s check. It is null until Razorpay checks the attached document.
string
Where the check is. Possible values:
  • in_progress: The check is running.
  • deferred: The check could not conclude, so a reviewer decides after the product is submitted. The requirement clears and error_code is null.
  • verified: The check passed.
  • rejected: The check failed. error_code says why.
  • collected: Razorpay has received the value and has not checked it yet.
string
A stable code for the failure, such as bank_name_mismatch, pan_not_found or otp_invalid. Razorpay never returns the bank’s or registry’s own record, such as the account holder’s name. The code says what did not match. Know more about failed-check codes.
string
A sentence to show the sub-merchant. The wording can change. It never repeats the value sent.
integer
Time at which the check passed, as a Unix timestamp in seconds.
object
Details of the check, where it has any. {} when the check has none.
integer
Time at which the check started, as a Unix timestamp in seconds.
Last modified on November 18, 2026