POST api/Documents/UploadSmartDocument

Allows a client admin to upload a SmartDocument.

Request Information

URI Parameters

None.

Body Parameters

The upload SmartDocument data.

ESignSystems.SmartSAFE.Models.SmartDocuments.SmartDocumentFileUploadModel

Name	Description	Type	Additional information
SmartDocumentBorrowers	Gets or sets a list of smart documents.	Collection of ESignSystems.SmartSAFE.Models.SigningRoomManager.UploadBorrowerModel	None.
SmartDocumentRegistrationSettings	Gets or sets the smart document registration settings information.	ESignSystems.SmartSAFE.Models.SmartDocuments.SmartDocumentRegistrationSettingsModel	None.
DocumentName	Gets or sets the name of the document being uploaded.	string	Max length: 256
FileName	Gets or sets the file name of the document being uploaded.	string	Max length: 256
ClientId	Gets or sets the ID of the client uploading the file.	integer	None.
FolderId	Gets or sets the folder identifier.	integer	None.
DocumentTypeId	Gets or sets the document's document type identifier.	integer	None.
UDF1	Gets or sets the first User Defined Field identifying the document.	string	Max length: 256
UDF2	Gets or sets the second User Defined Field identifying the document.	string	Max length: 256
UDF3	Gets or sets the third User Defined Field identifying the document.	string	Max length: 256
File	Gets or sets a byte array represting the file being uploaded.	Collection of byte	Required
PrintAndSign	Gets or sets the print and sign flag.	boolean	None.
ENotary	Gets or sets the eNotary flag.	boolean	None.
TransferableRecord	Gets or sets the transferable record flag.	boolean	None.
AuthoritativeCopy	Gets or sets the authoritative copy flag.	boolean	None.
ValidateSignature	Gets or sets a value indicating whether the document's tamper evident signature will be validated.	boolean	None.
ParentDocumentId	Gets or sets the parent document identifier.	integer	None.
Description	Gets or sets the description.	string	Max length: 500

Request Formats

application/json, text/json

Sample:

{
  "SmartDocumentBorrowers": [
    {
      "SSN": "sample string 1",
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4",
      "NameSuffix": "sample string 5",
      "DocumentName": "sample string 6",
      "FullName": "sample string 2 sample string 3 sample string 4 sample string 5"
    },
    {
      "SSN": "sample string 1",
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4",
      "NameSuffix": "sample string 5",
      "DocumentName": "sample string 6",
      "FullName": "sample string 2 sample string 3 sample string 4 sample string 5"
    }
  ],
  "SmartDocumentRegistrationSettings": {
    "SmartDocumentRegistrationSettingsId": 1,
    "RegistrationMethodId": 1,
    "RegistrationTypeId": 1,
    "ServicerMERSOrgId": "sample string 1",
    "ControllerMERSOrgId": "sample string 2",
    "LocationMERSOrgId": "sample string 3",
    "DelegateeForTransferMERSOrgId": "sample string 4",
    "SecuredPartyMERSOrgId": "sample string 5",
    "SecuredPartyDelegateeMERSOrgId": "sample string 6"
  },
  "DocumentName": "sample string 1",
  "FileName": "sample string 2",
  "ClientId": 1,
  "FolderId": 1,
  "DocumentTypeId": 1,
  "UDF1": "sample string 3",
  "UDF2": "sample string 4",
  "UDF3": "sample string 5",
  "File": "QEA=",
  "PrintAndSign": true,
  "ENotary": true,
  "TransferableRecord": true,
  "AuthoritativeCopy": true,
  "ValidateSignature": true,
  "ParentDocumentId": 1,
  "Description": "sample string 11"
}

application/xml, text/xml

Sample:

<SmartDocumentFileUploadModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartDocuments">
  <AuthoritativeCopy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">true</AuthoritativeCopy>
  <ClientId xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">1</ClientId>
  <Description xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">sample string 11</Description>
  <DocumentName xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">sample string 1</DocumentName>
  <DocumentTypeId xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">1</DocumentTypeId>
  <ENotary xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">true</ENotary>
  <File xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">QEA=</File>
  <FileName xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">sample string 2</FileName>
  <FolderId xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">1</FolderId>
  <ParentDocumentId xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">1</ParentDocumentId>
  <PrintAndSign xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">true</PrintAndSign>
  <TransferableRecord xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">true</TransferableRecord>
  <UDF1 xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">sample string 3</UDF1>
  <UDF2 xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">sample string 4</UDF2>
  <UDF3 xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">sample string 5</UDF3>
  <ValidateSignature xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">true</ValidateSignature>
  <SmartDocumentBorrowers xmlns:d2p1="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">
    <d2p1:UploadBorrowerModel>
      <d2p1:DocumentName>sample string 6</d2p1:DocumentName>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 4</d2p1:LastName>
      <d2p1:MiddleName>sample string 3</d2p1:MiddleName>
      <d2p1:NameSuffix>sample string 5</d2p1:NameSuffix>
      <d2p1:SSN>sample string 1</d2p1:SSN>
    </d2p1:UploadBorrowerModel>
    <d2p1:UploadBorrowerModel>
      <d2p1:DocumentName>sample string 6</d2p1:DocumentName>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 4</d2p1:LastName>
      <d2p1:MiddleName>sample string 3</d2p1:MiddleName>
      <d2p1:NameSuffix>sample string 5</d2p1:NameSuffix>
      <d2p1:SSN>sample string 1</d2p1:SSN>
    </d2p1:UploadBorrowerModel>
  </SmartDocumentBorrowers>
  <SmartDocumentRegistrationSettings>
    <ControllerMERSOrgId>sample string 2</ControllerMERSOrgId>
    <DelegateeForTransferMERSOrgId>sample string 4</DelegateeForTransferMERSOrgId>
    <LocationMERSOrgId>sample string 3</LocationMERSOrgId>
    <RegistrationMethodId>1</RegistrationMethodId>
    <RegistrationTypeId>1</RegistrationTypeId>
    <SecuredPartyDelegateeMERSOrgId>sample string 6</SecuredPartyDelegateeMERSOrgId>
    <SecuredPartyMERSOrgId>sample string 5</SecuredPartyMERSOrgId>
    <ServicerMERSOrgId>sample string 1</ServicerMERSOrgId>
    <SmartDocumentRegistrationSettingsId>1</SmartDocumentRegistrationSettingsId>
  </SmartDocumentRegistrationSettings>
</SmartDocumentFileUploadModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ESignSystems.SmartSAFE.Models.SmartDocuments.SmartDocumentUploadResult

Name	Description	Type	Additional information
DocumentId	Gets or sets the document id.	integer	None.
MIN	Gets or sets the MIN.	string	None.
AutoRegistered	Gets or sets a value indicating whether an attempt was made to auto register the Smart Doc with the eRegistry service.	boolean	None.
RegistrationSuccessful	Gets or sets a value indicating whether the Smart Doc was successfully auto registered.	boolean	None.
RegistrationErrorMessage	Gets or sets the registration error message if auto register failed.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DocumentId": 1,
    "MIN": "sample string 1",
    "AutoRegistered": true,
    "RegistrationSuccessful": true,
    "RegistrationErrorMessage": "sample string 3"
  },
  {
    "DocumentId": 1,
    "MIN": "sample string 1",
    "AutoRegistered": true,
    "RegistrationSuccessful": true,
    "RegistrationErrorMessage": "sample string 3"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSmartDocumentUploadResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartDocuments">
  <SmartDocumentUploadResult>
    <AutoRegistered>true</AutoRegistered>
    <DocumentId>1</DocumentId>
    <MIN>sample string 1</MIN>
    <RegistrationErrorMessage>sample string 3</RegistrationErrorMessage>
    <RegistrationSuccessful>true</RegistrationSuccessful>
  </SmartDocumentUploadResult>
  <SmartDocumentUploadResult>
    <AutoRegistered>true</AutoRegistered>
    <DocumentId>1</DocumentId>
    <MIN>sample string 1</MIN>
    <RegistrationErrorMessage>sample string 3</RegistrationErrorMessage>
    <RegistrationSuccessful>true</RegistrationSuccessful>
  </SmartDocumentUploadResult>
</ArrayOfSmartDocumentUploadResult>