← FlexAPI Documentation / API Calls / UpdateNotaryProfile
The UpdateNotaryProfile method lets your integration create, update or delete a user's eNotary profile (commission data and seal image) without that user completing the profile in the SIGNiX interface. A single Action element selects the operation. Available in SIGNiX release 185.
Client in CustInfo). You cannot target users outside your account.Demo. It belongs only on SubmitDocument. Use the same CustInfo credentials as other requests (Sponsor, Client, UserId, Pswd, and optional Workgroup).admin:account scope (account administration).Action, a target user and Reason. The target is UserId and/or Email.Seal to keep the existing seal.An annotated example of the request XML follows. It shows a Create request. The profile fields sit under Data, and the Action element selects Create, Update or Delete.
Target user. Specify UserId and/or Email for the notary. At least one is required.
Email is provided and several open identities share that email, you must also supply UserId.Seal. The Seal element holds the raw Base64 of the image bytes, not a file path. It can also be a data:image/...;base64,... URL. The image must be PNG or JPEG, and the decoded size must be within the same limit as the Document Dashboard eNotary UI (approximately 500 KB).
<?xml version="1.0" ?>
<UpdateNotaryProfileRq xmlns="urn:com:signix:schema:sdddc-1-1">
<CustInfo> <!-- Occurs once only -->
<!-- Assigned by SIGNiX when the Client is set up. All case sensitive. -->
<Sponsor>YOUR_SPONSOR</Sponsor>
<Client>YOUR_CLIENT</Client>
<UserId>YOUR_USER</UserId>
<Pswd>YOUR_PASSWORD</Pswd>
<!-- Optional. Only if SIGNiX assigned a Workgroup to your account. -->
<Workgroup>YOUR_WORKGROUP</Workgroup>
</CustInfo>
<Data> <!-- Occurs once only -->
<!-- Required. The operation: Create, Update or Delete. -->
<Action>Create</Action>
<!-- The notary to act on. At least one of UserId and Email is required. If both are sent,
they must refer to the same user. If only Email is sent and several open identities
share it, UserId is required too. The user must already exist in SIGNiX with at least
one role under your client. -->
<UserId>YOUR_NOTARY_USER_ID</UserId>
<Email>YOUR_NOTARY_EMAIL</Email>
<!-- Required. Free text recorded in the audit event. Max length 255. -->
<Reason>Initial profile supplied by integration</Reason>
<!-- Required on Create and Update. US or CA state or province code. -->
<NotaryState>TN</NotaryState>
<!-- Optional. May be blank where the state issues no commission ID. Max length 100. -->
<NotaryCommission>YOUR_COMMISSION_NUMBER</NotaryCommission>
<!-- Optional. MM/DD/YYYY. Blank is allowed. If present, it must be a future date. -->
<NotaryExpiration>12/31/2099</NotaryExpiration>
<!-- Required on Create and Update. yes or no: whether the eNotary performs real estate
transactions. -->
<DoesRealEstate>yes</DoesRealEstate>
<!-- Optional. image/png or image/jpeg. Can be inferred from a data: URL in Seal. -->
<SealMimeType>image/png</SealMimeType>
<!-- Required on Create. Base64 of the PNG or JPEG image bytes, or a data:image/...;base64,...
URL. On Update, omit it to keep the existing seal. -->
<Seal>BASE64_PNG</Seal>
</Data>
</UpdateNotaryProfileRq>
✓ = required, ○ = optional, — = not used for that action.
| Element | Create | Update | Delete | Notes |
|---|---|---|---|---|
Action | ✓ | ✓ | ✓ | Create, Update or Delete |
UserId | ○ | ○ | ○ | Required if Email is omitted |
Email | ○ | ○ | ○ | Required if UserId is omitted |
Reason | ✓ | ✓ | ✓ | Free text, max 255 characters (recorded in the audit event) |
NotaryState | ✓ | ✓ | — | US or CA state or province code |
NotaryCommission | ○ | ○ | — | May be blank where the state has no ID. Max 100 characters |
NotaryExpiration | ○ | ○ | — | MM/DD/YYYY. Blank is allowed. If present, it must be a future date |
DoesRealEstate | ✓ | ✓ | — | yes or no: "eNotary Performs Real Estate Transactions" |
SealMimeType | ○ | ○ | — | image/png or image/jpeg (may be inferred from a data-URL Seal) |
Seal | ✓ | ○ | — | Base64 image, or data:image/...;base64,.... Required on Create. On Update, omit it to keep the existing seal |
Seal limits. PNG or JPEG. The decoded image size must be within the same limit as the Document Dashboard eNotary UI (approximately 500 KB file size).
Delete. Send only Action, the target (UserId and/or Email) and Reason. Do not send profile or seal fields.
The Create request is shown above. These fragments show only the Data element of the request; the rest of the request is identical.
Omit Seal and SealMimeType to keep the existing seal. The response reports SealReplaced as no.
<Data>
<Action>Update</Action>
<!-- Target by Email, UserId, or both. -->
<Email>YOUR_NOTARY_EMAIL</Email>
<Reason>Commission renewed</Reason>
<NotaryState>TN</NotaryState>
<NotaryCommission>YOUR_COMMISSION_NUMBER</NotaryCommission>
<NotaryExpiration>12/31/2099</NotaryExpiration>
<DoesRealEstate>yes</DoesRealEstate>
<!-- Seal and SealMimeType omitted: the existing seal is kept. -->
</Data>
Send only Action, the target and Reason. The response omits SealReplaced.
<Data>
<Action>Delete</Action>
<Email>YOUR_NOTARY_EMAIL</Email>
<Reason>Profile removed per offboarding</Reason>
</Data>
Reason.SealReplaced tells you whether a new seal was stored.An annotated example of the response XML follows. See Status Codes on the main API page for the possible values and meanings of the StatusCode and StatusDesc elements.
Handle the response in this order:
StatusCode is 0 before reading anything else.Data echoes the operation. The response does not return the seal image bytes.StatusCode comes with a StatusDesc message, for example a missing required field, Use Notary turned off, a user not under your client, or a profile that already exists on Create.<?xml version="1.0" ?>
<UpdateNotaryProfileRs xmlns="urn:com:signix:schema:sdddc-1-1">
<Status> <!-- Occurs once only -->
<StatusCode>0</StatusCode> <!-- One of the numeric SC_* values -->
<StatusDesc>Success</StatusDesc> <!-- Human-readable version of StatusCode -->
</Status>
<Data> <!-- Optional. Occurs when Status.StatusCode is 0. -->
<!-- Echo of the operation: Create, Update or Delete. -->
<Action>Create</Action>
<!-- The resolved target user ID. -->
<UserId>YOUR_NOTARY_USER_ID</UserId>
<!-- The target email, when available. -->
<Email>YOUR_NOTARY_EMAIL</Email>
<!-- yes or no. Create and Update only: yes when a new seal was stored. The seal image is
never returned. -->
<SealReplaced>yes</SealReplaced>
</Data>
</UpdateNotaryProfileRs>
1110 Market Street, Suite 402
Chattanooga, TN 37402
877.890.5350
info@SIGNiX.com
©2016 SIGNiX. All Rights Reserved.