Account
Provides web services for managing user account information.
| API | Description |
|---|---|
| GET api/Account/UserInfo |
Allows the current user to get their own user info. |
| GET api/Account/GridSettings?route={route} |
Gets the user's grid settings defined by the specified URL-Encoded route. |
| POST api/Account/ChangePassword |
Allows the current user to change their password. |
| POST api/Account/ChangePasswordByUsername |
Allows the the user of the provided username to change their password. |
| POST api/Account/Logout |
Logs out the current user. |
| POST api/Account/GridSettings |
Saves the user's grid settings. |
| PUT api/Account/UpdateUser |
Allows a user to update the specified user. |
Client
Provides web services for managing clients.
| API | Description |
|---|---|
| DELETE api/ClientManagement/Clients/{clientId} |
Allows an organization admin to delete a client. |
| GET api/ClientManagement/Clients/Search?q={q}&organizationId={organizationId}&limit={limit}&offset={offset} |
Search for clients. |
| GET api/ClientManagement/Clients |
Allows a SAFEAdmin to get all clients, and allows an organization admin to get all clients associated associated with their organization. |
| GET api/ClientManagement/Clients/{clientId} |
Allows a client admin or an organization admin of the specified client to get the client. |
| GET api/ClientManagement/Clients/{clientId}/Users |
Allows a client admin or an organization admin of the specified client to get all users associated to the client. |
| GET api/ClientManagement/Clients/ActiveClientsWithSettings |
Gets the active clients with client smart registry settings. |
| GET api/ClientManagement/Clients/ActiveClients |
Gets the list of active clients. |
| GET api/ClientManagement/Clients/MERSInformation |
Gets the organization MERS information. |
| POST api/ClientManagement/Clients |
Allows an organization admin to create a new client, and allows a client admin to update their client. |
ClientMERSMembers
Provides web services for managing client MERS members
| API | Description |
|---|---|
| GET api/SmartRegistry/ClientMERSMembers |
Gets all MERS members associated to the client of the authenticated user. |
| GET api/SmartRegistry/ClientMERSMembers/Client/{clientId} |
Gets all MERS members associated to the client of the authenticated user. |
| GET api/SmartRegistry/ClientMERSMembers/Active |
Gets all active MERS members associated to the client of the authenticated user. |
| GET api/SmartRegistry/ClientMERSMembers/Active/{clientId} |
Gets all active MERS members associated to the client. |
| GET api/SmartRegistry/ClientMERSMembers/{clientMersMemberId} |
Gets a specific ClientMERSMember by the identifier. |
| POST api/SmartRegistry/ClientMERSMembers |
Saves the client MERS member. |
ClientToClientTransfer
Provides web services for client to client transfer functionality.
| API | Description |
|---|---|
| POST api/Documents/ClientToClientTransfer/Send |
Provides the ability to perform a client to client transfer using Document IDs. |
| POST api/Documents/ClientToClientTransfer/Send/Bulk |
Provides the ability to perform a client to client transfer using Document Names. |
ClientUser
Provides web services for managing client users.
| API | Description |
|---|---|
| DELETE api/ClientManagement/Users?userName={userName} |
Delete the specified user by username. |
| DELETE api/ClientManagement/Users?userId={userId} |
Delete the specified user by user identifier. |
| GET api/ClientManagement/Users?userName={userName} |
Allows a client admin or an org admin of the client to get the specified user. |
| GET api/ClientManagement/Users?userId={userId} |
Gets a user mathing the user identifier supplied. |
| POST api/ClientManagement/Users/Search |
Allows a client admin or an organization admin of the client to search the client's users. |
| POST api/ClientManagement/Users/Create |
Allows a client admin or an organization admin of the client to create a new user for the client. |
| POST api/ClientManagement/Users/Save |
Allows a client admin or an organization admin of the client to update the specified user. |
| POST api/ClientManagement/Users/ResetPassword |
Allows a client admin reset the specified user's password. |
Documents
Provides web services to manage documents.
| API | Description |
|---|---|
| DELETE api/Documents/{documentId} |
Allows a client admin to delete the specified document. |
| DELETE api/Documents/Linked?documentId={documentId} |
Unlinks the document from the parent document. |
| GET api/Documents/{documentId} |
Allows a client admin or a SigningRoom admin to get the specified document. |
| GET api/Documents/{documentId}/Download?smartDocumentAsPDF={smartDocumentAsPDF}&includeLinkedDocuments={includeLinkedDocuments}&includeAuditCertificate={includeAuditCertificate} |
Allows a client admin, a SigningRoom admin, or a participant to download the specified document. |
| GET api/Documents/{documentId}/PageImage/{pageNumber} |
Allows a client admin, a SigningRoom admin, or a participant to get the page image of the specified document and page. |
| GET api/Documents/{documentId}/AuditCertificate |
Allows a client admin or a SigningRoom admin to get the audit certificate of a signed document. |
| GET api/Documents/{documentId}/SmartDocument |
Gets all information for the SmartDocument. |
| GET api/Documents/{documentId}/SmartDocument/ExternalReferences?filename={filename} |
Gets the SmartDocument External Reference file |
| GET api/Documents/{documentId}/SmartDocument/Presentation |
Gets the SmartDocument Presentation. |
| GET api/Documents/{documentId}/SmartDocument/Xml |
Gets the SmartDocument xml. |
| GET api/Documents/{documentId}/SmartDocument/TransactionSummary |
Gets the SmartDocument transaction summary. |
| GET api/Documents/{documentId}/Borrowers |
Gets the borrowers for the specified document. |
| GET api/Documents/{documentId}/Linked |
Gets the linked documents for the provided document identifier. |
| POST api/Documents/Search |
Allows an organization admin to search for documents associated to the org, and allows client admins and client users to search for document associated to their client. |
| POST api/Documents/SearchEVault |
Allows an organization admin to search for eVault items associated to the org, and allows client admins and client users to search for eVault items associated to their client. |
| POST api/Documents |
Allows a client admin or a SigningRoom admin to save the document information. |
| POST api/Documents/DownloadAsZip |
Downloads multiple files into a zip. |
| POST api/Documents/Upload |
Allows a client admin to upload a document. |
| POST api/Documents/UploadSmartDocument |
Allows a client admin to upload a SmartDocument. |
| POST api/Documents/Borrowers |
Saves the given borrowers. |
| POST api/Documents/Delete |
Deletes the documents. |
| POST api/Documents/Linked/Children |
Gets the linked child documents for the provided document identifiers. |
| POST api/Documents/Linked |
Links multiple documents to a parent document. |
| POST api/Documents/Archive?includeLinkedDocuments={includeLinkedDocuments} |
Archive the documents with the specified identifiers. |
| POST api/Documents/Activate |
Activate the documents with the specified identifiers. |
| PUT api/Documents/{documentId}/Move/{destinationFolderId} |
Moves the document to the destination provided. |
EventSubscription
Provides web services for managing event subscriptions.
| API | Description |
|---|---|
| GET api/Configuration/EventSubscriptions |
Allows a user to get the event subscriptions for the client they are associated to. |
| GET api/Configuration/EventSubscriptions/Client/{clientId} |
Allows a user to get the event subscriptions for the client they specify. |
| GET api/Configuration/EventSubscriptions/{eventSubscriptionId} |
Allows a user to get a specified event subscription for their client. |
| POST api/Configuration/EventSubscriptions |
Allows a user to create a new event subscription for their client. |
ExceptionLog
Provides web services for managing exception logs.
| API | Description |
|---|---|
| GET api/Admin/ExceptionLog/{exceptionLogId} |
Allows a SAFEAdmin to get the specified exception log. |
| POST api/Admin/ExceptionLog/Search |
Allows a SAFEAdmin to search the exception logs. |
| POST api/Admin/ExceptionLog |
Creates a new exception log. |
Folder
Provides web services to manage folders.
HealthCheck
Provides web services for checking db health status.
| API | Description |
|---|---|
| GET api/HealthCheck/Status |
Checks the database connectivity by making db call. |
LockedDocuments
Provides web services for managing locked documents.
| API | Description |
|---|---|
| DELETE api/Admin/LockedDocuments/{documentId} |
Allows a SAFEAdmin to unlock a document. |
| GET api/Admin/LockedDocuments |
Allows a SAFEAdmin to search the locked documents. |
Lookups
Provides web services for managing lookups.
| API | Description |
|---|---|
| GET api/Configuration/DocumentTypes/{clientId}/Active |
Allows a user to get a list of active document types for the client id specified. |
| GET api/Configuration/DocumentTypes/{clientId} |
Allows a user to get active and inactive document types for the client id specified. |
| GET api/Configuration/EventTypes |
Allows a user to get all existing event types. |
| GET api/Configuration/SigningRoomActivityTypes |
Allows a user to get all existing SigningRoom activity types. |
| GET api/Configuration/SignatureFonts |
Gets the list of signature fonts. |
| GET api/Configuration/SigningRoomActionTypes |
Allows a user to get all existing SigningRoom action types. |
| GET api/Configuration/EVaultActivityTypes |
Allows a user to get all existing eVault activity types. |
| GET api/Configuration/ClientToClientTransferStatusTypes |
Allows a user to get all existing Client To Client Transfer Status Types. |
| GET api/Configuration/ParticipantRoleTypes |
Gets the list of participant role types. |
| POST api/Configuration/DocumentTypes |
Allows a client admin to update a document type associated with the client. |
Notification
Provides web services for managing Notifications.
Organization
Provides web services for managing organizations.
| API | Description |
|---|---|
| DELETE api/OrganizationManagement/Organizations/{organizationId} |
Allows a SAFEAdmin to delete a specified organization. |
| GET api/OrganizationManagement/Organizations/Search?q={q}&limit={limit}&offset={offset} |
Allows a SAFEAdmin to search for organizations. |
| GET api/OrganizationManagement/Organizations |
Allows a SAFEAdmin to get all organizations. |
| GET api/OrganizationManagement/Organizations/active |
Allows the user to get all active organizations. |
| GET api/OrganizationManagement/Organizations/{id}/Clients |
Get all clients for a specific organization. |
| GET api/OrganizationManagement/Organizations/{id}/Clients/Active |
Get all active clients for a specific organization. |
| GET api/OrganizationManagement/Organizations/{organizationId} |
Allows a SAFEAdmin to get a specific organization, and allows an organization admin to get their organization. |
| GET api/OrganizationManagement/Organizations/MERSInformation |
Gets the client MERS information for all of the clients in the Safe. |
| POST api/OrganizationManagement/Organizations/Create |
Allows a SAFEAdmin to create a new organization. |
| POST api/OrganizationManagement/Organizations/Save |
Allows a SAFEAdmin to update a specified organization, and allows an organization admin to update their organization. |
OrganizationUser
Provides web services for managing organization user admins.
| API | Description |
|---|---|
| DELETE api/organizationmanagement/user?userName={userName} |
Allows an organization admin to delete the specified user by username. |
| DELETE api/organizationmanagement/user?userId={userId} |
Allows an organization admin to delete the specified user by username. |
| DELETE api/organizationmanagement/user/{userId}/ClientAssignments/{clientId} |
Removes a client assignment. |
| GET api/organizationmanagement/user?userName={userName} |
Gets a user mathing the user name supplied. |
| GET api/organizationmanagement/user?userId={userId} |
Gets a user mathing the user identifier supplied. |
| POST api/organizationmanagement/user/Admins |
Gets all organization admins for current user. |
| POST api/organizationmanagement/user/Search |
Gets all organization users for current user. |
| POST api/organizationmanagement/user/Create |
Creates a new user assigned to the Organization Admin Role |
| POST api/organizationmanagement/user |
Allows an organization admin to update the specified user. |
| POST api/organizationmanagement/user/ClientAssignments |
Adds user client assignments. |
| POST api/organizationmanagement/user/ResetPassword |
Allows an organization admin reset the specified user's password. |
Permission
Provides web services for managing permissions.
| API | Description |
|---|---|
| DELETE api/Permissions?permissionAssignmentId={permissionAssignmentId} |
Removes the permission assignment from the users. |
| GET api/Permissions |
Gets all permissions. |
| GET api/Permissions/{permissionId} |
Gets the permission. |
| GET api/Permissions/{permissionId}/Assignments?pageSize={pageSize}&pageOffset={pageOffset} |
Gets the permission assignments for the permission. |
| GET api/Permissions/{userId}/Permissions |
Gets the permissions for a user. |
| GET api/Permissions/Categories |
Gets the permission categories. |
| POST api/Permissions/{userId}/{permissionId} |
Assigns the permission to the user. |
| POST api/Permissions/{userId}?permissionIdsList={permissionIdsList} |
Assigns the permissions to the user. |
| POST api/Permissions/{permissionId}/Assignments |
Assigns the permission to the users. |
Report
Provides web services for getting reports.
| API | Description |
|---|---|
| DELETE api/Reports/SearchCriteria/{userReportSearchCriteriaId} |
Deletes the specified UserReportSearchaCriteria. |
| GET api/Reports/EventNotification/{eventId} |
Allows a user to get an event that they have access to. |
| GET api/Reports/WebServiceLog/{webServiceLogId} |
Allows a SAFEAdmin to get a web service log. |
| GET api/Reports/SearchCriteria?route={route} |
Gets a list of user report search criteria for the report defined by the specified URL-Encoded route. |
| GET api/Reports/SigningRoomMetrics |
Gets the metrics of the signing rooms for the current client. |
| GET api/Reports/OrganizationMetrics/{organizationId} |
Gets the metrics of an organization. |
| GET api/Reports/LastAccessedFolders/{numberOfFolders} |
Gets specified number of folders that were last accessed by the user. |
| GET api/Reports/MostAccessedFolders/{numberOfFolders} |
Gets specified number of folders that were most accessed by the user. |
| GET api/Reports/LastCreatedClients/{numberOfClients} |
Gets information on the last created clients. |
| GET api/Reports/LastCreatedFolders/{numberOfFolders} |
Gets specified number of folders that were last created. |
| GET api/Reports/ClientToClientTransferResult/{clientToClientTransferLogId} |
Gets the client to client transfer log results for the identifier provided. |
| GET api/Reports/ARCValidationErrorLog/{arcValidationErrorLogId}/ErrorMessages |
Gets the ARC validation error messages. |
| POST api/Reports/EventNotification |
Allows a user to search for any event notifications that they have access to. |
| POST api/Reports/SigningRoomActivityLogSearch |
Allows a user to search for SigningRoom activity logs for any SigningRooms that they have access to. |
| POST api/Reports/LoginActivityLogSearch |
Allows a user to search for login activity logs. |
| POST api/Reports/MonthlyBilling |
Allows a SAFEAdmin to get the monthly billing reports for all organization in a specified time period. Allows an organization admin to get the monthly billing report for its organization. Allows a client admin to ge the monthly billing reports for its client. |
| POST api/Reports/WebServiceLog |
Allows a SAFEAdmin to search for web service logs. |
| POST api/Reports/SearchCriteria |
Searches the web service logs given the supplied search parameters |
| POST api/Reports/ChangePasswordLogSearch |
Allows a user to search for change password logs. |
| POST api/Reports/EVaultActivityLogSearch |
Allows a user to search for eVault activity logs. |
| POST api/Reports/ClientToClientTransferLogSearch |
Allows a user to search for client to client transfer logs. |
| POST api/Reports/ARCValidationErrorLogSearch |
Allows a user to search for ARC validation error logs. |
| POST api/Reports/ARCValidationErrorLog |
Creates an ARC validation error log. |
SessionManagement
Provides web services for managing user sessions.
| API | Description |
|---|---|
| DELETE api/Admin/UserSessions/{sessionId} |
Revokes the refresh token for the supplied session id. |
| POST api/Admin/UserSessions/Search |
Searches the user sessions based on the specified criteria. |
SmartRegistry
Provides web services for eRegistry functionality.
| API | Description |
|---|---|
| GET api/SmartRegistry/DocumentValidationFailure/{validationFailureId}/ErrorMessages |
Gets the validation error messages. |
| GET api/SmartRegistry/eNote/Batch/{eRegistryBatchId} |
Gets the eRegistry batch. |
| POST api/SmartRegistry/eNote/Inquiry |
Provides the ability to do an eNote inquiry. |
| POST api/SmartRegistry/eNote/Search |
Provides the ability to search for eNotes. |
| POST api/SmartRegistry/eNote/SearchByMINs |
Provides the ability to search for eNotes by multiple MINs. |
| POST api/SmartRegistry/SmartDocument/Search |
Provides the ability to search for smart documents. |
| POST api/SmartRegistry/eNote/Register |
Provides the ability to register eNotes. |
| POST api/SmartRegistry/eNote/Transfer |
Provides the ability to transfer eNotes. |
| POST api/SmartRegistry/eNote/Transfer/Bulk |
Provides the ability to transfer multiple eNotes. |
| POST api/SmartRegistry/eNote/ChangeData/ssn |
Provides the ability to update the ssn for eNotes. |
| POST api/SmartRegistry/eNote/ChangeData/ssn/Batch |
Provides the ability to update the ssn for eNotes. |
| POST api/SmartRegistry/eNote/ChangeData/VaultId |
Provides the ability to update the vault ids for eNotes. |
| POST api/SmartRegistry/eNote/ChangeData/Servicer |
Provides the ability to update the servicer for eNotes. |
| POST api/SmartRegistry/eNote/ChangeData/Delegatee |
Provides the ability to update the delegatee for eNotes. |
| POST api/SmartRegistry/eNote/ChangeData/Location |
Provides the ability to update the location for eNotes. |
| POST api/SmartRegistry/eNote/ChangeData/SecuredParty |
Update the secured party for an eNote. |
| POST api/SmartRegistry/eNote/ChangeData/SecuredPartyDelegatee |
Update the secured party delegatee for an eNote. |
| POST api/SmartRegistry/eNote/ChangeData/LoanData |
Provides the ability to update the loan data for eNotes. |
| POST api/SmartRegistry/eNote/ChangeData/LoanData/Batch |
Provides the ability to update the loan data for eNotes. |
| POST api/SmartRegistry/eNote/ChangeData/PresentNote |
Provides the ability to present eNotes. |
| POST api/SmartRegistry/eNote/ChangeData/PresentNote/Batch |
Provides the ability to present eNotes. |
| POST api/SmartRegistry/eNote/Transfer/Pending |
Gets the list of pending transfers. |
| POST api/SmartRegistry/eNote/Transfer/Cancel |
Provides the ability to cancel pending transfer for eNotes. |
| POST api/SmartRegistry/eNote/ChangeData/Modification |
Provides the ability to manage the modification request. |
| POST api/SmartRegistry/eNote/ChangeData/Modification/Batch |
Provides the ability to manage the modification request. |
| POST api/SmartRegistry/eNote/ChangeData/Assumption |
Provides the ability to assume a loan. |
| POST api/SmartRegistry/eNote/ChangeData/Assumption/Batch |
Provides the ability to assume a loan. |
| POST api/SmartRegistry/eNote/ChangeData/AddDocument |
Provides the ability to manage the add document request. |
| POST api/SmartRegistry/eNote/ChangeStatus |
Provides the ability to manage the change status request. |
| POST api/SmartRegistry/eNote/ChangeStatus/Batch |
Provides the ability to manage the change status request batch. |
| POST api/SmartRegistry/enote/eDelivery |
Sends an eDelivery request to MERS. |
| POST api/SmartRegistry/enote/eDelivery/Batch |
Sends an eDelivery request to MERS. |
| POST api/SmartRegistry/enote/eDelivery/bulk |
Provides the ability to eDeliver multiple eNotes. |
SmartRegistryLookups
Returns the lookup values used by eRegistry transactions.
SmartRegistryReport
Provides web services for getting eRegistry reports.
| API | Description |
|---|---|
| GET api/SmartRegistry/Reports/eDelivery/{trackingNumber}/Documents/{clientId} |
Gets the list of eDelivery documents based on tracking number. |
| GET api/SmartRegistry/Reports/eDelivery/{trackingNumber}/DistributionApproval/{clientId} |
Gets the list of distribution approval results based on the tracking number. |
| GET api/SmartRegistry/Reports/eDelivery/{trackingNumber}/DistributionApproval/{recipientMERSOrgId}/{clientId} |
Gets the list of distribution approval results based on the tracking number. |
| GET api/SmartRegistry/Reports/notificationlogs/{id} |
Gets the Notification log wih the supplied notification log id. |
| GET api/SmartRegistry/Reports/RequestLogs/{id} |
Gets the request log wih the supplied request log id. |
| POST api/SmartRegistry/Reports/eNoteRegistrationRequests |
Performs an eNote registration request search based on the search criteria. |
| POST api/SmartRegistry/Reports/eNoteTransferRequests |
Performs an eNote transfer request search based on the search criteria. |
| POST api/SmartRegistry/Reports/eNoteTransferRequests/Download |
Download a file of eNote transfer requests based on the search criteria. |
| POST api/SmartRegistry/Reports/eRegistryNotifications |
Provides the ability to search for eRegistry notifications. |
| POST api/SmartRegistry/Reports/eDelivery |
Performs an eDelivery Request search based on the search criteria. |
| POST api/SmartRegistry/Reports/eRegistryTransactions |
Performs an eRegistry transaction search based on the search criteria. |
| POST api/SmartRegistry/Reports/notificationlogs |
Performs a notification log search based on the search criteria. |
| POST api/SmartRegistry/Reports/RequestLogs |
Performs a request log search based on the search criteria. |
| POST api/SmartRegistry/Reports/ENoteInventory |
Gets the eNote inventory report data. |
| POST api/SmartRegistry/Reports/Batch |
Gets a list of eRegistry batch DTOs based on the search criteria. |
SmartRegistrySettings
Provides web services for managing SmartREGISTRY settings.
| API | Description |
|---|---|
| GET api/SmartRegistry/MERSRegistrationMethods |
Gets the MERS Registration Methods. |
| GET api/SmartRegistry/MERSRegistrationTypes |
Gets the MERS Registration Types. |
| GET api/SmartRegistry/Settings |
Gets the settings based on the settings identifier. |
| GET api/SmartRegistry/ClientSettings |
Gets the settings for the client. |
| GET api/SmartRegistry/ClientSettings/{clientId} |
Gets the settings for the client. |
| GET api/SmartRegistry/Connectivity |
Sends a connectivity request to MERS. |
| GET api/SmartRegistry/Connectivity/{clientId} |
Sends a connectivity request to MERS using the provided client's settings. |
| POST api/SmartRegistry/Settings |
Saves the registry settings. |
| POST api/SmartRegistry/ClientSettings |
Saves the settings. |
SmartSafeSettings
Provides web services for managing smart safe settings.
| API | Description |
|---|---|
| GET api/Configuration/SmartSafeSettings |
Gets the smart safe settings based on the current user. |
| GET api/Configuration/SmartSafeSettings/{clientId} |
Gets the smart safe settings by client id. |
| POST api/Configuration/SmartSafeSettings |
Saves the Smart Safe Settings entity. |
UserManagement
Provides web services for user management for a SAFEAdmin.
| API | Description |
|---|---|
| DELETE api/Admin/UserManagement/DeleteUser?userName={userName} |
Delete the specified user by username. |
| DELETE api/Admin/UserManagement/DeleteUser?userId={userId} |
Delete the specified user by user identifier. |
| GET api/Admin/UserManagement/UserExists?userName={userName} |
Allows a SAFEAdmin to check if a user with the specified user name already exists. |
| GET api/Admin/UserManagement/GetUser?userName={userName} |
Allows a SAFEAdmin to get the specified user by username. |
| GET api/Admin/UserManagement/GetUser?userId={userId} |
get the specified user by the user identifier. |
| GET api/Admin/UserManagement/Admins |
Allows a SAFEAdmin to get a list of all other SAFEAdmins. |
| GET api/Admin/UserManagement/UserManagers |
Allows a SAFEAdmin to get a list of all users with the UserManagers role. |
| POST api/Admin/UserManagement/SearchUsers |
Allows a SAFEAdmin to search for users. |
| POST api/Admin/UserManagement/Admins |
Allows a SAFEAdmin to create a new user who is also a SAFEAdmin. |
| POST api/Admin/UserManagement/SaveUser |
Allows a SAFEAdmin to update the specified user. |
| POST api/Admin/UserManagement/ResetPassword |
Allows a SAFEAdmin, an organization admin, or a client admin to reset the specified user's password. |
| POST api/Admin/UserManagement/UserManagers |
Allows a SAFEAdmin to create a new user who has the UserManagers role. |
| POST api/Admin/UserManagement/{userId}/Unlock |
Unlocks the user account. |