POST api/ESB/GetIndemnityFormData

Request Information

URI Parameters

None.

Body Parameters

string

Request Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'String'.

Response Information

Resource Description

GetIndemnityDataResponse

Name	Type	Additional information
Header	ESBHeaderAdvance	None.
Success	boolean	None.
Message	string	None.
TransactionId	string	None.
Individual	IndemnityIndividual	None.
Organisation	IndemnityOrganisation	None.
CIFNumber	string	None.
Signers	Collection of Signer	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "TransactionID": "sample string 1",
    "Organisation": "sample string 2",
    "UserID": "sample string 3",
    "SystemID": "sample string 4",
    "Timestamp": "2025-12-10T01:39:33",
    "portfolioSettings": {
      "ReferenceNumber": "sample string 1",
      "OrderNumber": 2,
      "Type": "sample string 3",
      "PortfolioCount": 4,
      "SendEmail": true,
      "PackageEmailName": "sample string 6",
      "SendOnComplete": true,
      "EmailInformationURL": "sample string 8"
    },
    "TypeOfTransaction": "sample string 6"
  },
  "Success": true,
  "Message": "sample string 2",
  "TransactionId": "sample string 3",
  "Individual": {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "IDNumber": "sample string 3",
    "DisplayName": "sample string 4"
  },
  "Organisation": {
    "RegistrationNumber": "sample string 1",
    "BusinessName": "sample string 2"
  },
  "CIFNumber": "sample string 4",
  "Signers": [
    {
      "RSAResident": true,
      "OnBehalfOf": "sample string 2",
      "Capacity": "sample string 3",
      "Surname": "sample string 4",
      "Name": "sample string 5",
      "IdentityNo": "sample string 6",
      "MobileNumber": "sample string 7",
      "Email": "sample string 8",
      "SignerType": "sample string 9"
    },
    {
      "RSAResident": true,
      "OnBehalfOf": "sample string 2",
      "Capacity": "sample string 3",
      "Surname": "sample string 4",
      "Name": "sample string 5",
      "IdentityNo": "sample string 6",
      "MobileNumber": "sample string 7",
      "Email": "sample string 8",
      "SignerType": "sample string 9"
    }
  ]
}

application/xml, text/xml

Sample:

<GetIndemnityDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels">
  <CIFNumber>sample string 4</CIFNumber>
  <Header xmlns:d2p1="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels.ESB">
    <d2p1:Organisation>sample string 2</d2p1:Organisation>
    <d2p1:SystemID>sample string 4</d2p1:SystemID>
    <d2p1:Timestamp>2025-12-10T01:39:33.866988+00:00</d2p1:Timestamp>
    <d2p1:TransactionID>sample string 1</d2p1:TransactionID>
    <d2p1:TypeOfTransaction>sample string 6</d2p1:TypeOfTransaction>
    <d2p1:UserID>sample string 3</d2p1:UserID>
    <d2p1:portfolioSettings xmlns:d3p1="http://schemas.datacontract.org/2004/07/MercantileEventHandler.Core.API.KYC">
      <d3p1:EmailInformationURL>sample string 8</d3p1:EmailInformationURL>
      <d3p1:OrderNumber>2</d3p1:OrderNumber>
      <d3p1:PackageEmailName>sample string 6</d3p1:PackageEmailName>
      <d3p1:PortfolioCount>4</d3p1:PortfolioCount>
      <d3p1:ReferenceNumber>sample string 1</d3p1:ReferenceNumber>
      <d3p1:SendEmail>true</d3p1:SendEmail>
      <d3p1:SendOnComplete>true</d3p1:SendOnComplete>
      <d3p1:Type>sample string 3</d3p1:Type>
    </d2p1:portfolioSettings>
  </Header>
  <Individual xmlns:d2p1="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels.ESB">
    <d2p1:DisplayName>sample string 4</d2p1:DisplayName>
    <d2p1:FirstName>sample string 1</d2p1:FirstName>
    <d2p1:IDNumber>sample string 3</d2p1:IDNumber>
    <d2p1:LastName>sample string 2</d2p1:LastName>
  </Individual>
  <Message>sample string 2</Message>
  <Organisation xmlns:d2p1="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels.ESB">
    <d2p1:BusinessName>sample string 2</d2p1:BusinessName>
    <d2p1:RegistrationNumber>sample string 1</d2p1:RegistrationNumber>
  </Organisation>
  <Signers xmlns:d2p1="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels.ESB">
    <d2p1:Signer>
      <d2p1:Capacity>sample string 3</d2p1:Capacity>
      <d2p1:Email>sample string 8</d2p1:Email>
      <d2p1:IdentityNo>sample string 6</d2p1:IdentityNo>
      <d2p1:MobileNumber>sample string 7</d2p1:MobileNumber>
      <d2p1:Name>sample string 5</d2p1:Name>
      <d2p1:OnBehalfOf>sample string 2</d2p1:OnBehalfOf>
      <d2p1:RSAResident>true</d2p1:RSAResident>
      <d2p1:SignerType>sample string 9</d2p1:SignerType>
      <d2p1:Surname>sample string 4</d2p1:Surname>
    </d2p1:Signer>
    <d2p1:Signer>
      <d2p1:Capacity>sample string 3</d2p1:Capacity>
      <d2p1:Email>sample string 8</d2p1:Email>
      <d2p1:IdentityNo>sample string 6</d2p1:IdentityNo>
      <d2p1:MobileNumber>sample string 7</d2p1:MobileNumber>
      <d2p1:Name>sample string 5</d2p1:Name>
      <d2p1:OnBehalfOf>sample string 2</d2p1:OnBehalfOf>
      <d2p1:RSAResident>true</d2p1:RSAResident>
      <d2p1:SignerType>sample string 9</d2p1:SignerType>
      <d2p1:Surname>sample string 4</d2p1:Surname>
    </d2p1:Signer>
  </Signers>
  <Success>true</Success>
  <TransactionId>sample string 3</TransactionId>
</GetIndemnityDataResponse>