Relationships

relationships

GET

/relationships

Returns links between a third party and a firm, product and/or investor along with attributes specific to that relationship.

Prod:
https://api.seic.com/v1/thirdparties/relationships
Query Parameters
Name Description Data Type Required
alternateId

Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.

string

productInvestorExternalId

Business identifier for the investor product relationship recognized by a third party system or application. Many times the externalProductInvestorId is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

string

relationshipExternalId

Business identifier for the third party relationship recognized by an external system or application. Many times the relationship external id is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

string

relationshipEntity

string

type

Specifies the type of product or subproduct. A full list of product types can be obtained through the Lists API.

string

subType

A secondary or subordinate type included within a more general type. Investors, Contacts, Transactions and Products all have associated types and subtypes to further describe these entities.

string

primary

Indicates that the email is the primary email if there is more than one.

string

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

createDate

Initial create timestamp for the record. Datetime is Eastern Standard Time (EST).

string

changeDate

Latest date the entity relevant to the API was modified. Date is in ISO 8601 format YYYY-MM-DD. Datetime is Eastern Standard Time (EST).

string

advisorId

Business identifier for the financial advisor.

string

attributeName

A characteristic that further defines the contact's relationship to the investor in a system consumable format, typically the attribute display name without spaces.

string

investorExternalId

Unique business identifier for the investor.

string

productExternalId

Unique business identifier for a product recognized by SEI and a third party system or application. Many times the productExternalId is used to synchronize SEI sourced data with another data source for the same record. Every product has an externalId.

string

Header Parameters
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

email

The email address at which communications can be sent or received.

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.

string

idbRole

Role that drives permissions in SEI Investor Dashboard to control what a contact can see and do.

string

HTTP Responses
  • Code
    Description
  • 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.

TEST ENDPOINT
alternateId

Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.

productInvestorExternalId

Business identifier for the investor product relationship recognized by a third party system or application. Many times the externalProductInvestorId is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

relationshipExternalId

Business identifier for the third party relationship recognized by an external system or application. Many times the relationship external id is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

relationshipEntity

type

Specifies the type of product or subproduct. A full list of product types can be obtained through the Lists API.

subType

A secondary or subordinate type included within a more general type. Investors, Contacts, Transactions and Products all have associated types and subtypes to further describe these entities.

primary

Indicates that the email is the primary email if there is more than one.

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.

createDate

Initial create timestamp for the record. Datetime is Eastern Standard Time (EST).

changeDate

Latest date the entity relevant to the API was modified. Date is in ISO 8601 format YYYY-MM-DD. Datetime is Eastern Standard Time (EST).

advisorId

Business identifier for the financial advisor.

attributeName

A characteristic that further defines the contact's relationship to the investor in a system consumable format, typically the attribute display name without spaces.

investorExternalId

Unique business identifier for the investor.

productExternalId

Unique business identifier for a product recognized by SEI and a third party system or application. Many times the productExternalId is used to synchronize SEI sourced data with another data source for the same record. Every product has an externalId.

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.

email

The email address at which communications can be sent or received.

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.

idbRole

Role that drives permissions in SEI Investor Dashboard to control what a contact can see and do.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...

Relationships

relationships

GET

/relationships

Returns links between a third party and a firm, product and/or investor along with attributes specific to that relationship.

Prod:
https://api.seic.com/v1/thirdparties/relationships
Query Parameters
Name Description Data Type Required
alternateId

Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.

string

productInvestorExternalId

Business identifier for the investor product relationship recognized by a third party system or application. Many times the externalProductInvestorId is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

string

relationshipExternalId

Business identifier for the third party relationship recognized by an external system or application. Many times the relationship external id is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

string

relationshipEntity

string

type

Specifies the type of product or subproduct. A full list of product types can be obtained through the Lists API.

string

subType

A secondary or subordinate type included within a more general type. Investors, Contacts, Transactions and Products all have associated types and subtypes to further describe these entities.

string

primary

Indicates that the email is the primary email if there is more than one.

string

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

createDate

Initial create timestamp for the record. Datetime is Eastern Standard Time (EST).

string

changeDate

Latest date the entity relevant to the API was modified. Date is in ISO 8601 format YYYY-MM-DD. Datetime is Eastern Standard Time (EST).

