Flywire Hospitality APIs - SOAP API

Endpoint and SOAP namespace

{BASE_URL} is the base URL of your portal environment. Sertifi gives you this value.

Protocols

The service configuration does not override the ASP.NET web service protocol defaults. These defaults apply:

Use SOAP 1.1 or SOAP 1.2 for all calls.

Authentication

Most methods take an API code as their first parameter. The parameter name changes between methods (pstr_APICode, p_APICode, or p_ApiCode). The value is the same API code in all cases.

Make sure that your API code meets these conditions:

1. The API code is not empty.
2. The API code belongs to your portal account.
3. Your portal account is enabled.

The service also applies these controls:

1. If the portal account has IP access restrictions, the client IP address must be in the allow list for that account. If the IP address is not in the list, the service returns a SOAP fault. The fault message starts with "Request has been denied due to IP restrictions".
2. Some methods can have a rate limit for each API code. If you exceed the limit, the service returns a SOAP fault with the message "Rate limit exceeded". The service then applies a cool-off period.

If the API code is not valid, most methods return ERROR: Invalid API Code. Methods that return a byte array return an empty array.

Keep your API code secret. Send it only over HTTPS. Do not put it in client-side code.

The API code has the format of a GUID, for example {API_CODE} = 00000000-0000-0000-0000-000000000000.

File ID, Document ID, and other identifiers

The service returns identifiers as strings:

• File ID (the signature request, also called a folder). CreateSignatureRequest returns it. FileQuery and the status methods also return it.
• Document ID. Methods that add documents return it.
• Reference document ID. Reference document methods return it when you set returnId to true.
• Payment ID. CreatePayment returns it.

These identifiers are opaque values. Store them exactly as the service returns them. Do not construct, change, or parse them. Do not assume a format or a length.

Response conventions

Most methods return a string. Read the string as follows:

Exceptions to this rule:

• EditUser returns some errors with the prefix Error: (mixed case). Compare the prefix without case sensitivity.
• RemoveFormFromRequest is no longer supported. It returns This API call is no longer supported. with no ERROR prefix.
• Methods that return a byte array (for example DownloadSignedDocument, DownloadFileContents, GetDocumentSummary) return an empty array when an error occurs. They do not return an error message. CreateFaxShell is no longer supported and always returns an empty array.
• Methods that return a complex type put the error in a field of that type. See FileQueryResult.ErrorMessage, UrlQueryResult.Error, and NotificationResult.ErrorMessage.
• IP restriction errors, rate limit errors, and unexpected server errors come back as SOAP faults.
• Input that the service cannot process (for example a missing required object, an unparseable date, an unknown enum value, or an ID of the wrong type) also returns a SOAP fault. Handle SOAP faults as well as ERROR: strings.

Do not parse the text after ERROR:. The text can change. Use it for logging and support only.

Send an eSignature request by email

1. CreateSignatureRequest — creates a folder and assigns signer(s)
2. AddDocumentToRequest or AddPrepopulatedPdfToRequest — attach documents / templates
3. InviteSigner or InviteSigners — sends the eSignature request via email

In-session / embedded signing

1. CreateSignatureRequest
2. AddDocumentToRequest or AddPrepopulatedPdfToRequest
3. GetLink (with FileSigningPageLink or SigningPageLink) — returns the in-session signing link

CreateSignatureRequest

Creates a new file (signature request) in the portal that owns the API code. Adds the sender, the signers, the second signers and the CCs to the file. Returns the File ID that you use in all other file operations.

Active

Returns: string. On success, the File ID: an opaque encrypted string. On failure, a string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: Filename cannot be empty or null
• ERROR: Password cannot be exceed 50 characters
• ERROR: Invalid sender email
• ERROR: Invalid sender email: '{pstr_SenderEmail}': {reason}
• ERROR: pstr_Signers is invalid
• ERROR: pstr_Signers is invalid: '{pstr_Signers}': {reason}
• ERROR: pstr_CCs is invalid: '{pstr_CCs}': {reason}
• ERROR: pstr_SecondSigners is invalid: '{pstr_SecondSigners}': {reason}
• ERROR: No. of total signers in the room can not be more than 24.
• ERROR: Sender name too long
• ERROR: Sender last name too long
• ERROR: User, {pstr_SenderEmail}, is disabled and cannot create files.

{reason} is one of these email validation messages: Email address too long or too short., Invalid email domain., Email contains invalid characters or is not complex enough., Email address missing., Email address too short.

Notes:

• The maximum is 24 signers in total (first signers plus second signers). The service counts the entries in the lists after it splits them at commas. An empty entry (for example, after a trailing comma) also counts. Do not end a list with a comma.
• The service does the 24-signer check before it adds the sender for cosign. Do not send more than 23 signers in total when pstr_Cosign is true.
• If no user exists for the sender email, the service creates one.
• If the sender already exists and has no first name or no last name, the service updates the name from pstr_SenderName.
• The service adds the portal's permanent CC emails to the CC list.
• The service creates a user record for each new participant email.
• This operation sends no emails. Use InviteSigners or InviteSigner to send invitations.
• A repeated email in pstr_CCs causes a server error (SOAP fault), not an ERROR: string.

AddDocumentToRequest

Uploads a signature document to a file. The service converts the document to PDF, processes text tags and optional prefill data, and returns a Document ID.

Active

Returns: string. On success, the Document ID: an opaque encrypted string (not SUCCESS). On failure, a string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: Title cannot be empty or null
• ERROR: You are attempting to upload a null referenced byte array
• ERROR: You are attempting to upload a zero-length file
• ERROR: pstr_FileName parameter is an invalid.
• ERROR: File could not be accessed
• ERROR: Room Expired
• ERROR: Not enough licenses available to upload this document
• ERROR: {message} when the document cannot be added. Known messages include:
  • A folder cannot have more than a 100 documents. Current count: {n}
  • This folder was created more than {n} days ago and cannot accept anymore documents. Date created: {date}
  • Documents cannot be added to Consolidated Signing Folders after a signer has signed.
  • Filename does not have an extension and the file is not a PDF.
  • File type not supported. Please contact {SUPPORT_EMAIL} for further information.
  • Could not save the document as a PDF
  • The document contains an invalid intelligent tag.
  • Unable to merge documents as room contains more that one document.
  • HTML documents/forms can't be merged.
  • Document in the room is already signed or unavailable for signature.
  • Unable to merge documents.
  • Unable to save the file to the vault. {details}
  • Could not pre-fill data. {details}
  • Other PDF processing and signing-location validation messages.

Notes:

• Each successful upload uses one license of the file owner.
• The service does not block uploads to archived files. It blocks only expired files.
• Depending on the portal merge setting, the service can merge the new document into an existing document in the file.
• This operation does not send invitations.

AddPrepopulatedPdfToRequest

Adds a signature document from the portal's document library to a file. You can prefill the PDF fields with XML. Returns a Document ID.

Active

Returns: string. On success, the Document ID: an opaque encrypted string. On failure, a string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: Title cannot be empty or null
• ERROR: Title cannot be exceed 100 characters (only when the title is longer than 100 characters and contains characters that are not valid in a path)
• ERROR: File could not be accessed
• ERROR: Room Expired
• ERROR: Form could not be accessed
• ERROR: Not enough licenses available to upload this document
• ERROR: Could not load form (the ID does not identify a signature document in this portal, or the content cannot be read)
• ERROR: Could not add form to the file.
• All errors of AddDocumentToRequest.

Notes:

• The library document must belong to the same portal as the API code.
• Library IDs that decrypt to a value from 1 to 1000 are mapped to a legacy ID range.
• If the library document has callback validation enabled, the new document also has it.
• If pstr_Xml is null, the service uses saved prefill XML for this library document and file, if it exists, and then deletes the saved copy.
• Each successful upload uses one license.

AddReferenceDocumentFromLibrary

Adds a reference document from the portal's document library to a file. Signers can see reference documents but do not sign them. You can set visibility permissions and custom metadata.

Active

Returns: string. SUCCESS, or the reference document ID (an opaque encrypted string) when returnId is true. On failure, a string that starts with ERROR:.

Errors:

• ERROR: Invalid document library id.
• ERROR: Invalid API Code
• ERROR: File could not be accessed
• ERROR: Room Expired
• ERROR: Invalid SEQUENCE in permissions, CC's sequence should equal to zero
• ERROR: Invalid SEQUENCE in permissions, sequence should be >= zero and less than 255 for signers (the service accepts 255)
• ERROR: Invalid EMAIL in permissions: {reason}
• ERROR: could not parse custom metadata (lowercase "could")
• ERROR: Could not fetch reference document from the library.
• ERROR: Could not fetch reference document from the library. Message: {message}. Known message: This folder was created more than {n} days ago and cannot accept anymore documents.

Notes:

• Use the emails of participants in the file for permission rules.
• The service validates permissions and metadata before it adds the document. It applies them after it adds the document.

AddReferenceDocumentToRequest

Uploads a reference document to a file. Signers can see reference documents but do not sign them. You can set visibility permissions and custom metadata.

Active

Returns: string. SUCCESS, or the reference document ID (an opaque encrypted string) when returnId is true. On failure, a string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: Title cannot be empty or null
• ERROR: File could not be accessed
• ERROR: Room Expired
• ERROR: Invalid SEQUENCE in permissions, CC's sequence should equal to zero
• ERROR: Invalid SEQUENCE in permissions, sequence should be >= zero and less than 255 for signers
• ERROR: Invalid EMAIL in permissions: {reason}
• ERROR: could not parse custom metadata
• ERROR: Filename cannot be empty or null
• ERROR: filename cannot be exceed 100 characters (lowercase "filename"; only when the name is longer than 100 characters and contains characters that are not valid in a path)
• ERROR: {extension} is not an allowed extension. (for example ERROR: .exe is not an allowed extension.)
• ERROR: You are attempting to upload a null referenced byte array
• ERROR: You are attempting to upload a zero-length file
• ERROR: This folder was created more than {n} days ago and cannot accept anymore documents.

