SEI Developer Portal

Investors

PATCH

/investors/{externalId}

Modify attributes associated with an investor. Except the internal identifier for an investor all the attributes can be modified.

Prod:

https://api.seic.com/v1/investors/{externalId}

Header Parameters

Name	Description	Data Type
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
content-type	Valid value is application/json-patch+json. This defines the content type of the request payload accepted by the API.	string

Path Parameters

Name	Description	Data Type	Required
externalId	The pneumonic of the lookup name	string

Body Parameters

Name	Description	Data Type	Required
requestPayload		object

HTTP Responses

Code

Description
202

Accepted-The request has been accepted for processing, but the processing may not be complete.
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 SEI 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

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.
content-type	Valid value is application/json-patch+json. This defines the content type of the request payload accepted by the API.

requestPayload

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Investors

PATCH

/investors/{externalId}

Modify attributes associated with an investor. Except the internal identifier for an investor all the attributes can be modified.

Prod:

https://api.seic.com/v1/investors/{externalId}

Header Parameters

Name	Description	Data Type
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
content-type	Valid value is application/json-patch+json. This defines the content type of the request payload accepted by the API.	string

Path Parameters

Name	Description	Data Type	Required
externalId	The pneumonic of the lookup name	string

Body Parameters

Name	Description	Data Type	Required
requestPayload		object

HTTP Responses

Code

Description
202

Accepted-The request has been accepted for processing, but the processing may not be complete.
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 SEI 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

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.
content-type	Valid value is application/json-patch+json. This defines the content type of the request payload accepted by the API.

requestPayload

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Test: https://test.api.seic.com/v1/investors/{externalId}

TLS*: https://mtls.api.seic.com/v1/investors/{externalId}

*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.

STEP 2

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

Investors

PATCH

/investors/{externalId}

Modify attributes associated with an investor. Except the internal identifier for an investor all the attributes can be modified.

Prod:

https://api.seic.com/v1/investors/{externalId}

Header Parameters

Name	Description	Data Type
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
content-type	Valid value is application/json-patch+json. This defines the content type of the request payload accepted by the API.	string

Path Parameters

Name	Description	Data Type	Required
externalId	The pneumonic of the lookup name	string

Body Parameters

Name	Description	Data Type	Required
requestPayload		object

HTTP Responses

Code

Description
202

Accepted-The request has been accepted for processing, but the processing may not be complete.
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 SEI 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

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.
content-type	Valid value is application/json-patch+json. This defines the content type of the request payload accepted by the API.

requestPayload

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

SAMPLE REQUEST

# The application developer can update any field by using the PATCH request. 
The only mandatory field is the investor's "externalId".

Described below is an example with a sample payload representing all the fields that can be updated:

curl -X PATCH\
  https://api.seic.com/v1/investors/123 \
  -H 'appkey: gsedgaerhDSHGRSH' \
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN' \
  -H 'content-type: application/json-patch+json' \
 -d ' [{
    "externalId": "JDOE3890131",
    "name": {
        "fullName": "John Doe Irrevocable Trust Dated 04/01/1983"
    },
    "address": [{
        "type": "Legal",
        "attention1": "Percival Jae, Esq",
        "attention2": "",
        "addressLine1": "472 W Eagle St",
        "addressLine2": "??NULL??",
        "addressLine3": "",
        "addressLine4": "",
        "city": "Crown Point",
        "stateCode": "IN",
        "postalCode": "46307",
        "countryIsoCode": "US"
    }]
}]

REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH
Content-type: application/json

RESPONSE HEADER

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

SAMPLE RESPONSE

{
	"data": {
		"jobStatusQueryKey": "string"
	}
}

MODEL

Operations

	Name	Description	Data Type (L)
	jobStatusQueryKey	The identifier returned to acknowledge a request has been submitted and is being processed. This identifier can typically be used with another API to get the current status of the request.	string

Investors

PATCH

/investors/{externalId}

Modify attributes associated with an investor. Except the internal identifier for an investor all the attributes can be modified.

Prod:

https://api.seic.com/v1/investors/{externalId}

Header Parameters

Name	Description	Data Type
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
content-type	Valid value is application/json-patch+json. This defines the content type of the request payload accepted by the API.	string

Path Parameters

