SEI Developer Portal

Firm

PUT

/firms/{firm}

This API call updates a Firm in SEI Trade.

Prod:

https://api.seic.com/v1/trade/firms/{firm}

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	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
firm	Identifier of Firm to Update.	string

Body Parameters

Name	Description	Data Type	Required
firm		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.

firm

Request Body

Firm to update.

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Firm

PUT

/firms/{firm}

This API call updates a Firm in SEI Trade.

Prod:

https://api.seic.com/v1/trade/firms/{firm}

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	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
firm	Identifier of Firm to Update.	string

Body Parameters

Name	Description	Data Type	Required
firm		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.

firm

Request Body

Firm to update.

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Test: https://test.api.seic.com/v1/trade/firms/{firm}

TLS*: https://mtls.api.seic.com/v1/trade/firms/{firm}

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

STEP 2

If you have created a Firm and want to update the record within your SEI Trade instance, send the full revised payload with a PUT request.

Firm

PUT

/firms/{firm}

This API call updates a Firm in SEI Trade.

Prod:

https://api.seic.com/v1/trade/firms/{firm}

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	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
firm	Identifier of Firm to Update.	string

Body Parameters

Name	Description	Data Type	Required
firm		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.

firm

Request Body

Firm to update.

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

SAMPLE REQUEST

curl -X PUT \
 https://api.seic.com/v1/trade/firms/1234\
  -H 'appkey: gsedgaerhDSHGRSH\
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d ' {
  "firm": "string",
  "firmName": "string",
  "userShare": true,
  "firmRoles": [
    {
      "roleName": "string",
      "rolePermissions": {
        "viewPipeline": true,
        "editPipeline": true,
        "viewDetails": true,
        "editDetails": true,
        "submitRequests": true,
        "reviewApprove": true
      }
    }
  ]
}'

REQUEST HEADER

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

REQUEST PAYLOAD MODEL

Operations

Name	Description	Data Type (L)
firm	An optional identifier that can be used to link a Firm to an Opportunity.	object
firmName	The full name of the firm or client.	string
userShare	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	string
firmRoles	The role(s) associated with the firm.	array
roleName	The role name(s) associated with the user.	string
rolePermissions	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	object
viewPipeline	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
editPipeline	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
viewDetails	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
editDetails	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
submitRequests	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
reviewApprove	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean

RESPONSE HEADER

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

SAMPLE RESPONSE

{
  "data": {
    "firm": "string",
    "firmName": "string",
    "userShare": true,
    "firmRoles": [
      {
        "roleName": "string",
        "rolePermissions": {
          "viewPipeline": true,
          "editPipeline": true,
          "viewDetails": true,
          "editDetails": true,
          "submitRequests": true,
          "reviewApprove": true
        }
      }
    ]
  }
}

MODEL

Operations

Name	Description	Data Type (L)
firmId	The identifier of the firm.	string
firmName	The full name of the firm or client.	string
userShare	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	string
firmRoles	The role(s) associated with the firm.	array
roleName	The role name(s) associated with the user.	string
rolePermissions	An enumerated list where values are 'true' or 'false'.	object
viewPipeline	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
editPipeline	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
viewDetails	An enumerated list where values are 'true' or 'false'.	boolean
editDetails	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
submitRequests	An enumerated list where values are 'true' or 'false'.	boolean
reviewApprove	An enumerated list where values are 'true' or 'false'.	boolean

Firm

PUT

/firms/{firm}

This API call updates a Firm in SEI Trade.

Prod:

https://api.seic.com/v1/trade/firms/{firm}

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	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
firm	Identifier of Firm to Update.	string

Body Parameters

Name	Description	Data Type	Required
firm		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.

firm

Request Body

Firm to update.

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Firm

PUT

/firms/{firm}

This API call updates a Firm in SEI Trade.

Prod:

https://api.seic.com/v1/trade/firms/{firm}

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	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
firm	Identifier of Firm to Update.	string

Body Parameters

Name	Description	Data Type	Required
firm		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.

firm

Request Body

Firm to update.

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

Test: https://test.api.seic.com/v1/trade/firms/{firm}

TLS*: https://mtls.api.seic.com/v1/trade/firms/{firm}

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

STEP 1

oAuthToken

POST

STEP 2

If you have created a Firm and want to update the record within your SEI Trade instance, send the full revised payload with a PUT request.

Firm

PUT

/firms/{firm}

This API call updates a Firm in SEI Trade.

Prod:

https://api.seic.com/v1/trade/firms/{firm}

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	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
firm	Identifier of Firm to Update.	string

Body Parameters

Name	Description	Data Type	Required
firm		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.

firm

Request Body

Firm to update.

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...

SAMPLE REQUEST

curl -X PUT \
 https://api.seic.com/v1/trade/firms/1234\
  -H 'appkey: gsedgaerhDSHGRSH\
  -H 'authorization: Bearer ADsgdnnkjnfdIKJN' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d ' {
  "firm": "string",
  "firmName": "string",
  "userShare": true,
  "firmRoles": [
    {
      "roleName": "string",
      "rolePermissions": {
        "viewPipeline": true,
        "editPipeline": true,
        "viewDetails": true,
        "editDetails": true,
        "submitRequests": true,
        "reviewApprove": true
      }
    }
  ]
}'

REQUEST HEADER

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

REQUEST PAYLOAD MODEL

Operations

Name	Description	Data Type (L)
firm	An optional identifier that can be used to link a Firm to an Opportunity.	object
firmName	The full name of the firm or client.	string
userShare	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	string
firmRoles	The role(s) associated with the firm.	array
roleName	The role name(s) associated with the user.	string
rolePermissions	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	object
viewPipeline	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
editPipeline	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
viewDetails	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
editDetails	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
submitRequests	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
reviewApprove	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean

RESPONSE HEADER

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

SAMPLE RESPONSE

{
  "data": {
    "firm": "string",
    "firmName": "string",
    "userShare": true,
    "firmRoles": [
      {
        "roleName": "string",
        "rolePermissions": {
          "viewPipeline": true,
          "editPipeline": true,
          "viewDetails": true,
          "editDetails": true,
          "submitRequests": true,
          "reviewApprove": true
        }
      }
    ]
  }
}

MODEL

Operations

Name	Description	Data Type (L)
firmId	The identifier of the firm.	string
firmName	The full name of the firm or client.	string
userShare	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	string
firmRoles	The role(s) associated with the firm.	array
roleName	The role name(s) associated with the user.	string
rolePermissions	An enumerated list where values are 'true' or 'false'.	object
viewPipeline	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
editPipeline	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
viewDetails	An enumerated list where values are 'true' or 'false'.	boolean
editDetails	An enumerated list where values are &#039 true&#039 or &#039 false&#039 .	boolean
submitRequests	An enumerated list where values are 'true' or 'false'.	boolean
reviewApprove	An enumerated list where values are 'true' or 'false'.	boolean

Firm

PUT

/firms/{firm}

This API call updates a Firm in SEI Trade.

Prod:

https://api.seic.com/v1/trade/firms/{firm}

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	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
firm	Identifier of Firm to Update.	string

Body Parameters

Name	Description	Data Type	Required
firm		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.

firm

Request Body

Firm to update.

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...

Working...