Notes:

• Use the emails of participants in the file for permission rules.

AddInstructionalDocumentToRequest

Uploads an instructional document to a file. Instructional documents give information to participants and are not signed.

Active

Returns: string. SUCCESS, or the document ID (an opaque encrypted string) when shouldReturnId is true. On failure, a string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: Title cannot be empty or null
• ERROR: File could not be accessed
• ERROR: Room Expired
• ERROR: Filename cannot be empty or null
• ERROR: filename cannot be exceed 100 characters
• ERROR: {extension} is not an allowed extension.
• ERROR: You are attempting to upload a null referenced byte array
• ERROR: You are attempting to upload a zero-length file
• ERROR: This folder was created more than {n} days ago and cannot accept anymore documents.

Notes:

• This operation has no permissions parameter and no metadata parameter.

AddSignerToRequest

Adds a signer to a file at a signing level. You can also give a mobile phone number for SMS notifications.

Active

Returns: string. SUCCESS, or a string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed
• ERROR: Invalid Email address
• ERROR: Room Expired
• ERROR: Room Archived
• ERROR: Invalid user sequence.
• ERROR: Invalid Email address: {reason}
• ERROR: The email you specified is already a participant at that level.
• ERROR: No. of total signers in the room can not be more than 24.
• ERROR: Unable to add as a signer. (the sequence is lower than the highest signing level in the file)
• ERROR: Invalid communication parameter. Could not parse {Value} as type MobilePhone (two spaces after the first period)
• ERROR: SMS is not enabled for this portal; please contact Sertifi support at {SUPPORT_EMAIL}.
• ERROR: Unable to add the email address.
• ERROR: An error occurred adding the communication to the folder.

Notes:

• If no user exists for the email, the service creates one.
• If the file already has documents with the status unsigned, converting or partially signed, the service creates signing requests for the new signer on those documents.
• If the service cannot save the contact information, it removes the signer again.
• This operation does not send an invitation.

AddSecondSignerToRequest

Adds a signer to a file at signing level 2.

Active

Returns: string. SUCCESS, or a string that starts with ERROR:.

Errors: The same errors as AddSignerToRequest, except the two contact information errors.

Notes: This operation is the same as AddSignerToRequest with sequence = 2 and no contact information.

AddCCToRequest

Adds a CC (a participant who does not sign) to a file.

Active

Returns: string. SUCCESS, or a string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed
• ERROR: Invalid Email address
• ERROR: Room Expired
• ERROR: Room Archived
• ERROR: Invalid Email address: {reason}
• ERROR: The email you specified is already a participant at that level. (the email is already a CC)
• ERROR: Unable to add the email address.

Notes:

• A signer can also be a CC on the same file.
• The signer limit does not apply to CCs.
• This operation does not send a notification. Use InviteSigners or InviteSigner.

InviteSigners

Sends invitations to the signers who can sign now (the current signing level). It can also notify all CCs.

Active

Returns: string. SUCCESS, or a string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed
• ERROR: Room Expired

Notes:

• If only payments remain in the file, the service sends a payment invitation to all signers.
• The service can also send SMS invitations to signers with a mobile phone number.
• If the portal setting "send CC notifications" is on, the service notifies every CC on each call, also CCs that it notified before.
• The service returns SUCCESS also when no signer is eligible for an invitation.

GetDocumentSummary

Returns the summary (audit trail) PDF for a file or for one document in the file.

Active

Returns: byte[]. The summary PDF contents (base64 in the SOAP message).

Errors: This operation returns no error strings. It returns an empty byte array when the API code is not valid, when the file or document cannot be accessed, or when the PDF cannot be generated.

Notes: If pstr_DocumentID is not a valid ID, the service ignores it and returns the summary for the full file.

InviteSignersWithAttachment

Sends invitations to the first-level signers. Each invitation has the first unsigned document attached as a PDF.

Active

Returns: string. SUCCESS, or a string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed
• ERROR: Room Expired
• ERROR: No unsigned documents in the room.

Notes:

• The service attaches only one document: the first document with the status unsigned, converting or partially signed.
• The service sends invitations only to signers at signing level 1. Call it before level 1 signers sign, to avoid repeat invitations.
• The service updates the invitation date for each signer.
• This operation does not notify CCs. It does not send SMS or payment invitations.

InviteSigner

Sends an invitation to one participant of a file. A signer gets a signing invitation. A participant who is only a CC gets a CC notification.

Active

Returns: string. SUCCESS, or a string that starts with ERROR:.

Errors: (the word "singer" is a typo in the service)

• ERROR: Invalid API Code
• ERROR: Invalid singer email
• ERROR: Invalid singer email: '{pstr_Signer}': {reason}
• ERROR: File could not be accessed
• ERROR: Room Expired
• ERROR: Signer not found

Notes:

• If the participant is both a signer and a CC, the service sends only the signing invitation.
• For a signer, the service uses the signer's current eligible signing level. If the signer is not eligible now, the service uses the signer's lowest signing level. Invite a signer only when it is that signer's turn to sign.
• If only payments remain in the file, the service sends a payment invitation instead.
• The service can also send an SMS invitation.

GetFilesStatus

Returns a short status for each file in the portal that was created in a date range.

Active

Returns: string with XML:

<?xml version="1.0" encoding="utf-16"?>
<CurrentStatus>
  <StartDate>{as sent}</StartDate>
  <EndDate>{as sent}</EndDate>
  <File>
    <Code>{File ID}</Code>
    <Name/>
    <Status>{numeric file status}</Status>
    <StatusFull>Active | Declined | Declined and Archived | Expired | Deleted | Archived</StatusFull>
    <Unsigned>{count}</Unsigned>
    <Signed>{count}</Signed>
    <DateCreated/>
    <DateLastAction/>
    <EventDate>{yyyy-MM-dd or empty}</EventDate>
  </File>
  ...
</CurrentStatus>

Errors:

• ERROR: Invalid API Code
• ERROR: pstr_StartDate is invalid.
• ERROR: pstr_EndDate is invalid.

Notes:

• Files with the status "awaiting verification" are not included.
• StatusFull shows Archived for every status that is not Active, Declined, Declined and Archived, Expired or Deleted.
• There is no limit on the date range or on the number of files.

GetMinimalFileStatus

Returns a short status for one file.

Active

Returns: string with XML: one <File> root element with the same child elements as in GetFilesStatus (Code, Name, Status, StatusFull, Unsigned, Signed, DateCreated, DateLastAction, EventDate). The XML has an XML declaration.

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed

GetFileStatus

Returns the full status of one file: file settings, signers, documents, signatures and participant groups.

Active

Returns: string with XML. Root element <File>. Child elements, in order:

• Code (File ID), Name, Status (numeric), EventDate (yyyy-MM-dd), RedirectUrl, UrlRedirectOnActions
• AdditionalInputFields1 to AdditionalInputFields10, AdditionalNumericField1
• ConfirmationNumber, ConsolidatedSigning, DefaultLanguage, EmailGroupName, EmailMessage, EnableIdCheck, EnableMouseSignature
• ExpiresOn and LastActionAt (format yyyy-MM-dd HH:mm:ssZ). ExpiresOn is in UTC. LastActionAt is in server local time, although it has the Z suffix. Do not read LastActionAt as UTC.
• MaskEmailsFromClient, Sender (owner email), SendReminders, SignatureType, Signed (count), Unsigned (count)
• One Signer element for each signer at each signing level. A signer at two levels has two Signer elements. Each element has UserID (opaque ID), Email, Signed (0 or 1), Open (0 or 1), SignerType (signing level), DateInvited, DateLastVisit. A date that is not set shows as 1/1/0001 12:00:00 AM. Other dates use the format MM/dd/yyyy h:mm:ssAM (no space before AM/PM).
• One Document element for each document, with DocumentID, Name, Status (text), DateCreated, DateSigned, FileName (only when includeDocumentDatabaseXML is true), and Signatures.
• Signatures holds a flat sequence of elements for each signing request (there is no wrapper element per request): Email, NameSigned, IpAddress, SignMethod (Electronic or Fax), DateSigned, SignerType (signing level), SignatureAction (only for consolidated signing), IdCheck (Required or Not Required), MustSignWithName. For a declined request it adds DateDeclined and DeclineComments. For a signed request it adds CustomField1 to CustomField4 (each with a Title attribute) when the document has those fields.
• DocumentDatabaseXML (only when includeDocumentDatabaseXML is true): an XML string, escaped as text.
• Groups with ParticipantGroup elements (Sequence, MaxSignerCount), only if the file has participant groups.
• GroupSets with ParticipantGroupSet elements (MinimumSequence, MaximumSequence), only if the file has group sets.

Boolean values show as True or False, except Signer/Signed and Signer/Open, which show 0 or 1. DateCreated, DateSigned and DateDeclined use the server's default date format.

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed

Notes: The response contains signer IP addresses and decline comments.

GetFileSigners

Returns one entry for each signing request in a file, with the signer and the signature details.

Active

Returns: string with XML:

<?xml version="1.0" encoding="utf-16"?>
<Signers>
  <Signer>
    <DocumentID/>
    <Status>{document status text}</Status>
    <Email/>
    <NameSigned/>
    <IpAddress/>
    <SignMethod>Electronic | Fax</SignMethod>
    <DateSigned/>
    <Sequence>{signing level}</Sequence>
  </Signer>
  ...
