This route is used to retrieve the details of securities given a set of search filters.
This endpoint is paginated, up to 10 records can be retrieved per call.
This endpoint can be called by applications with access to scope "readIssuance".
Required scopes
This endpoint requires the following scopes:
: readIssuance
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).
securityStatusFilterstringOptional
The comma delimited list of statuses to filter the security records. Up to 14 entries can be provided.Available values: deleted, preSync, active, closed, completed, bust_in_progress, busted, cancel_in_progress, canceled, refund_in_progress, retired, approved_revert_to_active, paused, archived
Example: active,closed
securityTypeFilterstringOptional
The comma delimited list of security types to filter the security records. Up to 8 entries can be provided.Available values: equity, lpUnits, llcUnits, spcUnits, convertible, lpInterest, llcUnitShares, cash
Example: equity,llcUnitShares
securityIdsFilterstringOptional
The comma delimited list of security ids to filter the security 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 security records. Up to 10 records can be provided. Each record should not exceed 100 characters. Any entry on this list that could contain commas should be withing "" like so: "this is , the correlation id".
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.
Responses
200
Successfully retrieved the Issuance 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.
