documents.md

Document

Create a Document

var formData = {
    'file': {
        'value': fs.createReadStream('/Users/your_name/Downloads/sample_uploaded.pdf'),
        'options': {
            'filename': 'sample_uploaded.pdf',
            'contentType': null
        }
    },
    'purpose': 'dispute_evidence'
};

instance.documents.create(formData);

Parameters:

Name	Type	Description
file*	string	The URL generated once the business proof document is uploaded.
purpose	string	Possible value is dispute_evidence

Response:

{
  "id": "doc_EsyWjHrfzb59Re",
  "entity": "document",
  "purpose": "dispute_evidence",
  "name": "doc_19_12_2020.jpg",
  "mime_type": "image/png",
  "size": 2863,
  "created_at": 1590604200
}

---

Fetch Document Information

var documentId = "doc_EsyWjHrfzb59Re";

instance.documents.fetch(documentId);

Parameters:

Name	Type	Description
Id*	string	The unique identifier of the document.

Response:

{
  "entity": "document",
  "id": "doc_00000000000000",
  "purpose": "dispute_evidence",
  "created_at": 1701701378,
  "mime_type": "application/pdf",
  "display_name": "ppm_00000000000000",
  "size": 404678,
  "url": ""
}

---

PN: * indicates mandatory fields

For reference click here