</Signers>

A signer can have more than one Signer element (one for each document and signing level).

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed

Notes: If the file has no signing requests, the response is an empty <Signers /> element.

GetDocumentsStatus

Returns the documents in the portal that were created in a date range and have a given status. You can filter by signer email.

Active

Returns: string with XML:

<?xml version="1.0" encoding="utf-16"?>
<CurrentStatus>
  <StartDate>{as sent}</StartDate>
  <EndDate>{as sent}</EndDate>
  <Document>
    <FileID/>
    <DocumentID/>
    <Name/>
    <FileName/>   <!-- the file (signature request) name; only when pstr_Signers is sent -->
    <Status>{status text}</Status>
    <DateCreated/>
    <DateSigned/>
  </Document>
  ...
</CurrentStatus>

The service sorts documents by creation date, newest first.

When you send pstr_Signers, a document can appear more than once: one time for each signing request that matches an email in the list. Remove duplicates by DocumentID.

Errors:

• ERROR: Invalid API Code
• ERROR: pstr_StartDate is invalid.
• ERROR: pstr_EndDate is invalid.
• ERROR: Status cant be empty or null.
• ERROR: pstr_Status is invalid. (text that does not match a status; the text Undefined also gives this error)
• ERROR: pstr_Signers is invalid: '{pstr_Signers}': {reason}

Notes:

• Only the number 10 returns all statuses. The service does not check other numbers; a number without a matching status returns no documents.
• There is no limit on the date range or on the number of documents.

GetUserInfo

Returns the profile of a user in the portal.

Active

Returns: string with XML:

<?xml version="1.0" encoding="utf-16"?>
<User>
  <FirstName/>
  <LastName/>
  <Address1/>
  <Address2/>
  <City/>
  <State/>
  <Zip/>
  <Phone/>
  <Fax/>
</User>

Errors:

• ERROR: Invalid API Code
• ERROR: Invalid user email
• ERROR: Invalid user email: '{pstr_Email}': {reason}
• ERROR: User not found (the user is not a user of this portal, or the user is disabled)

RemoveSignatureRequest

Deletes a file (signature request) and all of its documents. If the file has activity that must be kept, the service archives the file instead of deleting it.

Active

Returns: string. SUCCESS when the service deletes or archives the file.

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed
• ERROR: Signed documents exist
• ERROR: Could not remove file

Notes:

• The service rejects the call when the file has one or more fully signed or partially signed documents.
• The service archives the file (it does not delete it) when the file has declined documents, received payments, or any signed signature request. The call still returns SUCCESS.
• A deleted file appears in GetStatusOnChangedFiles results with status 10 (Deleted).

RemoveDocument

Removes one document from a file. The service also removes the payment and authorization requests that are attached to that document.

Active

Returns: string. SUCCESS when the service removes the document.

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed
• ERROR: Document could not be accessed
• ERROR: Payment request could not be accessed
• ERROR: Payment is currently being processed and could not be removed.
• ERROR: Could not remove payment request
• ERROR: Cannot remove document in "{status}" state. — {status} is the document status text: Unsigned, Signed, Converting to Pdf, Partially signed, Signed and archived, Declined, Expired, Conversion Failed or Undefined.
• ERROR: Document could not be removed.

Notes:

• You cannot remove a document that is signed, partially signed, declined, or signed and archived. In these cases the error shows the current status text.
• You also cannot remove a document when any signer has signed it. In this case the status text can be Unsigned.
• The service removes attached payment, authorization and eAuthorization requests first. It removes a payment request only when the payment is in the Ready or Error state.
• The service then removes the files that participants uploaded for the document.
• If the call fails, attached payment requests and uploaded files can already be removed.
• If the account sends documents as a packet and this removal completes a signing level, the service invites the signers at the next level.

RemoveReferenceDocument

Removes a reference document or an instructional document from a file.

Active

Returns: string. SUCCESS when the service removes the document.

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed
• ERROR: Document could not be accessed
• ERROR: Could not remove document.

RemoveUser

Removes a signer from one signing level of a file, or removes a CC from a file.

Active

Returns: string. SUCCESS when the operation completes.

Errors:

• ERROR: Invalid API Code
• ERROR: Invalid user email
• ERROR: Invalid user email: '{email}': {reason} — {reason} is one of Email address too long or too short., Invalid email domain. or Email contains invalid characters or is not complex enough.
• ERROR: Type does not exists
• ERROR: File could not be accessed
• ERROR: User is not a participant of the room
• ERROR: Signing sequence is not within a valid range of 1 to 10
• ERROR: Folder contains documents. Last signer cannot be removed.
• ERROR: User has already signed documents at this signing level and cannot be removed
• ERROR: User has already Declined documents at this signing level and cannot be removed
• ERROR: Failed to delete the participant. Specified signer does not exist.

Notes:

• ERROR: User is not a participant of the room means that no user with this email exists in the system. If the user exists but is not in this file, the signer path returns ERROR: Failed to delete the participant. Specified signer does not exist.
• The signer path also returns ERROR: Failed to delete the participant. Specified signer does not exist. when the signer has a payment request that is not in the Ready state.
• When the service removes a signer, it unassigns the Ready payment requests that were assigned to that signer.
• If the removal leaves a partially signed document with no pending signers, the service marks the document as signed and creates the final signed PDF.
• If the account sends second-level emails and you remove a level-1 signer, the service can invite level-2 signers.
• The cc path always returns SUCCESS, also when the email is not a CC on the file.

EditUser

Replaces a signer at one signing level with a different email address.

Active

Returns: string. SUCCESS when the service changes the signer.

Errors:

• ERROR: Invalid API Code
• ERROR: Invalid original user email
• ERROR: Invalid original user email: '{email}': {reason}
• ERROR: Invalid new user email
• ERROR: Invalid new user email: '{email}': {reason}
• Error: Invalid signer sequence
• Error: Type does not exists
• ERROR: File could not be accessed
• ERROR: Room Expired
• ERROR: pstr_OriginalEmail is not part of the file.
• The original email address does not exist. (no ERROR: prefix)
• The new signer already exists. (no ERROR: prefix)
• The original user has signed documents (no ERROR: prefix)

{reason} is one of Email address too long or too short., Invalid email domain. or Email contains invalid characters or is not complex enough.

In some cases the call fails with a SOAP fault, not an error string. This can occur when the original signer has signed documents at that level.

Notes:

• Some errors start with Error: (mixed case) and some have no prefix. Do not test only for the ERROR: prefix. Treat any value other than SUCCESS as a failure.
• ERROR: pstr_OriginalEmail is not part of the file. means that no user with that email exists in the system. If the user exists but is not in this file, the result is The original email address does not exist.
• The new signer already exists. means the new email is already a signer at the signing level in pshr_Sequence.
• If no user exists for the new email, the service creates one.
• The service resets the "date invited" value for the new signer. The service does not send an invitation in this operation.

ChangeSignerEmail

Replaces a participant email address in a file at all signing levels.

Active

Returns: string. SUCCESS when the service changes the email.

Errors:

• ERROR: Invalid API Code
• ERROR: Invalid original user email
• ERROR: Invalid orginal user email: '{email}': {reason}
• ERROR: Invalid new user email
• ERROR: Invalid new user email: '{email}': {reason}
• ERROR: File could not be accessed
• ERROR: Room Expired
• ERROR: pstr_OriginalEmail is not part of the file.
• ERROR: The original email address does not exist.
• ERROR: The new signer already exists.
• ERROR: The original user has signed documents

{reason} is one of Email address too long or too short., Invalid email domain. or Email contains invalid characters or is not complex enough.

In some cases the call fails with a SOAP fault, not an error string. This can occur when the original participant has signed documents.

Notes:

• This operation does not take a signing level. It changes the participant at every level.
• ERROR: The new signer already exists. means the new email is already a signer on the file at any level.
• If no user exists for the new email, the service creates one.
• The operation changes the email of any participant on the file, including a CC. Send pstr_OriginalEmail only for the participant that you intend to change.

GetSigningLink

Returns a link to the file signing page for one signer or for the file owner.

Active

Returns: string. An HTTPS URL on your account primary domain. If your account uses shortened links, the service returns a shortened URL.

Errors: The result is the error text instead of a URL. Error values are:

• ERROR: Invalid API Code
• FileID cannot be null or empty.
• Cannot find the FileID: '{FileID}'
• File could not be accessed.
• Signer is not a part of the file.

Notes:

• Only ERROR: Invalid API Code starts with ERROR:. A successful result starts with https://.
• The owner email comparison is case-sensitive. A participant email comparison is not case-sensitive.
• The call records the signer as invited at each signing level of the signer in the file.
• Treat the link as sensitive. Anyone with the link can open the signing page.

SendSignedDocumentEmail

Sends the "document signed" email for one document again.

Active

Returns: string. SUCCESS when the operation completes.

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed
• ERROR: Document could not be accessed
• SOAP fault (not an error string) when the service must attach a signed PDF and that PDF is not available.

Notes:

• The account "send signed email" setting controls the recipients (signers, CCs, owner, or a combination). If that setting is off, the service sends no email.
• The service also sends a copy to each address in the account-level CC email list.
• The service sends the email only when the document is signed. For accounts that send documents as a packet, the service also sends it for a declined document.
• The service returns SUCCESS also when it sends no email.
• The account attachment setting controls if the email has the signed PDF attached or a link. Attachments larger than 10 MB are replaced with a link.
• For files that send documents as a packet or use consolidated signing, the email is for the full file. When attachments are on, the email has the signed PDFs of all documents in the file, not only the document in pstr_DocumentID.

