All pages
Powered by GitBook
1 of 1

Loading...

AM/FA/Inv - Get Issuance Close History

Details

/external/v1/issuance-close/history

Synopsis

Get Issuance Close History

get

This route is used to retrieve the history data entries of issuance close(s) given a set of filters such as blockchain details or close identifiers.

The history entries will reflect the state of the issuance close(s) on a particular block on the ledger.

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

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

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

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

Example: USCCWSF01I00,USCCWSF01I01
closeCorrelationIdsFilterstringOptional

The comma delimited list of close correlation ids to filter the close records. Each record should not exceed 100 characters.

Example: 1234,5678,7890
closeCorrelationOrgIdstring · max: 12Optional

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

Responses
200
Successfully retrieved the issuance close(s) history
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
GET /external/v1/issuance-close/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"
    },
    "event": "Created",
    "update": {
      "securityId": "US9QIMAOAS1Q",
      "closeId": "US9QIMAOAS1Q",
      "status": "created",
      "organization": {
        "orgId": "TEST1234",
        "name": "Test Organization"
      }
    }
  }
]