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 type of the file. See Document Types.
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.Where the file came from. Possible values:
upload: You uploaded it.ckyc: Razorpay downloaded it from the CKYC record.
Document Types
Upload a Document accepts these 186 values fortype. 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 itsid 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:
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 anderror_codeisnull.verified: The check passed.rejected: The check failed.error_codesays why.collected: Razorpay has received the value and has not checked it yet.
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.