AM/FA/Inv - Get File Correlation IDs History

Details

/external/v1/file/correlation-id/history

Synopsis

Get File Correlation Ids History

get

This route is used to retrieve the history data entries of file correlation ids given a set of filters such as blockchain details or file identifiers.

The history entries will reflect the state of the file correlation ids on a particular block on the ledger.

This endpoint returns paginated data. Up to 20 can be extracted per call.

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

Authorizations

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-]*$

fileIdsFilterstringOptional

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

Example: USCCWSF01I00,USCCWSF01I01

fileCorrelationIdsFilterstringOptional

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

Example: 1234,5678,7890

fileCorrelationOrgIdstring · max: 12Optional

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

Responses

200

Successfully retrieved the File Correlation Ids history entries

application/json

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

HTTPcURLJavaScriptPython

GET /external/v1/file/correlation-id/history HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "signerData": {
      "name": "John Doe",
      "email": "[email protected]"
    },
    "timestamp": "2024-09-12T00:00:00.000Z",
    "blockNumber": 350,
    "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
    "channelName": "OG123",
    "organization": {
      "name": "Test Organization",
      "orgId": "TEST1234"
    },
    "hash": "$argon2id$v=19$m=4096,t=3,p=1$8AVpNOnlBvN/reiv7Rdkpw$lzXOuG0H4SibMa0elrEZ5sq3YAvdu+Y5L+ta0oSSMTg",
    "update": [
      {
        "correlationId": "123245573717",
        "entityType": "investor",
        "entityId": "123245573717",
        "status": "broadcast",
        "origin": "Backoffice-system-123",
        "organization": {
          "name": "Test Organization",
          "orgId": "TEST1234"
        }
      }
    ]
  }
]