Overview
A Document is a written, printed, or electronic matter that provides information or evidence or that serves as an official record.
Documents may sometimes be requested to complete underwriting and finalize Payment fulfillment. Examples of Document requests typically involve an invoice detailing the goods and services rendered by a Recipient, a photo of a Payer's government-issued ID, etc.
Plastiq Connect will request Documents via webhook events. More specifically, a Payment webhook will notify you when a Document request has been issued, the requested Document type, and the associated Payment identifiers linked to a customer's transaction.
Here is an example of a Document request:
{
"id": "dee9427c-3e33-490b-a9f1-9fd16b75a14f",
"event": "document.request",
"data": {
"id": "fc3d3ad3-52ae-45d7-bae0-501d112547ef",
"object": "PAYMENT",
"type": "INVOICE",
"timestamp": 1620080776056
}
}
Once the webhook event is acknowledged, a Document request can be satisfied by calling the POST Documents endpoint.
Here are some examples of different Document request types:
| Type | Description | Example |
|---|---|---|
INVOICE | A Document detailing the goods or services rendered by the Recipient. | *Picture of bill issued by Recipient |
ACCOUNT_STATEMENT | A Document displaying the authorized Payment charge on the Payment Method. | Picture of the cardholder's statement Picture of bank account statement |
IDENTIFICATION_PROOF | A Document displaying a government-issued form of identification for the Payer. | Picture of a driver's license Picture of a passport *Picture of government-issued ID |
Try it out
Sample Create Document Response
{
id: "1154422b-79c2-49e8-922e-474895e2a859",
fields: {
Key: "a7/a7125435-5ebd-40ee-a284-4dfa50d91347.png"
Policy: "eyJleHBpcmF0aW9uIjoiMjAyMC0xMS0wNVQxNzoxOTowMVoiLCJjb25kaXRpb25zIjpbWyJjb250ZW50LWxlbmd0aC1yYW5nZSIsMCw1MDAwMDAwMF0seyJLZXkiOiJhNy9hNzEyNTQzNS01ZWJkLTQwZWUtYTI4NC00ZGZhNTBkOTEzNDcucG5nIn0seyJzdWNjZXNzX2FjdGlvbl9zdGF0dXMiOiIyMDEifSx7ImJ1Y2tldCI6ImFwb2xsby11c2VyLXNlY3VyZS1hc3NldHMtcWEifSx7IlgtQW16LUFsZ29yaXRobSI6IkFXUzQtSE1BQy1TSEEyNTYifSx7IlgtQW16LUNyZWRlbnRpYWwiOiJBU0lBWlhRTVFPWjNHMlZWUlBWRS8yMDIwMTEwNS91cy13ZXN0LTIvczMvYXdzNF9yZXF1ZXN0In0seyJYLUFtei1EYXRlIjoiMjAyMDExMDVUMTcxNDAxWiJ9LHsiWC1BbXotU2VjdXJpdHktVG9rZW4iOiJJUW9KYjNKcFoybHVYMlZqRUpYLy8vLy8vLy8vL3dFYUNYVnpMWGRsYzNRdE1pSkdNRVFDSUI2SFhaR0c1NXRSZUM1MFNzc1lFSG0vR1dMUXZpWVVoem1xVzNDK1RVaERBaUJSRlcyTmhMUHF5TUlkUEJzQkI1dTEzQkJoRlI2OWg0R0lmMWd3UEdqNGFTckVBd2p1Ly8vLy8vLy8vLzhCRUFFYUREWTJPRGsyTnpRd01UQTNPQ0lNZk5nbTRnYVBRSzJmTStPSEtwZ0RNSEdtTk1QeUtxT21ibTJzOFNjbGRoYkludW5CQzRnMTYwQTF1Q25yUDErbVdSZmJqY2pjaHEyalRySDhWVHZiZlB1a3dObVJ0eHJSZis4QVJyS3VnTHZ6SEJtbi95d2Y2Q3k2TzI0b3ovUk0zMUJrYXZOek9KNGhFMlpuWjRHSFdYS2Yra3hIY3lWOXNNVkh0emJLY095b1B1Q0x5YWlxYmh4UHVwUDdZaWpieW9JOUNYUHR6YSs4WmNoc2dJaEgwMG1MRk5zWG5IOGlIWVpWUHoxQ0krTVNUSDhxd1h1d2pSSnJOT1hLTWUzeGZsSFpnNU0wTW1pdGdReVpSZG9tc2NvUFFYRnQ3cU5sSGJoTkVkL0g0aWtSZDEwQ2ZmWjFSaUVueDFYNVBZMkNNVUxFb1liV2hRWUVIVmdVd1p2OWljNDJyNFBEOUZZWXh6MGRLWXE4NnpvOFpsWVpZYlBsSnpWZ1hDS1JzeE1vbjBITG1rbDR1blc3cldZVzErNVQ2dzdGNklmWit4NkZLYW1tQm9UZVAwTUFwRUZrZ2hJUlN4bERPYk96SWQ0Snp4WnhxMUV5alVsa09MQ2hYY2pjaDcwME1wem1RQnZKOGw1dS93UEwyd0tjNkJ0TVNRY1ZNbzRVVktDdE1Zc2xSZ1A4SmxkVGNydVNwcThvZjJmQjdXY0NIQ3ZhMnBuamRENHFHQWVwRWxla05kUUNLcFd2TU5UZGovMEZPdXdCN3ZWSVQraHU1cG85bmFiUnNJbkgycitTSDVmVHJUZnMrSWQ1U1R1a2d6SU43RDRpU3hYV1lDU3V2SkRyTzd4YVkwUDF0SVBseC9mY2tzcUc2UHVuSFlhSHBDR0NWUS9yajc3TmZFcXZmQkVWOC9ZdWx3UzEzN0VwUGVscEZCZHpXWGMwcDU1TVNQc1BnSUh6WTg2enJ1ZUQyODFVYXZySjAvTFYyNHo4cHZhVHBieWxZQmVKTTFjNFBGM3diRzB6NWxocEM5UC9FbjdhTkhVd1ovdmlWU2RJSjI0YzVLTStnOFp6b1BJUm9UYlhmL0dUVVFaU0tpZ2VKM0RTWDNUMXZzakIvQVRjSFp3YzdWZGJqbFQwTHQ4Uy8xRzRyUXRGZEMvVEJadENCQXJsQkF1cStwcno4emNPbFJBPSJ9XX0="
X-Amz-Algorithm: "AWS4-HMAC-SHA256"
X-Amz-Credential: "ASIAZXQMQOZ3G2VVRPVE/20201105/us-west-2/s3/aws4_request"
X-Amz-Date: "20201105T171401Z"
X-Amz-Security-Token: "IQoJb3JpZ2luX2VjEJX//////////wEaCXVzLXdlc3QtMiJGMEQCIB6HXZGG55tReC50SssYEHm/GWLQviYUhzmqW3C+TUhDAiBRFW2NhLPqyMIdPBsBB5u13BBhFR69h4GIf1gwPGj4aSrEAwju//////////8BEAEaDDY2ODk2NzQwMTA3OCIMfNgm4gaPQK2fM+OHKpgDMHGmNMPyKqOmbm2s8ScldhbInunBC4g160A1uCnrP1+mWRfbjcjchq2jTrH8VTvbfPukwNmRtxrRf+8ARrKugLvzHBmn/ywf6Cy6O24oz/RM31BkavNzOJ4hE2ZnZ4GHWXKf+kxHcyV9sMVHtzbKcOyoPuCLyaiqbhxPupP7YijbyoI9CXPtza+8ZchsgIhH00mLFNsXnH8iHYZVPz1CI+MSTH8qwXuwjRJrNOXKMe3xflHZg5M0MmitgQyZRdomscoPQXFt7qNlHbhNEd/H4ikRd10CffZ1RiEnx1X5PY2CMULEoYbWhQYEHVgUwZv9ic42r4PD9FYYxz0dKYq86zo8ZlYZYbPlJzVgXCKRsxMon0HLmkl4unW7rWYW1+5T6w7F6IfZ+x6FKammBoTeP0MApEFkghIRSxlDObOzId4JzxZxq1EyjUlkOLChXcjch700MpzmQBvJ8l5u/wPL2wKc6BtMSQcVMo4UVKCtMYslRgP8JldTcruSpq8of2fB7WcCHCva2pnjdD4qGAepElekNdQCKpWvMNTdj/0FOuwB7vVIT+hu5po9nabRsInH2r+SH5fTrTfs+Id5STukgzIN7D4iSxXWYCSuvJDrO7xaY0P1tIPlx/fcksqG6PunHYaHpCGCVQ/rj77NfEqvfBEV8/YulwS137EpPelpFBdzWXc0p55MSPsPgIHzY86zrueD281UavrJ0/LV24z8pvaTpbylYBeJM1c4PF3wbG0z5lhpC9P/En7aNHUwZ/viVSdIJ24c5KM+g8ZzoPIRoTbXf/GTUQZSKigeJ3DSX3T1vsjB/ATcHZwc7VdbjlT0Lt8S/1G4rQtFdC/TBZtCBArlBAuq+prz8zcOlRA="
X-Amz-Signature: "7da11bd41d3a4c8c91b5d7b3924d042fa48cdaeea850714df9c572399e764d3b"
bucket: "apollo-user-secure-assets-qa"
success_action_status: "201"
},
uploadURL: "https://s3.us-west-2.amazonaws.com/apollo-user-secure-assets-qa"
}
The uploadURL is a pre-signed URL (S3 bucket) to be used in a multipart request when uploading assets. These pre-signed URLs expire after 15 minutes from creation.
Updated over 5 years ago
