Sertifi API Web Service
Functions as AddSigningLocation with a pint_FieldType of 1 (Full Name Text Box).
Request (AddSigningLocationSoapIn)

The request body is of type AddSigningLocation.

Request Body Parameters

NameDescriptionData Type
pstr_APICodeThe API code of the site.  This can be found through your Sertifi web interface under Administration -> Account Settings.xml:string
pstr_FileIDThe id of the relevant file.xml:string
pstr_DocumentIDThe id of the relevant document.xml:string
pint_PageThe page of the pdf to add the location.xml:int
pint_TopThe distance from the top of the page to the top edge of the signing location.xml:int
pint_LeftThe distance from the left side of the page to the left edge of the signing location.xml:int
pint_HeightPass '0'.  Unused, but still required.xml:int
pint_WidthPass '0'.  Unused, but still required.xml:int
pstr_SignerEmailThe email address of the signer who needs to sign in this location.xml:string
pstr_CaptionNot used.  Not required.xml:string
pstr_Caption Element pstr_SignerEmail Element pint_Width Element pint_Height Element pint_Left Element pint_Top Element pint_Page Element pstr_DocumentID Element pstr_FileID Element pstr_APICode Element Sequence AddSigningLocation Element
Response (AddSigningLocationSoapOut)

The response body is of type AddSigningLocationResponse.

Response Body Parameters

NameDescriptionData Type
AddSigningLocationResult"SUCCESS" or error message.xml:string
AddSigningLocationResult Element Sequence AddSigningLocationResponse Element
Common Errors include:
"ERROR: Invalid API Code"
"ERROR: Invalid page number."
"ERROR: Invalid top coordinates."
"ERROR: Invalid left coordinates."
"ERROR: Invalid signer email"
"ERROR: Invalid signer email: ..."
"ERROR: File could not be accessed"
"ERROR: Document could not be accessed"
"ERROR: Document Expired"
"ERROR: SignerEmail not valid"
"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"
See Also
All Operations Resource GroupSertifi API Web Service



© Sertifi, Inc., 2019 All Rights Reserved.

Send comments on this topic.