Users

users-post

POST

/users

This API call creates a User in SEI Trade.

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

Body Parameters
Name Description Data Type Required
user

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

user

Request Body

User to create.

HTTP Basic

OAuth 2.0

API Key

Working...

Users

users-post

POST

/users

This API call creates a User in SEI Trade.

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

Body Parameters
Name Description Data Type Required
user

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

user

Request Body

User to create.

HTTP Basic

OAuth 2.0

API Key

Working...

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

After evaluating what firms exist within your SEI Trade instance, create new firm records using the POST call in the format of the sample payload

Users

users-post

POST

/users

This API call creates a User in SEI Trade.

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

Body Parameters
Name Description Data Type Required
user

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

user

Request Body

User to create.

HTTP Basic

OAuth 2.0

API Key

Working...

SAMPLE REQUEST

curl -X POST \
 https://api.seic.com/v1/trade/users \
  -H 'appkey: gsedgaerhDSHGRSH\
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '
{
         "userId": "string",
         "emailAddress": "string",
         "firstName": "string",
         "lastName": "string",
         "firm": "string",
         "userRoles": [
           {
             "roleName": "string",
             "groupAssociations": [
                "string"
             ]
         }
    ]
}


REQUEST HEADER

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

REQUEST PAYLOAD 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
firm

An optional identifier that can be used to link a Firm to an Opportunity.

object
userRoles

The role(s) associated with the user.

array
roleName

The role name(s) associated with the user.

string
groupAssociation

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

string
firm

The firm of the user

string
RESPONSE HEADER

Content-Type: application/json 
Status: 201 Opportunities Created 
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-post

POST

/users

This API call creates a User in SEI Trade.

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

Body Parameters
Name Description Data Type Required
user

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

user

Request Body

User to create.

HTTP Basic

OAuth 2.0

API Key

Working...

Users

users-post

POST

/users

This API call creates a User in SEI Trade.

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

Body Parameters
Name Description Data Type Required
user

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

user

Request Body

User to create.

HTTP Basic

OAuth 2.0

API Key

Working...

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



STEP 2

After evaluating what firms exist within your SEI Trade instance, create new firm records using the POST call in the format of the sample payload

Users

users-post

POST

/users

This API call creates a User in SEI Trade.

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

Body Parameters
Name Description Data Type Required
user

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

user

Request Body

User to create.

HTTP Basic

OAuth 2.0

API Key

Working...

SAMPLE REQUEST

curl -X POST \
 https://api.seic.com/v1/trade/users \
  -H 'appkey: gsedgaerhDSHGRSH\
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '
{
         "userId": "string",
         "emailAddress": "string",
         "firstName": "string",
         "lastName": "string",
         "firm": "string",
         "userRoles": [
           {
             "roleName": "string",
             "groupAssociations": [
                "string"
             ]
         }
    ]
}


REQUEST HEADER

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

REQUEST PAYLOAD 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
firm

An optional identifier that can be used to link a Firm to an Opportunity.

object
userRoles

The role(s) associated with the user.

array
roleName

The role name(s) associated with the user.

string
groupAssociation

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

string
firm

The firm of the user

string
RESPONSE HEADER

Content-Type: application/json 
Status: 201 Opportunities Created 
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-post

POST

/users

This API call creates a User in SEI Trade.

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

Body Parameters
Name Description Data Type Required
user

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

user

Request Body

User to create.

HTTP Basic

OAuth 2.0

API Key

Working...