Name	Description	Data Type	Required
externalId	The pneumonic of the lookup name	string

Body Parameters

Name	Description	Data Type	Required
requestPayload		object

HTTP Responses

Code

Description
202

Accepted-The request has been accepted for processing, but the processing may not be complete.
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 SEI 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

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.
content-type	Valid value is application/json-patch+json. This defines the content type of the request payload accepted by the API.

requestPayload

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Investors

PATCH

/investors/{externalId}

Modify attributes associated with an investor. Except the internal identifier for an investor all the attributes can be modified.

Prod:

https://api.seic.com/v1/investors/{externalId}

Header Parameters

Name	Description	Data Type
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
content-type	Valid value is application/json-patch+json. This defines the content type of the request payload accepted by the API.	string

Path Parameters

Name	Description	Data Type	Required
externalId	The pneumonic of the lookup name	string

Body Parameters

Name	Description	Data Type	Required
requestPayload		object

HTTP Responses

Code

Description
202

Accepted-The request has been accepted for processing, but the processing may not be complete.
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 SEI 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

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.
content-type	Valid value is application/json-patch+json. This defines the content type of the request payload accepted by the API.

requestPayload

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Test: https://test.api.seic.com/v1/investors/{externalId}

TLS*: https://mtls.api.seic.com/v1/investors/{externalId}

*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.

STEP 1

oAuthToken

POST

STEP 2

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

Investors

PATCH

/investors/{externalId}

Modify attributes associated with an investor. Except the internal identifier for an investor all the attributes can be modified.

Prod:

https://api.seic.com/v1/investors/{externalId}

Header Parameters

Name	Description	Data Type
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
content-type	Valid value is application/json-patch+json. This defines the content type of the request payload accepted by the API.	string

Path Parameters

Name	Description	Data Type	Required
externalId	The pneumonic of the lookup name	string

Body Parameters

Name	Description	Data Type	Required
requestPayload		object

HTTP Responses

Code

Description
202

Accepted-The request has been accepted for processing, but the processing may not be complete.
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 SEI 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

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.
content-type	Valid value is application/json-patch+json. This defines the content type of the request payload accepted by the API.

requestPayload

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

SAMPLE REQUEST

# The application developer can update any field by using the PATCH request. 
The only mandatory field is the investor's "externalId".

Described below is an example with a sample payload representing all the fields that can be updated:

curl -X PATCH\
  https://api.seic.com/v1/investors/123 \
  -H 'appkey: gsedgaerhDSHGRSH' \
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN' \
  -H 'content-type: application/json-patch+json' \
 -d ' [{
    "externalId": "JDOE3890131",
    "name": {
        "fullName": "John Doe Irrevocable Trust Dated 04/01/1983"
    },
    "address": [{
        "type": "Legal",
        "attention1": "Percival Jae, Esq",
        "attention2": "",
        "addressLine1": "472 W Eagle St",
        "addressLine2": "??NULL??",
        "addressLine3": "",
        "addressLine4": "",
        "city": "Crown Point",
        "stateCode": "IN",
        "postalCode": "46307",
        "countryIsoCode": "US"
    }]
}]

REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH
Content-type: application/json

RESPONSE HEADER

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

SAMPLE RESPONSE

{
	"data": {
		"jobStatusQueryKey": "string"
	}
}

MODEL

Operations

	Name	Description	Data Type (L)
	jobStatusQueryKey	The identifier returned to acknowledge a request has been submitted and is being processed. This identifier can typically be used with another API to get the current status of the request.	string

Investors

PATCH

/investors/{externalId}

Modify attributes associated with an investor. Except the internal identifier for an investor all the attributes can be modified.

Prod:

https://api.seic.com/v1/investors/{externalId}

Header Parameters

Name	Description	Data Type
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
content-type	Valid value is application/json-patch+json. This defines the content type of the request payload accepted by the API.	string

Path Parameters

Name	Description	Data Type	Required
externalId	The pneumonic of the lookup name	string

Body Parameters

Name	Description	Data Type	Required
requestPayload		object

HTTP Responses

Code

Description
202

Accepted-The request has been accepted for processing, but the processing may not be complete.
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 SEI 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

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.
content-type	Valid value is application/json-patch+json. This defines the content type of the request payload accepted by the API.

requestPayload

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...