Relationships

relationships

GET

/contacts/relationships

Returns contact relationships.

Prod:
https://api.seic.com/v2/contacts/relationships
Query Parameters
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

alternateId

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

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

investorExternalId

Unique business identifier for the investor.

string

fundInvestorExternalId

Business identifier for the investor fund relationship recognized by a third party system or application. Many times the fund investor 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

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

primaryContact

Designates who is the primary contact for the investor and/or product. When "true" the contact relationship is primary. When "false" the contact relationship is not identified as primary

boolean

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

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

sections

One or more sections can be specified to target and limit the amount of fields returned in the response. Value options are "Email", "Financial Advisor". Passing one of these sections will exclude the other sections from being included in the response. If no sections are passed, the response will include all fields.

string

relChangeStartDate

Last change start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

string

relChangeEndDate

Last change end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

string

relCreateStartDate

Create start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

string

relCreateEndDate

Create end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

string

limit

The pageSize or number of records returned per page

integer

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

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
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.

alternateId

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

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.

investorExternalId

Unique business identifier for the investor.

fundInvestorExternalId

Business identifier for the investor fund relationship recognized by a third party system or application. Many times the fund investor 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.

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.

primaryContact

Designates who is the primary contact for the investor and/or product. When "true" the contact relationship is primary. When "false" the contact relationship is not identified as primary

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.

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.

sections

One or more sections can be specified to target and limit the amount of fields returned in the response. Value options are "Email", "Financial Advisor". Passing one of these sections will exclude the other sections from being included in the response. If no sections are passed, the response will include all fields.

relChangeStartDate

Last change start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

relChangeEndDate

Last change end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

relCreateStartDate

Create start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

relCreateEndDate

Create end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

limit

The pageSize or number of records returned per page

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.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...

Relationships

relationships

GET

/contacts/relationships

Returns contact relationships.

Prod:
https://api.seic.com/v2/contacts/relationships
Query Parameters
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

alternateId

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

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

investorExternalId

Unique business identifier for the investor.

string

fundInvestorExternalId

Business identifier for the investor fund relationship recognized by a third party system or application. Many times the fund investor 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

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

primaryContact

Designates who is the primary contact for the investor and/or product. When "true" the contact relationship is primary. When "false" the contact relationship is not identified as primary

boolean

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

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

sections

One or more sections can be specified to target and limit the amount of fields returned in the response. Value options are "Email", "Financial Advisor". Passing one of these sections will exclude the other sections from being included in the response. If no sections are passed, the response will include all fields.

string

relChangeStartDate

Last change start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

string

relChangeEndDate

Last change end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

string

relCreateStartDate

Create start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

string

relCreateEndDate

Create end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

string

limit

The pageSize or number of records returned per page

integer

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

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
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.

alternateId

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

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.

investorExternalId

Unique business identifier for the investor.

fundInvestorExternalId

Business identifier for the investor fund relationship recognized by a third party system or application. Many times the fund investor 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.

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.

primaryContact

Designates who is the primary contact for the investor and/or product. When "true" the contact relationship is primary. When "false" the contact relationship is not identified as primary

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.

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.

sections

One or more sections can be specified to target and limit the amount of fields returned in the response. Value options are "Email", "Financial Advisor". Passing one of these sections will exclude the other sections from being included in the response. If no sections are passed, the response will include all fields.

relChangeStartDate

Last change start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

relChangeEndDate

Last change end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

relCreateStartDate

Create start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

relCreateEndDate

Create end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

limit

The pageSize or number of records returned per page

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.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...

Test: https://test.api.seic.com/v2/contacts/relationships
TLS*: https://mtls.api.seic.com/v2/contacts/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

/contacts/relationships

Returns contact relationships.

Prod:
https://api.seic.com/v2/contacts/relationships
Query Parameters
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

alternateId

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

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

investorExternalId

Unique business identifier for the investor.

string

fundInvestorExternalId

Business identifier for the investor fund relationship recognized by a third party system or application. Many times the fund investor 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

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

primaryContact

Designates who is the primary contact for the investor and/or product. When "true" the contact relationship is primary. When "false" the contact relationship is not identified as primary

boolean

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

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

sections

