Consent Signature
Performs actions required to sign Consent documents
There are several different behaviors of this operation, depending upon the current state of signing and whether optional URL parameters have been supplied...
- If Consent signing has yet to be started, it will be initialized with a signing initiation email sent to the first signer
- If Consent signing has been started - and no optional URL parameters have been supplied - real-time synchronization with the signing vendor will be performed
- While inbound signing status events are expected from the signing vendor within a minute or two of any signing action, they may be delayed or, potentially, fail to be received
- This synchronization feature will perform real-time polling of the signing vendor for status, providing the very latest signing status without having to wait for any inbound signing status event
- This is as opposed to the Consent Status operation, which is a lighter-weight operation that will provide the list of documents and report the latest known signing status without any attempted synchronization
- If Consent signing has been started, and the optional
resendURL parameter is supplied, a signing initiation email is re-sent to the current signer- Note: A signer may enter their access code incorrectly too many times resulting in being locked out of signing, in which case re-sending the email will also serve to unlock signing; re-enabling the signing link in both new and prior signing initiation emails
- If Consent signing was systematically voided or declined by an individual signer, and the optional
resetURL parameter is supplied, signing will be re-initialized with a signing initiation email sent to the first signer - If Consent signing was successfully completed but authorized documents not yet submitted, the request is a NOP with a reminder that the documents are authorized and ready to be submitted
- If Consent signing was successfully completed and authorized documents already submitted, the request is a NOP with a message that the documents are both authorized and submitted
The Identifier of the application being acted upon
The firm's or agency's national producer number (npn)
Custom Trace ID Header for Tracking Requests
Asserts to resend a 'pending' signing package to the current signer (new signing packages are sent regardless), otherwise default behavior is on-demand ceremony synchronization with latest signing vendor status. Note: Existence of the parameter is sufficient, and non-empty values are irrelevant.
Asserts to start signing over if the ceremony happens to become 'declined' or 'voided' (otherwise ignored). Note: Existence of the parameter is sufficient, and non-empty values are irrelevant.
Optional request input field for Click Signing Type, IPv4 address of the client in the format of xxx.xxx.xxx.xxx, where each xxx(octet) is a decimal number between 0 and 255 inclusive. Octets cannot have leading zeros except for the number 0 itself (Ex: 01 is invalid)
Optional request input field for Click Signing Type, must be set to true for the Consent/Policy Package signing to be authorized and submitted
Optional Return URL Field For Embedded Signing Type, should be valued with Partner UI URL that signing vendor should redirect to after signing
Signing Type for different signing experiences.
Responses
OK
A description of the result of the request, when applicable
Mirrors the HTTP status code
A transfer object representing the body content of the response, when applicable