Skip to content

Latest commit

 

History

History
71 lines (57 loc) · 1.82 KB

document.md

File metadata and controls

71 lines (57 loc) · 1.82 KB

Document

Create a Document

$payload = array(
    'file'=> '/Users/your_name/Downloads/sample_uploaded.pdf'
    "purpose" => "dispute_evidence"
);

$api->document->create($payload);

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

$documentId = "";

$api->document->fetch($documentId);

Parameters:

Name Type Description
from timestamp timestamp after which the addons were created
to timestamp timestamp before which the addons were created
count integer number of addons to fetch (default: 10)
skip integer number of addons to be skipped (default: 0)

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