AM - Remove Service Provider from Offering

Service providers are third-party organizations, such as fund administrators, that take part in tasks associated with the lifecycle of an offering.

Details

/external/v1/service-providers/remove

Synopsis

Remove Service Provider from Offering

put

This route is used to remove a service provider from an existing offering (e.g. unassigning a fund admin). This will prevent further actions from being executed by the removed organization on this security and it will no longer be entitled to receiving new transactions' data. This should only be triggered by the organization that owns the security. It triggers an asynchronous process that will persist this information on the blockchain, which can be monitored using the "Transactions API" endpoints. This endpoint can't be invoked if the security is restricted. This endpoint can be called by applications with access to scope "manageServiceProviders".

Required scopes

This endpoint requires the following scopes:

• : manageServiceProviders

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

orgIdstringRequired

The id of the service provider organization. Used to uniquely identify the organization on the ledger

Example: US9QIMA

Responses

200

Successfully triggered the removal

application/json

processIdstringRequired

This is used to uniquely identity a transaction process on this system.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

orchestrationIdstringRequired

The orchestration id. It is used to uniquely identity a group of transactions that are being orchestrated following an action request.If a processId was passed as an input to the action, it will be returned on this property.

Example: 2159457f-0167-4e93-a969-9cf0db05e0bf

400

The following error codes can be returned: - GN0002 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 - AU0003 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 - OG0004 - OG0005 - IS0099 Please refer to the error code dictionary for the details of each error code.

application/json

404

The following error codes can be returned: - IS0009 - OG0001 Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned: - IS0119 - IS0013 - IS0010 - IS0062 - IS0117 - SP0004 - SP0005 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/service-providers/remove

HTTPcURLJavaScriptPython

PUT /external/v1/service-providers/remove HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "orgId": "US9QIMA"
}

{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}

Important Notes

• Caller must be the security owner.

• securityId: uniquely identifies the fund/offering. See Managing the SecurityId.

• See Blockchain Transaction Tracking for information on using orchestrationId and processId.