AM/FA/Inv - Update Investor's Reference Data

Details

/external/v1/investor/{investorId}

Synopsis

Update Investor`s reference data

put

This route is used to update investor's reference data. Should be called by the organization that created specified investor record. 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 called by applications with access to scope "manageReferenceData".

Required scopes

This endpoint requires the following scopes:

• : manageReferenceData

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

investorIdstringRequired

The unique identifier of the investor on the blockchain

Example: USS3JKS01I00

Body

application/json

transactionDataall ofRequired

This property contains the information regarding who is signing the transaction on the blockchain as well as how it will be signed

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

dataall ofRequired

This property contains the investor reference data information.

Example: {"type":"individual","accreditationLevel":"qualifiedClient","isInstitutional":false,"hasKYCPassed":false,"isComplianceApproved":false,"is5131RestrictedPerson":false,"isNominee":true,"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"}}}

Responses

200

Successfully triggered the process to update the investor's reference data on the ledger 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 - IV0009 - IV0023 - IV0036 - IV0014 - IV0015 - IV0031 - 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 Please refer to the error code dictionary for the details of each error code.

application/json

404

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

application/json

409

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

application/json

put

/external/v1/investor/{investorId}

HTTPcURLJavaScriptPython

PUT /external/v1/investor/{investorId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 920

{
  "transactionData": {
    "signer": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  },
  "data": {
    "type": "individual",
    "accreditationLevel": "qualifiedClient",
    "isInstitutional": false,
    "hasKYCPassed": false,
    "isComplianceApproved": false,
    "is5131RestrictedPerson": false,
    "isNominee": true,
    "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"
      }
    }
  }
}

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

Important Notes

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