Docs

API Documentation

Version 1.0.0

DataWise Document Exchange

API v1.0.0

Code Examples

Ready-to-use Examples

Copy and adapt these examples for your specific use case. Remember to replace YOUR_API_KEY with your actual API key.

Simple Document Generation

curl -X POST https://api.datawise.app/api/datawise_document_exchange \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "ddx_outputFormat=pdf" \
  -F "ddx_template=@template.docx" \
  -F "firstName=John" \
  -F "lastName=Doe" \
  -F "companyName=Acme Corporation" \
  -F "invoiceNumber=INV-2024-001" \
  -F "date=January 15, 2024"

const FormData = require('form-data');
const fs = require('fs');
const axios = require('axios');

const generateDocument = async () => {
  const form = new FormData();
  form.append('ddx_outputFormat', 'pdf');
  form.append('ddx_template', fs.createReadStream('template.docx'));
  form.append('firstName', 'John');
  form.append('lastName', 'Doe');
  form.append('companyName', 'Acme Corporation');
  form.append('invoiceNumber', 'INV-2024-001');
  form.append('date', 'January 15, 2024');

  try {
    const response = await axios.post(
      'https://api.datawise.app/api/datawise_document_exchange',
      form,
      {
        headers: {
          ...form.getHeaders(),
          'Authorization': 'Bearer YOUR_API_KEY'
        },
        responseType: 'arraybuffer',
      },
    );
    console.log('Document generated:', response.data);
  } catch (error) {
    if (error.response?.data instanceof Buffer) {
      const errorText = error.response.data.toString('utf-8');
      console.log('Error:', JSON.parse(errorText));
    } else {
      console.log('Network or other error:', error);
    }
  }
};

generateDocument();

import requests

def generate_document():
    url = 'https://api.datawise.app/api/datawise_document_exchange'

    headers = {
        'Authorization': 'Bearer YOUR_API_KEY'
    }

    files = {
        'ddx_template': open('template.docx', 'rb')
    }

    data = {
        'ddx_outputFormat': 'pdf',
        'firstName': 'John',
        'lastName': 'Doe',
        'companyName': 'Acme Corporation',
        'invoiceNumber': 'INV-2024-001',
        'date': 'January 15, 2024'
    }

    try:
        response = requests.post(url, headers=headers, files=files, data=data)
        response.raise_for_status()
        print('Document generated:', response.json())
    except requests.exceptions.RequestException as e:
        print('Error:', e)
    finally:
        files['ddx_template'].close()

generate_document()

<?php
function generateDocument() {
    $curl = curl_init();

    $postData = [
        'ddx_outputFormat' => 'pdf',
        'ddx_template' => new CURLFile('template.docx'),
        'firstName' => 'John',
        'lastName' => 'Doe',
        'companyName' => 'Acme Corporation',
        'invoiceNumber' => 'INV-2024-001',
        'date' => 'January 15, 2024'
    ];

    curl_setopt_array($curl, [
        CURLOPT_URL => 'https://api.datawise.app/api/datawise_document_exchange',
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_POST => true,
        CURLOPT_POSTFIELDS => $postData,
        CURLOPT_HTTPHEADER => [
            'Authorization: Bearer YOUR_API_KEY'
        ],
    ]);

    $response = curl_exec($curl);
    $httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
    curl_close($curl);

    if ($httpCode === 200) {
        echo 'Document generated: ' . $response;
    } else {
        echo 'Error: ' . $response;
    }
}

generateDocument();
?>

With Dynamic Images

curl -X POST https://api.datawise.app/api/datawise_document_exchange \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "ddx_outputFormat=pdf" \
  -F "ddx_template=@template.docx" \
  -F "companyName=Tech Innovations Inc" \
  -F "%logo_200x100=@company-logo.png" \
  -F "%signature_150x50=@ceo-signature.png" \
  -F "%productImage_300x200=https://example.com/product.jpg"

const FormData = require('form-data');
const fs = require('fs');
const axios = require('axios');

const generateDocumentWithImages = async () => {
  const form = new FormData();
  form.append('ddx_outputFormat', 'pdf');
  form.append('ddx_template', fs.createReadStream('template.docx'));
  form.append('companyName', 'Tech Innovations Inc');

  // Local image files
  form.append('%logo_200x100', fs.createReadStream('company-logo.png'));
  form.append('%signature_150x50', fs.createReadStream('ceo-signature.png'));

  // Image from URL
  form.append('%productImage_300x200', 'https://example.com/product.jpg');

  try {
    const response = await axios.post(
      'https://api.datawise.app/api/datawise_document_exchange',
      form,
      {
        headers: {
          ...form.getHeaders(),
          'Authorization': 'Bearer YOUR_API_KEY'
        },
        responseType: 'arraybuffer',
      },
    );
    console.log('Document with images generated:', response.data);
  } catch (e) {
    if (e.response?.data instanceof Buffer) {
      const errorText = e.response.data.toString('utf-8');
      console.log('Error:', JSON.parse(errorText));
    } else {
      console.log('Network or other error:', e);
    }
  }
};

