AM/TA/Inv - Get Asset Details

Details

/external/v1/asset

Synopsis

Get Asset Details

get

This route is used to retrieve the details of assets, given a set of search filters. This endpoint is paginated, up to 500 records can be retrieved per call. This value is reduced to 50 if the query param "includeComments" is set to "true". This endpoint can be called by applications with access to scope "readSubscription".

Required scopes

This endpoint requires the following scopes:

• : readSubscription

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).

includeCommentsbooleanOptional

Set this to "true" if "comments" are to be included in the response. Leave empty or set to "false" to skip retrieving asset comments. If this is set to "true" then the maximum number of records that can be pulled per call is reduced to 50. The full list of asset comments can always be consulted using the Comments API.

Example: true

excludeCommentReviewStatusFilterstringOptional

The comma delimited list of comment review statuses to exclude from asset comments. Up to 7 entries can be provided.Available values: draft, pending, fix_provided, resolved, fixRejected, declined, not_resolved

Example: resolved,draft

assetStatusFilterstringOptional

The comma delimited list of statuses to filter the asset records. Up to 27 entries can be provided.Available values: deleted, preSynced, created, modified, confirmed, settlement_confirmation_pending, settled, issued, busted, canceled, disposed, recalled, remediated, remediation_pending, locked, trade_proposed, in_trade, in_trade_pending, in_transfer, in_transfer_pending, restricted, retired, refunded, in_tender, in_tender_pending, template, locked_for_redemption

Example: created,settled

securityIdsFilterstringOptional

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

Example: USCCWSF01I00,USCCWSF01I01

securityCorrelationIdsFilterstringOptional

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

Example: 1234,5678,7890

assetIdsFilterstringOptional

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

Example: USCCWSF01I00,USCCWSF01I01

assetCorrelationIdsFilterstringOptional

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

Example: 1234,5678,7890

accountIdsFilterstringOptional

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

Example: USCCWSF01I00,USCCWSF01I01

accountCorrelationIdsFilterstringOptional

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

Example: 1234,5678,7890

securityCorrelationOrgIdstring · max: 12Optional

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

accountCorrelationOrgIdstring · max: 12Optional

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

assetCorrelationOrgIdstring · max: 12Optional

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

modelAssetIdsFilterstringOptional

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

Example: USCCWSF01I00,USCCWSF01I01

investorIdsFilterstringOptional

The comma delimited list of investor ids to filter the asset records. Up to 10 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 asset records. Up to 10 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.

closeIdsFilterstringOptional

The comma delimited list of close ids to filter the asset records. Up to 10 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 asset records. Up to 10 records can be provided. 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 asset details

application/json

assetIdstringRequired

The ID of the digital asset

Example: US9QIMAOAS1Q

modelAssetIdstringOptional

The ID of the model asset associated to this asset.

Example: USS3JKS01I00

modelPortfolioIdstringOptional

The ID of the model portfolio from which this asset was booked.

Example: USS3JKS01I00

modelClassIdstringOptional

The ID of the model class linked to the model portfolio from which this asset was booked.

Example: USS3JKS01I00

securityIdstringRequired

The security id of the issuance from which this asset was purchased from.

Example: USCCWSF01I00

closeIdstringRequired

The id of the close when this asset was issued.

Example: USCCWSF01I00

accountIdstringRequired

The unique identifier of the account where the asset is being held.

Example: US9QIMAOAS1Q

acquiredDatestring · date-timeRequired

The date on which the asset was purchased.

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

disposedDatestring · date-timeOptional

The date on which the asset was disposed.

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

acquiredPricenumberRequired

Price at which the asset was purchased

Example: 100

disposedPricenumberOptional

Price at which the asset was disposed

Example: 200

issuedDatestring · date-timeOptional

The date on which the asset was issued

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

amountnumberRequired

The amount of money invested in the security.

Example: 1000

sharesNumbernumberOptional

The number of shares for unitized financial instruments.

Example: 1000

commissionnumberOptional

The absolute value of the commission paid to the advisors.

Example: 1000

currentValuenumberOptional

The current asset value

Example: 1200

redemptionAmountnumberOptional

The current asset redemption amount waiting for approval

Example: 500

statusall ofRequired

The status of the asset

Example: issued

string · enumOptional

The status of the asset

Possible values:

