AM/FA - Remove Facilitation Account

Details

/external/v1/security-admin/facilitation-account/remove

Synopsis

Remove Facilitation Account

put

This route is used to remove a facilitation account from an existing security.

This update will be broadcast to organizations that have at least one of the following roles on this security: ["issuer","service_provider"].

This endpoint can be invoked if the security is in one of the following statuses: ["active","completed","approved_revert_to_active","closed"].

This endpoint can be invoked by organizations that have at least one of the following roles on this security: ["issuer","service_provider"].

This endpoint can't be invoked if the security is restricted.

It will trigger an asynchronous process (the id of which is returned on the success response) which can be monitored using the "Transactions API" endpoints.

This endpoint can be called by applications with access to scope "manageFacilitationAccount".

Authorizations

oauth2

Body

application/json

transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security for facilitation account removal

Example: {"securityId":"USS3JKS01I00","signer":{"email":"[email protected]","name":"John Doe"}}

accountDataall ofRequired

This property contains the reference data of the facilitation account to be removed.

Example: {"accountId":"ACCE3JUS03I04"}

Responses

200

Successfully triggered the process to remove facilitation account from the offering. The "processId" and "orchestrationId" properties can be used on the "Transactions API" to monitor the status of this asynchronous process.

application/json

400

The following error codes can be returned:

• GN0002

• IS0073

• AC0060

• AC0062

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

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

• AC0001

• IS0009

Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned:

• IS0013

• IS0012

• IS0002

• IS0010

• AC0052

• AC0053

Please refer to the error code dictionary for the details of each error code.

application/json

put

HTTPcURLJavaScriptPython

PUT /external/v1/security-admin/facilitation-account/remove HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "accountData": {
    "accountId": "ACCE3JUS03I04"
  }
}

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