DownloadSignedDocument

Returns the signed PDF for one document.

Active

Returns: byte[]. The signed PDF file content.

Errors: The service returns an empty byte array (length 0) in all failure cases:

• The API code is not valid.
• The file or document is not found, or does not belong to your account.
• The document status is not Signed.
• The document content is no longer available (removed under retention rules).
• The service cannot read the signed PDF.

Notes:

• A document in the "Signed and archived" status returns an empty array.

DownloadFileContents

Returns a ZIP archive with the signed documents and reference documents of a file.

Active

Returns: byte[]. A ZIP archive. It contains:

• One signed PDF for each document in the Signed or "Signed and archived" status. The entry name is the original document file name with .pdf added (for example, contract.docx.pdf).
• Each reference document, with its original file name.

Errors: The service returns an empty byte array (length 0) when the API code is not valid, when the file is not found or does not belong to your account, or when the service cannot start the archive.

Notes:

• Instructional documents are not in the archive.
• If the signed PDF of a document is not available (for example, removed under retention rules), the service leaves that document out of the archive. It does not return an error. Compare the archive entries with the document list of the file.
• If the file has no signed documents and no reference documents, the service can return a valid ZIP archive with no entries (not an empty array).

GetMaintenanceLink

Returns a link that opens the file maintenance page for the file owner.

Active

Returns: string. An HTTPS URL on your account primary domain, in the form https://{primary-domain}/passthrough.aspx?email=…&ac=…&id=…&oid=….

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed

Notes:

• The link identifies the file owner. Treat it as a credential. Do not send it to signers or other third parties.
• Treat the link as confidential. Accounts with secure link expiration turned on do not accept links older than 7 days.

GetDocumentHash

Returns the stored hash value of a fully signed document.

Active

Returns: string. The document hash value.

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed
• ERROR: Document could not be accessed
• ERROR: Document is not totally signed
• ERROR: Document has no hash

ApplySignature

Applies an electronic signature to a document for one signer, with no signer interaction.

Active

Returns: string. SUCCESS.

Errors:

• ERROR: Invalid API Code
• ERROR: Invalid signature name
• ERROR: Invalid signer email
• ERROR: Invalid signer email: '{email}': {reason} — {reason} is one of Email address too long or too short., Invalid email domain. or Email contains invalid characters or is not complex enough.
• ERROR: Invalid domin for ApplySignature
• ERROR: File could not be accessed
• ERROR: Document could not be accessed
• ERROR: Document Expired
• ERROR: Could not load form with Prefill data
• ERROR: Custom field 1 is invalid, please enter '{caption}'
• ERROR: Custom field 2 is invalid, please enter '{caption}'
• ERROR: Custom field 1 is invalid, please enter '{caption}' (also returned for custom field 3 and custom field 4; {caption} is the caption of the missing field)
• ERROR: Specified email is not a signer for this transaction
• ERROR: Specified signer signed this document already.

Notes:

• Email domain rule: if your account has no accepted-domain list for this operation, all email domains are accepted. If the list has values, the domain of pstr_Email must match one list entry exactly. The service changes pstr_Email to lowercase, and the comparison is case-sensitive. Write each list entry in lowercase, with no spaces.
• Call ApplySignature only when it is the signer's turn to sign.
• If the signer has unsigned requests at more than one level, the service signs the lowest unsigned level.
• The service records the IP address of the API caller as the signer IP address.
• The service fills these signer fields on the document: full name (from pstr_NameSigned), initials, and the custom text fields Date, Time (account time zone), Title and Company (from the signer profile).
• If the document has no signatures yet and has saved prefill data, the service applies the prefill data to the document before it signs.
• If the call fails, the prefill data can already be applied to the document.
• If the document is declined, the service does not sign it but still returns SUCCESS. The service still fills the signer fields listed above.
• When the last signer signs, the service completes the document.

GetStatusOnChangedFiles

Returns the status of all files that changed or were deleted in a date range.

Active

Returns: string. An XML document:

<?xml version="1.0" encoding="utf-16"?>
<CurrentStatus>
  <StartDate>{pstr_StartDate as sent}</StartDate>
  <EndDate>{pstr_EndDate as sent}</EndDate>
  <File>
    <Code>{file ID}</Code>
    <Name>{file name}</Name>
    <Status>{numeric status}</Status>
    <StatusFull>{status text}</StatusFull>
    <Unsigned>{count}</Unsigned>
    <Signed>{count}</Signed>
    <DateCreated>{date}</DateCreated>
    <DateLastAction>{date}</DateLastAction>
    <EventDate>{yyyy-MM-dd or empty}</EventDate>
  </File>
  <!-- more File elements -->
</CurrentStatus>

StatusFull values: 1 = Active, 6 = Declined, 7 = Declined and Archived, 8 = Expired, 10 = Deleted. All other status values show Archived.

Errors:

• ERROR: Invalid API Code
• ERROR: pstr_StartDate is invalid.
• ERROR: pstr_EndDate is invalid.

Notes:

• The service includes a file when its last-action date is in the range (start and end included).
• A date with no time means 00:00 (midnight) on that date. If you send only a date as pstr_EndDate, the results do not include changes made later on that day. Send a date-time for the end of the range (for example, 2026-10-05T23:59:59).
• The service also includes files deleted in the range. Deleted files have Status 10, StatusFull Deleted, Signed 0, and no EventDate element. For a deleted file, DateLastAction is the deletion date.
• Files in the Awaiting Verification status are not included.
• Unsigned is the count of open documents and forms. Signed is the count of signed documents.
• The service formats DateCreated and DateLastAction with the server default date format.
• The service does not limit the range length or the number of results.

AddSigningLocation

Adds a full-name signature field for a signer on a document. This is a shortcut for AddLocation with location type 1.

Active

Returns: string. SUCCESS.

Errors: Same as AddLocation.

AddLocation

Adds a field (signature, initials, text, upload or payment location) for a signer on a document.

Active

Location types (pint_FieldType):

Returns: string. SUCCESS.

Errors:

• ERROR: Invalid API Code
• ERROR: Invalid page number. Please ensure the page number is between 1 and 400.
• ERROR: Invalid top coordinates.
• ERROR: Invalid left coordinates.
• ERROR: Invalid signer email '{email}'. Reason: {reason} — {reason} is one of Email address too long or too short., Invalid email domain. or Email contains invalid characters or is not complex enough.
• ERROR: File could not be accessed
• ERROR: Document could not be accessed
• ERROR: Document Expired
• ERROR: SignerEmail not valid
• ERROR: {email} is not a signer at level {sequence}
• ERROR: Signer sequence ambiguous. Sequence must be included for this signer and document.
• ERROR: Signing locations can only be added for signers of a document.
• ERROR: Signing locations can only be added to unsigned signature requests
• ERROR: Could not remove an existing large signature box before adding a new one
• ERROR: Invalid LocationType

Notes:

• The service validates the page number against the 1 to 400 range only. It does not check the actual page count of the document.
• Type 7 replaces the existing large signature box for the same signer request. Other types add a new field each time.
• ERROR: SignerEmail not valid means the email is not a signer on the file (for example, a CC only).
• If no user exists for the signer email, the call fails with a SOAP fault, not an error string.

SetSigningBoxLocation

Adds a large signature box for a signer on a document. This is a shortcut for AddLocation with location type 7. It replaces any existing large signature box for the same signer request.

Active

Returns: string. SUCCESS.

Errors: Same as AddLocation.

Notes:

• The signer must be at only one signing level on the document. If the signer is at more than one level, the call returns ERROR: Signer sequence ambiguous. Sequence must be included for this signer and document. Use AddLocation with sequence instead.

ApplyTemplate

Applies a library template (a saved set of field locations) to a document, for one signer or for all signers.

Active

Returns: string. SUCCESS.

Errors:

• ERROR: Invalid API Code
• ERROR: Invalid signer email: '{email}': {reason} — {reason} is one of Email address too long or too short., Invalid email domain. or Email contains invalid characters or is not complex enough.
• ERROR: File could not be accessed
• ERROR: Document could not be accessed
• ERROR: Template could not be accessed
• ERROR: Document Expired
• ERROR: Signer not found
• ERROR: Template could not be found

Notes:

• The service adds a template field to a signer when the field signing level and signer order match the signer position in the file.
• The service adds fields each time you call it. It does not remove fields from an earlier call.
• If the document has no signers, the service adds no fields and returns SUCCESS. In this case it does not validate the template.
• Apply templates before signers sign the document.

VerifyFolderPassword

Checks a password against the password of a file.

Active

Returns: bool. true when the password matches the file password. Otherwise false.

Errors: The operation does not return error strings. It returns false when the file ID is not valid, the file is not found, or the password does not match.

SetRedirectURL

Sets the URL that the signer goes to after an action on the file.

Active

Returns: string. SUCCESS.

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed
• ERROR: Room Expired
• ERROR: Invalid URL. Cannot be empty or greater than 2000 characters.
• ERROR: {message} — the service could not save the URL.

Notes:

• The error text mentions only the maximum length. A URL shorter than 10 characters also returns this error.
• If you omit redirectActions, the service uses Sign. If you send an empty list, no action causes a redirect.
• For the Sign action, the redirect occurs when the signer has no more documents to sign, or when the account does not send signers back to the file page.
• Use an absolute https:// URL that you control.
• The URL can contain these placeholders. The service replaces them when it redirects the signer:

• If your account has a callback secret, the service signs the redirect URL with that secret. Verify the signature before you trust the URL values.

FileQuery

Searches the files of your account by metadata and returns a summary for each match.

Active

