A third party is an individual or entity that is involved in some capacity but not a principal. Third parties may work on behalf of one or more firms, products or investors. The third parties product supports the retrieval of Related Contacts, Custodians, Placement Agents and Vendors, along with party-specific attributes and relationships between the party and firms, products and/or investors.
Metadata
GET
/metadata
Name | Description | Data Type | Required |
---|---|---|---|
externalId |
Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application. Many times the externalId is used to synchronize SEI sourced data with another data source for the same record. |
string |
|
nsccId |
The Depository Trust & Clearing Corporation ( DTCC) member id. This value is only populated when the third party is a custodian and a member of the DTCC's Alternative Investment Products. |
string |
|
alternateId |
Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional. |
string |
|
classification |
ThirdParty Classification identifier. Valid values are "Individual" or "Entity". |
string |
|
type |
ThirdParty Type identifier |
string |
|
active |
Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis. |
boolean |
|
clientSpecific |
Flag to indicate if Third Party is Client Specific |
boolean |
|
section |
One or more sections can be specified to limit the fields returned in a response. Passing one or more sections will exclude other sections from being included in the response. If no sections are passed, the response will include all available fields. Can be individual or multiple delimited by a comma. |
string |
|
encoded |
Denotes whether cursor query parameters are encoded (default true) |
boolean |
|
validateRequest |
A flag to enable/disable request validation. |
boolean |
|
thirdPartyProperties |
Describes the third party property |
string |
|
prospectFlag |
Indicates if the Third Party is a prospect |
boolean |
|
prospectStatusType |
Describes the status of the Third Party prospect. |
string |
|
deceasedDate |
The date that the third party is deceased (if applicable). Required date format yyyy-MM-ddTHH:mm:ss.SSS. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
countryOfBirth |
Unique Country Code to identify country of birth of a third party. |
string |
|
limit |
Number of records per page (default 25) |
string |
|
systemIdName |
Name of the field from external system. |
string |
|
systemIdValue |
Value of the field from external system. |
string |
|
sortColumn |
Sorts the data |
string |
|
changeStartDate |
Last change start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third parties modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
changeEndDate |
Last change end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
createStartDate |
Created start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
createEndDate |
Created end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
fax |
The contact or third party's fax number. |
string |
Name | Description | Data Type | Required |
---|---|---|---|
Authorization |
access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
string |
|
AppKey |
This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
string |
|
firstName |
First Name of the ThirdParty |
string |
|
middleName |
Middle Name of the ThirdParty |
string |
|
lastName |
Last Name of the ThirdParty |
string |
|
taxId |
Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing. |
string |
|
firstCountryOfCitizenship |
Primary citizenship country for Third Party. |
string |
|
secondCountryOfCitizenship |
Secondary citizenship country for Third Party. |
string |
|
Email for the ThirdParty. A ThirdParty may have none, one or up to four email addresses. If multiple exist, only one email can be primary. |
string |
||
attention1 |
The first attention line of the address, typically used for a specific recipient. |
string |
|
attention2 |
The second attention line of the address. |
string |
|
addressLine1 |
The first line of the address, typically used for the street address. |
string |
|
addressLine2 |
The second line of the address. |
string |
|
addressLine3 |
The third line of the address. |
string |
|
addressLine4 |
The fourth line of the address. |
string |
|
city |
The city of the address. |
string |
|
stateCode |
The two character code for US and Canadian states and provinces. |
string |
|
postalCode |
The postal code of the address. |
string |
|
countryIsoCode |
Mailing Address Country Code |
string |
-
CodeDescription
-
200
OK- The request has succeeded and the response has been returned.
-
400
Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
-
401
Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
-
403
Forbidden -The SEI server understood the request but refuses to fulfill it.
-
404
Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
-
500
Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.
externalId |
Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application. Many times the externalId is used to synchronize SEI sourced data with another data source for the same record. |
nsccId |
The Depository Trust & Clearing Corporation ( DTCC) member id. This value is only populated when the third party is a custodian and a member of the DTCC's Alternative Investment Products. |
alternateId |
Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional. |
classification |
ThirdParty Classification identifier. Valid values are "Individual" or "Entity". |
type |
ThirdParty Type identifier |
active |
Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis. |
clientSpecific |
Flag to indicate if Third Party is Client Specific |
section |
One or more sections can be specified to limit the fields returned in a response. Passing one or more sections will exclude other sections from being included in the response. If no sections are passed, the response will include all available fields. Can be individual or multiple delimited by a comma. |
encoded |
Denotes whether cursor query parameters are encoded (default true) |
validateRequest |
A flag to enable/disable request validation. |
thirdPartyProperties |
Describes the third party property |
prospectFlag |
Indicates if the Third Party is a prospect |
prospectStatusType |
Describes the status of the Third Party prospect. |
deceasedDate |
The date that the third party is deceased (if applicable). Required date format yyyy-MM-ddTHH:mm:ss.SSS. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
countryOfBirth |
Unique Country Code to identify country of birth of a third party. |
limit |
Number of records per page (default 25) |
systemIdName |
Name of the field from external system. |
systemIdValue |
Value of the field from external system. |
sortColumn |
Sorts the data |
changeStartDate |
Last change start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third parties modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
changeEndDate |
Last change end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
createStartDate |
Created start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
createEndDate |
Created end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
fax |
The contact or third party's fax number. |
Authorization |
access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
AppKey |
This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
firstName |
First Name of the ThirdParty |
middleName |
Middle Name of the ThirdParty |
lastName |
Last Name of the ThirdParty |
taxId |
Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing. |
firstCountryOfCitizenship |
Primary citizenship country for Third Party. |
secondCountryOfCitizenship |
Secondary citizenship country for Third Party. |
Email for the ThirdParty. A ThirdParty may have none, one or up to four email addresses. If multiple exist, only one email can be primary. |
|
attention1 |
The first attention line of the address, typically used for a specific recipient. |
attention2 |
The second attention line of the address. |
addressLine1 |
The first line of the address, typically used for the street address. |
addressLine2 |
The second line of the address. |
addressLine3 |
The third line of the address. |
addressLine4 |
The fourth line of the address. |
city |
The city of the address. |
stateCode |
The two character code for US and Canadian states and provinces. |
postalCode |
The postal code of the address. |
countryIsoCode |
Mailing Address Country Code |
Request Body
Working...
Metadata
GET
/metadata
Name | Description | Data Type | Required |
---|---|---|---|
externalId |
Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application. Many times the externalId is used to synchronize SEI sourced data with another data source for the same record. |
string |
|
nsccId |
The Depository Trust & Clearing Corporation ( DTCC) member id. This value is only populated when the third party is a custodian and a member of the DTCC's Alternative Investment Products. |
string |
|
alternateId |
Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional. |
string |
|
classification |
ThirdParty Classification identifier. Valid values are "Individual" or "Entity". |
string |
|
type |
ThirdParty Type identifier |
string |
|
active |
Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis. |
boolean |
|
clientSpecific |
Flag to indicate if Third Party is Client Specific |
boolean |
|
section |
One or more sections can be specified to limit the fields returned in a response. Passing one or more sections will exclude other sections from being included in the response. If no sections are passed, the response will include all available fields. Can be individual or multiple delimited by a comma. |
string |
|
encoded |
Denotes whether cursor query parameters are encoded (default true) |
boolean |
|
validateRequest |
A flag to enable/disable request validation. |
boolean |
|
thirdPartyProperties |
Describes the third party property |
string |
|
prospectFlag |
Indicates if the Third Party is a prospect |
boolean |
|
prospectStatusType |
Describes the status of the Third Party prospect. |
string |
|
deceasedDate |
The date that the third party is deceased (if applicable). Required date format yyyy-MM-ddTHH:mm:ss.SSS. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
countryOfBirth |
Unique Country Code to identify country of birth of a third party. |
string |
|
limit |
Number of records per page (default 25) |
string |
|
systemIdName |
Name of the field from external system. |
string |
|
systemIdValue |
Value of the field from external system. |
string |
|
sortColumn |
Sorts the data |
string |
|
changeStartDate |
Last change start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third parties modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
changeEndDate |
Last change end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
createStartDate |
Created start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
createEndDate |
Created end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
fax |
The contact or third party's fax number. |
string |
Name | Description | Data Type | Required |
---|---|---|---|
Authorization |
access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
string |
|
AppKey |
This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
string |
|
firstName |
First Name of the ThirdParty |
string |
|
middleName |
Middle Name of the ThirdParty |
string |
|
lastName |
Last Name of the ThirdParty |
string |
|
taxId |
Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing. |
string |
|
firstCountryOfCitizenship |
Primary citizenship country for Third Party. |
string |
|
secondCountryOfCitizenship |
Secondary citizenship country for Third Party. |
string |
|
Email for the ThirdParty. A ThirdParty may have none, one or up to four email addresses. If multiple exist, only one email can be primary. |
string |
||
attention1 |
The first attention line of the address, typically used for a specific recipient. |
string |
|
attention2 |
The second attention line of the address. |
string |
|
addressLine1 |
The first line of the address, typically used for the street address. |
string |
|
addressLine2 |
The second line of the address. |
string |
|
addressLine3 |
The third line of the address. |
string |
|
addressLine4 |
The fourth line of the address. |
string |
|
city |
The city of the address. |
string |
|
stateCode |
The two character code for US and Canadian states and provinces. |
string |
|
postalCode |
The postal code of the address. |
string |
|
countryIsoCode |
Mailing Address Country Code |
string |
-
CodeDescription
-
200
OK- The request has succeeded and the response has been returned.
-
400
Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
-
401
Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
-
403
Forbidden -The SEI server understood the request but refuses to fulfill it.
-
404
Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
-
500
Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.
externalId |
Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application. Many times the externalId is used to synchronize SEI sourced data with another data source for the same record. |
nsccId |
The Depository Trust & Clearing Corporation ( DTCC) member id. This value is only populated when the third party is a custodian and a member of the DTCC's Alternative Investment Products. |
alternateId |
Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional. |
classification |
ThirdParty Classification identifier. Valid values are "Individual" or "Entity". |
type |
ThirdParty Type identifier |
active |
Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis. |
clientSpecific |
Flag to indicate if Third Party is Client Specific |
section |
One or more sections can be specified to limit the fields returned in a response. Passing one or more sections will exclude other sections from being included in the response. If no sections are passed, the response will include all available fields. Can be individual or multiple delimited by a comma. |
encoded |
Denotes whether cursor query parameters are encoded (default true) |
validateRequest |
A flag to enable/disable request validation. |
thirdPartyProperties |
Describes the third party property |
prospectFlag |
Indicates if the Third Party is a prospect |
prospectStatusType |
Describes the status of the Third Party prospect. |
deceasedDate |
The date that the third party is deceased (if applicable). Required date format yyyy-MM-ddTHH:mm:ss.SSS. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
countryOfBirth |
Unique Country Code to identify country of birth of a third party. |
limit |
Number of records per page (default 25) |
systemIdName |
Name of the field from external system. |
systemIdValue |
Value of the field from external system. |
sortColumn |
Sorts the data |
changeStartDate |
Last change start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third parties modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
changeEndDate |
Last change end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
createStartDate |
Created start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
createEndDate |
Created end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
fax |
The contact or third party's fax number. |
Authorization |
access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
AppKey |
This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
firstName |
First Name of the ThirdParty |
middleName |
Middle Name of the ThirdParty |
lastName |
Last Name of the ThirdParty |
taxId |
Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing. |
firstCountryOfCitizenship |
Primary citizenship country for Third Party. |
secondCountryOfCitizenship |
Secondary citizenship country for Third Party. |
Email for the ThirdParty. A ThirdParty may have none, one or up to four email addresses. If multiple exist, only one email can be primary. |
|
attention1 |
The first attention line of the address, typically used for a specific recipient. |
attention2 |
The second attention line of the address. |
addressLine1 |
The first line of the address, typically used for the street address. |
addressLine2 |
The second line of the address. |
addressLine3 |
The third line of the address. |
addressLine4 |
The fourth line of the address. |
city |
The city of the address. |
stateCode |
The two character code for US and Canadian states and provinces. |
postalCode |
The postal code of the address. |
countryIsoCode |
Mailing Address Country Code |
Request Body
Working...
Pass the oAuth Token and the App key to invoke this endpoint for a particular application.
Metadata
GET
/metadata
Name | Description | Data Type | Required |
---|---|---|---|
externalId |
Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application. Many times the externalId is used to synchronize SEI sourced data with another data source for the same record. |
string |
|
nsccId |
The Depository Trust & Clearing Corporation ( DTCC) member id. This value is only populated when the third party is a custodian and a member of the DTCC's Alternative Investment Products. |
string |
|
alternateId |
Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional. |
string |
|
classification |
ThirdParty Classification identifier. Valid values are "Individual" or "Entity". |
string |
|
type |
ThirdParty Type identifier |
string |
|
active |
Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis. |
boolean |
|
clientSpecific |
Flag to indicate if Third Party is Client Specific |
boolean |
|
section |
One or more sections can be specified to limit the fields returned in a response. Passing one or more sections will exclude other sections from being included in the response. If no sections are passed, the response will include all available fields. Can be individual or multiple delimited by a comma. |
string |
|
encoded |
Denotes whether cursor query parameters are encoded (default true) |
boolean |
|
validateRequest |
A flag to enable/disable request validation. |
boolean |
|
thirdPartyProperties |
Describes the third party property |
string |
|
prospectFlag |
Indicates if the Third Party is a prospect |
boolean |
|
prospectStatusType |
Describes the status of the Third Party prospect. |
string |
|
deceasedDate |
The date that the third party is deceased (if applicable). Required date format yyyy-MM-ddTHH:mm:ss.SSS. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
countryOfBirth |
Unique Country Code to identify country of birth of a third party. |
string |
|
limit |
Number of records per page (default 25) |
string |
|
systemIdName |
Name of the field from external system. |
string |
|
systemIdValue |
Value of the field from external system. |
string |
|
sortColumn |
Sorts the data |
string |
|
changeStartDate |
Last change start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third parties modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
changeEndDate |
Last change end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
createStartDate |
Created start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
createEndDate |
Created end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
fax |
The contact or third party's fax number. |
string |
Name | Description | Data Type | Required |
---|---|---|---|
Authorization |
access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
string |
|
AppKey |
This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
string |
|
firstName |
First Name of the ThirdParty |
string |
|
middleName |
Middle Name of the ThirdParty |
string |
|
lastName |
Last Name of the ThirdParty |
string |
|
taxId |
Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing. |
string |
|
firstCountryOfCitizenship |
Primary citizenship country for Third Party. |
string |
|
secondCountryOfCitizenship |
Secondary citizenship country for Third Party. |
string |
|
Email for the ThirdParty. A ThirdParty may have none, one or up to four email addresses. If multiple exist, only one email can be primary. |
string |
||
attention1 |
The first attention line of the address, typically used for a specific recipient. |
string |
|
attention2 |
The second attention line of the address. |
string |
|
addressLine1 |
The first line of the address, typically used for the street address. |
string |
|
addressLine2 |
The second line of the address. |
string |
|
addressLine3 |
The third line of the address. |
string |
|
addressLine4 |
The fourth line of the address. |
string |
|
city |
The city of the address. |
string |
|
stateCode |
The two character code for US and Canadian states and provinces. |
string |
|
postalCode |
The postal code of the address. |
string |
|
countryIsoCode |
Mailing Address Country Code |
string |
-
CodeDescription
-
200
OK- The request has succeeded and the response has been returned.
-
400
Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
-
401
Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
-
403
Forbidden -The SEI server understood the request but refuses to fulfill it.
-
404
Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
-
500
Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.
externalId |
Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application. Many times the externalId is used to synchronize SEI sourced data with another data source for the same record. |
nsccId |
The Depository Trust & Clearing Corporation ( DTCC) member id. This value is only populated when the third party is a custodian and a member of the DTCC's Alternative Investment Products. |
alternateId |
Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional. |
classification |
ThirdParty Classification identifier. Valid values are "Individual" or "Entity". |
type |
ThirdParty Type identifier |
active |
Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis. |
clientSpecific |
Flag to indicate if Third Party is Client Specific |
section |
One or more sections can be specified to limit the fields returned in a response. Passing one or more sections will exclude other sections from being included in the response. If no sections are passed, the response will include all available fields. Can be individual or multiple delimited by a comma. |
encoded |
Denotes whether cursor query parameters are encoded (default true) |
validateRequest |
A flag to enable/disable request validation. |
thirdPartyProperties |
Describes the third party property |
prospectFlag |
Indicates if the Third Party is a prospect |
prospectStatusType |
Describes the status of the Third Party prospect. |
deceasedDate |
The date that the third party is deceased (if applicable). Required date format yyyy-MM-ddTHH:mm:ss.SSS. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
countryOfBirth |
Unique Country Code to identify country of birth of a third party. |
limit |
Number of records per page (default 25) |
systemIdName |
Name of the field from external system. |
systemIdValue |
Value of the field from external system. |
sortColumn |
Sorts the data |
changeStartDate |
Last change start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third parties modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
changeEndDate |
Last change end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
createStartDate |
Created start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
createEndDate |
Created end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
fax |
The contact or third party's fax number. |
Authorization |
access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
AppKey |
This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
firstName |
First Name of the ThirdParty |
middleName |
Middle Name of the ThirdParty |
lastName |
Last Name of the ThirdParty |
taxId |
Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing. |
firstCountryOfCitizenship |
Primary citizenship country for Third Party. |
secondCountryOfCitizenship |
Secondary citizenship country for Third Party. |
Email for the ThirdParty. A ThirdParty may have none, one or up to four email addresses. If multiple exist, only one email can be primary. |
|
attention1 |
The first attention line of the address, typically used for a specific recipient. |
attention2 |
The second attention line of the address. |
addressLine1 |
The first line of the address, typically used for the street address. |
addressLine2 |
The second line of the address. |
addressLine3 |
The third line of the address. |
addressLine4 |
The fourth line of the address. |
city |
The city of the address. |
stateCode |
The two character code for US and Canadian states and provinces. |
postalCode |
The postal code of the address. |
countryIsoCode |
Mailing Address Country Code |
Request Body
Working...
curl --location --request GET 'https://api.seic.com/v3/thirdparties/metadata' \ --header 'Authorization: Bearer ADsgdnnkjnfdIKJN' \ --header 'AppKey: gsedgaerhDSHGRSH'
Authorization: Bearer ADsgdnnkjnfdIKJN AppKey: gsedgaerhDSHGRSH
Content: Type: application/json Status: 200 OK Requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9
{ "data": [ { "externalId": "1234", "nsccId": null, "alternateId": "10000", "type": "Contact", "active": true, "clientId": "1111", "classification": "Individual", "employmentStatus": null, "occupation": null, "annualIncomeType": null, "lastNetProfit": null, "lastNetProfitCurrency": null, "incomeTaxBandRate": null, "annualIncome": null, "changeDate": "2021-01-28T21:39:21.78", "annualIncomeCurrency": null, "createDate": "2020-12-11T03:33:08.02", "prospectFlag": "false", "prospectStatusType": "InterestedParty", "clientSpecific": true, "attributes": [ { "name": "string", "value": "string", "explanation": null } ], "pii": { "fullName": "string", "prefix": null, "firstName": "string", "middleName": "string", "lastName": "string", "suffix": null, "gender": null, "maritalStatus": null, "taxType": null, "taxId": null, "birthDateDateOfFormation": null, "countryOfBirth": null, "countryOfDomicile": null, "firstCountryOfCitizenship": null, "secondCountryOfCitizenship": null, "deceasedDate": null }, "address": [ { "type": "Legal", "attention1": null, "attention2": "string", "addressLine1": "string", "addressLine2": "string", "addressLine3": null, "addressLine4": null, "city": "string", "stateCode": "string", "postalCode": "10000", "countryIsoCode": "US", "salutation": null } ], "email": [ { "email": "test@email.com", "type": "Work", "primary": true }, { "email": "test@email.com", "type": "Group", "primary": false } ], "phone": [ { "phone": "+1 200 700-3000", "phoneExtension": null, "type": "Work", "primary": true, "countryIsoCode": "US", "fax": null } ], "phoneNumbers": { "fax": "string", "phone": [ { "phone": "string", "type": "string", "primary": "string", "countryIsoCode": "string" } ] }, "systemIdentifier": [ { "name": "IMS", "value": "1234" } ], "thirdPartyProperties": "Non Disclosure Agreement" } ], "paging": { "cursors": { "before": "NDM1NTcw", "after": "NDM1NTcw", "max": "NDM1NTcw", "last": null, "resultCount": 1 }, "totalCount": 1, "limit": 100, "previous": null, "next": null, "self": "https://api.seic.com/v3/thirdparties/metadata?externalId=1234&limit=100", "first": "https://api.seic.com/v3/thirdparties/metadata?externalId=1234&limit=100", "last": null } }
Metadata
GET
/metadata
Name | Description | Data Type | Required |
---|---|---|---|
externalId |
Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application. Many times the externalId is used to synchronize SEI sourced data with another data source for the same record. |
string |
|
nsccId |
The Depository Trust & Clearing Corporation ( DTCC) member id. This value is only populated when the third party is a custodian and a member of the DTCC's Alternative Investment Products. |
string |
|
alternateId |
Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional. |
string |
|
classification |
ThirdParty Classification identifier. Valid values are "Individual" or "Entity". |
string |
|
type |
ThirdParty Type identifier |
string |
|
active |
Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis. |
boolean |
|
clientSpecific |
Flag to indicate if Third Party is Client Specific |
boolean |
|
section |
One or more sections can be specified to limit the fields returned in a response. Passing one or more sections will exclude other sections from being included in the response. If no sections are passed, the response will include all available fields. Can be individual or multiple delimited by a comma. |
string |
|
encoded |
Denotes whether cursor query parameters are encoded (default true) |
boolean |
|
validateRequest |
A flag to enable/disable request validation. |
boolean |
|
thirdPartyProperties |
Describes the third party property |
string |
|
prospectFlag |
Indicates if the Third Party is a prospect |
boolean |
|
prospectStatusType |
Describes the status of the Third Party prospect. |
string |
|
deceasedDate |
The date that the third party is deceased (if applicable). Required date format yyyy-MM-ddTHH:mm:ss.SSS. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
countryOfBirth |
Unique Country Code to identify country of birth of a third party. |
string |
|
limit |
Number of records per page (default 25) |
string |
|
systemIdName |
Name of the field from external system. |
string |
|
systemIdValue |
Value of the field from external system. |
string |
|
sortColumn |
Sorts the data |
string |
|
changeStartDate |
Last change start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third parties modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
changeEndDate |
Last change end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
createStartDate |
Created start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
createEndDate |
Created end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
fax |
The contact or third party's fax number. |
string |
Name | Description | Data Type | Required |
---|---|---|---|
Authorization |
access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
string |
|
AppKey |
This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
string |
|
firstName |
First Name of the ThirdParty |
string |
|
middleName |
Middle Name of the ThirdParty |
string |
|
lastName |
Last Name of the ThirdParty |
string |
|
taxId |
Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing. |
string |
|
firstCountryOfCitizenship |
Primary citizenship country for Third Party. |
string |
|
secondCountryOfCitizenship |
Secondary citizenship country for Third Party. |
string |
|
Email for the ThirdParty. A ThirdParty may have none, one or up to four email addresses. If multiple exist, only one email can be primary. |
string |
||
attention1 |
The first attention line of the address, typically used for a specific recipient. |
string |
|
attention2 |
The second attention line of the address. |
string |
|
addressLine1 |
The first line of the address, typically used for the street address. |
string |
|
addressLine2 |
The second line of the address. |
string |
|
addressLine3 |
The third line of the address. |
string |
|
addressLine4 |
The fourth line of the address. |
string |
|
city |
The city of the address. |
string |
|
stateCode |
The two character code for US and Canadian states and provinces. |
string |
|
postalCode |
The postal code of the address. |
string |
|
countryIsoCode |
Mailing Address Country Code |
string |
-
CodeDescription
-
200
OK- The request has succeeded and the response has been returned.
-
400
Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
-
401
Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
-
403
Forbidden -The SEI server understood the request but refuses to fulfill it.
-
404
Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
-
500
Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.
externalId |
Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application. Many times the externalId is used to synchronize SEI sourced data with another data source for the same record. |
nsccId |
The Depository Trust & Clearing Corporation ( DTCC) member id. This value is only populated when the third party is a custodian and a member of the DTCC's Alternative Investment Products. |
alternateId |
Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional. |
classification |
ThirdParty Classification identifier. Valid values are "Individual" or "Entity". |
type |
ThirdParty Type identifier |
active |
Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis. |
clientSpecific |
Flag to indicate if Third Party is Client Specific |
section |
One or more sections can be specified to limit the fields returned in a response. Passing one or more sections will exclude other sections from being included in the response. If no sections are passed, the response will include all available fields. Can be individual or multiple delimited by a comma. |
encoded |
Denotes whether cursor query parameters are encoded (default true) |
validateRequest |
A flag to enable/disable request validation. |
thirdPartyProperties |
Describes the third party property |
prospectFlag |
Indicates if the Third Party is a prospect |
prospectStatusType |
Describes the status of the Third Party prospect. |
deceasedDate |
The date that the third party is deceased (if applicable). Required date format yyyy-MM-ddTHH:mm:ss.SSS. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
countryOfBirth |
Unique Country Code to identify country of birth of a third party. |
limit |
Number of records per page (default 25) |
systemIdName |
Name of the field from external system. |
systemIdValue |
Value of the field from external system. |
sortColumn |
Sorts the data |
changeStartDate |
Last change start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third parties modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
changeEndDate |
Last change end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
createStartDate |
Created start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
createEndDate |
Created end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
fax |
The contact or third party's fax number. |
Authorization |
access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
AppKey |
This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
firstName |
First Name of the ThirdParty |
middleName |
Middle Name of the ThirdParty |
lastName |
Last Name of the ThirdParty |
taxId |
Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing. |
firstCountryOfCitizenship |
Primary citizenship country for Third Party. |
secondCountryOfCitizenship |
Secondary citizenship country for Third Party. |
Email for the ThirdParty. A ThirdParty may have none, one or up to four email addresses. If multiple exist, only one email can be primary. |
|
attention1 |
The first attention line of the address, typically used for a specific recipient. |
attention2 |
The second attention line of the address. |
addressLine1 |
The first line of the address, typically used for the street address. |
addressLine2 |
The second line of the address. |
addressLine3 |
The third line of the address. |
addressLine4 |
The fourth line of the address. |
city |
The city of the address. |
stateCode |
The two character code for US and Canadian states and provinces. |
postalCode |
The postal code of the address. |
countryIsoCode |
Mailing Address Country Code |
Request Body
Working...
Metadata
GET
/metadata
Name | Description | Data Type | Required |
---|---|---|---|
externalId |
Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application. Many times the externalId is used to synchronize SEI sourced data with another data source for the same record. |
string |
|
nsccId |
The Depository Trust & Clearing Corporation ( DTCC) member id. This value is only populated when the third party is a custodian and a member of the DTCC's Alternative Investment Products. |
string |
|
alternateId |
Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional. |
string |
|
classification |
ThirdParty Classification identifier. Valid values are "Individual" or "Entity". |
string |
|
type |
ThirdParty Type identifier |
string |
|
active |
Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis. |
boolean |
|
clientSpecific |
Flag to indicate if Third Party is Client Specific |
boolean |
|
section |
One or more sections can be specified to limit the fields returned in a response. Passing one or more sections will exclude other sections from being included in the response. If no sections are passed, the response will include all available fields. Can be individual or multiple delimited by a comma. |
string |
|
encoded |
Denotes whether cursor query parameters are encoded (default true) |
boolean |
|
validateRequest |
A flag to enable/disable request validation. |
boolean |
|
thirdPartyProperties |
Describes the third party property |
string |
|
prospectFlag |
Indicates if the Third Party is a prospect |
boolean |
|
prospectStatusType |
Describes the status of the Third Party prospect. |
string |
|
deceasedDate |
The date that the third party is deceased (if applicable). Required date format yyyy-MM-ddTHH:mm:ss.SSS. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
countryOfBirth |
Unique Country Code to identify country of birth of a third party. |
string |
|
limit |
Number of records per page (default 25) |
string |
|
systemIdName |
Name of the field from external system. |
string |
|
systemIdValue |
Value of the field from external system. |
string |
|
sortColumn |
Sorts the data |
string |
|
changeStartDate |
Last change start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third parties modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
changeEndDate |
Last change end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
createStartDate |
Created start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
createEndDate |
Created end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
fax |
The contact or third party's fax number. |
string |
Name | Description | Data Type | Required |
---|---|---|---|
Authorization |
access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
string |
|
AppKey |
This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
string |
|
firstName |
First Name of the ThirdParty |
string |
|
middleName |
Middle Name of the ThirdParty |
string |
|
lastName |
Last Name of the ThirdParty |
string |
|
taxId |
Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing. |
string |
|
firstCountryOfCitizenship |
Primary citizenship country for Third Party. |
string |
|
secondCountryOfCitizenship |
Secondary citizenship country for Third Party. |
string |
|
Email for the ThirdParty. A ThirdParty may have none, one or up to four email addresses. If multiple exist, only one email can be primary. |
string |
||
attention1 |
The first attention line of the address, typically used for a specific recipient. |
string |
|
attention2 |
The second attention line of the address. |
string |
|
addressLine1 |
The first line of the address, typically used for the street address. |
string |
|
addressLine2 |
The second line of the address. |
string |
|
addressLine3 |
The third line of the address. |
string |
|
addressLine4 |
The fourth line of the address. |
string |
|
city |
The city of the address. |
string |
|
stateCode |
The two character code for US and Canadian states and provinces. |
string |
|
postalCode |
The postal code of the address. |
string |
|
countryIsoCode |
Mailing Address Country Code |
string |
-
CodeDescription
-
200
OK- The request has succeeded and the response has been returned.
-
400
Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
-
401
Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
-
403
Forbidden -The SEI server understood the request but refuses to fulfill it.
-
404
Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
-
500
Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.
externalId |
Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application. Many times the externalId is used to synchronize SEI sourced data with another data source for the same record. |
nsccId |
The Depository Trust & Clearing Corporation ( DTCC) member id. This value is only populated when the third party is a custodian and a member of the DTCC's Alternative Investment Products. |
alternateId |
Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional. |
classification |
ThirdParty Classification identifier. Valid values are "Individual" or "Entity". |
type |
ThirdParty Type identifier |
active |
Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis. |
clientSpecific |
Flag to indicate if Third Party is Client Specific |
section |
One or more sections can be specified to limit the fields returned in a response. Passing one or more sections will exclude other sections from being included in the response. If no sections are passed, the response will include all available fields. Can be individual or multiple delimited by a comma. |
encoded |
Denotes whether cursor query parameters are encoded (default true) |
validateRequest |
A flag to enable/disable request validation. |
thirdPartyProperties |
Describes the third party property |
prospectFlag |
Indicates if the Third Party is a prospect |
prospectStatusType |
Describes the status of the Third Party prospect. |
deceasedDate |
The date that the third party is deceased (if applicable). Required date format yyyy-MM-ddTHH:mm:ss.SSS. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
countryOfBirth |
Unique Country Code to identify country of birth of a third party. |
limit |
Number of records per page (default 25) |
systemIdName |
Name of the field from external system. |
systemIdValue |
Value of the field from external system. |
sortColumn |
Sorts the data |
changeStartDate |
Last change start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third parties modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
changeEndDate |
Last change end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
createStartDate |
Created start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
createEndDate |
Created end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
fax |
The contact or third party's fax number. |
Authorization |
access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
AppKey |
This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
firstName |
First Name of the ThirdParty |
middleName |
Middle Name of the ThirdParty |
lastName |
Last Name of the ThirdParty |
taxId |
Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing. |
firstCountryOfCitizenship |
Primary citizenship country for Third Party. |
secondCountryOfCitizenship |
Secondary citizenship country for Third Party. |
Email for the ThirdParty. A ThirdParty may have none, one or up to four email addresses. If multiple exist, only one email can be primary. |
|
attention1 |
The first attention line of the address, typically used for a specific recipient. |
attention2 |
The second attention line of the address. |
addressLine1 |
The first line of the address, typically used for the street address. |
addressLine2 |
The second line of the address. |
addressLine3 |
The third line of the address. |
addressLine4 |
The fourth line of the address. |
city |
The city of the address. |
stateCode |
The two character code for US and Canadian states and provinces. |
postalCode |
The postal code of the address. |
countryIsoCode |
Mailing Address Country Code |
Request Body
Working...
Pass the oAuth Token and the App key to invoke this endpoint for a particular application.
Metadata
GET
/metadata
Name | Description | Data Type | Required |
---|---|---|---|
externalId |
Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application. Many times the externalId is used to synchronize SEI sourced data with another data source for the same record. |
string |
|
nsccId |
The Depository Trust & Clearing Corporation ( DTCC) member id. This value is only populated when the third party is a custodian and a member of the DTCC's Alternative Investment Products. |
string |
|
alternateId |
Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional. |
string |
|
classification |
ThirdParty Classification identifier. Valid values are "Individual" or "Entity". |
string |
|
type |
ThirdParty Type identifier |
string |
|
active |
Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis. |
boolean |
|
clientSpecific |
Flag to indicate if Third Party is Client Specific |
boolean |
|
section |
One or more sections can be specified to limit the fields returned in a response. Passing one or more sections will exclude other sections from being included in the response. If no sections are passed, the response will include all available fields. Can be individual or multiple delimited by a comma. |
string |
|
encoded |
Denotes whether cursor query parameters are encoded (default true) |
boolean |
|
validateRequest |
A flag to enable/disable request validation. |
boolean |
|
thirdPartyProperties |
Describes the third party property |
string |
|
prospectFlag |
Indicates if the Third Party is a prospect |
boolean |
|
prospectStatusType |
Describes the status of the Third Party prospect. |
string |
|
deceasedDate |
The date that the third party is deceased (if applicable). Required date format yyyy-MM-ddTHH:mm:ss.SSS. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
countryOfBirth |
Unique Country Code to identify country of birth of a third party. |
string |
|
limit |
Number of records per page (default 25) |
string |
|
systemIdName |
Name of the field from external system. |
string |
|
systemIdValue |
Value of the field from external system. |
string |
|
sortColumn |
Sorts the data |
string |
|
changeStartDate |
Last change start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third parties modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
changeEndDate |
Last change end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
createStartDate |
Created start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
createEndDate |
Created end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
fax |
The contact or third party's fax number. |
string |
Name | Description | Data Type | Required |
---|---|---|---|
Authorization |
access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
string |
|
AppKey |
This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
string |
|
firstName |
First Name of the ThirdParty |
string |
|
middleName |
Middle Name of the ThirdParty |
string |
|
lastName |
Last Name of the ThirdParty |
string |
|
taxId |
Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing. |
string |
|
firstCountryOfCitizenship |
Primary citizenship country for Third Party. |
string |
|
secondCountryOfCitizenship |
Secondary citizenship country for Third Party. |
string |
|
Email for the ThirdParty. A ThirdParty may have none, one or up to four email addresses. If multiple exist, only one email can be primary. |
string |
||
attention1 |
The first attention line of the address, typically used for a specific recipient. |
string |
|
attention2 |
The second attention line of the address. |
string |
|
addressLine1 |
The first line of the address, typically used for the street address. |
string |
|
addressLine2 |
The second line of the address. |
string |
|
addressLine3 |
The third line of the address. |
string |
|
addressLine4 |
The fourth line of the address. |
string |
|
city |
The city of the address. |
string |
|
stateCode |
The two character code for US and Canadian states and provinces. |
string |
|
postalCode |
The postal code of the address. |
string |
|
countryIsoCode |
Mailing Address Country Code |
string |
-
CodeDescription
-
200
OK- The request has succeeded and the response has been returned.
-
400
Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
-
401
Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
-
403
Forbidden -The SEI server understood the request but refuses to fulfill it.
-
404
Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
-
500
Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.
externalId |
Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application. Many times the externalId is used to synchronize SEI sourced data with another data source for the same record. |
nsccId |
The Depository Trust & Clearing Corporation ( DTCC) member id. This value is only populated when the third party is a custodian and a member of the DTCC's Alternative Investment Products. |
alternateId |
Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional. |
classification |
ThirdParty Classification identifier. Valid values are "Individual" or "Entity". |
type |
ThirdParty Type identifier |
active |
Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis. |
clientSpecific |
Flag to indicate if Third Party is Client Specific |
section |
One or more sections can be specified to limit the fields returned in a response. Passing one or more sections will exclude other sections from being included in the response. If no sections are passed, the response will include all available fields. Can be individual or multiple delimited by a comma. |
encoded |
Denotes whether cursor query parameters are encoded (default true) |
validateRequest |
A flag to enable/disable request validation. |
thirdPartyProperties |
Describes the third party property |
prospectFlag |
Indicates if the Third Party is a prospect |
prospectStatusType |
Describes the status of the Third Party prospect. |
deceasedDate |
The date that the third party is deceased (if applicable). Required date format yyyy-MM-ddTHH:mm:ss.SSS. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
countryOfBirth |
Unique Country Code to identify country of birth of a third party. |
limit |
Number of records per page (default 25) |
systemIdName |
Name of the field from external system. |
systemIdValue |
Value of the field from external system. |
sortColumn |
Sorts the data |
changeStartDate |
Last change start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third parties modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
changeEndDate |
Last change end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
createStartDate |
Created start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
createEndDate |
Created end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
fax |
The contact or third party's fax number. |
Authorization |
access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
AppKey |
This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
firstName |
First Name of the ThirdParty |
middleName |
Middle Name of the ThirdParty |
lastName |
Last Name of the ThirdParty |
taxId |
Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing. |
firstCountryOfCitizenship |
Primary citizenship country for Third Party. |
secondCountryOfCitizenship |
Secondary citizenship country for Third Party. |
Email for the ThirdParty. A ThirdParty may have none, one or up to four email addresses. If multiple exist, only one email can be primary. |
|
attention1 |
The first attention line of the address, typically used for a specific recipient. |
attention2 |
The second attention line of the address. |
addressLine1 |
The first line of the address, typically used for the street address. |
addressLine2 |
The second line of the address. |
addressLine3 |
The third line of the address. |
addressLine4 |
The fourth line of the address. |
city |
The city of the address. |
stateCode |
The two character code for US and Canadian states and provinces. |
postalCode |
The postal code of the address. |
countryIsoCode |
Mailing Address Country Code |
Request Body
Working...
curl --location --request GET 'https://api.seic.com/v3/thirdparties/metadata' \ --header 'Authorization: Bearer ADsgdnnkjnfdIKJN' \ --header 'AppKey: gsedgaerhDSHGRSH'
Authorization: Bearer ADsgdnnkjnfdIKJN AppKey: gsedgaerhDSHGRSH
Content: Type: application/json Status: 200 OK Requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9
{ "data": [ { "externalId": "1234", "nsccId": null, "alternateId": "10000", "type": "Contact", "active": true, "clientId": "1111", "classification": "Individual", "employmentStatus": null, "occupation": null, "annualIncomeType": null, "lastNetProfit": null, "lastNetProfitCurrency": null, "incomeTaxBandRate": null, "annualIncome": null, "changeDate": "2021-01-28T21:39:21.78", "annualIncomeCurrency": null, "createDate": "2020-12-11T03:33:08.02", "prospectFlag": "false", "prospectStatusType": "InterestedParty", "clientSpecific": true, "attributes": [ { "name": "string", "value": "string", "explanation": null } ], "pii": { "fullName": "string", "prefix": null, "firstName": "string", "middleName": "string", "lastName": "string", "suffix": null, "gender": null, "maritalStatus": null, "taxType": null, "taxId": null, "birthDateDateOfFormation": null, "countryOfBirth": null, "countryOfDomicile": null, "firstCountryOfCitizenship": null, "secondCountryOfCitizenship": null, "deceasedDate": null }, "address": [ { "type": "Legal", "attention1": null, "attention2": "string", "addressLine1": "string", "addressLine2": "string", "addressLine3": null, "addressLine4": null, "city": "string", "stateCode": "string", "postalCode": "10000", "countryIsoCode": "US", "salutation": null } ], "email": [ { "email": "test@email.com", "type": "Work", "primary": true }, { "email": "test@email.com", "type": "Group", "primary": false } ], "phone": [ { "phone": "+1 200 700-3000", "phoneExtension": null, "type": "Work", "primary": true, "countryIsoCode": "US", "fax": null } ], "phoneNumbers": { "fax": "string", "phone": [ { "phone": "string", "type": "string", "primary": "string", "countryIsoCode": "string" } ] }, "systemIdentifier": [ { "name": "IMS", "value": "1234" } ], "thirdPartyProperties": "Non Disclosure Agreement" } ], "paging": { "cursors": { "before": "NDM1NTcw", "after": "NDM1NTcw", "max": "NDM1NTcw", "last": null, "resultCount": 1 }, "totalCount": 1, "limit": 100, "previous": null, "next": null, "self": "https://api.seic.com/v3/thirdparties/metadata?externalId=1234&limit=100", "first": "https://api.seic.com/v3/thirdparties/metadata?externalId=1234&limit=100", "last": null } }
Metadata
GET
/metadata
Name | Description | Data Type | Required |
---|---|---|---|
externalId |
Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application. Many times the externalId is used to synchronize SEI sourced data with another data source for the same record. |
string |
|
nsccId |
The Depository Trust & Clearing Corporation ( DTCC) member id. This value is only populated when the third party is a custodian and a member of the DTCC's Alternative Investment Products. |
string |
|
alternateId |
Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional. |
string |
|
classification |
ThirdParty Classification identifier. Valid values are "Individual" or "Entity". |
string |
|
type |
ThirdParty Type identifier |
string |
|
active |
Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis. |
boolean |
|
clientSpecific |
Flag to indicate if Third Party is Client Specific |
boolean |
|
section |
One or more sections can be specified to limit the fields returned in a response. Passing one or more sections will exclude other sections from being included in the response. If no sections are passed, the response will include all available fields. Can be individual or multiple delimited by a comma. |
string |
|
encoded |
Denotes whether cursor query parameters are encoded (default true) |
boolean |
|
validateRequest |
A flag to enable/disable request validation. |
boolean |
|
thirdPartyProperties |
Describes the third party property |
string |
|
prospectFlag |
Indicates if the Third Party is a prospect |
boolean |
|
prospectStatusType |
Describes the status of the Third Party prospect. |
string |
|
deceasedDate |
The date that the third party is deceased (if applicable). Required date format yyyy-MM-ddTHH:mm:ss.SSS. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
countryOfBirth |
Unique Country Code to identify country of birth of a third party. |
string |
|
limit |
Number of records per page (default 25) |
string |
|
systemIdName |
Name of the field from external system. |
string |
|
systemIdValue |
Value of the field from external system. |
string |
|
sortColumn |
Sorts the data |
string |
|
changeStartDate |
Last change start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third parties modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
changeEndDate |
Last change end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
createStartDate |
Created start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
createEndDate |
Created end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
string |
|
fax |
The contact or third party's fax number. |
string |
Name | Description | Data Type | Required |
---|---|---|---|
Authorization |
access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
string |
|
AppKey |
This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
string |
|
firstName |
First Name of the ThirdParty |
string |
|
middleName |
Middle Name of the ThirdParty |
string |
|
lastName |
Last Name of the ThirdParty |
string |
|
taxId |
Primary tax identifier for the Investor or Contact or Third party. When used in a search, is the full digits or characters, less special characters and spacing. |
string |
|
firstCountryOfCitizenship |
Primary citizenship country for Third Party. |
string |
|
secondCountryOfCitizenship |
Secondary citizenship country for Third Party. |
string |
|
Email for the ThirdParty. A ThirdParty may have none, one or up to four email addresses. If multiple exist, only one email can be primary. |
string |
||
attention1 |
The first attention line of the address, typically used for a specific recipient. |
string |
|
attention2 |
The second attention line of the address. |
string |
|
addressLine1 |
The first line of the address, typically used for the street address. |
string |
|
addressLine2 |
The second line of the address. |
string |
|
addressLine3 |
The third line of the address. |
string |
|
addressLine4 |
The fourth line of the address. |
string |
|
city |
The city of the address. |
string |
|
stateCode |
The two character code for US and Canadian states and provinces. |
string |
|
postalCode |
The postal code of the address. |
string |
|
countryIsoCode |
Mailing Address Country Code |
string |
-
CodeDescription
-
200
OK- The request has succeeded and the response has been returned.
-
400
Bad request - The server cannot or will not process the request due to an inaccurate request submitted by the client application. Please resubmit the request after making the required corrections indicated in the error response. For more Info on SEI Error Standards please refer to the API Standards FAQ under Support.
-
401
Unauthorized - Invalid authentication details have been provided. Also useful to trigger an authorization pop up if the API is used from a browser.
-
403
Forbidden -The SEI server understood the request but refuses to fulfill it.
-
404
Not Found- The requested resource or the underlying resource does not exist. Please resubmit the request after making the required corrections
-
500
Internal Server Error - The server was unable to fulfill the request due to an unknown condition. Please contact SEI for support. For More Info please refer to the "Response & Errors" FAQ under support.
externalId |
Unique business identifier that represents a contact, investor, product, transaction or alternate entity recognized by SEI and a third party system or application. Many times the externalId is used to synchronize SEI sourced data with another data source for the same record. |
nsccId |
The Depository Trust & Clearing Corporation ( DTCC) member id. This value is only populated when the third party is a custodian and a member of the DTCC's Alternative Investment Products. |
alternateId |
Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional. |
classification |
ThirdParty Classification identifier. Valid values are "Individual" or "Entity". |
type |
ThirdParty Type identifier |
active |
Designates whether the record is active or inactive. Typically an inactive record is no longer referenced, or expected to be referenced, on a regular basis. |
clientSpecific |
Flag to indicate if Third Party is Client Specific |
section |
One or more sections can be specified to limit the fields returned in a response. Passing one or more sections will exclude other sections from being included in the response. If no sections are passed, the response will include all available fields. Can be individual or multiple delimited by a comma. |
encoded |
Denotes whether cursor query parameters are encoded (default true) |
validateRequest |
A flag to enable/disable request validation. |
thirdPartyProperties |
Describes the third party property |
prospectFlag |
Indicates if the Third Party is a prospect |
prospectStatusType |
Describes the status of the Third Party prospect. |
deceasedDate |
The date that the third party is deceased (if applicable). Required date format yyyy-MM-ddTHH:mm:ss.SSS. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
countryOfBirth |
Unique Country Code to identify country of birth of a third party. |
limit |
Number of records per page (default 25) |
systemIdName |
Name of the field from external system. |
systemIdValue |
Value of the field from external system. |
sortColumn |
Sorts the data |
changeStartDate |
Last change start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third parties modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
changeEndDate |
Last change end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party modified on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
createStartDate |
Created start date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
createEndDate |
Created end date for the third party. Required date format yyyy-MM-ddTHH:mm:ss.SSS. Can be used to target third party created on, since or between specified datetime. Date only can also be accepted. Datetime is Eastern Standard Time (EST). |
fax |
The contact or third party's fax number. |
Authorization |
access_token value obtained from the Token endpoint.This is passed as "Bearer access_token" |
AppKey |
This is the Consumer Key provided during the App Registration process and is used to identify the user's application. |
firstName |
First Name of the ThirdParty |
middleName |
Middle Name of the ThirdParty |
lastName |
Last Name of the ThirdParty |
taxId |