GET api/TaxIdentity?VendorId={VendorId}&ReturnDeactivated={ReturnDeactivated}

Request Information

URI Parameters

Name	Description	Type	Additional information
VendorId		string	Required
ReturnDeactivated		string	None.

Body Parameters

None.

Response Information

Resource Description

TaxIdentity

Name	Type	Additional information
IdentityKey	globally unique identifier	None.
AccountId	string	None.
VendorId	string	None.
LegalName	string	None.
FirstName	string	None.
LastName	string	None.
DoingBusinessAsName	string	None.
IRSLegalName	string	None.
EmailAddress	string	None.
PrimaryPhone	string	None.
TaxStatus	TaxStatus	None.
TaxStatusExpiryDate	date	None.
KYCStatus	KYCStatus	None.
KYCCheckDate	date	None.
CountryIncorporation	string	None.
CountryIncorporationCode	string	None.
DateOfBirth	date	None.
TIN	string	None.
TINType	TINTypeEnum	None.
TIN_Hash	string	None.
ForeignTIN_Hash	string	None.
TINValidationDate	date	None.
ForeignTIN	string	None.
FormType	string	None.
IsUSPerson	boolean	None.
IsIndividual	boolean	None.
IsECIBusiness	boolean	None.
PaymentThroughQI	boolean	None.
ForeignTINNotReqd	boolean	None.
HasTreatyClaim	boolean	None.
TaxTreatyCountry	string	None.
TaxTreatyCountryCode	string	None.
TaxIncomeType	string	None.
IsSubjectToBWHT	boolean	None.
TWR_RoyaltyCopyright	decimal number	None.
TWR_RoyaltyFilm	decimal number	None.
TWR_Royalty_OtherIndustrial	decimal number	None.
TWR_Entertainment	decimal number	None.
TWR_Service	decimal number	None.
TWR_Prizes	decimal number	None.
ConsentElectronicSignature	boolean	None.
ConsentElectronicReporting	boolean	None.
EffectiveDate	date	None.
SignatureDate	date	None.
RecordSource	string	None.
PortalSource	string	None.
EntityType	string	None.
ProfileType	string	None.
NotificationMethod	string	None.
LastPaymentDate	date	None.
PaymentAccountCountry	string	None.
PaymentAccountCurrency	string	None.
CreatedOn	date	None.
ModifiedOn	date	None.
Timestamp	date	None.
PermAddress	Address	None.
MailAddress	Address	None.
ExtraFormData	Dictionary of string [key] and Object [value]	None.
IdentityActions	Collection of APIIdentityAction	None.
InterviewLanguage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "InterviewLanguage": "sample string 1",
  "IdentityKey": "d543d486-81b3-4a4c-b0f1-725136eb1ddb",
  "AccountId": "sample string 2",
  "VendorId": "sample string 3",
  "LegalName": "sample string 4",
  "FirstName": "sample string 5",
  "LastName": "sample string 6",
  "DoingBusinessAsName": "sample string 7",
  "IRSLegalName": "sample string 8",
  "EmailAddress": "sample string 9",
  "PrimaryPhone": "sample string 10",
  "TaxStatus": "TaxInfoNotRequired",
  "TaxStatusExpiryDate": "2026-04-04T11:34:31.0665848Z",
  "KYCStatus": "KYCNotTested",
  "KYCCheckDate": "2026-04-04T11:34:31.0665848Z",
  "CountryIncorporation": "sample string 11",
  "CountryIncorporationCode": "sample string 12",
  "DateOfBirth": "2026-04-04T11:34:31.0665848Z",
  "TIN": "sample string 13",
  "TINType": "SSN",
  "TINValidationDate": "2026-04-04T11:34:31.0665848Z",
  "ForeignTIN": "sample string 14",
  "FormType": "sample string 15",
  "IsUSPerson": true,
  "IsIndividual": true,
  "IsECIBusiness": true,
  "PaymentThroughQI": true,
  "ForeignTINNotReqd": true,
  "HasTreatyClaim": true,
  "TaxTreatyCountry": "sample string 17",
  "TaxTreatyCountryCode": "sample string 18",
  "TaxIncomeType": "sample string 19",
  "IsSubjectToBWHT": true,
  "TWR_RoyaltyCopyright": 1.0,
  "TWR_RoyaltyFilm": 1.0,
  "TWR_Royalty_OtherIndustrial": 1.0,
  "TWR_Entertainment": 1.0,
  "TWR_Service": 1.0,
  "TWR_Prizes": 1.0,
  "ConsentElectronicSignature": true,
  "ConsentElectronicReporting": true,
  "EffectiveDate": "2026-04-04T11:34:31.0665848Z",
  "SignatureDate": "2026-04-04T11:34:31.0665848Z",
  "RecordSource": "sample string 21",
  "PortalSource": "sample string 22",
  "EntityType": "sample string 23",
  "ProfileType": "sample string 24",
  "NotificationMethod": "sample string 25",
  "LastPaymentDate": "2026-04-04T11:34:31.0665848Z",
  "PaymentAccountCountry": "sample string 26",
  "PaymentAccountCurrency": "sample string 27",
  "CreatedOn": "2026-04-04T11:34:31.0665848Z",
  "ModifiedOn": "2026-04-04T11:34:31.0665848Z",
  "Timestamp": "2026-04-04T11:34:31.0665848Z",
  "PermAddress": {
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "AddressCity": "sample string 3",
    "AddressState": "sample string 4",
    "AddressPostcode": "sample string 5",
    "AddressCountry": "sample string 6",
    "AddressCountryCode": "sample string 7"
  },
  "MailAddress": {
    "AddressLine1": "sample string 1",
    "AddressLine2": "sample string 2",
    "AddressCity": "sample string 3",
    "AddressState": "sample string 4",
    "AddressPostcode": "sample string 5",
    "AddressCountry": "sample string 6",
    "AddressCountryCode": "sample string 7"
  },
  "ExtraFormData": {},
  "IdentityActions": []
}

