Inv - Get Pending Assignment

Details

/external/v1/exclusivity/pending-assignments

Synopsis

Get Pending Assignment

get

This route is used to get the pending assignment requests for this current organization. This endpoint can be called by applications with access to scope "readExclusivityOptions".

Required scopes

This endpoint requires the following scopes:

• : readExclusivityOptions

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Responses

200

Successfully extracted data

application/json

securityIdstringRequired

This is the security identifier. It uniquely identifies a particular offering on the blockchain.

Example: USS3JKS01I00

createdDatestring · date-timeRequired

The date in which the assignment took place

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

syncJobStatusall ofRequired

The status of the issuance synchronization

Example: success

string · enumOptional

The status of the issuance synchronization

Possible values:

blockNumberstringOptional

The block number of the ledger transaction where the assignment took place.

blockchainTransactionIdstringOptional

The id of the transaction on the ledger where the assignment took place.

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/exclusivity/pending-assignments

HTTPcURLJavaScriptPython

GET /external/v1/exclusivity/pending-assignments HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "securityId": "USS3JKS01I00",
    "assignerOrg": {
      "name": "Test Issuer",
      "orgId": "US9QIMA"
    },
    "createdDate": "2024-09-12T00:00:00.000Z",
    "details": [
      {
        "securityId": "USS3JKS01I00",
        "status": "assigned"
      }
    ],
    "syncJobStatus": "success",
    "blockNumber": "text",
    "blockchainTransactionId": "text"
  }
]