Subscribe

esign-subscribe-post

POST

/esign/subscribe

Subscribe to receive real time notifications whenever the esign status for signers changes for a given Tracking number or the Opportunity group. If either the trackingNumber or opportunityGroupID is not provided, the Client is subscribed globally.
Prod:
https://api.seic.com/v1/trade/esign/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
  • 200

    Successfully subscribed for ESign Ceremony process.

  • 400

    Malformed request.

  • 401

    Invalid or expired authorization.

  • 403

    Access forbidden for resource.

  • 404

    Not Authorized to perform this action.

  • 405

    Method is not allowed on specified resource.

  • 409

    The request cannot be completed due to conflict with current state of the resource.

  • 422

    Payload is invalid.

  • 500

    Internal server error.

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

HTTP Basic

OAuth 2.0

API Key

Working...

Subscribe

esign-subscribe-post

POST

/esign/subscribe

Subscribe to receive real time notifications whenever the esign status for signers changes for a given Tracking number or the Opportunity group. If either the trackingNumber or opportunityGroupID is not provided, the Client is subscribed globally.
Prod:
https://api.seic.com/v1/trade/esign/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
  • 200

    Successfully subscribed for ESign Ceremony process.

  • 400

    Malformed request.

  • 401

    Invalid or expired authorization.

  • 403

    Access forbidden for resource.

  • 404

    Not Authorized to perform this action.

  • 405

    Method is not allowed on specified resource.

  • 409

    The request cannot be completed due to conflict with current state of the resource.

  • 422

    Payload is invalid.

  • 500

    Internal server error.

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

HTTP Basic

OAuth 2.0

API Key

Working...

Test: https://test.api.seic.com/v1/trade/esign/subscribe
TLS*: https://mtls.api.seic.com/v1/trade/esign/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

Subscribe

esign-subscribe-post

POST

/esign/subscribe

Subscribe to receive real time notifications whenever the esign status for signers changes for a given Tracking number or the Opportunity group. If either the trackingNumber or opportunityGroupID is not provided, the Client is subscribed globally.
Prod:
https://api.seic.com/v1/trade/esign/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
  • 200

    Successfully subscribed for ESign Ceremony process.

  • 400

    Malformed request.

  • 401

    Invalid or expired authorization.

  • 403

    Access forbidden for resource.

  • 404

    Not Authorized to perform this action.

  • 405

    Method is not allowed on specified resource.

  • 409

    The request cannot be completed due to conflict with current state of the resource.

  • 422

    Payload is invalid.

  • 500

    Internal server error.

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

HTTP Basic

OAuth 2.0

API Key

Working...

SAMPLE REQUEST

curl --location --request POST 'https://api.seic.com/v1/trade/esign/subscribe' \
--header 'Authorization: Bearer OYpZRATaCdWtrp8akNoLRfmG8t8X' \
--header 'AppKey: GeIeCDxU5c9GDbVnwdnXVxK1nGChAG2O' \
--data-raw '{
   "trackingNumber": "5EBC3164TBKEXB0",
   "opportunityGroupID": "string",
   "url": "https://webhook.site/7ba539f0-fe26-4249-a546-86558681b0bd",  
   "failureEmailAddress": "email@email.com"  
}


REQUEST HEADER

Authorization: Bearer OYpZRATaCdWtrp8akNoLRfmG8t8X
AppKey: GeIeCDxU5c9GDbVnwdnXVxK1nGChAG2O
Content-Type: application/json
REQUEST PAYLOAD MODEL
Operations
Name Description Data Type (L)
trackingNumber

A unique tracking number assigned to a specific request.

string
url

The callback URL to which you wish to receive notifications.

string
opportunityGroupId A unique identifier for a group of opportunities. A group Id will have multiple tracking numbers. string
RESPONSE HEADER

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


SAMPLE RESPONSE

{
  "subscriptionId": "14"
}
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


Subscribe

esign-subscribe-post

POST

/esign/subscribe