reviewStatusall ofRequired

The current status of the asset (i.e. subscription) review process. Typically it would go through the following stages: - initial: when the subscription is undergoing basic validations - detailed: when the subscription is undergoing thorough checks from the various teams (legal, client services, KYC/AML, etc...) - final: when all the comments have been collected and the final reviewers are determining which action to take (accept, reject, request remediation) - completed: when the review has been completed and the final action taken (accept, reject, request remediation)

Example: initial

string · enumOptional

The current status of the asset (i.e. subscription) review process. Typically it would go through the following stages: - initial: when the subscription is undergoing basic validations - detailed: when the subscription is undergoing thorough checks from the various teams (legal, client services, KYC/AML, etc...) - final: when all the comments have been collected and the final reviewers are determining which action to take (accept, reject, request remediation) - completed: when the review has been completed and the final action taken (accept, reject, request remediation)

Possible values:

shouldReinvestbooleanRequired

Should dividends, if any, be reinvested

Example: false

customCostBasisbooleanRequired

Has a custom cost basis calculation been applied

Example: false

customCostBasisValuenumberOptional

Custom cost basis value

Example: 100

completedByAdvisorIdstringOptional

The id of the advisor who proposed this investment

subDocSignDatestring · date-timeRequired

Date on which the subscription agreement was signed

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

originatingTradeIdstringOptional

Id of the trade that originated the asset

Example: 345023

fileIdsstring[]Optional

The list of asset document(s) file Id(s). The "Files API" can be used to get the details regarding these files.

Example: ["US9QIFILE1","US9QIFILE2"]

bookingModelall ofRequired

The booking model defined by investing org when assigned and accepted in security the asset belongs to.

Example: fullyDisclosedFBO

string · enumOptional

The booking model defined by investing org when assigned and accepted in security the asset belongs to.

Possible values:

underlyingInvestorAccountIdstringOptional

The underlying investor account number when asset booking model defined by investing org is of type omnibus. This is only available on the investing organization, it is never shared with the issuer. Use this id on the "Accounts API" to obtain the full details of the underlying account and its investors.

Example: US9QIMAOAC3F

typeall ofRequired

The type of an asset, could be standard or offline

Example: standard

string · enumOptional

The type of an asset, could be standard or offline

Possible values:

inputIdsstring[]Optional