generateDocumentWithImages();

import requests

def generate_document_with_images():
    url = 'https://api.datawise.app/api/datawise_document_exchange'

    headers = {
        'Authorization': 'Bearer YOUR_API_KEY'
    }

    files = {
        'ddx_template': open('template.docx', 'rb'),
        '%logo_200x100': open('company-logo.png', 'rb'),
        '%signature_150x50': open('ceo-signature.png', 'rb')
    }

    data = {
        'ddx_outputFormat': 'pdf',
        'companyName': 'Tech Innovations Inc',
        '%productImage_300x200': 'https://example.com/product.jpg'
    }

    try:
        response = requests.post(url, headers=headers, files=files, data=data)
        response.raise_for_status()
        print('Document with images generated:', response.json())
    except requests.exceptions.RequestException as e:
        print('Error:', e)
    finally:
        for file in files.values():
            file.close()

generate_document_with_images()

<?php
function generateDocumentWithImages() {
    $curl = curl_init();

    $postData = [
        'ddx_outputFormat' => 'pdf',
        'ddx_template' => new CURLFile('template.docx'),
        'companyName' => 'Tech Innovations Inc',
        '%logo_200x100' => new CURLFile('company-logo.png'),
        '%signature_150x50' => new CURLFile('ceo-signature.png'),
        '%productImage_300x200' => 'https://example.com/product.jpg'
    ];

    curl_setopt_array($curl, [
        CURLOPT_URL => 'https://api.datawise.app/api/datawise_document_exchange',
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_POST => true,
        CURLOPT_POSTFIELDS => $postData,
        CURLOPT_HTTPHEADER => [
            'Authorization: Bearer YOUR_API_KEY'
        ],
    ]);

    $response = curl_exec($curl);
    curl_close($curl);

    echo 'Document with images generated: ' . $response;
}

generateDocumentWithImages();
?>

With Loop Data (Tables/Lists)

curl -X POST https://api.datawise.app/api/datawise_document_exchange \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "ddx_outputFormat=pdf" \
  -F "ddx_template=@invoice-template.docx" \
  -F "invoiceNumber=INV-2024-001" \
  -F '#items=[{"description":"Website Development","quantity":1,"rate":5000,"amount":5000},{"description":"SEO Optimization","quantity":3,"rate":500,"amount":1500},{"description":"Maintenance (Monthly)","quantity":12,"rate":200,"amount":2400}]' \
  -F "totalAmount=8900"

const FormData = require('form-data');
const fs = require('fs');
const axios = require('axios');

const generateInvoiceWithTable = async () => {
  const form = new FormData();
  form.append('ddx_outputFormat', 'pdf');
  form.append('ddx_template', fs.createReadStream('invoice-template.docx'));
  form.append('invoiceNumber', 'INV-2024-001');

  // Loop data for table generation
  const items = [
    { description: 'Website Development', quantity: 1, rate: 5000, amount: 5000 },
    { description: 'SEO Optimization', quantity: 3, rate: 500, amount: 1500 },
    { description: 'Maintenance (Monthly)', quantity: 12, rate: 200, amount: 2400 }
  ];

  form.append('#items', JSON.stringify(items));
  form.append('totalAmount', '8900');

  try {
    const response = await axios.post(
      'https://api.datawise.app/api/datawise_document_exchange',
      form,
      {
        headers: {
          ...form.getHeaders(),
          'Authorization': 'Bearer YOUR_API_KEY'
        },
       responseType: 'arraybuffer',
      }
    );
    console.log('Invoice generated:', response.data);
  } catch (e) {
    if (e.response?.data instanceof Buffer) {
      const errorText = e.response.data.toString('utf-8');
      console.log('Error:', JSON.parse(errorText));
    } else {
      console.log('Network or other error:', e);
    }
  }
};

generateInvoiceWithTable();

import requests
import json

