company

AM/FA - Request Transfer Assets Remediation

Details

/external/v1/transfer/{transferId}/request-assets-remediation

Synopsis

Request Transfer Assets Remediation

put

This route is used to trigger an assets remediation request of the transfer asset draft details to the sender investor organization.

Asset manager that owns this security or fund admins assigned to this offering can execute this action, then once this call is completed the transfer will be marked as pending assetsremediation on the ledger and the sender organization will be able to amend the transfer request (e.g. update assets to be transfered data).

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 be invoked by 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 if the transfer is in one of the following statuses: ["approved_by_sender","assets_remediated"].

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

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

Authorizations
Path parameters
transferIdanyRequired

The id that uniquely identifies the transfer on the ledger.

Example: TEST0000
Body
transactionDataall ofRequired

This property contains the transactional data information, i.e. which is the security where the remediation request was created

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

This property contains the reason for the rejection.

Example: {"reason":[{"message":"reject reason","category":"EC006","documentWithIssues":[{"document":{"fileId":"FILE3JUS03I04"},"pages":[{"pageNumber":1,"description":"The first page has an invalid signature"}]}]}],"extraData":{"externalId":"123456789","some":"Custom Property"}}
Responses
200
Successfully triggered the request for transfer assets remediation.
application/json
put
PUT /external/v1/transfer/{transferId}/request-assets-remediation HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 394

{
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "rejectReason": {
    "reason": [
      {
        "message": "reject reason",
        "category": "EC006",
        "documentWithIssues": [
          {
            "document": {
              "fileId": "FILE3JUS03I04"
            },
            "pages": [
              {
                "pageNumber": 1,
                "description": "The first page has an invalid signature"
              }
            ]
          }
        ]
      }
    ],
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    }
  }
}
{
  "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
  "transferId": "US9QIMAOAS1Q",
  "fileIds": [
    "US9QIFILE1",
    "US9QIFILE2"
  ],
  "referenceData": {
    "account": {
      "accountId": "US9QIMAOAS1Q",
      "custodian": {
        "custodianId": "US9ZIMAOAS1Q"
      }
    },
    "investors": [
      {
        "investorId": "US9QIM123S1Q"
      }
    ]
  }
}
PreviousInv - Allocate Transfer AssetsNextInv - Remediate Transfer Assets

Last updated

Was this helpful?