Untitled Document

eoCreateDocumentProfile

Action Parameter	eoCreateDocumentProfile
Purpose	To create a document information template as a standard means of collecting and controlling information about a document and its subsequent versions
Description	The createDocumentProfile action establishes a document profile. A document profile represents a document and contains a list of document versions.
Type	Granular
Preconditions	A transaction has been created, and the client application has the transactionSid as well as the dptSid or dptName.
Implementation Notes	Each Document Profile must be mapped to an existing Document Type. A Document Type is a template for creating a unique instance of a document within the eCore service. Document Types must be configured within Command Center (see Preferences) and should have the "Required in Signing Experience" flag set IF the document will be signed within eOriginal's SmartSign Web application. Document Type configurations will vary based on your specific use case. Document Types may or may not be mapped to a source PDF. Note that if a source PDF is mapped to your Document Type, the PDF will be created by default within your Document Profile at the time of Document Profile creation.

Parameters

Required	Parameter	Value	Description
	transactionSid		Sequence ID (SID) of the transaction that will contain the document profile
	dptName		Name of the document profile template (DPT) used to create the document profile
	dpName		Document profile name of the document to be signed
	dpDescription		Document profile description of the document to be signed
	customField		Name of custom field configured for organization
	dpXRef1		External reference ID used on the document profile
	dpXRef2		External reference ID used on the document profile
	dpXRef3		External reference ID used on the document profile
	dpBusinessProcessName		Business Process name applied to document; if not provided, the default is the organization's default Business Process.
	dpTaskTemplateName		Task Template name applied to document; if not provided, the default is the organization's default Task Template.
	dpStateName		Document profile's state name after it is created. If this parameter is not passed, the default is the eCore® default state.
	dpRetentionPolicyName		Retention policy applied to a document profile
	dpExtraData		Extra data to be added to the document profile

Response

We recommend using the most recent version of FireFox while testing API calls via your web browser. Microsoft Edge and Google Chrome require 3rd party XML extensions to display the XML response natively in your browser.