POST api/SmartRegistry/eNote/Transfer
Provides the ability to transfer eNotes.
Request Information
URI Parameters
None.
Body Parameters
The transfer information.
ESignSystems.SmartSAFE.Models.SmartRegistry.TransferENoteModel| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentIds |
Gets or sets the document ids to be transferred. |
Collection of integer |
None. |
| ControllerMERSOrgId |
Gets or sets the controller MERS organization identifier. |
string |
None. |
| ServicerMERSOrgId |
Gets or sets the servicer MERS organization identifier. |
string |
None. |
| LocationMERSOrgId |
Gets or sets the location MERS organization identifier. |
string |
None. |
| SubservicerMERSOrgId |
Gets or sets the subservicer MERS organization identifier. |
string |
None. |
| SecuredPartyDelegateeMERSOrgId |
Gets or sets the secured party delegatee MERS organization identifier. |
string |
None. |
| SecuredPartyMERSOrgId |
Gets or sets the secured party MERS organization identifier. |
string |
None. |
| DelegateeForTransfersMERSOrgId |
Gets or sets the delegatee for transfer MERS organization identifier. |
string |
None. |
| CounterPartyMERSOrgId |
Gets or sets the counter party MERS organization identifier. |
string |
None. |
| MersTransferRequestTypeId |
Gets or sets the MERS transfer request type identifier. |
integer |
None. |
| TransferEffectiveDate |
Gets or sets the transfer effective data. |
date |
Required |
| ClientId |
Gets or sets the client identifier. |
integer |
None. |
Request Formats
application/json, text/json
{
"DocumentIds": [
1,
2
],
"ControllerMERSOrgId": "sample string 1",
"ServicerMERSOrgId": "sample string 2",
"LocationMERSOrgId": "sample string 3",
"SubservicerMERSOrgId": "sample string 4",
"SecuredPartyDelegateeMERSOrgId": "sample string 5",
"SecuredPartyMERSOrgId": "sample string 6",
"DelegateeForTransfersMERSOrgId": "sample string 7",
"CounterPartyMERSOrgId": "sample string 8",
"MersTransferRequestTypeId": 9,
"TransferEffectiveDate": "2025-12-12T21:07:04.5125195-05:00",
"ClientId": 1
}
application/xml, text/xml
<TransferENoteModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartRegistry">
<ClientId>1</ClientId>
<ControllerMERSOrgId>sample string 1</ControllerMERSOrgId>
<CounterPartyMERSOrgId>sample string 8</CounterPartyMERSOrgId>
<DelegateeForTransfersMERSOrgId>sample string 7</DelegateeForTransfersMERSOrgId>
<LocationMERSOrgId>sample string 3</LocationMERSOrgId>
<MersTransferRequestTypeId>9</MersTransferRequestTypeId>
<SecuredPartyDelegateeMERSOrgId>sample string 5</SecuredPartyDelegateeMERSOrgId>
<SecuredPartyMERSOrgId>sample string 6</SecuredPartyMERSOrgId>
<ServicerMERSOrgId>sample string 2</ServicerMERSOrgId>
<SubservicerMERSOrgId>sample string 4</SubservicerMERSOrgId>
<TransferEffectiveDate>2025-12-12T21:07:04.5125195-05:00</TransferEffectiveDate>
<DocumentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:long>1</d2p1:long>
<d2p1:long>2</d2p1:long>
</DocumentIds>
</TransferENoteModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Collection of ESignSystems.ERegistry.Models.ResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| MIN | string |
None. |
|
| DocumentName | string |
None. |
|
| Success | boolean |
None. |
|
| ResponseMessages | Collection of ESignSystems.ERegistry.Models.ResponseMessageModel |
None. |
Response Formats
application/json, text/json
[
{
"MIN": "sample string 1",
"DocumentName": "sample string 2",
"Success": true,
"ResponseMessages": [
{
"MIN": "sample string 1",
"StatusCode": "sample string 2",
"StatusName": "sample string 3",
"StatusDescription": "sample string 4",
"Success": true,
"TransferIdentifier": "sample string 6",
"TrackingNumber": "sample string 7",
"Error": true
},
{
"MIN": "sample string 1",
"StatusCode": "sample string 2",
"StatusName": "sample string 3",
"StatusDescription": "sample string 4",
"Success": true,
"TransferIdentifier": "sample string 6",
"TrackingNumber": "sample string 7",
"Error": true
}
]
},
{
"MIN": "sample string 1",
"DocumentName": "sample string 2",
"Success": true,
"ResponseMessages": [
{
"MIN": "sample string 1",
"StatusCode": "sample string 2",
"StatusName": "sample string 3",
"StatusDescription": "sample string 4",
"Success": true,
"TransferIdentifier": "sample string 6",
"TrackingNumber": "sample string 7",
"Error": true
},
{
"MIN": "sample string 1",
"StatusCode": "sample string 2",
"StatusName": "sample string 3",
"StatusDescription": "sample string 4",
"Success": true,
"TransferIdentifier": "sample string 6",
"TrackingNumber": "sample string 7",
"Error": true
}
]
}
]
application/xml, text/xml
<ArrayOfResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.ERegistry.Models">
<ResponseModel>
<DocumentName>sample string 2</DocumentName>
<MIN>sample string 1</MIN>
<ResponseMessages>
<ResponseMessageModel>
<Error>true</Error>
<MIN>sample string 1</MIN>
<StatusCode>sample string 2</StatusCode>
<StatusDescription>sample string 4</StatusDescription>
<StatusName>sample string 3</StatusName>
<Success>true</Success>
<TrackingNumber>sample string 7</TrackingNumber>
<TransferIdentifier>sample string 6</TransferIdentifier>
</ResponseMessageModel>
<ResponseMessageModel>
<Error>true</Error>
<MIN>sample string 1</MIN>
<StatusCode>sample string 2</StatusCode>
<StatusDescription>sample string 4</StatusDescription>
<StatusName>sample string 3</StatusName>
<Success>true</Success>
<TrackingNumber>sample string 7</TrackingNumber>
<TransferIdentifier>sample string 6</TransferIdentifier>
</ResponseMessageModel>
</ResponseMessages>
<Success>true</Success>
</ResponseModel>
<ResponseModel>
<DocumentName>sample string 2</DocumentName>
<MIN>sample string 1</MIN>
<ResponseMessages>
<ResponseMessageModel>
<Error>true</Error>
<MIN>sample string 1</MIN>
<StatusCode>sample string 2</StatusCode>
<StatusDescription>sample string 4</StatusDescription>
<StatusName>sample string 3</StatusName>
<Success>true</Success>
<TrackingNumber>sample string 7</TrackingNumber>
<TransferIdentifier>sample string 6</TransferIdentifier>
</ResponseMessageModel>
<ResponseMessageModel>
<Error>true</Error>
<MIN>sample string 1</MIN>
<StatusCode>sample string 2</StatusCode>
<StatusDescription>sample string 4</StatusDescription>
<StatusName>sample string 3</StatusName>
<Success>true</Success>
<TrackingNumber>sample string 7</TrackingNumber>
<TransferIdentifier>sample string 6</TransferIdentifier>
</ResponseMessageModel>
</ResponseMessages>
<Success>true</Success>
</ResponseModel>
</ArrayOfResponseModel>