One or more sections can be specified to target and limit the amount of fields returned in the response. Value options are "Email", "Financial Advisor". Passing one of these sections will exclude the other sections from being included in the response. If no sections are passed, the response will include all fields.

string

relChangeStartDate

Last change start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

string

relChangeEndDate

Last change end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

string

relCreateStartDate

Create start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

string

relCreateEndDate

Create end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

string

limit

The pageSize or number of records returned per page

integer

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

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
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.

alternateId

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

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.

investorExternalId

Unique business identifier for the investor.

fundInvestorExternalId

Business identifier for the investor fund relationship recognized by a third party system or application. Many times the fund investor 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.

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.

primaryContact

Designates who is the primary contact for the investor and/or product. When "true" the contact relationship is primary. When "false" the contact relationship is not identified as primary

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.

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.

sections

One or more sections can be specified to target and limit the amount of fields returned in the response. Value options are "Email", "Financial Advisor". Passing one of these sections will exclude the other sections from being included in the response. If no sections are passed, the response will include all fields.

relChangeStartDate

Last change start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

relChangeEndDate

Last change end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

relCreateStartDate

Create start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

relCreateEndDate

Create end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

limit

The pageSize or number of records returned per page

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.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...

SAMPLE REQUEST

curl -X GET \
   https://api.seic.com/v2/contacts/relationships?externalId=ip1&investorExternalId=crump \
  -H 'appkey: gsedgaerhDSHGRSH' \
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN' \


REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH
RESPONSE HEADER

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


SAMPLE RESPONSE

 {
	"data": [{
		"type": "Individual",
		"subType": "Financial Advisor",
		"relationshipType": "Investor",
		"relatedContactRelationshipTypeValue": "Investor - Financial Advisor",
		"primary": false,
		"active": true,
		"changeDate": "2019-08-15T11:58:28.173",
		"createDate": "2014-04-24T22:58:11",
		"product": {
			"productId": 0,
			"productExternalId": "string",
			"productFullName": "string"
		},
		"investor": {
			"investorId": 2281,
			"investorExternalId": "Crump",
			"investorName": "Jim Crump",
			"taxId": "111-11-1111",
			"dob": "1950-01-01T00:00:00",
			"legalAddressPostalCode": "19456"
		},
		"fundInvestorExternalId": null,
		"contactMetadata": {
			"externalId": "ip1",
			"alternateId": "001x4291020",
			"fullName": "John Jameson",
			"primaryEmail": "dnel@seic.com",
			"primary": true,
			"emailType": "Personal",
			"changeDate": "2019-08-15T11:58:27.03",
			"createDate": "2014-04-24T22:58:11",
			"links": [{
					"rel": "contactDemographics",
					"href": "https://test.api.seic.com/v2/contacts/demographics?firmId=9999&externalId=ip1&validateRequest=false"
				},
				{
					"rel": "contactRelationships",
					"href": "https://test.api.seic.com/v2/contacts/relationships?firmId=9999&externalId=ip1&validateRequest=false"
				}
			]
		},
		"financialAdvisor": {
			"advisorId": "12345",
			"accountNumber": "04957292",
			"brokerCode": null,
			"relatedBroker": null
		},
		"email": [{
			"email": "dnel@seic.com",
			"type": "Personal",
			"primary": true
		}],
		"deliveryMethods": [{
			"attributeName": "ContactByInvestorDashboard",
			"attributeDisplayName": "Contact By Investor Dashboard",
			"attributeType": "Delivery Methods"
		}],
		"affiliateRoles": [{
			"attributeName": "AuthorizedSigner",
			"attributeDisplayName": "Authorized Signer",
			"attributeType": "Affiliate Role"
		}],
		"clientContactRoles": [{
			"attributeName": "string",
			"attributeDisplayName": "string",
			"attributeType": "string"
		}],
		"idbRole": "Advisor"
	}],
	"paging": {
		"cursors": {
			"before": "ODY3OTY=",
			"after": "ODY3OTY=",
			"max": null,
			"last": null,
			"resultCount": 1
		},
		"totalCount": 1,
		"limit": 1,
		"previous": null,
		"next": null,
		"self": "https://test.api.seic.com/v2/contacts/relationships?externalId=ip1&investorExternalId=crump&limit=1",
		"first": "https://test.api.seic.com/v2/contacts/relationships?externalId=ip1&investorExternalId=crump&limit=1",
		"last": null
	}
}
MODEL
Operations
Name Description Data Type (L)
type

