Skip to main content
POST
/
masterfiles
/
export
/
pdf
Export
curl --request POST \
  --url https://sandbox.syngrafii.com/api/v1/masterfiles/export/pdf \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "packageId": "<string>"
}
'
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; name="example.pdf";filename*=utf-8''example.pdf

<PDF-BINARY-DATA>
You can export a customized version of the MasterFile PDF through the masterfiles/export/pdf endpoint. MasterFile export allows you to control the included sections, PII, as well as filtering sections to include or exclude specific record types.

​
Request

Request
POST /masterfiles/export/pdf 
{
    "packageId": "245f9562-7ddc-4d38-9e61-2d75b0774af9",
    "signerId": null,
    "options": {
        "details": {
            "include": true,
            "maps": false,
            "counts": true
        },
        "host": null,
        "signers": {
            "include": true,
            "name": true,
            "email": false,
            "mobileNumber": false,
            "device": false,
            "ipAddress": false,
            "location": false,
            "verification": {
                "include": true,
                "passed": true,
                "failed": true,
                "errored": false,
                "analysis": true,
                "data": true,
                "identity": true,
                "documents": {
                    "include": true,
                    "includeTypes": [
                        "drivers_license",
                        "passport"
                    ],
                    "images": {
                        "include": true,
                        "includeTypes": [
                            "live_photo"
                        ]
                    }
                }
            }
        },
        "recipients": {
            "include": false
        },
        "documents": {
            "include": true
        },
        "meetings": null,
        "verificationHistory": {
            "include": false
        },
        "accessHistory": {
            "include": false
        },
        "packageHistory": {
            "include": true,
            "excludeTypes": [
                "package_added"
            ]
        },
        "notificationHistory": {
            "include": false
        },
        "logs": {
            "include": true,
            "excludeTypes": [
                "field_digitalsignature_add",
                "page_enter",
                "page_exit"
            ]
        }
    }
}

​
Body

​
packageId
string
required
Unique package ID of the package to export MasterFile for.
​
signerId
string
Generates the MasterFile for the specified signer ID, hiding other signers’ PII and including the specified signer’s PII based on the export options.
If not provided, the MasterFile will include all signers’ PII based on the export options.
​
timeZone
string
Overrides the default package or organization’s time zone.IANA Time Zones: https://www.iana.org/time-zones
​
explicit
boolean
default:false
When set to true the export options will not be merged with the default MasterFile export options. This is useful if you do not want new sections to automatically appear in future releases.
​
options
object
Options to customize how the MasterFile PDF is generated during export.

​
Response

Returns a PDF file of the requested package’s MasterFile based on the provided options. 
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; name="example.pdf";filename*=utf-8''example.pdf

<PDF-BINARY-DATA>