Docs Logo

Documents API

Create a Document

Fetch Document Information

Fetch Document Content

Docs Logo

API Test keys

Api

Documents

Fetch Info

API Test keys

Api

Documents

Fetch Info

Fetch Document Information

GET
/v1/documents/:id

Click to copy

Use this endpoint to retrieve the details of any document that was uploaded earlier.

Is this page helpful?

Curl

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2
-X GET https://api.razorpay.com/v1/documents/doc_EsyWjHrfzb59Re

Success

Failure

1
{
2
  "id": "doc_EsyWjHrfzb59Re",
3
  "entity": "document",
4
  "purpose": "dispute_evidence",
5
  "name": "file_19_18_2020.jpg",
6
  "mime_type": "image/png",
7
  "size": 2863,
8
  "created_at": 1590604200
9
}
Path Parameters
id

*

string

The unique identifier of the document.

Response Parameters
id
string

The 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 nature and format in which the document is uploaded. Possible values include:

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

created_at
integer

Unix timestamp at which the document was uploaded.

Errors

The API <key/secret> provided is invalid.

Error Status: 400

The API credentials passed in the API call differ from the ones generated on the Dashboard.

  • Different keys for test mode and live modes.
  • Expired API key.

Solution

_id is not a valid id.

Error Status: 400

  • The id is not 14 characters long.
  • The id is not alphanumeric.

Solution

Fetch Document Information

GET
/v1/documents/:id

Click to copy

Use this endpoint to retrieve the details of any document that was uploaded earlier.

Is this page helpful?

Path Parameters
id

*

string

The unique identifier of the document.

Response Parameters
id
string

The 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 nature and format in which the document is uploaded. Possible values include:

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

created_at
integer

Unix timestamp at which the document was uploaded.

Errors

The API <key/secret> provided is invalid.

Error Status: 400

The API credentials passed in the API call differ from the ones generated on the Dashboard.

  • Different keys for test mode and live modes.
  • Expired API key.

Solution

_id is not a valid id.

Error Status: 400

  • The id is not 14 characters long.
  • The id is not alphanumeric.

Solution

Curl

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2
-X GET https://api.razorpay.com/v1/documents/doc_EsyWjHrfzb59Re

Success

Failure

1
{
2
  "id": "doc_EsyWjHrfzb59Re",
3
  "entity": "document",
4
  "purpose": "dispute_evidence",
5
  "name": "file_19_18_2020.jpg",
6
  "mime_type": "image/png",
7
  "size": 2863,
8
  "created_at": 1590604200
9
}