Type of contact.

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
relatedContactRelationshipTypeValue

Type of related contact relationship.

string
primary

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

boolean
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
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
products

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

array
productId

The SEI internal system identifier for the product or fund. This query parameter is used to retrieve a limited set of positions data.

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 (40)
productFullName

Product legal name.

string
investor

Indicates the external investor ID related to the contact relationship.

object
investorId

This is a unique internal identifier for the investor generated by SEI

string
investorExternalId

Unique business identifier for the investor.

string
investorName

Investor full legal name as indicated on the subscription document.

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
dob

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

string
legalAddressPostalCode

The postal code of the address.

string
fundInvestorExternalId

Business identifier for the investor fund relationship recognized by a third party system or application. Many times the fund investor 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
contactMetadata

A collection of contact fields that identify the contact.

object
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
alternateId

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

string (100)
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
primaryEmail

Primary email for the contact. A contact may have none, one or up to four email addresses. If multiple exist, only one email can be primary. Primary email is used for Investor Dashboard access (if applicable).

string
emailType

Indicates the type of email. A full list of email types can be obtained through the Lists API.

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
financialAdvisor

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

object
advisorId

Business identifier for the financial advisor.

string (100)
accountNumber

Code which uniquely identifies an individual or entity.

string
brokerCode

Business identifier for the broker.

string
relatedBroker

Name of the broker the financial advisor is associated with. A relatedBroker is optional.

string (200)
email

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

string
email

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

object
type

Indicates the type of email. Value options for this field are "Group", "Other", "Personal" or "Work"

string
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
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
attributeDisplayName

A characteristic that further defines the contact's relationship to the investor in a business friendly format.

string
attributeType

Describes types of roles a contact relationship may have. Value options are 'Affiliate Role', 'Delivery Methods', 'Contact Roles' and 'IDB Contact Roles.'

string (50)
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
idbRoles

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

string


Relationships

relationships

GET

/contacts/relationships

Returns contact relationships.

Prod:
https://api.seic.com/v2/contacts/relationships
Query Parameters
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

alternateId

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

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

investorExternalId

Unique business identifier for the investor.

string

fundInvestorExternalId

Business identifier for the investor fund relationship recognized by a third party system or application. Many times the fund investor 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

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

primaryContact

Designates who is the primary contact for the investor and/or product. When "true" the contact relationship is primary. When "false" the contact relationship is not identified as primary

boolean

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

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

sections

One or more sections can be specified to target and limit the amount of fields returned in the response. Value options are "Email", "Financial Advisor". Passing one of these sections will exclude the other sections from being included in the response. If no sections are passed, the response will include all fields.

string

relChangeStartDate

Last change start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

string

relChangeEndDate

Last change end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

string

relCreateStartDate

Create start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

string

relCreateEndDate

Create end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

string

limit

The pageSize or number of records returned per page

integer

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

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
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.

alternateId

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

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.

investorExternalId

Unique business identifier for the investor.

fundInvestorExternalId

Business identifier for the investor fund relationship recognized by a third party system or application. Many times the fund investor 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.

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.

primaryContact

Designates who is the primary contact for the investor and/or product. When "true" the contact relationship is primary. When "false" the contact relationship is not identified as primary

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.

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.

sections

One or more sections can be specified to target and limit the amount of fields returned in the response. Value options are "Email", "Financial Advisor". Passing one of these sections will exclude the other sections from being included in the response. If no sections are passed, the response will include all fields.

relChangeStartDate

Last change start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

relChangeEndDate

Last change end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships modified on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

relCreateStartDate

Create start date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 00:00:00:0000. Datetime is Eastern Standard Time (EST).

relCreateEndDate

Create end date for the contact relationship in ISO 8601 UTC format. Can be used to target contact relationships created on, since or between specified datetime. Date only can be accepted and assumes a time of 23:59:59:9999. Datetime is Eastern Standard Time (EST).

limit

The pageSize or number of records returned per page

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.

Request Body

HTTP Basic

OAuth 2.0

API Key

Working...