Returns: FileQueryResult[] with one element. On success, Result is a FileSummary[] with one item for each matching file (newest first), and ErrorMessage is empty. Each FileSummary has FileId, DateCreated, DateLastAction, FileStatus, OwnerEmail, Signed, Unsigned and Participants (each with Email and Roles). See Data types.

Errors: On failure, Result is null and ErrorMessage has one of these values:

• ERROR: Invalid API Code
• ERROR: No files found
• ERROR: Invalid 'FileNumericId1' parameter. — the value is not a whole number.
• ERROR: Invalid 'FileDateSigned' parameter, account is not packetized.
• ERROR: Invalid 'DocumentDateSigned' parameter — the FileDateSigned value is not in the format yyyy-MM-ddTHH:mm:ss.
• ERROR: Specified argument was out of the range of valid values. followed by a line break and Parameter name: 'DocumentDateSigned' out of range — the FileDateSigned value is in the future or before the year 2000.
• ERROR: Invalid 'FileExternalId1' parameter. — the value is null or longer than 100 characters.
• ERROR: Invalid 'FileExternalId2' parameter. — the value is null or longer than 100 characters.
• ERROR: Value cannot be null. followed by a line break and Parameter name: parameters cannot be null — parameters is missing.
• ERROR: {message} — other unexpected failures. For example, this occurs when you send the same Type more than one time.

Notes:

• Send each Type one time only.
• FileDateSigned is available only for accounts that send documents as a packet. It matches files signed within that second. The service reads the value as server local time.
• An empty parameters array returns all files of the account.
• The service does not page or limit the results.

SetDocumentParameters

Updates properties of one document in a file. You can set the three document external IDs. You can also expire or unexpire the document.

Active

p_XMLContent format

Send one parameter element for each setting, inside a root element. Attribute names are case-sensitive:

Supported name values:

Example:

<?xml version='1.0' encoding='UTF-8' ?>
<document>
  <parameter name='externalid1' value='EXT-0001' />
  <parameter name='externalid2' value='EXT-0002' />
</document>

Returns: string. SUCCESS when the change is saved. Otherwise a string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed.
• ERROR: Document could not be accessed
• ERROR: Invalid API code for the Document id.
• ERROR: Document id does not match the File id.
• ERROR: Invalid parameter attributes.
• ERROR: invalid value in one of externalid parameters.
• ERROR: invalid value in changeExpiredStatus parameter.
• ERROR: Invalid XML.
• ERROR: cannot update external id and expiration status in the same call.
• ERROR: Error saving the document.
• ERROR: Error updating the document.
• ERROR: Document remained unchanged.

Notes:

• You cannot change external IDs and the expiration status in the same call. Use two calls.
• The service ignores unknown parameter names. If the XML has no supported parameter, the call returns ERROR: Document remained unchanged.
• If a parameter occurs more than one time, the last value is used.
• When you set external IDs, the service saves all three external IDs together. An external ID that you do not send keeps its current value.
• expire works only when the document is not yet complete: awaiting signature, partially signed, awaiting verification, or converting to PDF. In other states the call returns ERROR: Error updating the document. The service also sends a document-expired notification.
• unexpire works only when the document is expired and its content is not deleted. The document returns to "partially signed" if any signature exists. Otherwise it returns to "awaiting signature". The service clears the document expiration date.
• If the XML is not valid, the service saves no changes.

SetSignatureRequestParameters

Updates settings of a file (signature request). You can set signer options, file metadata, language, email group, expiration, and other file settings. You can also add custom metadata to the file.

Active

You must send p_XMLContent, p_CustomMetadataXML, or both. If neither causes a change, the call returns ERROR: File remain unchanged.

p_XMLContent format

Send one parameter element for each setting, inside a root element (the examples use file). The service applies the elements in order. Attribute names are case-sensitive.

Supported name values:

Boolean values accept true and false (case-insensitive).

Example:

<?xml version='1.0' encoding='UTF-8' ?>
<file>
  <parameter name='FileExternalId1' value='ORDER-0001' />
  <parameter name='MustSignWithName' email='[email protected]' value='Pat Example' preFillName='true' />
  <parameter name='DefaultLanguage' value='fr-CA' />
  <parameter name='ExpirationDateTime' value='2026-12-31 17:00' />
</file>

p_CustomMetadataXML format

The service accepts these three forms:

The service uses the first form if any element is named exactly field. The service adds the values to the custom metadata of the file.

Returns: string.

• SUCCESS when the changes are saved.
• WARNING: <messages> when the changes are saved but one or more parameters were ignored or truncated. Messages are separated by line breaks.
• Otherwise a string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: File could not be accessed
• ERROR: could not parse custom metadata
• ERROR: Invalid parameter attributes.
• ERROR: Invalid parameter attributes 'email': <email>. <reason>
• ERROR: Invalid parameter attributes. Signer '<email>' is not part of the file.
• ERROR: invalid value in one of IDCheck parameters.
• ERROR: invalid value in maskemailsfromclient parameter.
• ERROR: Must specify e-mail address for MustSignWithName parameter. Name passed: <name>.
• ERROR: enablemousesignature is disabled for this account.
• ERROR: invalid value in one of enablemousesignature parameters.
• ERROR: <value> is not a supported language
• ERROR: Security prompt cannot be longer than 200 characters. Email: <email>. Prompt: <prompt>.
• ERROR: Password cannot be longer than 200 characters. Email: <email>. Password: <prompt> (the real limit is 50 characters)
• ERROR: "<name>" email group is either not present or does not have any e-mail templates defined.
• ERROR: Cannot set expiration date for a folder beyond 365 days from now. Value passed: <value>.
• ERROR: <value> is not a properly formatted date. Expected format yyyy-mm-dd (four digit year followed by a two digit month, followed by a two digit day)
• ERROR: You can't set the expiration date for a folder for more than 365 days from now. Set the expiration date for less than 365 days.
• ERROR: <value> isn't properly formatted. Format the date + time as: yyyy-MM-dd HH:mm.
• ERROR: invalid value in ConsolidatedSigning parameter.
• ERROR: Consolidated Signing not available for this account. If you would like this feature, please contact our sales or support team.
• ERROR: invalid value in SendReminders parameter.
• ERROR: <value> is not a properly formatted date. Expected format yyyy-mm-dd (four digit year followed by a two digit month, followed by a two digit day, or blank.)
• ERROR: "ConfirmationNumber" cannot exceed 100 characters.
• ERROR: Invalid <name> value. (<name> is the lowercase parameter name)
• ERROR: Invalid XML.
• ERROR: File remain unchanged.

Warning messages (returned after WARNING:):

• <name> is not a valid File External Id. Valid parameters are FileExternalId1 - FileExternalId10.
• The passed value of "<value>" exceeded the maximum length of 100 for parameter <name> and was truncated.
• <name> is not a valid File Numberic Id. Valid parameters is FileNumbericId1.
• <name> is not a valid File Numberic Id. Valid parameters is FileNumericId1.
• <name> has invalid File Numberic Id value.

Notes:

• The short names ExternalId1–ExternalId10 and NumericId1 do not work. They return ERROR: Invalid <name> value. Use FileExternalId<n> and FileNumericId1.
• In the warning text and the truncation warning, the service shows the parameter name and value in lowercase. The saved FileExternalId value keeps its original case.
• The service ignores unknown parameter names.
• Put IDCheck parameters before all other file settings in the XML. If IDCheck comes after a file setting (for example MaskEmailsFromClient, DefaultLanguage, or an expiration), the service does not save those earlier file settings, but the call still returns SUCCESS.
• Always send the email attribute on each SecurityQuestion parameter. If you do not, the service applies the question and answer to the signer of an earlier parameter in the same XML that has email. If no such parameter exists, the call returns ERROR: Invalid securityquestion value.
• The service saves IDCheck changes immediately, while it reads the XML. If a later parameter fails, the IDCheck change stays saved. The service does not save the other changes in that case.
• If all parameters only cause warnings, no change occurs and the call returns ERROR: File remain unchanged.
• EnableMouseSignature counts as a change only when the new value is different from the current value.

SendNotificationMessage

Sends a payment-related email notification to participants of a file. The notification can be a payment invitation, a payment due invitation, or a payment cancellation.

Active

Supported NotificationType values:

All three types require FileId and PaymentId. The payment must belong to the file.

Returns: NotificationResult. On success, IsSuccessful is true and ErrorMessage is null. On failure, IsSuccessful is false and ErrorMessage contains one or more error lines. See Data types.

Errors: (values of ErrorMessage; multiple errors are separated by line breaks)

• ERROR: Invalid API Code
• ERROR: To email address required
• ERROR: To email <email> : <reason>
• ERROR: CC email <email> : <reason>
• ERROR: File could not be accessed
• ERROR: Payment could not be accessed
• ERROR: Document could not be accessed
• ERROR: <email> is not a participant in the folder
• ERROR: Unexpected error occurred, please provide reference id <reference-id> when contacting support

Notes:

• Each To address must be a participant of the file. CC addresses must be valid email addresses, but they do not need to be participants.
• The service sends one email to each To and CC address.
• The service replaces each custom token (CustomTokens name/value pair) in the email template with its value.
• If you send DocumentId, the document must belong to the file.
• The service validates all recipients before it sends any email. If one validation fails, it sends no email.

GetLink

Creates one or more links to pages or documents of a file. Each item in the request gives one result. Each result contains a link or an error.

Active

Supported LinkType values:

"Secure link" means a link that logs in the named user one time through a token. By default a secure link is single-use and expires 5 minutes after it is created. If the account has secure link expiration turned on, the account setting controls the maximum number of uses.

