Get a submitter
The API endpoint provides functionality to retrieve information about a submitter, along with the submitter documents and field values.
path Parameters
idThe unique identifier of the submitter.
Get a submitter › Responses
OK
idSubmitter unique ID number.
submission_idSubmission unique ID number.
uuidSubmitter UUID.
emailThe email address of the submitter.
slugUnique key to be used in the form signing link and embedded form.
sent_atThe date and time when the signing request was sent to the submitter.
opened_atThe date and time when the submitter opened the signing form.
completed_atThe date and time when the submitter completed the signing form.
declined_atThe date and time when the submitter declined the signing form.
created_atThe date and time when the submitter was created.
updated_atThe date and time when the submitter was last updated.
nameSubmitter name.
phoneSubmitter phone number.
statusSubmitter's submission status.
external_idThe unique applications-specific identifier
metadataMetadata object with additional submitter information.
preferencesSubmitter preferences.
Base template details.
An array of pre-filled values for the submitter.
An array of completed or signed documents by the submitter.
roleThe role of the submitter in the signing process.
Update a submitter
The API endpoint allows you to update submitter details, pre-fill or update field values and re-send emails.
Related Guides
Automatically sign documents via API
path Parameters
idThe unique identifier of the submitter.
Update a submitter › Request Body
nameThe name of the submitter.
emailThe email address of the submitter.
phoneThe phone number of the submitter, formatted according to the E.164 standard.
valuesAn object with pre-filled values for the submission. Use field names for keys of the object. For more configurations see fields param.
external_idYour application-specific unique string key to identify this submitter within your app.
send_emailSet true to re-send signature request emails.
send_smsSet true to re-send signature request via phone number SMS.
reply_toSpecify Reply-To address to use in the notification emails.
completedPass true to mark submitter as completed and auto-signed via API.
metadataMetadata object with additional submitter information.
completed_redirect_urlSubmitter specific URL to redirect to after the submission completion.
logo_urlPublic URL of a logo image to display on the signing page for this submitter. Overrides the account-level white-label logo for this recipient only. Pass an empty string to clear a previously stored value. Account Personalization is never modified.
company_nameCompany / brand name to display next to the logo on the signing page for this submitter. Overrides the account-level white-label name for this recipient only. Account Personalization is never modified.
stamp_urlPublic URL of an image to embed in the signature stamp when this submitter completes signing. Falls back to this submitter's logo_url then to the account-level branding.
require_phone_2faSet to true to require phone 2FA verification via a one-time code sent to the phone number in order to access the documents.
A list of configurations for template document form fields.
Update a submitter › Responses
OK
idSubmitter unique ID number.
submission_idSubmission unique ID number.
uuidSubmitter UUID.
emailThe email address of the submitter.
slugUnique key to be used in the form signing link and embedded form.
sent_atThe date and time when the signing request was sent to the submitter.
opened_atThe date and time when the submitter opened the signing form.
completed_atThe date and time when the submitter completed the signing form.
declined_atThe date and time when the submitter declined the signing form.
created_atThe date and time when the submitter was created.
updated_atThe date and time when the submitter was last updated.
nameSubmitter name.
phoneSubmitter phone number.
statusSubmitter's submission status.
external_idThe unique applications-specific identifier
metadataMetadata object with additional submitter information.
preferencesSubmitter preferences.
An array of pre-filled values for the submitter.
An array of completed or signed documents by the submitter.
roleThe role of the submitter in the signing process.
embed_srcThe src URL value to embed the signing form or sign via a link.
List all submitters
The API endpoint provides the ability to retrieve a list of submitters.
query Parameters
submission_idThe submission ID allows you to receive only the submitters related to that specific submission.
qFilter submitters on name, email or phone partial match.
slugFilter submitters by unique slug.
completed_afterThe date and time string value to filter submitters that completed the submission after the specified date and time.
completed_beforeThe date and time string value to filter submitters that completed the submission before the specified date and time.
external_idThe unique applications-specific identifier provided for a submitter when initializing a signature request. It allows you to receive only submitters with a specified external id.
limitThe number of submitters to return. Default value is 10. Maximum value is 100.
afterThe unique identifier of the submitter to start the list from. It allows you to receive only submitters with id greater than the specified value. Pass ID value from the pagination.next response to load the next batch of submitters.
beforeThe unique identifier of the submitter to end the list with. It allows you to receive only submitters with id less than the specified value.
List all submitters › Responses
OK