Skip to main content
POST
/
v3
/
document
Upload Document
curl --request POST \
  --url https://service-sandbox.tazapay.com/v3/document \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "type": "goods_delivery_proof",
  "reference": "<string>",
  "name": "<string>",
  "description": "<string>",
  "metadata": "<string>"
}
'
{
  "status": "success",
  "message": "",
  "data": {
    "created_at": "2023-09-13T10:22:12.711645400Z",
    "description": "This is a sample document",
    "id": "doc_ck0oql7oclf1aqlh4jdg",
    "metadata": null,
    "name": "Purchase proof",
    "object": "document",
    "reference": "esc_ck0og8noclf1aqlh4icg",
    "type": "tracking_url",
    "url": "https://drive.google.com/file/d/1q5kk5YKcCojdTYir-rONXjN7szuXE16m/view?usp=sharing"
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
url
string
required

Dynamically downloadable URL for document OR Shipment tracking URL

​
type
enum<string>
required

Type of document uploaded

Available options:
goods_delivery_proof,
service_delivery_proof,
tracking_url,
other
​
reference
string
required

ID of the object for which the document is being submitted (checkout, escrow, payin)

​
name
string

Name of the type in case the type is 'other'

​
description
string

Additional information about the document uploaded

​
metadata
string<json>

Set of key-value pairs to attach to the document

Response

200

​
status
string

Indicates whether the document upload or retrieval operation was successful.

Example:

"success"

​
message
string

Additional message or status detail for the API response.

Example:

""

​
data
object

Contains detailed information about the uploaded or retrieved document.