GET ipbs/all/individuals

All Individuals

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

CRMIndividual
NameDescriptionTypeAdditional information
KYCID

integer

Required

IndividualId

integer

None.

FirstName

string

Required

Max length: 50

Min length: 1

MiddleName

string

Max length: 50

LastName

string

Required

Max length: 50

Min length: 1

Gender

string

Required

Max length: 50

Min length: 1

CountryOfBirthCountryId

string

Required

Max length: 3

Min length: 1

CountryOfCitzenshipCountryId

string

Required

Max length: 3

Min length: 1

DateofBirth

date

Required

DomiciliationCountryId

string

Max length: 3

DomiciliationProvinceOrState

string

Max length: 50

DomiciliationCityTown

string

Max length: 50

DomiciliationPostalOrPOBox

string

Max length: 50

EmailAddress

string

Max length: 75

HomePhone

string

Max length: 35

HomePhoneCountryId

string

Max length: 3

OtherPhone

string

Max length: 35

MailingAddress

string

Required

Max length: 500

PassportNumber

string

Max length: 35

PassportIssued

string

Max length: 35

PassportDateIssued

date

None.

PassportExpirationDate

date

None.

DriversLicense

string

Max length: 35

SocialSecurity

string

Max length: 35

CreatedDate

date

None.

ModifiedDate

date

None.

Response Formats

application/json, text/json

Sample:
{
  "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-03T23:55:51.2865163-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-03T23:55:51.2865163-04:00",
  "PassportExpirationDate": "2025-04-03T23:55:51.2865163-04:00",
  "DriversLicense": "sample string 19",
  "SocialSecurity": "sample string 20",
  "CreatedDate": "2025-04-03T23:55:51.2865163-04:00",
  "ModifiedDate": "2025-04-03T23:55:51.2865163-04:00"
}

text/xml

Sample:
<CRMIndividual xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPBSAPIV1">
  <CountryOfBirthCountryId>sample string 6</CountryOfBirthCountryId>
  <CountryOfCitzenshipCountryId>sample string 7</CountryOfCitzenshipCountryId>
  <CreatedDate>2025-04-03T23:55:51.2865163-04:00</CreatedDate>
  <DateofBirth>2025-04-03T23:55:51.2865163-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-03T23:55:51.2865163-04:00</ModifiedDate>
  <OtherPhone>sample string 15</OtherPhone>
  <PassportDateIssued>2025-04-03T23:55:51.2865163-04:00</PassportDateIssued>
  <PassportExpirationDate>2025-04-03T23:55:51.2865163-04:00</PassportExpirationDate>
  <PassportIssued>sample string 18</PassportIssued>
  <PassportNumber>sample string 17</PassportNumber>
  <SocialSecurity>sample string 20</SocialSecurity>
</CRMIndividual>