Users

users-userId-get

GET

/users/{userId}

This API call gets a User in SEI Trade.

Prod:
https://api.seic.com/v1/trade/users/{userId}
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

Content-Type

This is the content type of the payload being passed. Valid value is application/json.

string

X-SEIC-CURRENT-USER-CONTEXT

Email address of the user authenticated into the application to view data.

string

Path Parameters
Name Description Data Type Required
userId

The identifier of the user for which you are retrieving data.

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

This is the content type of the payload being passed. Valid value is application/json.

X-SEIC-CURRENT-USER-CONTEXT

Email address of the user authenticated into the application to view data.

Request Body

userId The identifier of the user for which you are retrieving data. true

HTTP Basic

OAuth 2.0

API Key

Working...

Users

users-userId-get

GET

/users/{userId}

This API call gets a User in SEI Trade.

Prod:
https://api.seic.com/v1/trade/users/{userId}
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

Content-Type

This is the content type of the payload being passed. Valid value is application/json.

string

X-SEIC-CURRENT-USER-CONTEXT

Email address of the user authenticated into the application to view data.

string

Path Parameters
Name Description Data Type Required
userId

The identifier of the user for which you are retrieving data.

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

This is the content type of the payload being passed. Valid value is application/json.

X-SEIC-CURRENT-USER-CONTEXT

Email address of the user authenticated into the application to view data.

Request Body

userId The identifier of the user for which you are retrieving data. true

HTTP Basic

OAuth 2.0

API Key

Working...

Test: https://test.api.seic.com/v1/trade/users/{userId}
TLS*: https://mtls.api.seic.com/v1/trade/users/{userId}
*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.
STEP 2

Retrieve specific role and group association information about a particular user within SEI Trade.

Users

users-userId-get

GET

/users/{userId}

This API call gets a User in SEI Trade.

Prod:
https://api.seic.com/v1/trade/users/{userId}
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

Content-Type

This is the content type of the payload being passed. Valid value is application/json.

string

X-SEIC-CURRENT-USER-CONTEXT

Email address of the user authenticated into the application to view data.

string

Path Parameters
Name Description Data Type Required
userId

The identifier of the user for which you are retrieving data.

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

This is the content type of the payload being passed. Valid value is application/json.

X-SEIC-CURRENT-USER-CONTEXT

Email address of the user authenticated into the application to view data.

Request Body

userId The identifier of the user for which you are retrieving data. true

HTTP Basic

OAuth 2.0

API Key

Working...

SAMPLE REQUEST

curl -X GET \
   https://api.seic.com/v1/trade/users/1234 \
  -H 'appkey: gsedgaerhDSHGRSH' \
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN' \


REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH
REQUEST PAYLOAD MODEL
Operations
RESPONSE HEADER

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


SAMPLE RESPONSE

{
  "data":{
         "userId": "string",
         "emailAddress": "string",
         "firstName": "string",
         "lastName": "string",
         "firm": "string",
         "userRoles": [
           {
             "roleName": "string",
             "groupAssociations": [
                "string"
             ]
         }
    ]
  }
}
MODEL
Operations
Name Description Data Type (L)
userId

The Id that may be used to refer to the user.

String
emailAddress

The email address of the user.

string
firstName

The first name for the financial advisor, investor,manager or contact or third party

string(50)
lastName

The last name of the user.

string
firmId

The identifier of the firm.

string
userRoles

The role(s) associated with the user.

array
groupAssociation

The roleName along with groupAssociation are used to assign the role to a user.

string
roleName

The role name(s) associated with the user.

string


Users

users-userId-get

GET

/users/{userId}

This API call gets a User in SEI Trade.

Prod:
https://api.seic.com/v1/trade/users/{userId}
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

Content-Type

This is the content type of the payload being passed. Valid value is application/json.

string

X-SEIC-CURRENT-USER-CONTEXT

Email address of the user authenticated into the application to view data.

string

Path Parameters
Name Description Data Type Required
userId

The identifier of the user for which you are retrieving data.

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