The list of asset ids that were used to create this one (e.g. split transfers, partial lot sells on secondary market or tender offers.

Example: ["US9QIMAOAS1Q"]

positionIdstringOptional

The unique identifier of the position where the asset is being held. A position is defined by its id or alternative by the unique pair account id + security id.

Example: US9QIMAOAS1Q

purchaseDefinitionall ofOptional

This field defines if this is a new investment or a subsequent investment on an existing security. It is optional.

Example: initial

string · enumOptional

This field defines if this is a new investment or a subsequent investment on an existing security. It is optional.

Possible values:

ownerNamestringOptional

The asset owner name.

Example: <WeInvest Inc.> fbo "John Doe, Jane Doe"

lockedbooleanRequired

True if the asset is locked for edit (e.g. while executing certain blockchain actions), false otherwise.

Example: false

latestUpdateTimestampstring · date-timeOptional

The timestamp of the latest update to this asset. This will match the "timestamp" obtained via asset history endpoint for the latest block where this asset's data was recorded.

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

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/asset

HTTPcURLJavaScriptPython

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

[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "assetId": "US9QIMAOAS1Q",
    "modelAssetId": "USS3JKS01I00",
    "modelPortfolioId": "USS3JKS01I00",
    "modelClassId": "USS3JKS01I00",
    "securityId": "USCCWSF01I00",
    "closeId": "USCCWSF01I00",
    "accountId": "US9QIMAOAS1Q",
    "acquiredDate": "2024-09-12T00:00:00.000Z",
    "disposedDate": "2024-09-12T00:00:00.000Z",
    "acquiredPrice": 100,
    "disposedPrice": 200,
    "issuedDate": "2024-09-12T00:00:00.000Z",
    "amount": 1000,
    "sharesNumber": 1000,
    "commission": 1000,
    "currentValue": 1200,
    "redemptionAmount": 500,
    "remediationProposal": {
      "amount": 500
    },
    "tenderProposal": {
      "sharesNumberSubmitted": 500,
      "sharesNumberAccepted": 500,
      "tradeId": "TEST1234"
    },
    "capitalCallDetails": {
      "calledAmount": 300000,
      "calledAmountOutsideCommitment": 5000,
      "distributedAmount": 10000,
      "enabled": true
    },
    "status": "issued",
    "reviewStatus": "initial",
    "shouldReinvest": false,
    "customCostBasis": false,
    "customCostBasisValue": 100,
    "completedByAdvisorId": "text",
    "subDocSignDate": "2024-09-12T00:00:00.000Z",
    "originatingTradeId": 345023,
    "fileIds": [
      "US9QIFILE1",
      "US9QIFILE2"
    ],
    "bookingModel": "fullyDisclosedFBO",
    "underlyingInvestorAccountId": "US9QIMAOAC3F",
    "fees": {
      "frontendFee": 1,
      "backendFee": 0,
      "managementFees": [
        {
          "description": "IP: annually of capital commitments | 6 years from the date of initial investment",
          "value": 2,
          "unit": "percentage",
          "frequency": "Annually"
        },
        {
          "description": "Post-IP: annually on invested capital (remaining cost) | 11 years from the initial investment with 2 one-year extension options",
          "value": 1.5,
          "unit": "percentage",
          "frequency": "Annually"
        }
      ],
      "investorServicingFees": [
        {
          "description": "IP: annually of capital commitments | 6 years from the date of initial investment",
          "value": 3,
          "unit": "percentage",
          "frequency": "Annually"
        },
        {
          "description": "Post-IP: annually on invested capital (remaining cost) | 11 years from the initial investment with 2 one-year extension options",
          "value": 2.5,
          "unit": "percentage",
          "frequency": "Annually"
        }
      ],
      "otherFees": [
        {
          "groupName": "Global fees",
          "groupDetails": [
            {
              "description": "Some global fee",
              "value": 75,
              "unit": "basisPoints",
              "frequency": "One-Off"
            }
          ]
        },
        {
          "groupName": "Bank fees",
          "groupDetails": [
            {
              "description": "Bank fees - tier 1 - $5,000,000 - $9,999,999",
              "value": 50,
              "unit": "basisPoints",
              "frequency": "One-Off"
            }
          ]
        }
      ]
    },
    "type": "standard",
    "inputIds": [
      "US9QIMAOAS1Q"
    ],
    "organization": {
      "orgId": "TEST1234",
      "name": "Test Organization"
    },
    "externalEntityStateData": [
      {
        "organization": {
          "orgId": "TEST1234",
          "name": "Test Organization"
        },
        "state": {
          "status": "PENDING",
          "extraData": {
            "some": "custom property"
          }
        }
      }
    ],
    "positionId": "US9QIMAOAS1Q",
    "purchaseDefinition": "initial",
    "correlationData": [
      {
        "correlationId": "123245573717",
        "origin": "Identifies security on backoffice",
        "organization": {
          "name": "Test Organization",
          "orgId": "TEST1234"
        },
        "extraData": {
          "some": "Custom Property"
        }
      }
    ],
    "ownerName": "<WeInvest Inc.> fbo \"John Doe, Jane Doe\"",
    "locked": false,
    "latestUpdateTimestamp": "2024-09-12T00:00:00.000Z",
    "comments": [
      {
        "commentId": "US9QICOMMENT1",
        "message": "Invalid signature was provided",
        "category": "EC003",
        "status": "broadcast",
        "viewOrgs": [
          "US9QIORG1",
          "US9QIORG2"
        ],
        "type": "review",
        "reviewStatus": "pending",
        "flaggedDocument": {
          "document": {
            "fileId": "US9QIFILE1"
          },
          "details": {
            "issueType": "mismatch",
            "pageNumber": 1,
            "additionalNotes": "The signature on the top of the page is different than expected according to the provided ID document",
            "pageSectionDetails": "Signature Form"
          }
        },
        "organization": {
          "orgId": "TEST1234",
          "name": "Test Organization"
        }
      }
    ],
    "positionDetails": {
      "dividendReinvestmentPlanElection": "cash",
      "status": "sync",
      "organization": {
        "orgId": "TEST1234",
        "name": "Test Organization"
      },
      "extraData": {
        "some": "custom property"
      }
    }
  }
]