Inv - Remediate Transfer

Details

/external/v1/transfer/{transferId}/remediate

Synopsis

Remediate Transfer

put

This route is used to trigger transfer data remediation on the blockchain by the recipient investor organization. This means that the recipient investor organization has updated the transfer after being requested data remediation. 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: ["investor"]. 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: ["remediation_pending","created"]. This endpoint can't be invoked if the security is restricted. This endpoint can be called by applications with access to scope "manageTransfer"

Required scopes

This endpoint requires the following scopes:

• : manageTransfer

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

transferIdanyRequired

The id that uniquely identifies the transfer on the ledger.

Example: TEST0000

Body

application/json

Responses

200

Successfully triggered the remediation of the transfer data.

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

transferIdstringRequired

The id that uniquely identifies the transfer on the ledger.

Example: US9QIMAOAS1Q

fileIdsstring[]Required

The created document(s) file ID(s). Each ID uniquely identifies a file on the ledger.

Example: ["US9QIFILE1","US9QIFILE2"]

400

The following error codes can be returned: - GN0002 - IS0008 - IS0106 - TR0002 - IV0008 - IV0020 - IV0009 - IV0022 - IV0017 - IV0016 - IV0023 - IV0036 - IV0037 - AC0049 - AC0031 - AC0032 - AC0033 - AC0034 - AC0035 - AC0026 - AC0023 - AC0050 - AC0027 - FL0002 - FL0003 - FL0019 - FL0004 - FL0005 - FL0017 - FL0020 - QU0001 - QU0002 - QU0003 - QU0004 - QU0005 - QU0006 - QU0007 - QU0008 - QU0009 - QU0010 - CI0001 - CI0002 - CI0003 - CI0004 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 - IV0013 - AC0020 - 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 - TR0001 - OG0001 - IV0002 - AC0002 - FL0008 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 - IS0063 - IS0013 - IS0002 - IS0012 - TR0008 - TR0009 - TR0007 - TR0003 - TR0006 - TR0004 - TR0030 - TR0031 - IV0003 - AC0009 - AC0010 - AC0029 - FL0001 - FL0006 - FL0010 - FL0011 - FL0028 Please refer to the error code dictionary for the details of each error code.

application/json

put

/external/v1/transfer/{transferId}/remediate

HTTPcURLJavaScriptPython

PUT /external/v1/transfer/{transferId}/remediate HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2625

{
  "referenceData": {
    "investors": [
      {
        "investorId": "TEST123345",
        "data": {
          "type": "individual",
          "accreditationLevel": "qualifiedClient",
          "isInstitutional": false,
          "hasKYCPassed": false,
          "isComplianceApproved": false,
          "is5131RestrictedPerson": false,
          "name": "John Doe",
          "individualInfo": {
            "name": "John Doe",
            "dateOfBirth": "2024-09-12",
            "taxId": "123456789",
            "occupation": {
              "role": "Software Engineer",
              "companyName": "Sample Company"
            },
            "residentialAddress": {
              "addressLineOne": "8 Greenway Plaza",
              "addressLineTwo": "Suite 1515",
              "country": "US",
              "state": "Texas",
              "city": "Houston",
              "zipCode": "77046 USA"
            },
            "mailingAddress": {
              "addressLineOne": "8 Greenway Plaza",
              "addressLineTwo": "Suite 1515",
              "country": "US",
              "state": "Texas",
              "city": "Houston",
              "zipCode": "77046 USA"
            },
            "isUsPerson": true,
            "contactInfo": [
              {
                "email": "[email protected]",
                "phoneNumber": "832-426-4242"
              }
            ],
            "extraData": {
              "externalInvestorId": "123456",
              "some": "other property"
            }
          }
        }
      }
    ],
    "account": {
      "accountId": "TEST67891",
      "data": {
        "name": "Individual Account",
        "type": "Individual",
        "relationshipType": "Brokerage",
        "bankAccount": {
          "accountNumber": "111111111",
          "accountName": "savings account",
          "bankABA": "555555555",
          "bankName": "Test Bank",
          "bankSwift": "AAAA-BB-CC-123",
          "extraData": {
            "settlementInstructions": "Please wire the amount within 72 hours",
            "some": "Other Property"
          }
        },
        "contactInfo": [
          {
            "email": "[email protected]",
            "phoneNumber": "832-426-4242",
            "type": "primary"
          },
          {
            "email": "[email protected]",
            "phoneNumber": "987-564-1234",
            "type": "tax",
            "name": "John Doe",
            "description": "Use this contact for Tax Related Information (K-1, 1099 or other tax related information)"
          }
        ],
        "custodian": {
          "data": {
            "name": "Charles Schwab"
          }
        },
        "advisors": [
          {
            "data": {
              "type": "FA",
              "name": "Chris Smith",
              "crdCode": "546321",
              "repCode": "AB98765"
            }
          }
        ],
        "authorizedSigners": [
          {
            "name": "Jane Doe",
            "primary": true,
            "extraData": {
              "externalId": "123456",
              "some": "Other Property"
            }
          }
        ],
        "beneficiaries": [
          {
            "name": "John Doe",
            "beneficialOwnership": 40,
            "individualInfo": {
              "name": "John Doe",
              "taxId": "123456789"
            }
          },
          {
            "name": "Jane Doe LLC",
            "beneficialOwnership": 60,
            "legalEntityInfo": {
              "name": "Jane Doe Private Investments and Capital Management, LLC",
              "type": "LLC",
              "taxId": "987654321"
            }
          }
        ],
        "secureExtraData": {
          "sensitive": "Data to be protected by application encryptions"
        }
      }
    }
  },
  "transactionData": {
    "securityId": "USS3JKS01I00",
    "amount": 50000,
    "transferReason": "gift",
    "sourceAccountData": {
      "orgId": "TEST1234",
      "accountId": "TEST67891"
    },
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "documents": [
    {
      "uploadData": {
        "type": "IdentityVerification",
        "extension": "pdf",
        "name": "John Doe ID",
        "link": "https://test-storage.s3.amazonaws.com/some-id.pdf"
      },
      "extraData": {
        "someCustom": "property to be shared"
      }
    },
    {
      "fileId": "FILE3JUS03I04"
    }
  ]
}

{
  "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"
      }
    ]
  }
}

Important Notes

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