AdditionalProperties names for SecureFileSigningPageLink (case-insensitive; the service ignores other names): idc_firstname, idc_middlename, idc_lastname, idc_address, idc_aptno, idc_city, idc_state, idc_zip, idc_mdob, idc_ydob, idc_l4ssn, idc_lockedfields. The service adds these values to the link in encrypted form.

Returns: UrlQueryResult[]. One result for each item in parameters, in the same order. Each result echoes FileId, DocumentId, LinkType, and SignerEmail (in lowercase). On success, Link contains the URL and Error is null. On failure, Link is null and Error contains the message. If the API code is not valid, the array has one result with the error. See Data types.

Errors: (values of Error)

• ERROR: Invalid API Code
• Invalid link parameter type
• FileID cannot be null or empty.
• Cannot find the FileID: '<FileId>'
• DocumentID cannot be null or empty.
• Cannot find the DocumentID: '<DocumentId>'
• PaymentID cannot be null or empty.
• Cannot find the PaymentID: '<PaymentId>'
• File could not be accessed.
• Document could not be accessed.
• Payment could not be accessed.
• Document is expired.
• Signer email is invalid. <reason>
• Signer is not a part of the file.
• Insufficient permissions to view this file.
• <email> is not an allowed sender for this account.
• <email> is not allowed to make changes to this folder.
• Edit locations link is not available for this document.
• Document Prefill link is not available for this document.
• Other system messages can occur, for example when SignerEmail is not an existing user.

Notes:

• For FileSigningPageLink and SigningPageLink, the service records the signer as invited. It updates the invitation date for each signing step of that user.
• Direct links (types without the Secure prefix, except PrintablePdfLink and PaymentReceiptLink) open the file without a sign-in step. Treat them as confidential. Accounts with secure link expiration turned on do not accept direct links older than 7 days. Some accounts return a shortened URL for direct links.
• For SecureSendingPageLink, SecureFileMaintenanceLink, SecureHomePageLink, SecureDocumentPrefillLink, and PrintablePdfLink: if no user exists for SignerEmail, the service creates one.
• One failed item does not stop the other items.

CreatePayment

Adds a payment request to a file. The payment can be a one-time or monthly payment, and the operation can be pay or authorize.

Active

xmlContent format

Send one lowercase parameter element for each field, inside a root element (the example uses payment). Each element has a name attribute (value case-insensitive) and a value attribute. If a name occurs more than one time, the first one is used. Empty values are ignored.

Example:

<payment>
  <parameter name="billingname" value="Pat Example" />
  <parameter name="billingaddress1" value="100 Example Street" />
  <parameter name="billingcity" value="Example City" />
  <parameter name="billingstate" value="IL" />
  <parameter name="billingzipcode" value="00000" />
  <parameter name="billingcountry" value="US" />
  <parameter name="payeremail" value="[email protected]" />
  <parameter name="allowedpaymethods" value="CC, ACH" />
</payment>

Returns: string. On success, the payment ID (an opaque string that does not start with ERROR:). Use it with RemovePayment, GetPaymentsStatus, GetLink, and SendNotificationMessage. Otherwise a string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: Payments are not enabled for this account.
• ERROR: File could not be accessed
• ERROR: invalid date payment due.
• ERROR: datePaymentDue not in recognized date format yyyy/MM/dd
• ERROR: Payment Gateway not configured.
• ERROR: Payment Gateway does not support selected payment recurrence.
• ERROR: Operation <operation> is not enabled or supported for payment gateway. (for Authorize, <operation> is Verify)
• ERROR: Could not parse XML content. <details>
• ERROR: '<method>' is an invalid value for allowedpaymethods.
• ERROR: 'billingnames' parameter cannot exceed 100 characters.
• ERROR: 'billingaddress1' parameter cannot exceed 100 characters.
• ERROR: 'billingaddress2' parameter cannot exceed 100 characters.
• ERROR: 'billingcity' parameter cannot exceed 100 characters.
• ERROR: 'billingstate' parameter cannot exceed 20 characters.
• ERROR: Invalid 'billingcountry' parameter. Only two or three letter ISO 3661-1 codes are accepted.
• ERROR: Invalid 'billingstate' parameter. Only two letter US state codes are accepted.
• ERROR: 'BillingEmail' parameter cannot exceed 100 characters.
• ERROR: 'payeremail' parameter contains invalid email.
• ERROR: payeremail '<email>' is not a participant of given fileId.
• ERROR: setting 'allowedpaymethods' is not a supported feature for the AuthorizeNet payment gateway
• ERROR: There are no available payment methods for the payee. Enable one or more payment methods to continue.
• ERROR: payeremail parameter is required along with other billing details.
• ERROR: 'CloneDescription' parameter cannot exceed 100 characters.
• ERROR: CloneAmount not set to valid number.
• ERROR: Surcharging isn't supported by a payment gateway in the portal
• ERROR: HasSurcharge isn't set to a valid value
• ERROR: Amount needs to be greater than 0
• ERROR: Amount needs to be 0
• ERROR: Amount needs to be less than 1,000,000
• ERROR: Number of decimal places in the amount cannot be greater than 2
• ERROR: Number of decimal places in the CloneAmount cannot be greater than 2
• ERROR: Description cannot be blank
• ERROR: Either 'Use Automatic Rules' must be selected or payment methods must be selected
• ERROR: Could not save payment
• ERROR: <message> (a save error from the payment service)

Notes:

• If you send any billing detail (billingname, billingaddress1, billingaddress2, billingcity, billingstate, billingzipcode, billingcountry), you must also send payeremail. billingemail does not have this rule.
• For allowedpaymethods, the service removes each method that no active payment gateway supports for this operation and recurrence. It does not report an error for a removed method. It reports an error only if no method remains. ALL skips this check.
• When more than one validation error occurs on the payment amount or description, the call returns only the first one.
• The new payment is added to the actions of the file.

RemovePayment

Removes a payment request from a file. You can remove a payment only when it is awaiting payment or in error.

Active

Returns: string. SUCCESS when the payment is removed. Otherwise a string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: Payments are not enabled for this account.
• ERROR: File could not be accessed
• ERROR: Payment request could not be accessed
• ERROR: Payment is currently being processed and could not be removed.
• ERROR: Could not remove payment request

Notes:

• The payment status must be "Awaiting payment" or "Error". The payment processor must also report the payment as awaiting payment or in error. Any other status returns ERROR: Payment is currently being processed and could not be removed.
• The service also closes any open hosted payment session for the payment and removes the payment from the actions of the file.
• ERROR: Could not remove payment request can occur after the payment is removed. Call GetPaymentsStatus to confirm the result.

GetPaymentsStatus

Returns the details and status of the payments in a file. You can get all payments of the file or one payment.

Active

Returns: string. On success, an XML document with this shape:

<Payments Count="1">
  <Payment>
    <Amount>...</Amount>
    ...
  </Payment>
</Payments>

Count is the number of Payment elements. Each Payment element contains these child elements, in this order. An element is empty when it has no value.

Otherwise a string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: Payments are not enabled for this account.
• ERROR: File could not be accessed
• ERROR: Payment request could not be accessed

Notes:

• The response contains payer and bank details. Protect it as confidential payment data.

Retired operations

These operations remain in the WSDL for older clients. Do not call them. Each one always returns the value shown.

Use SetSignatureRequestParameters with the IDCheck parameter in place of EnableIDCheck. Use AddPrepopulatedPdfToRequest in place of the form operations.

Communication

Used by: AddSignerToRequest (parameter contactInfo, optional).

Contact information for a signer.

Rules:

• For MobilePhone, give the number in international format with a leading + and the country code, for example +15555550100. The service rejects numbers that it cannot parse and numbers with an extension.
• For MobilePhone, SMS messaging must be enabled for the portal. If it is not, the method returns an error.
• If the value is not valid, the method returns ERROR: Invalid communication parameter. ....

CommunicationMethod (enum)

ReferenceDocumentPermission

Used by: AddReferenceDocumentFromLibrary and AddReferenceDocumentToRequest (parameter permissions, optional array).

A rule that shows or hides a reference document for a participant.

By default, all participants see a reference document. A rule with Action = Hide removes the document from the view of the matching participants. A rule with Action = Show makes the document visible again for the matching participants. A rule with an email address takes priority over a rule without an email address.

Examples:

ReferenceDocumentPermission.RoleType (enum)

ReferenceDocumentPermission.ActionType (enum)

RedirectOnAction (enum)

Used by: SetRedirectURL (parameter redirectActions, optional array).

The signer actions that send the signer to the redirect URL. You can send more than one value. The service combines all values.

If you do not send redirectActions, the service uses Sign. If you send an empty array, the service does not redirect for any action. The redirect URL must be 10 to 2000 characters long after the service removes leading and trailing spaces.

SearchParameter

Used by: FileQuery (parameter parameters, array).

One search condition.

FileQuery rules:

• The service returns only files that belong to the account of the API code.
• The service joins all conditions with AND.
• Each condition is an exact match.
• Do not send the same Type more than once in one call.
• If you send an empty array, the service returns all files of the account. The service does not page the results. Avoid this on large accounts.
• If parameters is null, the method returns an error.
• The service sorts results by creation date, newest first.

SearchParameterType (enum)

Note: some FileDateSigned error messages use the name DocumentDateSigned.

FileQueryResult

Returned by: FileQuery (array).

The method always returns an array with one item.

FileSummary

Part of: FileQueryResult.

FileParticipant

Part of: FileSummary.

FileRole

Part of: FileParticipant.

RoomStatus (enum)

Used in: FileSummary.FileStatus.

NotificationMessage

Used by: SendNotificationMessage (parameter message).

A request to send a payment notification email.

EmailAddress

Part of: NotificationMessage.