This is the content type of the payload being passed. Valid value is application/json.

X-SEIC-CURRENT-USER-CONTEXT

Email address of the user authenticated into the application to view data.

Request Body

userId The identifier of the user for which you are retrieving data. true

HTTP Basic

OAuth 2.0

API Key

Working...

Users

users-userId-get

GET

/users/{userId}

This API call gets a User in SEI Trade.

Prod:
https://api.seic.com/v1/trade/users/{userId}
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

Content-Type

This is the content type of the payload being passed. Valid value is application/json.

string

X-SEIC-CURRENT-USER-CONTEXT

Email address of the user authenticated into the application to view data.

string

Path Parameters
Name Description Data Type Required
userId

The identifier of the user for which you are retrieving data.

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

This is the content type of the payload being passed. Valid value is application/json.

X-SEIC-CURRENT-USER-CONTEXT

Email address of the user authenticated into the application to view data.

Request Body

userId The identifier of the user for which you are retrieving data. true

HTTP Basic

OAuth 2.0

API Key

Working...

Test: https://test.api.seic.com/v1/trade/users/{userId}
TLS*: https://mtls.api.seic.com/v1/trade/users/{userId}
*The TLS endpoint is only used if Server Based Application was selected during the App Registration process.
STEP 1



STEP 2

Retrieve specific role and group association information about a particular user within SEI Trade.

Users

users-userId-get

GET

/users/{userId}

This API call gets a User in SEI Trade.

Prod:
https://api.seic.com/v1/trade/users/{userId}
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

Content-Type

This is the content type of the payload being passed. Valid value is application/json.

string

X-SEIC-CURRENT-USER-CONTEXT

Email address of the user authenticated into the application to view data.

string

Path Parameters
Name Description Data Type Required
userId

The identifier of the user for which you are retrieving data.

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

This is the content type of the payload being passed. Valid value is application/json.

X-SEIC-CURRENT-USER-CONTEXT

Email address of the user authenticated into the application to view data.

Request Body

userId The identifier of the user for which you are retrieving data. true

HTTP Basic

OAuth 2.0

API Key

Working...

SAMPLE REQUEST

curl -X GET \
   https://api.seic.com/v1/trade/users/1234 \
  -H 'appkey: gsedgaerhDSHGRSH' \
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN' \


REQUEST HEADER

Authorization: Bearer ADsgdnnkjnfdIKJN
AppKey: gsedgaerhDSHGRSH
REQUEST PAYLOAD MODEL
Operations
RESPONSE HEADER

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


SAMPLE RESPONSE

{
  "data":{
         "userId": "string",
         "emailAddress": "string",
         "firstName": "string",
         "lastName": "string",
         "firm": "string",
         "userRoles": [
           {
             "roleName": "string",
             "groupAssociations": [
                "string"
             ]
         }
    ]
  }
}
MODEL
Operations
Name Description Data Type (L)
userId

The Id that may be used to refer to the user.

String
emailAddress

The email address of the user.

string
firstName

The first name for the financial advisor, investor,manager or contact or third party

string(50)
lastName

The last name of the user.

string
firmId

The identifier of the firm.

string
userRoles

The role(s) associated with the user.

array
groupAssociation

The roleName along with groupAssociation are used to assign the role to a user.

string
roleName

The role name(s) associated with the user.

string


Users

users-userId-get

GET

/users/{userId}

This API call gets a User in SEI Trade.

Prod:
https://api.seic.com/v1/trade/users/{userId}
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

Content-Type

This is the content type of the payload being passed. Valid value is application/json.

string

X-SEIC-CURRENT-USER-CONTEXT

Email address of the user authenticated into the application to view data.

string

Path Parameters
Name Description Data Type Required
userId

The identifier of the user for which you are retrieving data.

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

This is the content type of the payload being passed. Valid value is application/json.

X-SEIC-CURRENT-USER-CONTEXT

Email address of the user authenticated into the application to view data.

Request Body

userId The identifier of the user for which you are retrieving data. true

HTTP Basic

OAuth 2.0

API Key

Working...