string

advisorId

Business identifier for the financial advisor.

string

attributeName

A characteristic that further defines the contact's relationship to the investor in a system consumable format, typically the attribute display name without spaces.

string

investorExternalId

Unique business identifier for the investor.

string

productExternalId

Unique business identifier for a product recognized by SEI and a third party system or application. Many times the productExternalId is used to synchronize SEI sourced data with another data source for the same record. Every product has an externalId.

string

Header Parameters
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

email

The email address at which communications can be sent or received.

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.

string

idbRole

Role that drives permissions in SEI Investor Dashboard to control what a contact can see and do.

string

HTTP Responses
  • Code
    Description
  • 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.

TEST ENDPOINT
alternateId

Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.

productInvestorExternalId

Business identifier for the investor product relationship recognized by a third party system or application. Many times the externalProductInvestorId is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

relationshipExternalId

Business identifier for the third party relationship recognized by an external system or application. Many times the relationship external id is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

relationshipEntity

type

Specifies the type of product or subproduct. A full list of product types can be obtained through the Lists API.

subType

A secondary or subordinate type included within a more general type. Investors, Contacts, Transactions and Products all have associated types and subtypes to further describe these entities.

primary

Indicates that the email is the primary email if there is more than one.

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.

createDate

Initial create timestamp for the record. Datetime is Eastern Standard Time (EST).

changeDate

Latest date the entity relevant to the API was modified. Date is in ISO 8601 format YYYY-MM-DD. Datetime is Eastern Standard Time (EST).

advisorId

Business identifier for the financial advisor.

attributeName

A characteristic that further defines the contact's relationship to the investor in a system consumable format, typically the attribute display name without spaces.

investorExternalId

Unique business identifier for the investor.

productExternalId

Unique business identifier for a product recognized by SEI and a third party system or application. Many times the productExternalId is used to synchronize SEI sourced data with another data source for the same record. Every product has an externalId.

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.

email

The email address at which communications can be sent or received.

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.

idbRole

Role that drives permissions in SEI Investor Dashboard to control what a contact can see and do.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...

Test: https://test.api.seic.com/v1/thirdparties/relationships
TLS*: https://mtls.api.seic.com/v1/thirdparties/relationships
*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.

Pass the oAuth Token and the App key to invoke this endpoint for a particular application.

Relationships

relationships

GET

/relationships

Returns links between a third party and a firm, product and/or investor along with attributes specific to that relationship.

Prod:
https://api.seic.com/v1/thirdparties/relationships
Query Parameters
Name Description Data Type Required
alternateId

Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.

string

productInvestorExternalId

Business identifier for the investor product relationship recognized by a third party system or application. Many times the externalProductInvestorId is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

string

relationshipExternalId

Business identifier for the third party relationship recognized by an external system or application. Many times the relationship external id is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

string

relationshipEntity

string

type

Specifies the type of product or subproduct. A full list of product types can be obtained through the Lists API.

string

subType

A secondary or subordinate type included within a more general type. Investors, Contacts, Transactions and Products all have associated types and subtypes to further describe these entities.

string

primary

Indicates that the email is the primary email if there is more than one.

string

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

createDate

Initial create timestamp for the record. Datetime is Eastern Standard Time (EST).

string

changeDate

Latest date the entity relevant to the API was modified. Date is in ISO 8601 format YYYY-MM-DD. Datetime is Eastern Standard Time (EST).

string

advisorId

Business identifier for the financial advisor.

string

attributeName

A characteristic that further defines the contact's relationship to the investor in a system consumable format, typically the attribute display name without spaces.

string

investorExternalId

Unique business identifier for the investor.

string

productExternalId

Unique business identifier for a product recognized by SEI and a third party system or application. Many times the productExternalId is used to synchronize SEI sourced data with another data source for the same record. Every product has an externalId.

string

Header Parameters
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

email

The email address at which communications can be sent or received.

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.

string

idbRole

Role that drives permissions in SEI Investor Dashboard to control what a contact can see and do.

string

HTTP Responses
  • Code
    Description
  • 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.

TEST ENDPOINT
alternateId

Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.

productInvestorExternalId

Business identifier for the investor product relationship recognized by a third party system or application. Many times the externalProductInvestorId is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