NameValuePair

Part of: NotificationMessage.CustomTokens and LinkParameter.AdditionalProperties.

NotificationType (enum)

NotificationResult

Returned by: SendNotificationMessage.

The response can carry the type name NotificationProcessingResult (xsi:type). That type adds no fields on the wire.

If an unexpected error occurs, the message includes a reference ID. Give this ID to support.

LinkParameter

Used by: GetLink (parameter parameters, array).

A request for one link. You can request many links in one call. The service returns one UrlQueryResult for each LinkParameter, in the same order.

AdditionalProperties for SecureFileSigningPageLink: the service accepts these names to prefill identity verification data for the signer. The service ignores other names. Names are not case-sensitive.

idc_firstname, idc_middlename, idc_lastname, idc_address, idc_aptno, idc_city, idc_state, idc_zip, idc_mdob, idc_ydob, idc_l4ssn, idc_lockedfields

LinkParameterType (enum)

"Secure" link types return a link that signs the user in one time through a token. By default the link is single-use and expires 5 minutes after it is created. If the account has secure link expiration turned on, the account setting controls the maximum number of uses.

UrlQueryResult

Returned by: GetLink (array).

Check Error on each item. One item can fail while other items succeed. The response does not echo PaymentId. Use the array position to match a result to its request.

PaymentReccurence (enum)

Used by: CreatePayment (parameter recurrence, optional). The name has this spelling in the WSDL.

PaymentOperationType (enum)

Used by: CreatePayment (parameter operation, optional).

GatewayV2.DownloadFileContents

Returns a ZIP archive of the completed documents and reference documents in a folder. This operation replaces the Gateway operation of the same name.

Active

Returns: base64Binary (byte array). On success, the bytes of a ZIP archive. On a validation failure, an empty byte array (length 0). A folder with no files returns a valid ZIP archive with no entries, not an empty byte array.

Errors: This operation returns no error strings. It returns an empty byte array when:

• The API code is not valid.
• The folder ID is not valid, the folder does not exist, or the folder belongs to a different portal.
• The service cannot create the archive.

Notes:

• The archive contains the signed PDF of each document with status Signed or Archived. Documents with other statuses are not included.
• The archive also contains all reference documents of the folder, with their original file names.
• The service adds a file only if the stored file exists.
• Difference from Gateway: GatewayV2 names signed PDF entries Contract.pdf, not Contract.pdf.pdf.
• To select which content to download, use DownloadSelectedContent. It accepts folders in any status except deleted.

GatewayV2.CreateSignatureRequest

Creates a new folder in the portal and adds the sender and participants. In GatewayV2, the list of first signers is optional. You can add signers later.

Active

Returns: string. On success, the new folder ID (an opaque token). On failure, an error string that starts with ERROR:.

Errors:

• ERROR: Invalid API Code
• ERROR: Filename cannot be empty or null
• ERROR: Password cannot be exceed 50 characters
• ERROR: Invalid sender email
• ERROR: Invalid sender email: '{senderEmail}': {reason}
• ERROR: pstr_Signers is invalid: '{signers}': {reason}
• ERROR: pstr_CCs is invalid: '{ccs}': {reason}
• ERROR: pstr_SecondSigners is invalid: '{secondSigners}': {reason}
• ERROR: No. of total signers in the room can not be more than 24.
• ERROR: Sender name too long
• ERROR: Sender last name too long
• ERROR: User, {senderEmail}, is disabled and cannot create files.

Notes:

• Difference from Gateway: GatewayV2 accepts an empty pstr_Signers.
• The signer limit of 24 counts first-level and second-level signers. It does not count the sender that pstr_Cosign adds. An empty pstr_Signers counts as one signer, so with an empty pstr_Signers you can send a maximum of 23 second-level signers. Empty entries between commas also count.
• The service converts email addresses to lowercase and removes spaces.
• The service adds the permanent CC addresses of the portal to the CC list.
• If no user exists for the sender email, the service creates one. If the sender has a portal role lower than Admin, the service changes the role to Admin.
• If the sender has no first name or last name on file, the service sets them from pstr_SenderName.
• This operation does not send invitations. Use the invitation operations of the Gateway service to send them.

AddParticipantGroup

Adds participant groups and participant group sets to an active folder. A group marks a signer level as a group. A group set lets a range of signer levels sign at the same time.

Active

Returns: ParticipantGroupResult. On success, IsSuccess = true, FolderId = the folder ID you sent, and Groups and GroupSets contain all groups and group sets of the folder after the change. On failure, IsSuccess = false and ErrorMessage contains the error.

Errors:

• ERROR: Invalid API Code
• ERROR: Participant groups settings parameter is required.
• ERROR: Folder could not be accessed
• ERROR: Folder is not active.
• ERROR: MinimumSequence must be in range of 1-10.
• ERROR: MaximumSequence must be in range of 1-10.
• ERROR: MaximumSequence must be greater than or equal to MinimumSequence.
• ERROR: Sequence {n} can only be part of one Participant Level Pool. Please make sure to remove unwanted Participant Level Pools before adding replacements.
• ERROR: Max signer count should be equal to 1.
• ERROR: Participant sequence should be in range of 1-10

Notes:

• The folder must be active.
• MaxSignerCount must be 1 for each group.
• If a group already exists for a Sequence, the service updates it. It does not add a second group.
• A signer level can be in only one group set. The service checks the new group sets against each other and against the existing group sets of the folder. To replace a group set, remove it first with RemoveParticipantGroup.
• If Groups or GroupSets is missing (null), the call fails with a SOAP fault. Always send both lists.

RemoveParticipantGroup

Removes participant groups and participant group sets from a folder.

Active

Returns: ParticipantGroupResult. On success, IsSuccess = true, FolderId = the folder ID you sent, and Groups and GroupSets contain the groups and group sets that remain on the folder. On failure, IsSuccess = false and ErrorMessage contains the error.

Errors:

• ERROR: Invalid API Code
• ERROR: Participant groups settings parameter is required.
• ERROR: Cannot find Participant Group Sequence {sequence} to remove.
• ERROR: Cannot find Participant Group Set with MinimumSequence {minimumSequence} to remove.
• ERROR: Participant Group Set MaximumSequence {maximumSequence} does not match existing record.

Notes:

• The service identifies a group by its Sequence. It ignores MaxSignerCount.
• The service identifies a group set by its MinimumSequence. MaximumSequence must match the existing group set.
• The service checks that all groups and group sets exist before it removes any of them.

AddManyLocations

Adds many field locations to one document for one signer. The service processes each location separately and returns one result for each location.

Active

Returns: string. An XML document with one AddLocationResult element for each location, in the order of locations. Each element contains SUCCESS or an error string. Example:

<?xml version="1.0" encoding="utf-16"?>
<LocationResults>
  <AddLocationResult>SUCCESS</AddLocationResult>
  <AddLocationResult>ERROR: Invalid top coordinates.</AddLocationResult>
</LocationResults>

Errors: Each AddLocationResult can contain one of these strings:

• ERROR: Invalid API Code
• ERROR: Invalid page number. Please ensure the page number is between 1 and 400.
• ERROR: Invalid top coordinates.
• ERROR: Invalid left coordinates.
• ERROR: Invalid signer email '{signerEmail}'. Reason: {reason}
• ERROR: File could not be accessed
• ERROR: Document could not be accessed
• ERROR: Document Expired
• ERROR: SignerEmail not valid
• ERROR: {signerEmail} is not a signer at level {sequence}
• ERROR: Signer sequence ambiguous. Sequence must be included for this signer and document.
• ERROR: Signing locations can only be added for signers of a document.
• ERROR: Signing locations can only be added to unsigned signature requests
• ERROR: Could not remove an existing large signature box before adding a new one
• ERROR: Invalid LocationType

Notes:

• The service does not process the locations as one transaction. Some locations can succeed and others can fail.
• FieldType controls the location type. These values are accepted: FullNameTextBox, InitialTextBox, CustomTextBox, ShortCustomTextBox, SignatureBox, FileUpload, PaymentAuth, PaymentAuthWithAddress, Date, Time, LargeCustomBox, Company, Title. The values Label and Comment return ERROR: Invalid LocationType.
• The service treats CustomTextBox as LargeCustomBox.
• The service ignores Height, Width and Value. The field type sets the size.
• Caption rules: ShortCustomTextBox uses the first 7 characters. LargeCustomBox (and CustomTextBox) uses the first 20 characters. FileUpload uses the first 100 characters. FullNameTextBox, InitialTextBox, Date, Time, Company and Title use fixed captions.
• A SignatureBox replaces the existing signature box of the same signer request on the document.
• A FileUpload location also creates a signer upload request for the signer.
• If the signer email is valid but no user exists for it, the call fails with a SOAP fault.

DownloadSelectedContent

Returns a ZIP archive with the folder content that you select. You can select documents by status, reference documents and signer uploads.

Active

Returns: DownloadSelectedContentResult. On success, IsSuccess = true, FolderId = the folder ID you sent, and FilesZip = the bytes of the ZIP archive. On failure, IsSuccess = false and ErrorMessage contains the error.

Errors:

• ERROR: Invalid API Code
• ERROR: download file content request parameter is required.
• ERROR: Folder could not be accessed.
• ERROR: Folder was deleted.
• ERROR: No download options were selected; try again after selecting one or more download options.
• ERROR: Downloading signer uploads on their own and as attachments to documents is not allowed.
• ERROR: Folder does not contain any documents in the selected categories.
• ERROR: An error occurred gathering the files. If this problem persists, please contact support.

Notes:

