AM/TA - Get Investor History

Details

/external/v1/investor/history

Synopsis

Get Investor History

get

This route is used to retrieve the history data entries of investors given a set of filters such as blockchain details or investor identifiers. The history entries will reflect the state of the investors on a particular block on the ledger. This endpoint returns paginated data. Up to 25 can be extracted per call. This endpoint can be called by applications with access to scope "readInvestor".

Required scopes

This endpoint requires the following scopes:

• : readInvestor

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Query parameters

pageSizenumberOptional

The number of rows being retrieved. Must be a positive integer.

offsetnumberOptional

The offset (i.e. row start index). Must be a positive integer (or 0).

blockNumbernumber · max: 2147483647Optional

The block number where the action was recorded on the ledger.

Example: 350

transactionIdstring · max: 500Optional

The transaction id where the action was recorded on the ledger.

Example: 456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$

channelNamestring · max: 20Optional

The name of the channel where the action was recorded on the ledger.

Example: OG123Pattern: ^[a-zA-Z0-9-]*$

investorIdsFilterstringOptional

The comma delimited list of investor ids to filter the investor records. Up to 25 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

investorCorrelationIdsFilterstringOptional

The comma delimited list of investor correlation ids to filter the investor records. Up to 25 records can be provided. Each record should not exceed 100 characters.

Example: 1234,5678,7890

investorCorrelationOrgIdstring · max: 12Optional

The organization identifier linked to the correlation ids provided in the "investorCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.

Responses

200

Successfully retrieved the Investors history

application/json

timestampstring · date-timeRequired

The timestamp of the action

Example: 2024-09-12T00:00:00.000Z

blockNumbernumberRequired

The block number where the investor history was recorded.

Example: 350

transactionIdstringRequired

The transaction id where the investor history was recorded.

Example: 456789OIJHGFCVGHJKLKJHGF67JH

channelNamestringRequired

The name of the channel where the investor history was recorded on the ledger.

Example: OG123

hashstringRequired

The hash of the referenced investor. Argon2id is used for hashing with dynamic salt

Example: $argon2id$v=19$m=4096,t=3,p=1$8AVpNOnlBvN/reiv7Rdkpw$lzXOuG0H4SibMa0elrEZ5sq3YAvdu+Y5L+ta0oSSMTg

400

The following error codes can be returned: - GN0002 - GN0004 - GN0005 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 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 Please refer to the error code dictionary for the details of each error code.

application/json

get

/external/v1/investor/history

HTTPcURLJavaScriptPython

GET /external/v1/investor/history HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "timestamp": "2024-09-12T00:00:00.000Z",
    "blockNumber": 350,
    "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
    "channelName": "OG123",
    "hash": "$argon2id$v=19$m=4096,t=3,p=1$8AVpNOnlBvN/reiv7Rdkpw$lzXOuG0H4SibMa0elrEZ5sq3YAvdu+Y5L+ta0oSSMTg",
    "update": {
      "investorId": "TEST123345",
      "type": "individual",
      "accreditationLevel": "qualifiedClient",
      "isInstitutional": false,
      "hasKYCPassed": false,
      "isComplianceApproved": false,
      "is5131RestrictedPerson": false,
      "name": "John Doe",
      "individualInfo": {
        "name": "John Doe",
        "dateOfBirth": "1984-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"
        },
        "isUsPerson": true,
        "contactInfo": [
          {
            "email": "[email protected]",
            "phoneNumber": "832-426-4242"
          }
        ],
        "extraData": {
          "externalInvestorId": "123456",
          "some": "other property"
        }
      },
      "organization": {
        "orgId": "TEST1234",
        "name": "Test Organization"
      }
    },
    "signerData": {
      "email": "[email protected]",
      "name": "John Doe"
    },
    "organization": {
      "name": "Test Organization",
      "orgId": "TEST1234"
    }
  }
]

Important Notes

• Returns a series of updates that make up the history of the identified investor.