relationshipExternalId

Business identifier for the third party relationship recognized by an external system or application. Many times the relationship external id is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

relationshipEntity

type

Specifies the type of product or subproduct. A full list of product types can be obtained through the Lists API.

subType

A secondary or subordinate type included within a more general type. Investors, Contacts, Transactions and Products all have associated types and subtypes to further describe these entities.

primary

Indicates that the email is the primary email if there is more than one.

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.

createDate

Initial create timestamp for the record. Datetime is Eastern Standard Time (EST).

changeDate

Latest date the entity relevant to the API was modified. Date is in ISO 8601 format YYYY-MM-DD. Datetime is Eastern Standard Time (EST).

advisorId

Business identifier for the financial advisor.

attributeName

A characteristic that further defines the contact's relationship to the investor in a system consumable format, typically the attribute display name without spaces.

investorExternalId

Unique business identifier for the investor.

productExternalId

Unique business identifier for a product recognized by SEI and a third party system or application. Many times the productExternalId is used to synchronize SEI sourced data with another data source for the same record. Every product has an externalId.

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.

email

The email address at which communications can be sent or received.

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.

idbRole

Role that drives permissions in SEI Investor Dashboard to control what a contact can see and do.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...

SAMPLE REQUEST

curl -X GET \ 
'https://test.api.seic.com/v1/reports/metadata?firmid=1575'\ 
-H 'AppKey: gsedgaerhDSHGRSHv' \
-H 'Authorization: Bearer ADsgdnnkjnfdIKJN'\


REQUEST HEADER

AppKey: gsedgaerhDSHGRSHv
Authorization: Bearer ADsgdnnkjnfdIKJN
RESPONSE HEADER

Content: Type: application/json
Status: 200 OK 
Requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9


SAMPLE RESPONSE

{
  "data": [
    {
      "externalId": "string",
      "nsccId": "string",
      "fullName": "string",
      "secondaryExternalId": "string",
      "email": [
        {
          "email": "string",
          "type": "string",
          "primary": true
        }
      ],
      "productInvestorExternalId": "string",
      "active": true,
      "relationshipExternalId": "string",
      "taxID": "string",
      "clientID": "string",
      "relationshipEntity": "string",
      "firstCountryofCitizenship": "string",
      "thirdPartyType": "string",
      "secondCountryofCitizenship": "string",
      "thirdPartySubType": "string",
      "classification": "string",
      "prefix": "string",
      "countryofDomicile": "string",
      "relationshipTypeName": "string",
      "suffix": "string",
      "firstName": "string",
      "primaryThirdParty": true,
      "middleName": "string",
      "lastName": "string",
      "idbCustomRole": [
        {
          "attributeName": "string",
          "attributeDisplayName": "string",
          "attributeType": "string"
        }
      ],
      "taxType": "string",
      "birthDate": "2020-02-07T20:37:02.443Z",
      "financialAdvisor": {
        "advisorId": "string",
        "accountNumber": "string",
        "brokerCode": "string",
        "relatedBroker": "string",
        "primary": true
      },
      "gender": "string",
      "deliveryMethods": [
        {
          "attributeName": "string",
          "attributeDisplayName": "string",
          "attributeType": "string"
        }
      ],
      "employmentStatus": "string",
      "occupation": "string",
      "affiliateRoles": [
        {
          "attributeName": "string",
          "attributeDisplayName": "string",
          "attributeType": "string"
        }
      ],
      "annualIncomeType": "string",
      "lastNetProfit": 0,
      "clientThirdPartyRoles": [
        {
          "attributeName": "string",
          "attributeDisplayName": "string",
          "attributeType": "string"
        }
      ],
      "lastNetProfitCurrency": "string",
      "incomeTaxBandRate": "string",
      "investor": {
        "investorExternalId": "string",
        "fullName": "string",
        "taxId": "string",
        "dob": "2020-02-07T20:37:02.443Z",
        "legalAddressPostalCode": "string"
      },
      "annualIncome": 0,
      "annualIncomeCurrency": "string",
      "product": {
        "productExternalId": "string",
        "fullName": "string"
      },
      "maritalStatus": "string",
      "prospect": true,
      "changeDate": "2020-02-07T20:37:02.444Z",
      "prospectStatus": "string",
      "clientSpecific": true,
      "createDate": "2020-02-07T20:37:02.444Z",
      "links": [
        {
          "rel": "string",
          "href": "string"
        }
      ],
      "corporateActionRoles": [
        {
          "attributeName": "string",
          "attributeDisplayName": "string",
          "attributeType": "string"
        }
      ],
      "relationshipType": "string"
    }
  ],
  "paging": {
    "totalCount": 0,
    "limit": 0,
    "first": "string",
    "last": "string",
    "previous": "string",
    "next": "string",
    "self": "string"
  }
}
MODEL
Operations
Name Description Data Type (L)
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
fullName