application/xml, text/xml

Sample:

<TaxIdentity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lilaham.TaxIdPOC.Models.API">
  <AccountId>sample string 2</AccountId>
  <ConsentElectronicReporting>true</ConsentElectronicReporting>
  <ConsentElectronicSignature>true</ConsentElectronicSignature>
  <CountryIncorporation>sample string 11</CountryIncorporation>
  <CountryIncorporationCode>sample string 12</CountryIncorporationCode>
  <CreatedOn>2026-04-04T11:34:31.0665848+00:00</CreatedOn>
  <DateOfBirth>2026-04-04T11:34:31.0665848+00:00</DateOfBirth>
  <DoingBusinessAsName>sample string 7</DoingBusinessAsName>
  <EffectiveDate>2026-04-04T11:34:31.0665848+00:00</EffectiveDate>
  <EmailAddress>sample string 9</EmailAddress>
  <EntityType>sample string 23</EntityType>
  <ExtraFormData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <FirstName>sample string 5</FirstName>
  <ForeignTIN>sample string 14</ForeignTIN>
  <ForeignTINNotReqd>true</ForeignTINNotReqd>
  <FormType>sample string 15</FormType>
  <HasTreatyClaim>true</HasTreatyClaim>
  <IRSLegalName>sample string 8</IRSLegalName>
  <IdentityActions />
  <IdentityKey>d543d486-81b3-4a4c-b0f1-725136eb1ddb</IdentityKey>
  <InterviewLanguage>sample string 1</InterviewLanguage>
  <IsECIBusiness>true</IsECIBusiness>
  <IsIndividual>true</IsIndividual>
  <IsSubjectToBWHT>true</IsSubjectToBWHT>
  <IsUSPerson>true</IsUSPerson>
  <KYCCheckDate>2026-04-04T11:34:31.0665848+00:00</KYCCheckDate>
  <KYCStatus>KYCNotTested</KYCStatus>
  <LastName>sample string 6</LastName>
  <LastPaymentDate>2026-04-04T11:34:31.0665848+00:00</LastPaymentDate>
  <LegalName>sample string 4</LegalName>
  <MailAddress>
    <AddressCity>sample string 3</AddressCity>
    <AddressCountry>sample string 6</AddressCountry>
    <AddressCountryCode>sample string 7</AddressCountryCode>
    <AddressLine1>sample string 1</AddressLine1>
    <AddressLine2>sample string 2</AddressLine2>
    <AddressPostcode>sample string 5</AddressPostcode>
    <AddressState>sample string 4</AddressState>
  </MailAddress>
  <ModifiedOn>2026-04-04T11:34:31.0665848+00:00</ModifiedOn>
  <NotificationMethod>sample string 25</NotificationMethod>
  <PaymentAccountCountry>sample string 26</PaymentAccountCountry>
  <PaymentAccountCurrency>sample string 27</PaymentAccountCurrency>
  <PaymentThroughQI>true</PaymentThroughQI>
  <PermAddress>
    <AddressCity>sample string 3</AddressCity>
    <AddressCountry>sample string 6</AddressCountry>
    <AddressCountryCode>sample string 7</AddressCountryCode>
    <AddressLine1>sample string 1</AddressLine1>
    <AddressLine2>sample string 2</AddressLine2>
    <AddressPostcode>sample string 5</AddressPostcode>
    <AddressState>sample string 4</AddressState>
  </PermAddress>
  <PortalSource>sample string 22</PortalSource>
  <PrimaryPhone>sample string 10</PrimaryPhone>
  <ProfileType>sample string 24</ProfileType>
  <RecordSource>sample string 21</RecordSource>
  <SignatureDate>2026-04-04T11:34:31.0665848+00:00</SignatureDate>
  <TIN>sample string 13</TIN>
  <TINType>SSN</TINType>
  <TINValidationDate>2026-04-04T11:34:31.0665848+00:00</TINValidationDate>
  <TWR_Entertainment>1</TWR_Entertainment>
  <TWR_Prizes>1</TWR_Prizes>
  <TWR_RoyaltyCopyright>1</TWR_RoyaltyCopyright>
  <TWR_RoyaltyFilm>1</TWR_RoyaltyFilm>
  <TWR_Royalty_OtherIndustrial>1</TWR_Royalty_OtherIndustrial>
  <TWR_Service>1</TWR_Service>
  <TaxIncomeType>sample string 19</TaxIncomeType>
  <TaxStatus>TaxInfoNotRequired</TaxStatus>
  <TaxStatusExpiryDate>2026-04-04T11:34:31.0665848+00:00</TaxStatusExpiryDate>
  <TaxTreatyCountry>sample string 17</TaxTreatyCountry>
  <TaxTreatyCountryCode>sample string 18</TaxTreatyCountryCode>
  <Timestamp>2026-04-04T11:34:31.0665848+00:00</Timestamp>
  <VendorId>sample string 3</VendorId>
</TaxIdentity>