SEI Developer Portal

POST

/documents/subscribe

Subscribe to receive real time notifications whenever document related data changes.

Prod:

https://api.seic.com/v1/trade/documents/subscribe

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

Body Parameters

Name	Description	Data Type	Required
subscriptionRequest		object

HTTP Responses

Code

Description
201

Created- The request has been fulfilled.
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

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.

subscriptionRequest

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

POST

/documents/subscribe

Subscribe to receive real time notifications whenever document related data changes.

Prod:

https://api.seic.com/v1/trade/documents/subscribe

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

Body Parameters

Name	Description	Data Type	Required
subscriptionRequest		object

HTTP Responses

Code

Description
201

Created- The request has been fulfilled.
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

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.

subscriptionRequest

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Test: https://test.api.seic.com/v1/trade/documents/subscribe

TLS*: https://mtls.api.seic.com/v1/trade/documents/subscribe

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

POST

/documents/subscribe

Subscribe to receive real time notifications whenever document related data changes.

Prod:

https://api.seic.com/v1/trade/documents/subscribe

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

Body Parameters

Name	Description	Data Type	Required
subscriptionRequest		object

HTTP Responses

Code

Description
201

Created- The request has been fulfilled.
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

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.

subscriptionRequest

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

SAMPLE REQUEST

curl -X POST \
https://api.seic.com/v1/trade/documents/subscribe \
  -H 'appkey: gsedgaerhDSHGRSH' \
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN' \
  -H 'content-type: application/json' \
  -d '{
    "trackingNumber": "123",
    "url": "http://www.example.com/location-to-call"
}

REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH

RESPONSE HEADER

Content-Type: application/json 
Status: 201 Opportunities Created
requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9

SAMPLE RESPONSE

{
  "subscriptionId": "string"
}

MODEL

Operations

	Name	Description	Data Type (L)
	subscriptionId	You can subscribe to updates for a specified URL. This unique identifier tracks the URL for you have subscribed so that you can be notified when updates are available.	string

POST

/documents/subscribe

Subscribe to receive real time notifications whenever document related data changes.

Prod:

https://api.seic.com/v1/trade/documents/subscribe

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

Body Parameters

Name	Description	Data Type	Required
subscriptionRequest		object

HTTP Responses

Code

Description
201

Created- The request has been fulfilled.
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

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.

subscriptionRequest

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

POST

/documents/subscribe

Subscribe to receive real time notifications whenever document related data changes.

Prod:

https://api.seic.com/v1/trade/documents/subscribe

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

Body Parameters

Name	Description	Data Type	Required
subscriptionRequest		object

HTTP Responses

Code

Description
201

Created- The request has been fulfilled.
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

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.

subscriptionRequest

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Test: https://test.api.seic.com/v1/trade/documents/subscribe

TLS*: https://mtls.api.seic.com/v1/trade/documents/subscribe

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

POST

/documents/subscribe

Subscribe to receive real time notifications whenever document related data changes.

Prod:

https://api.seic.com/v1/trade/documents/subscribe

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

Body Parameters

Name	Description	Data Type	Required
subscriptionRequest		object

HTTP Responses

Code

Description
201

Created- The request has been fulfilled.
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

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.

subscriptionRequest

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

SAMPLE REQUEST

curl -X POST \
https://api.seic.com/v1/trade/documents/subscribe \
  -H 'appkey: gsedgaerhDSHGRSH' \
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN' \
  -H 'content-type: application/json' \
  -d '{
    "trackingNumber": "123",
    "url": "http://www.example.com/location-to-call"
}

REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH

RESPONSE HEADER

Content-Type: application/json 
Status: 201 Opportunities Created
requesttrackingid: 67e1ff68-164f-03ad-0f2d-5cbbfda56ec9

SAMPLE RESPONSE

{
  "subscriptionId": "string"
}

MODEL

Operations

	Name	Description	Data Type (L)
	subscriptionId	You can subscribe to updates for a specified URL. This unique identifier tracks the URL for you have subscribed so that you can be notified when updates are available.	string

POST

/documents/subscribe

Subscribe to receive real time notifications whenever document related data changes.

Prod:

https://api.seic.com/v1/trade/documents/subscribe

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

Body Parameters

Name	Description	Data Type	Required
subscriptionRequest		object

HTTP Responses

Code

Description
201

Created- The request has been fulfilled.
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

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.

subscriptionRequest

Request Body

Value
Schema

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...