Subscribe to receive real time notifications whenever the esign status for signers changes for a given Tracking number or the Opportunity group. If either the trackingNumber or opportunityGroupID is not provided, the Client is subscribed globally.
Prod:
https://api.seic.com/v1/trade/esign/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
  • 200

    Successfully subscribed for ESign Ceremony process.

  • 400

    Malformed request.

  • 401

    Invalid or expired authorization.

  • 403

    Access forbidden for resource.

  • 404

    Not Authorized to perform this action.

  • 405

    Method is not allowed on specified resource.

  • 409

    The request cannot be completed due to conflict with current state of the resource.

  • 422

    Payload is invalid.

  • 500

    Internal server error.

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

HTTP Basic

OAuth 2.0

API Key

Working...

Subscribe

esign-subscribe-post

POST

/esign/subscribe

Subscribe to receive real time notifications whenever the esign status for signers changes for a given Tracking number or the Opportunity group. If either the trackingNumber or opportunityGroupID is not provided, the Client is subscribed globally.
Prod:
https://api.seic.com/v1/trade/esign/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
  • 200

    Successfully subscribed for ESign Ceremony process.

  • 400

    Malformed request.

  • 401

    Invalid or expired authorization.

  • 403

    Access forbidden for resource.

  • 404

    Not Authorized to perform this action.

  • 405

    Method is not allowed on specified resource.

  • 409

    The request cannot be completed due to conflict with current state of the resource.

  • 422

    Payload is invalid.

  • 500

    Internal server error.

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

HTTP Basic

OAuth 2.0

API Key

Working...

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



STEP 2

Pass the OAuth Token and the App Key to invoke this endpoint for a particular application

Subscribe

esign-subscribe-post

POST

/esign/subscribe

Subscribe to receive real time notifications whenever the esign status for signers changes for a given Tracking number or the Opportunity group. If either the trackingNumber or opportunityGroupID is not provided, the Client is subscribed globally.
Prod:
https://api.seic.com/v1/trade/esign/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
  • 200

    Successfully subscribed for ESign Ceremony process.

  • 400

    Malformed request.

  • 401

    Invalid or expired authorization.

  • 403

    Access forbidden for resource.

  • 404

    Not Authorized to perform this action.

  • 405

    Method is not allowed on specified resource.

  • 409

    The request cannot be completed due to conflict with current state of the resource.

  • 422

    Payload is invalid.

  • 500

    Internal server error.

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

HTTP Basic

OAuth 2.0

API Key

Working...

SAMPLE REQUEST

curl --location --request POST 'https://api.seic.com/v1/trade/esign/subscribe' \
--header 'Authorization: Bearer OYpZRATaCdWtrp8akNoLRfmG8t8X' \
--header 'AppKey: GeIeCDxU5c9GDbVnwdnXVxK1nGChAG2O' \
--data-raw '{
   "trackingNumber": "5EBC3164TBKEXB0",
   "opportunityGroupID": "string",
   "url": "https://webhook.site/7ba539f0-fe26-4249-a546-86558681b0bd",  
   "failureEmailAddress": "email@email.com"  
}


REQUEST HEADER

Authorization: Bearer OYpZRATaCdWtrp8akNoLRfmG8t8X
AppKey: GeIeCDxU5c9GDbVnwdnXVxK1nGChAG2O
Content-Type: application/json
REQUEST PAYLOAD MODEL
Operations
Name Description Data Type (L)
trackingNumber

A unique tracking number assigned to a specific request.

string
url

The callback URL to which you wish to receive notifications.

string
opportunityGroupId A unique identifier for a group of opportunities. A group Id will have multiple tracking numbers. string
RESPONSE HEADER

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


SAMPLE RESPONSE

{
  "subscriptionId": "14"
}
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


Subscribe

esign-subscribe-post

POST

/esign/subscribe

Subscribe to receive real time notifications whenever the esign status for signers changes for a given Tracking number or the Opportunity group. If either the trackingNumber or opportunityGroupID is not provided, the Client is subscribed globally.
Prod:
https://api.seic.com/v1/trade/esign/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
  • 200

    Successfully subscribed for ESign Ceremony process.

  • 400

    Malformed request.

  • 401

    Invalid or expired authorization.

  • 403

    Access forbidden for resource.

  • 404

    Not Authorized to perform this action.

  • 405

    Method is not allowed on specified resource.

  • 409

    The request cannot be completed due to conflict with current state of the resource.

  • 422

    Payload is invalid.

  • 500

    Internal server error.

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

HTTP Basic

OAuth 2.0

API Key

Working...