Redact Documents

POST

https://api.staple.io/v2/redaction/document

This API endpoint allows you to redact PDF documents based on input data. The endpoint supports pre-configured formats, and only specific data can go into each PDF document.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Request

This endpoint expects an object.

qidintegerOptional

documentIdslist of integersOptional

redactedFieldslist of stringsOptional

1	{
2	"createRedactedDocument": {
3	"message": "The document(s) are being processed. Please wait a moment. Processing time will depend on the number of documents and their size.",
4	"redactedDocuments": [
5	{
6	"documentId": 1,
7	"trackingId": "f028c439-6ffd-4d11-9f60-d5bb72c3a574"
8	},
9	{
10	"documentId": 2,
11	"trackingId": "1620e1d6-e4fe-408b-b785-ded50b462633"
12	}
13	]
14	}
15	}

$	curl -X POST https://api.staple.io/v2/redaction/document \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json"

Authentication

Request

Response