def generate_invoice_with_table():
    url = 'https://api.datawise.app/api/datawise_document_exchange'

    headers = {
        'Authorization': 'Bearer YOUR_API_KEY'
    }

    files = {
        'ddx_template': open('invoice-template.docx', 'rb')
    }

    items = [
        {'description': 'Website Development', 'quantity': 1, 'rate': 5000, 'amount': 5000},
        {'description': 'SEO Optimization', 'quantity': 3, 'rate': 500, 'amount': 1500},
        {'description': 'Maintenance (Monthly)', 'quantity': 12, 'rate': 200, 'amount': 2400}
    ]

    data = {
        'ddx_outputFormat': 'pdf',
        'invoiceNumber': 'INV-2024-001',
        '#items': json.dumps(items),
        'totalAmount': '8900'
    }

    try:
        response = requests.post(url, headers=headers, files=files, data=data)
        response.raise_for_status()
        print('Invoice generated:', response.json())
    except requests.exceptions.RequestException as e:
        print('Error:', e)
    finally:
        files['ddx_template'].close()

generate_invoice_with_table()

<?php
function generateInvoiceWithTable() {
    $curl = curl_init();

    $items = [
        ['description' => 'Website Development', 'quantity' => 1, 'rate' => 5000, 'amount' => 5000],
        ['description' => 'SEO Optimization', 'quantity' => 3, 'rate' => 500, 'amount' => 1500],
        ['description' => 'Maintenance (Monthly)', 'quantity' => 12, 'rate' => 200, 'amount' => 2400]
    ];

    $postData = [
        'ddx_outputFormat' => 'pdf',
        'ddx_template' => new CURLFile('invoice-template.docx'),
        'invoiceNumber' => 'INV-2024-001',
        '#items' => json_encode($items),
        'totalAmount' => '8900'
    ];

    curl_setopt_array($curl, [
        CURLOPT_URL => 'https://api.datawise.app/api/datawise_document_exchange',
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_POST => true,
        CURLOPT_POSTFIELDS => $postData,
        CURLOPT_HTTPHEADER => [
            'Authorization: Bearer YOUR_API_KEY'
        ],
    ]);

    $response = curl_exec($curl);
    curl_close($curl);

    echo 'Invoice generated: ' . $response;
}

generateInvoiceWithTable();
?>

E-Signature Integration

E-Signature Setup

Before using the E-signature feature, you need to set up your sender identity in the dashboard. This is a self-service process that takes just a few minutes.

Setup Steps:

Log in to your account at go.datawise.app
Navigate to Sender Identities from the main navigation menu
Click Add Sender Identity and provide:
- Name: Display name for your sender identity
- Email: The email address to use for sending documents (can be your account email)
- Notification Settings: Choose which notifications you want to receive (optional)
Verify the sender email: A verification email will be sent to the sender email address you specified in step 3. The person with access to that email must click the verification link to approve the sender identity.
Start using E-signatures: Once the sender email is verified, the sender identity status will change to "Approved" and you can start sending documents for signature using that sender email.

