GET ipbs/individual/related/entities/{KYCID}

All Individual Related Entities

Request Information

URI Parameters

NameDescriptionTypeAdditional information
KYCID

integer

Required

Body Parameters

None.

Response Information

Resource Description

CRMRelatedIndividualEntities
NameDescriptionTypeAdditional information
Individual

CRMIndividual

None.
RelatedEntities

Collection of CRMRelatedEntityId

None.

Response Formats

application/json, text/json

Sample: 
{
  "Individual": {
    "KYCID": 1,
    "IndividualId": 1,
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "Gender": "sample string 5",
    "CountryOfBirthCountryId": "sample string 6",
    "CountryOfCitzenshipCountryId": "sample string 7",
    "DateofBirth": "2025-04-04T00:01:46.8908509-04:00",
    "DomiciliationCountryId": "sample string 8",
    "DomiciliationProvinceOrState": "sample string 9",
    "DomiciliationCityTown": "sample string 10",
    "DomiciliationPostalOrPOBox": "sample string 11",
    "EmailAddress": "sample string 12",
    "HomePhone": "sample string 13",
    "HomePhoneCountryId": "sample string 14",
    "OtherPhone": "sample string 15",
    "MailingAddress": "sample string 16",
    "PassportNumber": "sample string 17",
    "PassportIssued": "sample string 18",
    "PassportDateIssued": "2025-04-04T00:01:46.8908509-04:00",
    "PassportExpirationDate": "2025-04-04T00:01:46.8908509-04:00",
    "DriversLicense": "sample string 19",
    "SocialSecurity": "sample string 20",
    "CreatedDate": "2025-04-04T00:01:46.8908509-04:00",
    "ModifiedDate": "2025-04-04T00:01:46.8908509-04:00"
  },
  "RelatedEntities": [
    {
      "EntityID": "sample string 1",
      "RoleId": 2,
      "RoleDescription": "sample string 3",
      "MarkedAs": "sample string 4",
      "ProductType": "sample string 5",
      "ProductDescription": "sample string 6"
    },
    {
      "EntityID": "sample string 1",
      "RoleId": 2,
      "RoleDescription": "sample string 3",
      "MarkedAs": "sample string 4",
      "ProductType": "sample string 5",
      "ProductDescription": "sample string 6"
    }
  ]
}

text/xml

Sample: 
<CRMRelatedIndividualEntities xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPBSAPIV1">
  <Individual>
    <CountryOfBirthCountryId>sample string 6</CountryOfBirthCountryId>
    <CountryOfCitzenshipCountryId>sample string 7</CountryOfCitzenshipCountryId>
    <CreatedDate>2025-04-04T00:01:46.8908509-04:00</CreatedDate>
    <DateofBirth>2025-04-04T00:01:46.8908509-04:00</DateofBirth>
    <DomiciliationCityTown>sample string 10</DomiciliationCityTown>
    <DomiciliationCountryId>sample string 8</DomiciliationCountryId>
    <DomiciliationPostalOrPOBox>sample string 11</DomiciliationPostalOrPOBox>
    <DomiciliationProvinceOrState>sample string 9</DomiciliationProvinceOrState>
    <DriversLicense>sample string 19</DriversLicense>
    <EmailAddress>sample string 12</EmailAddress>
    <FirstName>sample string 2</FirstName>
    <Gender>sample string 5</Gender>
    <HomePhone>sample string 13</HomePhone>
    <HomePhoneCountryId>sample string 14</HomePhoneCountryId>
    <IndividualId>1</IndividualId>
    <KYCID>1</KYCID>
    <LastName>sample string 4</LastName>
    <MailingAddress>sample string 16</MailingAddress>
    <MiddleName>sample string 3</MiddleName>
    <ModifiedDate>2025-04-04T00:01:46.8908509-04:00</ModifiedDate>
    <OtherPhone>sample string 15</OtherPhone>
    <PassportDateIssued>2025-04-04T00:01:46.8908509-04:00</PassportDateIssued>
    <PassportExpirationDate>2025-04-04T00:01:46.8908509-04:00</PassportExpirationDate>
    <PassportIssued>sample string 18</PassportIssued>
    <PassportNumber>sample string 17</PassportNumber>
    <SocialSecurity>sample string 20</SocialSecurity>
  </Individual>
  <RelatedEntities>
    <CRMRelatedEntityId>
      <EntityID>sample string 1</EntityID>
      <MarkedAs>sample string 4</MarkedAs>
      <ProductDescription>sample string 6</ProductDescription>
      <ProductType>sample string 5</ProductType>
      <RoleDescription>sample string 3</RoleDescription>
      <RoleId>2</RoleId>
    </CRMRelatedEntityId>
    <CRMRelatedEntityId>
      <EntityID>sample string 1</EntityID>
      <MarkedAs>sample string 4</MarkedAs>
      <ProductDescription>sample string 6</ProductDescription>
      <ProductType>sample string 5</ProductType>
      <RoleDescription>sample string 3</RoleDescription>
      <RoleId>2</RoleId>
    </CRMRelatedEntityId>
  </RelatedEntities>
</CRMRelatedIndividualEntities>