Use the Documents APIs to securely send documents to Razorpay. Document upload might be necessary for the following use cases:

Submission of dispute evidence.
Submission of identification proofs during onboarding.

Documents Entity🔗

 Documents Entity
Copy{
  "id": "doc_EsyWjHrfzb59Re",
  "entity": "document",
  "purpose": "dispute_evidence",
  "name": "file_19_18_2020.png",
  "mime_type": "image/png",
  "size": 2863,
  "created_at": 1590604200
}

id

string Unique identifier of the document uploaded.

entity

string Indicates the type of entity. In this case, it is document.

purpose

string The reason you are uploading this document. Here, it is dispute_evidence.

size

integer Indicates the size of the document in bytes.

mime_type

string Indicates the mime_type of the document uploaded. Possible values include:

image/jpg
image/jpeg
image/png
application/pdf

created_at

integer Timestamp (in Unix) when the document was uploaded.

Create a Document🔗

You can upload a document onto the Razorpay ecosystem using the below endpoint. Post successful document creation, the corresponding document_id (present in response) can be provided in use cases such as dispute evidence submission.

/documents

 Request Response
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST 'https://api.razorpay.com/v1/documents' \
-H "Content-Type: multipart/form-data" \
-F 'purpose=dispute_evidence' \
-F 'file=@/Users/your_name/sample_uploaded.jpeg'
Copy{
  "id": "doc_EsyWjHrfzb59Re",
  "entity": "document",
  "purpose": "dispute_evidence",
  "name": "doc_19_12_2020.png",
  "mime_type": "image/png",
  "size": 2863,
  "created_at": 1590604200
}

Fetch Document Information🔗

This API allows you to retrieve details of any document that has been uploaded earlier.

/documents/:id

 Request Response
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X GET https://api.razorpay.com/v1/documents/doc_EsyWjHrfzb59Re
Copy{
  "id": "doc_EsyWjHrfzb59Re",
  "entity": "document",
  "purpose": "dispute_evidence",
  "name": "file_19_18_2020.png",
  "mime_type": "image/png",
  "size": 2863,
  "created_at": 1590604200
}

Path Parameter🔗

id mandatory: string The unique identifier of the document.

Fetch Document Content🔗

This API allows you to download an earlier uploaded document.

/documents/:id/content

 Request
Copycurl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-X GET https://api.razorpay.com/v1/documents/:id/content

Path Parameter🔗

id mandatory: string The unique identifier of the document.