The full legal name of the investor,manager or contact or any other entity represented by the object grouping of the field in the JSON response structure.

string
alternateId

Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.

string (100)
email

A collection of data points specific to a contact's email address.

object
type

Transaction Types are the basic unit for recording transactions in SEI Accounting system and identifying the specfic purpose of the debit or credit being booked.

string
primary

Indicates that the email is the primary email if there is more than one.

boolean
productInvestorExternalId

Business identifier for the investor product relationship recognized by a third party system or application. Many times the externalProductInvestorId is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

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.

string
taxId

Primary tax identifier for the Investor or Contact. When used in a search, is the full digits or characters, less special characters and spacing.

string
clientId

Identifies the SEI id for the firm the schedule was created for.

string
subType

A secondary or subordinate type included within a more general type. Investors, Contacts, Transactions and Products all have associated types and subtypes to further describe these entities.

string (100)
relationshipType

Identifies the relationship between the investor and a particular contact.

string
firstName

The first name for the financial advisor, investor,manager or contact or any other entity represented by the object grouping of the field in the JSON response structure.

string
idbRoles

Role that drives permissions in SEI Investor Dashboard to control what a contact can see and do.

string
lastName

The last name for the financial advisor, investor,manager or contact or any other entity represented by the object grouping of the field in the JSON response structure.

string
financialAdvisor

The collection of fields captured when a financial advisor is listed as a contact for a given investor.

object
deliveryMethods

Delivery methods for end investor communications. A contact relationship may have none, one or more methods. A full list of delivery methods can be obtained through the Lists API.

array
affiliateRoles

A contact may be affiliated to an investor in different capacities. A full list of affiliate roles can be obtained through the Lists API.

array
clientContactRoles

The role assigned to a contact as defined by the Investment Manager. A contact may have none, one or more roles. Typically a role is used to indicate the permissions the contact has in another system.

array
investor

Indicates the external investor ID related to the contact relationship.

object
products

A collection of data points specific to an investment vehicles for which an investor is eligible to subscribe.

array
changeDate

Latest date the entity relevant to the API was modified. Date is in ISO 8601 format YYYY-MM-DD. Datetime is Eastern Standard Time (EST).

string
createDate

Initial create timestamp for the record. Datetime is Eastern Standard Time (EST).

string
links

Embedded URLs in responses that allow for easier navigation.

array
rel

The name of a link returned by the href URL. This is immutable.

string
href

Fully configured URL to obtain more information regarding an entity. Allows for easier navigation across products. These links should not be cached.

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
thirdPartyPrimaryCitizenshipCountryCd

Country Code to identify primary country of citizenship for the Third Party. ISO country code ISO 3166-1 alpha-2 code format.

string
thirdPartySecondaryCitizenshipCountryCd

Country Code to identify secondary country of citizenship for the Third Party. ISO country code ISO 3166-1 alpha-2 code format.

string
classificationType

Identifies if the Third Party is an Investor or an Entity.

string
prefix

Prefix for a Third Party where Third Party is an Individual. Value for Prefix: Mr., Mrs., Ms., Dr.

string
suffix

Suffix for a Third Party where Third Party is an Individual.Value for Suffix: Jr., Sr., Esq.

string
middleName

Middle name for Third Party when Third Party is Individual

string
taxIdType Type of tax identifier for the Third Party. Value for TaxID: SSN, EIN, Other; Null/Blank string
birthDate

Date of birth or date of formation in the format MM/DD/YYYY.

