AM/FA/Inv - Get Asset Details

Details

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

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

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

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

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

[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "assetId": "US9QIMAOAS1Q",
    "modelAssetId": "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"
      }
    }
  }
]

PreviousAM/FA/Inv - Get Security Correlation IDs History NextAM/FA/Inv - Get Asset History

Last updated 7 months ago

Was this helpful?