Important: The verification email goes to the sender email address (not your account email, unless they're the same). There may be a wait time depending on how quickly that person responds. Make sure they check their inbox and spam folder.

curl -X POST https://api.datawise.app/api/datawise_document_exchange \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "ddx_outputFormat=pdf" \
  -F "ddx_template=@contract-template.docx" \
  -F "clientName=John Doe" \
  -F "contractDate=January 15, 2025" \
  -F 'ddxE_signers=[{"signerRole":"client","signerEmail":"john@example.com","signerName":"John Doe","required":["signature","date"]},{"signerRole":"company","signerEmail":"legal@company.com","signerName":"Jane Smith","required":["signature","initials","date"]}]' \
  -F "ddxE_senderEmail=noreply@company.com" \
  -F "ddxE_emailMessage=Please review and sign the attached service agreement." \
  -F "ddxE_webhookUrl=https://yourapp.com/webhooks/signature-status"

const FormData = require('form-data');
const fs = require('fs');
const axios = require('axios');

const sendDocumentForSignature = async () => {
  const form = new FormData();
  form.append('ddx_outputFormat', 'pdf');
  form.append('ddx_template', fs.createReadStream('contract-template.docx'));
  form.append('clientName', 'John Doe');
  form.append('contractDate', 'January 15, 2025');

  // E-signature configuration
  const signers = [
    {
      signerRole: 'client',
      signerEmail: 'john@example.com',
      signerName: 'John Doe',
      required: ['signature', 'date']
    },
    {
      signerRole: 'company',
      signerEmail: 'legal@company.com',
      signerName: 'Jane Smith',
      required: ['signature', 'initials', 'date']
    }
  ];

  form.append('ddxE_signers', JSON.stringify(signers));
  form.append('ddxE_senderEmail', 'noreply@company.com');
  form.append('ddxE_emailMessage', 'Please review and sign the attached service agreement.');
  form.append('ddxE_webhookUrl', 'https://yourapp.com/webhooks/signature-status');

  try {
    const response = await axios.post(
      'https://api.datawise.app/api/datawise_document_exchange',
      form,
      {
        headers: {
          ...form.getHeaders(),
          'Authorization': 'Bearer YOUR_API_KEY'
        },
        responseType: 'arraybuffer',
      }
    );
    console.log('Document sent for signature:', response.data);
  } catch (e) {
    if (e.response?.data instanceof Buffer) {
      const errorText = e.response.data.toString('utf-8');
      console.log('Error:', JSON.parse(errorText));
    } else {
      console.log('Network or other error:', e);
    }
  }
};

sendDocumentForSignature();

import requests
import json

def send_document_for_signature():
    url = 'https://api.datawise.app/api/datawise_document_exchange'

    headers = {
        'Authorization': 'Bearer YOUR_API_KEY'
    }

    files = {
        'ddx_template': open('contract-template.docx', 'rb')
    }

    signers = [
        {
            'signerRole': 'client',
            'signerEmail': 'john@example.com',
            'signerName': 'John Doe',
            'required': ['signature', 'date']
        },
        {
            'signerRole': 'company',
            'signerEmail': 'legal@company.com',
            'signerName': 'Jane Smith',
            'required': ['signature', 'initials', 'date']
        }
    ]

    data = {
        'ddx_outputFormat': 'pdf',
        'clientName': 'John Doe',
        'contractDate': 'January 15, 2025',
        'ddxE_signers': json.dumps(signers),
        'ddxE_senderEmail': 'noreply@company.com',
        'ddxE_emailMessage': 'Please review and sign the attached service agreement.',
        'ddxE_webhookUrl': 'https://yourapp.com/webhooks/signature-status'
    }

    try:
        response = requests.post(url, headers=headers, files=files, data=data)
        response.raise_for_status()
        print('Document sent for signature:', response.json())
    except requests.exceptions.RequestException as e:
        print('Error:', e)
    finally:
        files['ddx_template'].close()

send_document_for_signature()

<?php
function sendDocumentForSignature() {
    $curl = curl_init();

    $signers = [
        [
            'signerRole' => 'client',
            'signerEmail' => 'john@example.com',
            'signerName' => 'John Doe',
            'required' => ['signature', 'date']
        ],
        [
            'signerRole' => 'company',
            'signerEmail' => 'legal@company.com',
            'signerName' => 'Jane Smith',
            'required' => ['signature', 'initials', 'date']
        ]
    ];

    $postData = [
        'ddx_outputFormat' => 'pdf',
        'ddx_template' => new CURLFile('contract-template.docx'),
        'clientName' => 'John Doe',
        'contractDate' => 'January 15, 2025',
        'ddxE_signers' => json_encode($signers),
        'ddxE_senderEmail' => 'noreply@company.com',
        'ddxE_emailMessage' => 'Please review and sign the attached service agreement.',
        'ddxE_webhookUrl' => 'https://yourapp.com/webhooks/signature-status'
    ];

    curl_setopt_array($curl, [
        CURLOPT_URL => 'https://api.datawise.app/api/datawise_document_exchange',
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_POST => true,
        CURLOPT_POSTFIELDS => $postData,
        CURLOPT_HTTPHEADER => [
            'Authorization: Bearer YOUR_API_KEY'
        ],
    ]);

    $response = curl_exec($curl);
    curl_close($curl);

    echo 'Document sent for signature: ' . $response;
}

sendDocumentForSignature();
?>

Testing with Preview Mode

Test your e-signature integration without sending actual emails by using preview mode:

curl -X POST https://api.datawise.app/api/datawise_document_exchange \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "ddx_outputFormat=pdf" \
  -F "ddx_template=@contract-template.docx" \
  -F "clientName=Test User" \
  -F 'ddxE_signers=[{"signerRole":"client","signerEmail":"test@example.com","signerName":"Test User","required":["signature"]}]' \
  -F "ddxE_senderEmail=sender@example.com" \
  -F "ddxE_signPreview=true"

With ddxE_signPreview=true, the API will process the document and return a preview URL without actually sending signature request emails.

PDF Merging

Merge multiple PDFs with your generated document:

curl -X POST https://api.datawise.app/api/datawise_document_exchange \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "ddx_outputFormat=pdf" \
  -F "ddx_template=@report-template.docx" \
  -F "reportTitle=Annual Report 2025" \
  -F "reportDate=January 15, 2025" \
  -F "&cover=@cover-page.pdf" \
  -F "&appendix=@appendix.pdf" \
  -F '&structure=["cover", "content", "appendix"]'

The &structure array defines the order of PDFs, where "content" represents the generated document.

Ready to Build?

These examples cover the most common use cases. For more complex scenarios, combine different features and refer to the parameter documentation for all available options.