string
secondaryThirdPartyExternalId An optional unique business identifier used to identify a Third Party string
genderType Identifies the gender of a Third Party where Third Party is an Individual. string
employmentStatusType Identifies the Employment status of a Third Party. string
occupationType Identifies the occupation of a Third Party. string
annualIncomeType Identifies the Annual Income Type of a Third Party. string
lastNetProfit Identifies the Last Net Profit of a Third Party. string
lastNetProfitCurrencyType Identifies the Last Net Profit Currency of a Third Party. string
incomeTaxBandRate The income tax band rate of the Third Party. string
annualIncome Annual income of the Third Party number
annualIncomeCurrencyType Indicates currency of Annual Income for Third Party. string
maritalStatus Indicates the Marital Status of the Third Party string
prospectFl Indicates if the Third Party is a Prospect string
thirdPartyProspectStatusType Indicates the status of the Prospect. string
relationshipExternalId

Business identifier for the third party relationship recognized by an external system or application. Many times the relationship external id is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

string


Relationships

relationships

GET

/relationships

Returns links between a third party and a firm, product and/or investor along with attributes specific to that relationship.

Prod:
https://api.seic.com/v1/thirdparties/relationships
Query Parameters
Name Description Data Type Required
alternateId

Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.

string

productInvestorExternalId

Business identifier for the investor product relationship recognized by a third party system or application. Many times the externalProductInvestorId is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

string

relationshipExternalId

Business identifier for the third party relationship recognized by an external system or application. Many times the relationship external id is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

string

relationshipEntity

string

type

Specifies the type of product or subproduct. A full list of product types can be obtained through the Lists API.

string

subType

A secondary or subordinate type included within a more general type. Investors, Contacts, Transactions and Products all have associated types and subtypes to further describe these entities.

string

primary

Indicates that the email is the primary email if there is more than one.

string

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

createDate

Initial create timestamp for the record. Datetime is Eastern Standard Time (EST).

string

changeDate

Latest date the entity relevant to the API was modified. Date is in ISO 8601 format YYYY-MM-DD. Datetime is Eastern Standard Time (EST).

string

advisorId

Business identifier for the financial advisor.

string

attributeName

A characteristic that further defines the contact's relationship to the investor in a system consumable format, typically the attribute display name without spaces.

string

investorExternalId

Unique business identifier for the investor.

string

productExternalId

Unique business identifier for a product recognized by SEI and a third party system or application. Many times the productExternalId is used to synchronize SEI sourced data with another data source for the same record. Every product has an externalId.

string

Header Parameters
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

email

The email address at which communications can be sent or received.

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.

string

idbRole

Role that drives permissions in SEI Investor Dashboard to control what a contact can see and do.

string

HTTP Responses
  • Code
    Description
  • 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.

TEST ENDPOINT
alternateId

Alternate identifier. This is a secondary identifier typically used when integrating between systems. Use of this field is optional.

productInvestorExternalId

Business identifier for the investor product relationship recognized by a third party system or application. Many times the externalProductInvestorId is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

relationshipExternalId

Business identifier for the third party relationship recognized by an external system or application. Many times the relationship external id is used to synchronize SEI sourced data with another data source for the same record. This field is not required to be unique.

relationshipEntity

type

Specifies the type of product or subproduct. A full list of product types can be obtained through the Lists API.

subType

A secondary or subordinate type included within a more general type. Investors, Contacts, Transactions and Products all have associated types and subtypes to further describe these entities.

primary

Indicates that the email is the primary email if there is more than one.

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.

createDate

Initial create timestamp for the record. Datetime is Eastern Standard Time (EST).

changeDate

Latest date the entity relevant to the API was modified. Date is in ISO 8601 format YYYY-MM-DD. Datetime is Eastern Standard Time (EST).

advisorId

Business identifier for the financial advisor.

attributeName

A characteristic that further defines the contact's relationship to the investor in a system consumable format, typically the attribute display name without spaces.

investorExternalId

Unique business identifier for the investor.

productExternalId

Unique business identifier for a product recognized by SEI and a third party system or application. Many times the productExternalId is used to synchronize SEI sourced data with another data source for the same record. Every product has an externalId.

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.

email

The email address at which communications can be sent or received.

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.

idbRole

Role that drives permissions in SEI Investor Dashboard to control what a contact can see and do.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...