GET api/Documents/{documentId}/Borrowers

Gets the borrowers for the specified document.

Request Information

URI Parameters

Name	Description	Type	Additional information
documentId	The document identifier.	integer	Required

Body Parameters

None.

Response Information

Resource Description

The list of borrowers.

Collection of ESignSystems.SmartSAFE.Models.SmartDocuments.SmartDocumentBorrowerModel

Name	Description	Type	Additional information
SmartDocumentBorrowerId	Gets or sets the SmartDocumentBorrowerId.	integer	None.
DocumentId	Gets or sets the DocumentId.	integer	None.
IsSigner	Gets or sets a value indicating if this borrower is a signer.	boolean	None.
FullName	Gets the borrower's full name.	string	None.
SignerName	Gets or sets the signer's name.	string	None.
PowerOfAttorney	Gets or sets the Power of Attorney.	ESignSystems.SmartSAFE.Models.SmartDocuments.SmartDocumentPowerOfAttorneyModel	None.
HasSSN	Gets or sets a value indicating whether the borrower has an SSN already saved.	boolean	None.
BorrowerId	Gets or sets the id of the borrower.	string	Required
FirstName	Gets or sets the FirstName.	string	None.
MiddleName	Gets or sets the MiddleName.	string	None.
LastName	Gets or sets the LastName.	string	None.
SSN	Gets or sets the SSN.	string	Max length: 9 Min length: 9
NameSuffix	Gets or sets the NameSuffix.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SmartDocumentBorrowerId": 1,
    "DocumentId": 1,
    "IsSigner": true,
    "FullName": "sample string 5 sample string 6 sample string 7 sample string 9",
    "SignerName": "sample string 2",
    "PowerOfAttorney": {
      "UnparsedName": "sample string 1",
      "TitleDescription": "sample string 2",
      "SigningCapacityTextDescription": "sample string 3"
    },
    "HasSSN": true,
    "BorrowerId": "sample string 4",
    "FirstName": "sample string 5",
    "MiddleName": "sample string 6",
    "LastName": "sample string 7",
    "SSN": "sample string 8",
    "NameSuffix": "sample string 9"
  },
  {
    "SmartDocumentBorrowerId": 1,
    "DocumentId": 1,
    "IsSigner": true,
    "FullName": "sample string 5 sample string 6 sample string 7 sample string 9",
    "SignerName": "sample string 2",
    "PowerOfAttorney": {
      "UnparsedName": "sample string 1",
      "TitleDescription": "sample string 2",
      "SigningCapacityTextDescription": "sample string 3"
    },
    "HasSSN": true,
    "BorrowerId": "sample string 4",
    "FirstName": "sample string 5",
    "MiddleName": "sample string 6",
    "LastName": "sample string 7",
    "SSN": "sample string 8",
    "NameSuffix": "sample string 9"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSmartDocumentBorrowerModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SmartDocuments">
  <SmartDocumentBorrowerModel>
    <BorrowerId>sample string 4</BorrowerId>
    <FirstName>sample string 5</FirstName>
    <LastName>sample string 7</LastName>
    <MiddleName>sample string 6</MiddleName>
    <NameSuffix>sample string 9</NameSuffix>
    <SSN>sample string 8</SSN>
    <DocumentId>1</DocumentId>
    <HasSSN>true</HasSSN>
    <IsSigner>true</IsSigner>
    <PowerOfAttorney>
      <SigningCapacityTextDescription>sample string 3</SigningCapacityTextDescription>
      <TitleDescription>sample string 2</TitleDescription>
      <UnparsedName>sample string 1</UnparsedName>
    </PowerOfAttorney>
    <SignerName>sample string 2</SignerName>
    <SmartDocumentBorrowerId>1</SmartDocumentBorrowerId>
  </SmartDocumentBorrowerModel>
  <SmartDocumentBorrowerModel>
    <BorrowerId>sample string 4</BorrowerId>
    <FirstName>sample string 5</FirstName>
    <LastName>sample string 7</LastName>
    <MiddleName>sample string 6</MiddleName>
    <NameSuffix>sample string 9</NameSuffix>
    <SSN>sample string 8</SSN>
    <DocumentId>1</DocumentId>
    <HasSSN>true</HasSSN>
    <IsSigner>true</IsSigner>
    <PowerOfAttorney>
      <SigningCapacityTextDescription>sample string 3</SigningCapacityTextDescription>
      <TitleDescription>sample string 2</TitleDescription>
      <UnparsedName>sample string 1</UnparsedName>
    </PowerOfAttorney>
    <SignerName>sample string 2</SignerName>
    <SmartDocumentBorrowerId>1</SmartDocumentBorrowerId>
  </SmartDocumentBorrowerModel>
</ArrayOfSmartDocumentBorrowerModel>