Generate
Overview
The Generate operation is used to request document processing based on transaction data included in the request. The Generate operation is an asynchronous call back that transaction data, a Content URI, an account ID (AccountID), and any additional optional request data for the calling application and returns a Transaction ID with a status. This is typically followed by a call to the GetRequestResult operation, using the transaction ID returned in the Generate response, to retrieve generated package documents as requested by the calling application in the Generate request.
| Method | URL | Description |
|---|---|---|
| POST | /api/v1/Document/account/{accountId}/generate | The POST method submits the accountId as part of the Generate call |
| Parameter | Type | Constraints | Description |
|---|---|---|---|
| accountId | integer | Required | The account used to associate to the request. |
| DocumentFormat | DocumentFormatType | Optional | A string identifying the format of the document to return. Options include: PDF, Raw XML, TRF, Tagged PDF. |
| DaysToPersistInLongTermStorage | int | Optional | The value used to calculate when the request will be deleted from the database (in days). Setting a value of "-1" will immediately delete all request data and images. "7" is the default value. |
| TransactionData | xml | Required | Transaction data in the form of a XML file that will be used to process the request. |
| ContentIdentifier | string | Required | A string identifying the type of content to be used. |
| AncillaryOutputOptions | AncillaryOutputOption | Optional | A sequence of elements indicating Watermark and Barcode information. AncillaryOutPutOptions is an array of AncillaryOutputOption |
| Attachments | Attachment | Optional | The Attachment object contains the requested file as a
PDF and includes description information about the attached
PDF. Attachment format. Attachments are base64 encoded. The code reads the file and the uses a .net library call to encode the file for transmission: Attachment = Convert.ToBase64String(data, 0, strLen) Convert can be found in System.Convert |
| AttachmentPosition | LocationEnum | Optional | An enumerator indicating the location of the attachment in relation to the documents. |
| Callback | Callback | Optional | A sequence of elements indicating the Callback URL, Username and Password. |
| PassThroughIdentifier | string | Optional |
The PassThroughIdentifier is an optional user-defined generated parameter. This parameter is case-sensitive. The PassThroughIdentifier MUST be unique for each request. If a PassThroughIdentifier has been submitted previously for an account and exists in the database, Expere Document Services will return the original transaction ID. A new transaction ID will not be created. If the PassThroughIdentifier is passed in the request and the parameter is empty (null), Expere Document Services will process the request and return a new transaction ID. |
| MergeTRIDDocs | boolean | Optional | A true or false value indicating whether to include the MergeTRIDDocs parameter. |
| EZConfig | EZConfig | Optional | Container object for EZConfigID information. |
| EZTransform | EZTransform | Optional | Container object for EZTransform information. |
Sample Request
{
"generate": {
"request": {
"daysToExpire": 0,
"documentFormat": "PDF",
"transactionData": "PFR4biB4bWxucz0iaHR0cDovL3NjaGVtYXMuYmFua2Vyc3N5c3RlbXMuY29tLzIwMDQvRXhwZXJlVHhuIj48U2VydmljaW5ncz48U2VydmljaW5nPjxPYmxpZ29ycz48T2JsaWdvcj48Rmlyc3ROYW1lPk9zY2FyPC9GaXJzdE5hbWU+PE1pZGRsZU5hbWU+SmFtZXM8L01pZGRsZU5hbWU+PExhc3ROYW1lPk9ibGlnb3I8L0xhc3ROYW1lPjxTdWZmaXg+SnIuPC9TdWZmaXg+PE1haWxpbmdBZGRyZXNzU3RyZWV0QWRkcmVzcz4xMTExIE9ibGlnYXRvciBMYW5lPC9NYWlsaW5nQWRkcmVzc1N0cmVldEFkZHJlc3M+PE1haWxpbmdBZGRyZXNzU3RyZWV0QWRkcmVzczI+U3VpdGUgT0IxPC9NYWlsaW5nQWRkcmVzc1N0cmVldEFkZHJlc3MyPjxNYWlsaW5nQWRkcmVzc0NpdHk+RGVudmVyPC9NYWlsaW5nQWRkcmVzc0NpdHk+PE1haWxpbmdBZGRyZXNzU3RhdGU+TlY8L01haWxpbmdBZGRyZXNzU3RhdGU+PE1haWxpbmdBZGRyZXNzUG9zdGFsQ29kZT41NzMyOTwvTWFpbGluZ0FkZHJlc3NQb3N0YWxDb2RlPjxSZW1icmFuZHRJRD45NzYxPC9SZW1icmFuZHRJRD48L09ibGlnb3I+PE9ibGlnb3I+PEZpcnN0TmFtZT5CZXR0eTwvRmlyc3ROYW1lPjxNaWRkbGVOYW1lPkxvdTwvTWlkZGxlTmFtZT48TGFzdE5hbWU+U21pdGg8L0xhc3ROYW1lPjxTdWZmaXgvPjxNYWlsaW5nQWRkcmVzc1N0cmVldEFkZHJlc3M+MTExMSBPYmxpZ2F0b3IgTGFuZTwvTWFpbGluZ0FkZHJlc3NTdHJlZXRBZGRyZXNzPjxNYWlsaW5nQWRkcmVzc1N0cmVldEFkZHJlc3MyPlN1aXRlIE9CMTwvTWFpbGluZ0FkZHJlc3NTdHJlZXRBZGRyZXNzMj48TWFpbGluZ0FkZHJlc3NDaXR5PkRlbnZlcjwvTWFpbGluZ0FkZHJlc3NDaXR5PjxNYWlsaW5nQWRkcmVzc1N0YXRlPk5WPC9NYWlsaW5nQWRkcmVzc1N0YXRlPjxNYWlsaW5nQWRkcmVzc1Bvc3RhbENvZGU+NTczMjk8L01haWxpbmdBZGRyZXNzUG9zdGFsQ29kZT48UmVtYnJhbmR0SUQ+OTc2MjwvUmVtYnJhbmR0SUQ+PC9PYmxpZ29yPjwvT2JsaWdvcnM+PFNlcnZpY2luZ1Rlcm1zPjxTZXJ2aWNpbmdUZXJtPjxEb2N1bWVudERhdGU+MjAxNzAxMDE8L0RvY3VtZW50RGF0ZT48RGVmYXVsdEN1cmVQYXltZW50UGhvbmVOdW1iZXI+NTQzLTg5Ny0zMjExPC9EZWZhdWx0Q3VyZVBheW1lbnRQaG9uZU51bWJlcj48RGVmYXVsdEN1cmVUb3RhbEFtb3VudD4zMjAwPC9EZWZhdWx0Q3VyZVRvdGFsQW1vdW50PjxBY2NvdW50SWRlbnRpZmllcj45OTk4ODg3Nzc8L0FjY291bnRJZGVudGlmaWVyPjxMaWVuUHJpb3JpdHlUeXBlPjM8L0xpZW5Qcmlvcml0eVR5cGU+PERlZmF1bHRDdXJlRmVlcz48RGVmYXVsdEN1cmVGZWU+PERlZmF1bHRDdXJlRmVlQW1vdW50PjEwMDwvRGVmYXVsdEN1cmVGZWVBbW91bnQ+PERlZmF1bHRDdXJlRmVlRGVzYz5EZWZhdWx0Q3VyZUZlZTE8L0RlZmF1bHRDdXJlRmVlRGVzYz48L0RlZmF1bHRDdXJlRmVlPjxEZWZhdWx0Q3VyZUZlZT48RGVmYXVsdEN1cmVGZWVBbW91bnQ+MjAwPC9EZWZhdWx0Q3VyZUZlZUFtb3VudD48RGVmYXVsdEN1cmVGZWVEZXNjPkRlZmF1bHRDdXJlRmVlMjwvRGVmYXVsdEN1cmVGZWVEZXNjPjwvRGVmYXVsdEN1cmVGZWU+PERlZmF1bHRDdXJlRmVlPjxEZWZhdWx0Q3VyZUZlZUFtb3VudD4zMDA8L0RlZmF1bHRDdXJlRmVlQW1vdW50PjxEZWZhdWx0Q3VyZUZlZURlc2M+RGVmYXVsdEN1cmVGZWUzPC9EZWZhdWx0Q3VyZUZlZURlc2M+PC9EZWZhdWx0Q3VyZUZlZT48RGVmYXVsdEN1cmVGZWU+PERlZmF1bHRDdXJlRmVlQW1vdW50PjQwMDwvRGVmYXVsdEN1cmVGZWVBbW91bnQ+PERlZmF1bHRDdXJlRmVlRGVzYz5EZWZhdWx0Q3VyZUZlZTQ8L0RlZmF1bHRDdXJlRmVlRGVzYz48L0RlZmF1bHRDdXJlRmVlPjxEZWZhdWx0Q3VyZUZlZT48RGVmYXVsdEN1cmVGZWVBbW91bnQ+NTAwPC9EZWZhdWx0Q3VyZUZlZUFtb3VudD48RGVmYXVsdEN1cmVGZWVEZXNjPkRlZmF1bHRDdXJlRmVlNTwvRGVmYXVsdEN1cmVGZWVEZXNjPjwvRGVmYXVsdEN1cmVGZWU+PC9EZWZhdWx0Q3VyZUZlZXM+PERlZmF1bHRSZWFzb25zRGVzYz5EZWZhdWx0UmVhc29uRGVzY3JpcHRpb24gR29lcyBIZXJlPC9EZWZhdWx0UmVhc29uc0Rlc2M+PERlZmF1bHRDdXJlRHVlRGF0ZT4yMDE3MTIwNTwvRGVmYXVsdEN1cmVEdWVEYXRlPjxMYXN0UGF5bWVudEFwcGxpZWREYXRlPjIwMTcxMDAxPC9MYXN0UGF5bWVudEFwcGxpZWREYXRlPjxQcmluY2lwYWxVbnBhaWRCYWxhbmNlQW1vdW50PjE0MDAwPC9QcmluY2lwYWxVbnBhaWRCYWxhbmNlQW1vdW50PjxJbnRlcmVzdFJhdGVDdXJyZW50RW5kRGF0ZT4yMDE3MTAxNTwvSW50ZXJlc3RSYXRlQ3VycmVudEVuZERhdGU+PEludGVyZXN0UmF0ZT43LjU8L0ludGVyZXN0UmF0ZT48TG9zc01pdGlnYXRpb25Qcm9ncmFtU3RhdGVtZW50RGVzYz5EZXNjcmlwdGlvbiBvZiB0aGUgTG9zcyBNaXRpZ2F0aW9uIFByb2dyYW0gU3RhdGVtZW50IGdvZXMgaGVyZSE8L0xvc3NNaXRpZ2F0aW9uUHJvZ3JhbVN0YXRlbWVudERlc2M+PExvc3NNaXRpZ2F0aW9uQWdlbnROYW1lPkFuZ2llIEFnZW50PC9Mb3NzTWl0aWdhdGlvbkFnZW50TmFtZT48TG9zc01pdGlnYXRpb25BZ2VudFBob25lTnVtYmVyPjEtMzIwLTI1MS0xNTE1PC9Mb3NzTWl0aWdhdGlvbkFnZW50UGhvbmVOdW1iZXI+PExvc3NNaXRpZ2F0aW9uQWdlbnRTdHJlZXRBZGRyZXNzPkFHX1N0cmVldEFkZHJlc3M8L0xvc3NNaXRpZ2F0aW9uQWdlbnRTdHJlZXRBZGRyZXNzPjxMb3NzTWl0aWdhdGlvbkFnZW50U3RyZWV0QWRkcmVzczI+QUdfU3RyZWV0QWRkcmVzczI8L0xvc3NNaXRpZ2F0aW9uQWdlbnRTdHJlZXRBZGRyZXNzMj48TG9zc01pdGlnYXRpb25BZ2VudENpdHk+QUdfQ2l0eTwvTG9zc01pdGlnYXRpb25BZ2VudENpdHk+PExvc3NNaXRpZ2F0aW9uQWdlbnRTdGF0ZT5OVjwvTG9zc01pdGlnYXRpb25BZ2VudFN0YXRlPjxMb3NzTWl0aWdhdGlvbkFnZW50UG9zdGFsQ29kZT41MTUxNTwvTG9zc01pdGlnYXRpb25BZ2VudFBvc3RhbENvZGU+PExvc3NNaXRpZ2F0aW9uQWdlbnRFbWFpbEFkZHJlc3M+QUdfRW1haWxBZGRyZXNzPC9Mb3NzTWl0aWdhdGlvbkFnZW50RW1haWxBZGRyZXNzPjxJbnRlcmVzdFJhdGVOZXh0Q2hhbmdlRGF0ZT4yMDE3MTEwNTwvSW50ZXJlc3RSYXRlTmV4dENoYW5nZURhdGU+PC9TZXJ2aWNpbmdUZXJtPjwvU2VydmljaW5nVGVybXM+PFNlcnZpY2Vycz48U2VydmljZXI+PFRvbGxGcmVlUGhvbmVOdW1iZXI+MS04MDAtNDU0LTQwNDA8L1RvbGxGcmVlUGhvbmVOdW1iZXI+PENvbXBhbnlOYW1lPlNWX0NvbXBhbnlOYW1lPC9Db21wYW55TmFtZT48TWFpbGluZ0FkZHJlc3NTdHJlZXRBZGRyZXNzPlNWX1N0cmVldEFkZHJlc3M8L01haWxpbmdBZGRyZXNzU3RyZWV0QWRkcmVzcz48TWFpbGluZ0FkZHJlc3NTdHJlZXRBZGRyZXNzMj5TVl9TdHJlZXRBZGRyZXNzMjwvTWFpbGluZ0FkZHJlc3NTdHJlZXRBZGRyZXNzMj48TWFpbGluZ0FkZHJlc3NDaXR5PlNWX0NpdHk8L01haWxpbmdBZGRyZXNzQ2l0eT48TWFpbGluZ0FkZHJlc3NTdGF0ZT5OVjwvTWFpbGluZ0FkZHJlc3NTdGF0ZT48TWFpbGluZ0FkZHJlc3NQb3N0YWxDb2RlPjIyMjExPC9NYWlsaW5nQWRkcmVzc1Bvc3RhbENvZGU+PENvbnRhY3ROYW1lPlNWX0NvbnRhY3RQZXJzb248L0NvbnRhY3ROYW1lPjwvU2VydmljZXI+PC9TZXJ2aWNlcnM+PENvbGxhdGVyYWxJdGVtcz48Q29sbGF0ZXJhbD48QWRkcmVzc2VzPjxBZGRyZXNzPjxTdHJlZXRBZGRyZXNzPjEyMyBBcHBsZSBSb2FkPC9TdHJlZXRBZGRyZXNzPjxDaXR5PkxhcyBWZWdhczwvQ2l0eT48UG9zdGFsQ29kZT41MTUxNTwvUG9zdGFsQ29kZT48U3RyZWV0QWRkcmVzczI+U3VpdGUgNTAwPC9TdHJlZXRBZGRyZXNzMj48L0FkZHJlc3M+PC9BZGRyZXNzZXM+PExvY2F0aW9uU3RhdGU+TlY8L0xvY2F0aW9uU3RhdGU+PE9jY3VwYW5jeVN0YXR1c1R5cGU+MTwvT2NjdXBhbmN5U3RhdHVzVHlwZT48L0NvbGxhdGVyYWw+PC9Db2xsYXRlcmFsSXRlbXM+PFByZWZvcmVjbG9zdXJlc1BhY2thZ2VzPjxQcmVmb3JlY2xvc3VyZVBhY2thZ2U+PFByZWZvcmVjbG9zdXJlUGFja2FnZVR5cGU+MjM8L1ByZWZvcmVjbG9zdXJlUGFja2FnZVR5cGU+PC9QcmVmb3JlY2xvc3VyZVBhY2thZ2U+PC9QcmVmb3JlY2xvc3VyZXNQYWNrYWdlcz48L1NlcnZpY2luZz48L1NlcnZpY2luZ3M+PFRhZ2xpbmVCYXJjb2RlRGVzYy8+PFRhZ2xpbmVVc2VyRGVmaW5lZENlbnRlckRlc2M+Q2VudGVyPC9UYWdsaW5lVXNlckRlZmluZWRDZW50ZXJEZXNjPjxUYWdsaW5lVXNlckRlZmluZWRMZWZ0RGVzYz5MZWZ0PC9UYWdsaW5lVXNlckRlZmluZWRMZWZ0RGVzYz48VGFnbGluZVVzZXJEZWZpbmVkUmlnaHREZXNjPlJpZ2h0PC9UYWdsaW5lVXNlckRlZmluZWRSaWdodERlc2M+PC9UeG4+",
"contentIdentifier": "BaseLibrary.PKG.Default_Default",
"ancillaryOutput": [
{
"outputType": "Barcode",
"barcode": {
"type": "barcode2D",
"pattern": "%BRCD%,2200478271,DP_CLOSE-2020-05-20T03:40:27.69032-2200478271,%page%,%totalpages%",
"horizontalAlignment": "Right"
}
},
{
"outputType": "Watermark",
"watermark": {
"text": "Sample",
"rotate": true,
"location": "Center"
}
}
],
"attachmentPosition": "Beginning",
"delivery": {
"deliveryHold": true,
"deliveryMode": "DirectToPaper",
"recipients": [
{
"name": "borrower one",
"addressLine1": "123 main street",
"addressLine2": "apt 4",
"city": "Fargo",
"state": "ND",
"zip": "58102",
"countryCode": "USA",
"mailingMethod": [
"USPSFirstClass","FedExStandardOvernight"
]
}, {
"name": "borrower two",
"addressLine1": "321 main street",
"addressLine2": "apt 5",
"city": "Cold Spring",
"state": "MN",
"zip": "56320",
"countryCode": "USA",
"mailingMethod": [
"USPSFirstClass"
]
}
],
"returnAddress": {
"name": "WKFS",
"businessName": "WKES businessName",
"addressLine1": "6815 Saukview",
"addressLine2": "suite 100",
"city": "St Cloud",
"state": "MN",
"zip": "56301",
"countryCode": "BBB"
},
"fiPreConsent": true
}
}
}
}Sample Response
{
"generate": {
"request": {
"documentFormat": "PDF",
"documentsToGenerate": [
{
"documentID": "string",
"format": "PDF",
"ancillaryOutput": [
{
"outputType": "Barcode",
"watermark": {
"imageURL": "string",
"text": "string",
"rotate": true,
"location": "Top"
},
"setEncryption": {
"strength128Bits": true,
"passwords": {
"user": "string",
"owner": "string"
},
"permissions": {
"allowPrinting": true,
"allowModifyContents": true,
"allowCopy": true,
"allowModifyAnnotations": true,
"allowScreenReaders": true,
"allowFillIn": true,
"allowAssembly": true,
"allowDegradedPrinting": true
}
},
"barcode": {
"type": "Barcode128",
"pattern": "string",
"useCoverPage": true,
"firstPageOnly": true,
"horizontalAlignment": "Left"
},
"eSignatureAndFieldSupport": {
"eSignatureCoordinatesOnly": true,
"eSignatureDateSupport": true,
"eSignatureTooltip": "string",
"eSignatureInitialsTooltip": "string",
"nonSignatureFieldCoordinatesOnly": true,
"eSignatureWKES": true
},
"logo": {
"image": "string",
"heightInInches": 0,
"widthInInches": 0,
"placement": "AllPages",
"justification": "Left",
"alternateText": "string"
}
}
]
}
],
"daysToExpire": 0,
"transactionData": "string",
"contentIdentifier": "string",
"callback": {
"authorization": {
"authType": "HTTPBasic",
"user": "string",
"password": "string",
"token": "string"
},
"url": "string"
},
"passthroughIdentifier": "string",
"ancillaryOutput": [
{
"outputType": "Barcode",
"watermark": {
"imageURL": "string",
"text": "string",
"rotate": true,
"location": "Top"
},
"setEncryption": {
"strength128Bits": true,
"passwords": {
"user": "string",
"owner": "string"
},
"permissions": {
"allowPrinting": true,
"allowModifyContents": true,
"allowCopy": true,
"allowModifyAnnotations": true,
"allowScreenReaders": true,
"allowFillIn": true,
"allowAssembly": true,
"allowDegradedPrinting": true
}
},
"barcode": {
"type": "Barcode128",
"pattern": "string",
"useCoverPage": true,
"firstPageOnly": true,
"horizontalAlignment": "Left"
},
"eSignatureAndFieldSupport": {
"eSignatureCoordinatesOnly": true,
"eSignatureDateSupport": true,
"eSignatureTooltip": "string",
"eSignatureInitialsTooltip": "string",
"nonSignatureFieldCoordinatesOnly": true,
"eSignatureWKES": true
},
"logo": {
"image": "string",
"heightInInches": 0,
"widthInInches": 0,
"placement": "AllPages",
"justification": "Left",
"alternateText": "string"
}
}
],
"attachments": [
{
"attachmentDoc": "string",
"displayName": "string",
"instanceFileName": "string",
"attachmentPosition": "Beginning",
"passwords": {
"user": "string",
"owner": "string"
}
}
],
"attachmentPosition": "Beginning",
},
"mergeTRIDDocs": true,
"ezConfig": {
"orgId": "string",
"orgName": "string",
"orgAlias": "string",
"orgLOB": "string"
}
}
}
}