Workflow Applications: DOCAPOSTESEND & DOCAPOSTECHECK usage

Development Workflow Applications
1

Overview

The DOCAPOSTESEND workflow application lets you send one or more documents to Docaposte for electronic signature.

The DOCAPOSTECHECK workflow application lets you check the status of a transaction and download the associated files.

For more information and complete instructions on how to use the applications, including how to customize the body of the email, as well as examples, see the DOCAPOSTESEND Workflow Application and DOCAPOSTECHECK Workflow Application sections in the WorkflowGen Administration Guide.

DOCAPOSTESEND

Required parameters

You can use one of the following two configurations: with a list of signers or with signer numbers.

With a list of signers

Parameter Type Direction Description
SIGNER_FIRSTNAME_LIST TEXT IN First names of signers, separated by the value defined in the DATA_SEPARATOR parameter
SIGNER_LASTNAME_LIST TEXT IN Last names of signers, separated by the value defined in the DATA_SEPARATOR parameter
SIGNER_EMAIL_LIST TEXT IN Email addresses of the signers, separated by the value defined in the DATA_SEPARATOR parameter
FILEx FILE IN File(s) to send, where x is the file number; you can add one or more files

With signer numbers

Parameter Type Direction Description
SIGNER_FIRSTNAMEx TEXT IN First name(s) of the signer(s), where x corresponds to the signer number; you can add one or more signers
SIGNER_LASTNAMEx TEXT IN Last name(s) of the signer(s), where x corresponds to the signer number; you can add one or more signers
SIGNER_EMAILx TEXT IN Email address(es) of the signer(s), where x is the signer’s number; you can add one or more signers
FILEx FILE IN File(s) to send, where x is the file number; you can add one or more files

Optional parameters

Docaposte configuration

Parameters Type Direction Description
DOCAPOSTE_USERNAME TEXT IN Docaposte username

By default, this value comes from the DocaposteUsername parameter in the web.config file.
DOCAPOSTE_PASSWORD TEXT IN Docaposte password

By default, this value comes from the DocapostePassword parameter in the web.config file.
DOCAPOSTE_HOST_SERVER TEXT IN Docaposte host server

By default, this value comes from the DocaposteHostServer parameter in the web.config file.
DOCAPOSTE_OFFER_CODE TEXT IN Docaposte offer code

By default, this value comes from the DocaposteOfferCode parameter in the web.config file.
DOCAPOSTE_ORGANIZATIONAL_UNIT_CODE TEXT IN Docaposte organizational unit code

By default, this value comes from the DocaposteOrganizationalUnitCode parameter in the web.config file.

General

Parameters Type Direction Description
DATA_SEPARATOR TEXT IN Separator used to separate the contents of SIGNERS_FIRSTNAME_LIST , SIGNERS_LASTNAME_LIST , SIGNERS_EMAIL_LIST , and SIGNER_TYPE_LIST
Default : , (comma)
SIGNER_TYPE_LIST TEXT IN Signature type of signers, separated by the value defined in the DATA_SEPARATOR parameter

Possible values:
  • OTP (default)
  • PAD
  • TOKEN
  • CONSENT_PROOF
  • IDENTITY
SIGNER_TYPEX TEXT IN Signature type of signer(s), where x corresponds to the signer number; you can add one or more signers

Possible values:
  • OTP (default)
  • PAD
  • TOKEN
  • CONSENT_PROOF
  • IDENTITY
CUSTOM_REFERENCE TEXT IN Provider reference

The content of this parameter can allow the provider to identify the transaction on its end with; for example, a value specific to its business domain (e.g. customer file number).
Default: WorkflowGen
TEST_MODE TEXT IN Indicates whether the transaction is a TEST transaction ( Y or N )
Default: N
EMAIL_SUBJECT TEXT IN Subject of the email that will be sent to signers
Default: Please sign the document sent from WorkflowGen
EMAIL_FROM TEXT IN Domain name of the email address that will be used to send the email to signers
Default : do-not-reply
EMAIL_BODY FILE IN Content of the email to send to signers
‌

Return parameters

Parameter Type Direction Description
DOCAPOSTE_TRANSACTION_ID ` TEXT OUT Contains the Docaposte transaction ID; you can use this ID in the DOCAPOSTECHECK workflow application
DOCAPOSTE_DOCUMENT_NAMES TEXT OUT Contains the names of the documents sent to Docaposte; you can use these values in the DOCAPOSTECHECK workflow application

DOCAPOSTECHECK

Required parameter

Parameter Type Direction Description
DOCAPOSTE_TRANSACTION_ID TEXT IN ID of the transaction to check

Optional parameters

Docaposte configuration

Parameters Type Direction Description
DOCAPOSTE_USERNAME TEXT IN Docaposte username

By default, this value comes from the DocaposteUsername parameter in the web.config file.
DOCAPOSTE_PASSWORD TEXT IN Docaposte password

By default, this value comes from the DocapostePassword parameter in the web.config file.
DOCAPOSTE_HOST_SERVER TEXT IN Docaposte host server

By default, this value comes from the DocaposteHostServer parameter in the web.config file.

General

Parameters Type Direction Description
DOCAPOSTE_DOCUMENT_NAMES TEXT IN Name(s) of the document(s) sent for signature(s)
DOCAPOSTE_DOCUMENTx FILE OUT Signed document(s), where x is the document number
DOCAPOSTE_STATUS TEXT OUT Transaction status