Sertifi API Web Service
Remove a user from a file.
Request (RemoveUserSoapIn)

The request body is of type RemoveUser.

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_EmailThe email of the signer who you wish to remove.xml:string
pstr_SignerType"signer" or it won't do anything.xml:string
pint_SequenceThe signer level to remove them from.  Between 1 and 24.xml:int
pint_Sequence Element pstr_SignerType Element pstr_Email Element pstr_FileID Element pstr_APICode Element Sequence RemoveUser Element
Response (RemoveUserSoapOut)

The response body is of type RemoveUserResponse.

Response Body Parameters

NameDescriptionData Type
RemoveUserResult"SUCCESS" or error message.xml:string
RemoveUserResult Element Sequence RemoveUserResponse Element
<soap:Envelope xmlns:soap="" xmlns:ser="">
         <ser:pstr_Email>[email protected]</ser:pstr_Email>
Common Errors include:
"ERROR: Invalid API Code"
"ERROR: File could not be accessed"
"ERROR: Invalid user email"
"ERROR: Invalid user email: ..."
"ERROR: Type does not exists"
"ERROR: Signing sequence is not within a valid range of 1 to 24"
"ERROR: User is not a participant of the room"
"ERROR: Folder contains documents. Last signer cannot be removed."
"ERROR: User has already signed documents at this signing level and cannot be removed"
See Also
All Operations Resource GroupSertifi API Web Service



© Sertifi, Inc., 2019 All Rights Reserved.

Send comments on this topic.