company

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"

Authorizations
Path parameters
transferIdanyRequired

The id that uniquely identifies the transfer on the ledger.

Example: TEST0000
Body
referenceDataall ofOptional

This property contains the reference data information for investor/account. Can optionally be passed to update the investor and account data as part of this action

Example: {"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"}}}}
transactionDataall ofRequired

This property contains the transactional data information, i.e. transfer data to be remediated and which is the security of the transfer

Example: {"securityId":"USS3JKS01I00","amount":50000,"transferReason":"gift","sourceAccountData":{"orgId":"TEST1234","accountId":"TEST67891"},"signer":{"email":"[email protected]","name":"John Doe"}}
Responses
200
Successfully triggered the remediation of the transfer data.
application/json
put
PUT /external/v1/transfer/{transferId}/remediate HTTP/1.1
Host: 
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

PreviousAM/FA - Request Transfer RemediationNextInv - Allocate Transfer Assets

Last updated

Was this helpful?