POST Policy/GetBeneficiary

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
SecurityKey		string	None.
PolicyId		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "SecurityKey": "sample string 1",
  "PolicyId": 2
}

application/xml, text/xml

Sample:

<SecurityTokenVerifiedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
  <PolicyId>2</PolicyId>
  <SecurityKey>sample string 1</SecurityKey>
</SecurityTokenVerifiedRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfBeneficiary

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Entity	Beneficiary	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Entity": {
    "Id": 1,
    "IdNumber": "sample string 2",
    "PassportNumber": "sample string 3",
    "FirstName": "sample string 4",
    "Surname": "sample string 5",
    "DateOfBirth": "2025-05-14T00:58:06.7518903+02:00",
    "Gender": "sample string 7",
    "InsuredType": "sample string 8",
    "StartDate": "2025-05-14T00:58:06.7518903+02:00",
    "EndDate": "2025-05-14T00:58:06.7518903+02:00",
    "JobTitle": "sample string 11",
    "ContactMethods": [
      {
        "Value": "sample string 1",
        "ContactType": "sample string 2"
      },
      {
        "Value": "sample string 1",
        "ContactType": "sample string 2"
      }
    ],
    "Attachments": [
      {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "data": "QEA="
      },
      {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "data": "QEA="
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfBeneficiarylP_S41WJs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnePlan.Core">
  <Entity xmlns:d2p1="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
    <d2p1:Attachments>
      <d2p1:Attachment>
        <d2p1:Description>sample string 2</d2p1:Description>
        <d2p1:Name>sample string 1</d2p1:Name>
        <d2p1:data>QEA=</d2p1:data>
      </d2p1:Attachment>
      <d2p1:Attachment>
        <d2p1:Description>sample string 2</d2p1:Description>
        <d2p1:Name>sample string 1</d2p1:Name>
        <d2p1:data>QEA=</d2p1:data>
      </d2p1:Attachment>
    </d2p1:Attachments>
    <d2p1:ContactMethods>
      <d2p1:ContactMethod>
        <d2p1:ContactType>sample string 2</d2p1:ContactType>
        <d2p1:Value>sample string 1</d2p1:Value>
      </d2p1:ContactMethod>
      <d2p1:ContactMethod>
        <d2p1:ContactType>sample string 2</d2p1:ContactType>
        <d2p1:Value>sample string 1</d2p1:Value>
      </d2p1:ContactMethod>
    </d2p1:ContactMethods>
    <d2p1:DateOfBirth>2025-05-14T00:58:06.7518903+02:00</d2p1:DateOfBirth>
    <d2p1:EndDate>2025-05-14T00:58:06.7518903+02:00</d2p1:EndDate>
    <d2p1:FirstName>sample string 4</d2p1:FirstName>
    <d2p1:Gender>sample string 7</d2p1:Gender>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IdNumber>sample string 2</d2p1:IdNumber>
    <d2p1:InsuredType>sample string 8</d2p1:InsuredType>
    <d2p1:JobTitle>sample string 11</d2p1:JobTitle>
    <d2p1:PassportNumber>sample string 3</d2p1:PassportNumber>
    <d2p1:StartDate>2025-05-14T00:58:06.7518903+02:00</d2p1:StartDate>
    <d2p1:Surname>sample string 5</d2p1:Surname>
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfBeneficiarylP_S41WJs>