Custom Transaction Data

Java SDK.NET SDKREST APIAPEX SDK

Java SDK

DocumentPackage superDuperPackage1=newPackageNamed("Policy " + new SimpleDateFormat("HH:mm:ss").format(new Date())).describedAs("This is a package created using the e-SignLive SDK").expiresAt(new Date()).withEmailMessage("This message should be delivered to all signers").withSigner(newSignerWithEmail("signer1@xyz.com").withCustomId("Client1").withFirstName("John").withLastName("Smith").withTitle("Managing Director").withCompany("Acme Inc.")).withDocument(newDocumentWithName("First Document").fromStream(new java.io.FileInputStream(DOCUMENT_PATH), DocumentType.PDF).withSignature(signatureFor("signer1@xyz.com").onPage(0).withField(FieldBuilder.checkBox().onPage(0).atPosition(400, 200).withValue("x")).atPosition(100, 100))).withAttributes(newDocumentPackageAttributes().withAttribute("First Name", "Bill").withAttribute("Last Name", "Johnson").withAttribute("Signing Order", "1").build()).build();  

  DocumentPackage retrievedPackage = eslClient.getPackage(packageId);
Map < String, Object > attributes = retrievedPackage.getAttributes().getContents();
for (Map.Entry < String, Object > entry: attributes.entrySet()) {
	System.out.println(entry.getKey() + ": " + entry.getValue());
} 

.NET SDK

  DocumentPackage superDuperPackage = PackageBuilder.NewPackageNamed("Policy " + DateTime.Now).DescribedAs("This is a package created using the e-SignLive SDK").ExpiresOn(DateTime.Now.AddMonths(1)).WithEmailMessage("This message should be delivered to all signers").WithSigner(SignerBuilder.NewSignerWithEmail("john.smith@example.com").WithCustomId("Client1").WithFirstName("John").WithLastName("Smith").WithTitle("Managing Director").WithCompany("Acme Inc.")).WithDocument(DocumentBuilder.NewDocumentNamed("First Document").FromFile(@ "C:/Users/hhaidary/Desktop/pdf/doc1.pdf").WithSignature(SignatureBuilder.SignatureFor("john.smith@example.com").OnPage(0).WithField(FieldBuilder.CheckBox().OnPage(0).AtPosition(400, 200).WithValue("x")).AtPosition(100, 100))).WithAttributes(new DocumentPackageAttributesBuilder().WithAttribute("First Name", "Bill").WithAttribute("Last Name", "Johnson").WithAttribute("Signing Order", "1").Build()).Build();  

  DocumentPackage retrievedPackage = eslClient.GetPackage(packageId);
IDictionary < string, Object > attributes = retrievedPackage.Attributes.Contents;
foreach(KeyValuePair < string, Object > entry in attributes) {
	Debug.WriteLine(entry.Key + ": " + entry.Value);
} 

REST API

To download the full code sample see our Code Share site.

Document attributes are customized data related to a document in a transaction, or to all data in a transaction. This data is not interpreted by OneSpan Sign. As such, the users of this data are free to store and interpret whatever data they want.

Customized data can also be applied at the transaction level. For more information, see Document Attributes.

The following code shows you how to edit your DocumentPackage object to add package attributes.

HTTP Request

POST /api/packages

HTTP Headers

Accept: application/json 
Content-Type: multipart/form-data 
Authorization: Basic api_key  

Request Payload

  -- -- --WebKitFormBoundary1bNO60n7FqP5WO4t Content - Disposition: form - data;
name = "file";
filename = "testDocumentExtraction.pdf"
Content - Type: application / pdf % PDF - 1.5 % µµµµ 1 0 obj < >>> endobj....-- -- --WebKitFormBoundary1bNO60n7FqP5WO4t Content - Disposition: form - data;
name = "payload" {
	"documents": [{
		"approvals": [{
			"id": "ExampleSignatureId",
			"role": "Signer1",
			"fields": [{
				"page": 0,
				"top": 200,
				"subtype": "LABEL",
				"height": 50,
				"left": 100,
				"width": 200,
				"id": "myLabelField",
				"type": "INPUT",
				"value": "Example label field value"
			}, {
				"page": 0,
				"top": 100,
				"subtype": "FULLNAME",
				"height": 50,
				"left": 100,
				"width": 200,
				"type": "SIGNATURE",
				"name": "ExampleSignatureId"
			}],
			"name": ""
		}],
		"id": "sample-contract",
		"name": "Test Document"
	}],
	"status": "DRAFT",
	"type": "PACKAGE",
	"roles": [{
		"id": "Signer1",
		"type": "SIGNER",
		"signers": [{
			"email": "signer@example.com",
			"firstName": "John",
			"lastName": "Smith",
			"id": "Signer1"
		}],
		"name": "Signer1"
	}],
	"name": "Example Package",
	"data": {
		"First Name": "Bill",
		"Last Name": "Johnson",
		"Signing Order": "1"
	}
}-- -- --WebKitFormBoundary1bNO60n7FqP5WO4t--  

For a complete description of each field, see the Request Payload table below.

Response Payload

  { "id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI=" }  

Attributes are set on a package level. Therefore, you will need to get your package JSON in order to retrieve your package attributes.

Results

Here is an example of what you can expect to see once you have run your code.

Request Payload Table

APEX SDK

  public void addAttributes(String packageId, Map<String, Object> attributes)  

  public Map<String, Object> getAttributes(String packageId)