• You must set at least one of these options to true: UnsignedDocuments, PartiallySignedDocuments, FullySignedDocuments, ExpiredDocuments, DeclinedDocuments, ReferenceDocuments, SignerUploadedAttachments. AppendSignerUploads alone is not sufficient.
• You cannot set both SignerUploadedAttachments and AppendSignerUploads to true.
• Content for each document status:
  • Awaiting signature or converting: the original file.
  • Declined or revoked: the original file.
  • Signed or archived: the signed PDF.
  • Partially signed: a PDF that the service generates with the signatures to date.
  • Expired: the service uses the signatures to date. All signed = signed PDF. Some signed = generated partially signed PDF. None signed = original file.
• If AppendSignerUploads is true, the service generates the signed and partially signed PDFs with the signer uploads attached.
• Document entries have the name {document name without extension}-[{token}].pdf. The token is an opaque unique value.
• Reference document entries have the name {file name without extension}-[{token}].pdf. The .pdf extension is always used, also for files that are not PDF.
• Signer uploads from the classic signing experience have the name {signer email}.zip.
• Other signer uploads are in a subfolder with the name {upload name}-{token}. Each file has the name {file name}-{token}.{extension}.
• The service replaces characters that are not valid in file names with -.
• The service adds a file only if the stored file exists.
• The folder can be in any status except deleted.

RemoveAllDocumentFields

Removes all field locations from a document that nobody has signed. It also removes the signer upload requests that belong to the document.

Active

Returns: DocumentFieldsResult. On success, IsSuccessful = true. On failure, IsSuccessful = false and ErrorMessage contains the error.

Errors:

• ERROR: Invalid API Code
• ERROR: Document does not exist.
• ERROR: Document Fields cannot be removed from this document.

Notes:

• The document status must be awaiting signature or converting. For all other statuses, the service returns ERROR: Document Fields cannot be removed from this document.
• The operation removes all location types, including signature boxes, text boxes, file upload locations and payment locations.
• The operation also removes the signer upload requests that belong to the document. This change cannot be undone.

GatewayV2.GetMaintenanceLink

Retired It does not return a link. Use GetLink with LinkType = FileMaintenanceLink or SecureFileMaintenanceLink.

ParticipantGroupSettings

ParticipantGroup

ParticipantGroupSet

ParticipantGroupResult

DocumentField

DocumentFieldType (enumeration)

DownloadSelectedContentDTO

DownloadSelectedContentResult

DocumentFieldsResult

GetFolderStatus

Returns the settings, signers, documents and signatures of a folder. This operation is a new version of the Gateway operation GetFileStatus.

Active

Returns: FolderStatus. On success, IsSuccessful = true and the other fields contain the folder data. On failure, IsSuccessful = false and ErrorMessage contains the error.

Errors:

• Error: Invalid API Code
• Error: Folder could not be accessed

Notes:

• The operation returns data for folders in all statuses.
• Signers contains one entry for each signer level of each participant. A CC participant has an entry with SignerType = 0.
• If includeDocumentDatabaseXML is false, DocumentDatabaseXML is empty.
• The document database XML contains the folder external IDs FileExternalId1 to FileExternalId10, FileNumericId1, and the document external IDs DocumentExternalId1 to DocumentExternalId3.

SetFolderParameters

Sets one or more parameters on a folder. The service returns one result for each parameter, in the order of the request.

Active

Returns: FolderParametersResponse. If the API code and folder are valid, IsSuccessful = true and Results contains one ParameterSetResult for each parameter. Check each result: IsSuccessful shows if that parameter was set, and Message contains an error or a warning. If the API code or folder is not valid, IsSuccessful = false and ErrorMessage contains the error.

Errors: Call-level errors (in ErrorMessage):

• Error: Invalid API Code
• Error: Folder could not be accessed

Parameter-level messages (in Results[n].Message):

• Warning: The Value passed was too long and was truncated to 100 characters. (with IsSuccessful = true)
• Error: BoolValue required for this parameter type.
• Error: DateValue required for this parameter type.
• Error: NumericValue required for this parameter type.
• Error: a valid EmailValue required for this parameter type.
• Error: could not parse XML.
• Error: Consolidated Signing not available for this account. If you would like this feature, please contact our sales or support team.
• Error: enablemousesignature is disabled for this portal.
• Error: You can't set the expiration date for a folder for more than 365 days from now. Set the expiration date for less than 365 days.
• Error: Security prompt cannot be longer than 200 characters.
• Error: Security answer cannot be longer than 50 characters.
• Error: {value} is not a supported language
• ERROR: "{emailGroupName}" email group is either not present or does not have any e-mail templates defined.

Parameter types:

Custom metadata XML (CustomMetadataXml, Value1): The service reads the XML in one of three formats. The service ignores an element with the name record (any case). Use it as the root element.

1. Attribute format. The first element after record is named field (exact case). Each element has these attributes:

xml <record> <field Name="ReservationType" Text="Group" /> </record>

2. Element-name format. The first element after record has any other name. The element name is the metadata name. The Text attribute is the value.

xml <record> <ReservationType Text="Group" /> </record>

3. Standard format. After an element with the name recordstandardxmlformat (any case), each child element name is the metadata name and the element text is the value.

xml <recordstandardxmlformat> <ReservationType>Group</ReservationType> </recordstandardxmlformat>

The service marks a metadata name that starts with SENS__ as sensitive. The service ignores items that do not have a valid name. If the XML is not valid, or Value1 is empty, the result is Error: could not parse XML. The service adds the new items to the existing metadata. It does not remove existing items.

Notes:

• The service saves all folder changes after it processes all parameters. A failed parameter does not stop the other parameters.
• MustSignWithName, SecurityQuestion, CustomMetadataXml and IdCheck with a UserEmail save their changes immediately.
• ParameterType is required. If you omit it, the service uses MaskEmailsFromClient, and a BoolValue then changes email masking for the folder.
• Dates in DateValue must be in a format that .NET DateTimeOffset can parse, for example ISO 8601 (2026-12-31T17:00:00-05:00). If the service cannot parse the date, the call fails with a SOAP fault. Changes from parameters that save immediately stay in effect. Other changes from the same call are lost.
• If UserEmail does not match a user for MustSignWithName or SecurityQuestion, the call fails with a SOAP fault.

NewPayment

Creates a payment or authorization request in a folder.

Active

Returns: PaymentResult. On success, IsSuccess = true and Payment contains the status of the new payment. On failure, IsSuccess = false and ErrorMessage contains the error.

Errors:

• Error: Invalid API Code
• Error: Payments are not enabled for this account.
• Error: Folder could not be accessed
• Error: Payment Gateway not configured.
• Error: Payment Gateway does not support selected payment recurrence.
• Error: Payment Operation is not enabled or supported for payment gateway.
• Error: Invalid 'billingcountry' parameter. Only two or three letter ISO 3661-1 codes are accepted.
• Error: payeremail is not a participant of given fileId.
• Error: Amount needs to be greater than 0
• Error: Amount needs to be 0
• Error: Refund amount needs to be greater than 0
• Error: Refunds need to be linked to a parent transaction
• Error: Payer required for refund transaction
• Error: Need to indicate who initiated the refund
• Error: Amount needs to be less than 1,000,000
• Error: Number of decimal places in the amount cannot be greater than 2
• Error: Number of decimal places in the CloneAmount cannot be greater than 2
• Error: Description cannot be blank
• Error: Either 'Use Automatic Rules' must be selected or payment methods must be selected
• Error: Could not save payment
• Error: {message} (other errors from the payment service)

Notes:

• The service returns only the first validation error.
• Operation = Pay: Amount must be more than 0. Operation = Verify (authorization): Amount must be 0.
• Operation = Refund always fails. This operation cannot link a refund to an existing payment.
• Amount must be less than 1,000,000 and have a maximum of 2 decimal places. Trailing zeros count as decimal places, so 10.000 fails. The same rule applies to CloneAmount.
• The service truncates Description and CloneDescription to 50 characters.
• If CloneAmount is 0 or less, the service ignores it.
• If the service cannot parse DatePaymentDue, it ignores the value and sets no due date.
• BillingCountry must be an ISO 3166-1 alpha-2 or alpha-3 code. The service stores and returns the country name that matches the code.
• PayerEmail must belong to a signer in the folder. A CC participant is not accepted. If no user exists for PayerEmail, the call fails with a SOAP fault.
• If AllowedPayMethods is omitted, the service allows all payment methods.
• Recurrence = Monthly requires a payment gateway that supports recurring payments.
• On success, the payment also appears in the action list of the folder.

GetPaymentStatus

Returns the status of one payment in a folder.

Active

Returns: PaymentResult. On success, IsSuccess = true and Payment contains the payment status. On failure, IsSuccess = false and ErrorMessage contains the error.

Errors:

• Error: Invalid API Code
• Error: Payments are not enabled for this account.
• Error: Folder could not be accessed
• Error: Payment request could not be accessed

Notes:

• The service does not return deleted payments.
• SurchargeAmount, SurchargePercent and GrossAmount have values only when Status = Approved. Refer to PaymentStatus in Data types.

GetAllPaymentStatusesForFolder

Returns the status of all payments in a folder.

Active

Returns: AllPaymentResults. On success, IsSuccess = true and Payments contains one PaymentStatus for each payment. The list is empty if the folder has no payments. On failure, IsSuccess = false and ErrorMessage contains the error.

Errors:

• Error: Invalid API Code
• Error: Payments are not enabled for this account.
• Error: Folder could not be accessed

Notes:

• The service does not return deleted payments.

FolderStatus

FolderSigner

DocumentStatus

Signature

CustomField

FolderParameter

FolderParametersResponse

ParameterSetResult

PaymentToCreate

PaymentResult

AllPaymentResults

PaymentStatus