Description

The Locate API (v1) enables clients to submit bulk locate requests and retrieve request results through a standardized interface. The service supports: - Bulk locate request submission (POST /requests) - Request inquiry by client request ID, returning request information plus all locates under that request (GET /requests/{imRequestId}) - Request inquiry by client request ID with specified locate IDs, returning request information plus only the requested locate details (GET /requests/{imRequestId}/{imLocateIds}) - Optional callback-based submission flow (POST /callback-requests)

The API is intended for system-to-system integration to reduce manual operational touchpoints in the locate request process.

For standard bulk submission (POST /requests), the service first attempts to process the request within an internal fast-return threshold. If processing completes within that threshold, the response returns the request result immediately. If processing exceeds that threshold, the service continues execution asynchronously and the response is returned with request status Pending. In that case, clients should use the query endpoints with imRequestId to retrieve the eventual result.

imRequestId is the client-defined request identifier and is globally unique in the current implementation (platform-level namespace, not scoped by user). If the same imRequestId is submitted more than once, the request is rejected as a duplicate request. Clients are strongly encouraged to use high-entropy IDs such as UUIDv4, or a composite identifier pattern like client-specific-prefix + clientDefinedId.

Within a single request, each locate item is identified by imLocateId. imLocateId must be unique within that request (imRequestId + imLocateId unique per request). Submitting duplicate imLocateId values in the same request is not allowed because it can cause item-level overwrite; such requests are rejected.

The callback-based submission flow (POST /callback-requests) follows the same business pattern with different field names. Before using this callback interface, clients must contact State Street to onboard/configure SiteID and complete required firewall/network allowlist setup. BulkLocateID is the callback equivalent of imRequestId and must be unique per submission (same platform-level request namespace behavior). Each LocateID is the callback equivalent of imLocateId, and each BulkLocateID + LocateID combination must be unique within the request. After validation and acceptance, final processing results are delivered asynchronously to the registered ReplyURL.

To minimize accidental collisions and reduce predictability, clients are strongly encouraged to generate high-entropy identifiers (for example, UUIDv4) for both imRequestId and BulkLocateID.

Client Benefits

• Higher operational efficiency: Automates request submission and inquiry, reducing manual processing effort.
• Simpler integration: Provides consistent REST endpoints and payload structures for client platform integration.
• Better status transparency: Allows clients to query both bulk request outcomes and selected locate-level details.
• Lower operational risk: Standardized interfaces reduce manual entry errors and process inconsistency.
• Flexible processing model: Supports both polling-based inquiry and callback-based integration patterns.

Data Availability

The API provides two main query views: - Request + full locate set: Request/result information keyed by imRequestId, including all locates under that request. - Request + selected locate details: Request/result information plus selected locate records under the same request, filtered by comma-separated imLocateIds.

Availability is processing-dependent: - If a standard submission completes within the internal fast-return threshold, the initial submission response may already contain the completed result. - If the initial standard submission response returns Pending, clients should query later by imRequestId until processing is complete. - For callback submissions, the immediate response only confirms validation/acceptance status; final locate results are delivered asynchronously to ReplyURL.

Historical access and retention period are subject to the platform's data retention policy and environment configuration.

Description

The epam-import-export is designed for importing messages into PAM and running PAM jobs. Users can initiate message imports and job executions, the epam-import-export then delivers these requests to PAM for processing and generating execution results, uses can query the processing status.

Client Benefits

• Enable users to utilize the APIs for managing operational processes, rather than manually logging into the application

Data Availability

• Data is compartmentalized by user and environment
• Updates in near real-time
• User-created records are periodically deleted

Description

The income statement lists all income for both pending and paid events.The pending income may include estimated rates not yet confirmed in the market.

Client Benefits

• Access to current income data.
• Increased efficiency and reduced query volumes through reduction of manual and email-based operations.
• Comprehensive data sets with customization and flexibility.
• Tailored API requests which allow for concise data extracts.

Data Availability

• Income data is available at any given time regardless of market.
• The API will provide the current status of income as it is updated on State Street core custody applications.

Note

For additional detail on field formats and codes, please reach out to api-support@statestreet.com or your client service representative.

Description

Token Management API is designed to manage smart contract templates, smart contract deployments, contract calls for different functions like mint, burn, transfer transactions etc, balance query and also support whitelisting of contract addresses. This API supports RESTful endpoints for different entities i.e. templates, smartcontracts, deploy, call, transactions and whitelist.

Consuming systems can make calls to create, query, update and delete operations for different entities. Below are the high level information for each APIs. * Templates - The API provides endpoints to create contract template entry in the database based on the provided request payload data. Provides endpoints for to get the contract template and the detail information. Also consuming systems can query templates by template id. Provides an option to update the status of a template. * Smartcontracts - The API provides endpoints to create a smart contract instance entry in the database. It also provides all the deployed smart contracts based on digital account id. also consuming systems can get the details for a specific deployed instance. * Deploy - The API provides endpoints to initiate a smartcontract deployment using the workflow defined in the API for the provided template id. Also consumers can get detail status of a initiated smart contract deployment. * Call - The API provides endpoints to initiate Smartcontract function calls using the workflow defined in DAP. Consumers can get the status as well for a specific transaction. It supports endpoint to read blockchain transactions data like supply, balance, etc for an address. * Transactions - This API support creation of a transaction record in the database and as well provide query options. * Whitelist - This API supports the whitelisting of contract addresses generated part of the Smartcontract deployments.

Client Benefits

• Consumers can quickly use the APIs to build smart contract templates.
• Smartcontract deployment to tokenize assets with whitelisting.
• Consumers can seamlessly perform transactions like mint, burn, transfer etc and get the status and balance information.
• Consumers can get transaction history as well.

Data Availability

• Records will be created and data will be available for consumers.

Description

Account Management API is designed to manage digital wallets and addresses part of client's digital account. This API supports RESTful endpoints for wallet creation, address creation, retrieving wallet and address info.

Consuming systems can make calls to create a wallet and address in the state street provided blockchain network. Consuming systems can get wallet details for a digital account of a client and can query wallets by providing a wallet id as well. This API provides an endpoint to create a blockchain address for a wallet.

Client Benefits

• Seamless wallet setup for different types of wallet for a client or investor.
• Quick integration to enable the client to operate in state street's digital assets platform.

Data Availability

• Records will be created and data will be available for consumers.

Description

This API contains records of voluntary and mandatory corporate action events. Details includes entity information as well as option, entitlement, notification and response.

Client Benefits

• Provides clients with comprehensive, near real‑time visibility into Corporate Action activity, including event details, election responses, and notifications—enabling informed decision‑making and improved operational oversight.

• Empowers clients to tailor reporting to their specific needs through flexible filtering and customization, allowing them to analyze data for deeper insight, efficiency, and control.

Data Availability

Ensures clients receive the most current Corporate Action information available, as reflected in the latest notifications, through API delivery.

Description

This service API delivers CNAV-sourced NAV data, including MyNav impacts, dynamic benchmarking, extended NAV (CNAV trial), digital rates and yields, and subledger-related impacts.

Client Benefits

*The ENTITY_NAV_EXTENDED API enables clients to access extended CNAV-sourced NAV data, allowing them to review funds in scope for MyNav impacts, benchmark performance, digital rates and yields, and subledger impacts through a single, comprehensive dataset.

Data Availability

• Daily after MyNAV approval and event 'Send data to NDS is triggered'.

Note

For additional detail on field formats and codes, please reach out to api-support@statestreet.com or your client service representative.

Description

Core trade status API provides a near real-time matching, settlement (pre and post settle date), and cancellation (client or market initiated) status for all security trades (buys and sells) based upon the status in State Street’s Custody system across Sub-Custodian, CSD or ICSD. Further asset servicing trade status transparency enriched by State Street custody where applicable for lending, borrowing, collateral and other corporate action event encumbering activity leading to trade settlement issues. Availability of status of a transaction at any given time regardless of market of settlement or status of transaction.

Client Benefits

• Access to current updates to trade status data
• Increased efficiency and reduced query volumes through reduction of manual and email-based operations
• Comprehensive data sets with customization and flexibility
• Tailored API requests which allow for concise data extracts

Data Availability

• Status of a trade is available at any given time regardless of market of settlement, or status of trade.
• The API will provide the current status of the trade as it gets updated as part its life cycle on State Street Custody applications.
• For example, markets where status on match to settle with counterparty is available through status received from the sub-custodian/CSD.
• The API will provide the custody trade status data for entity IDs in which the consumer is entitled.

Description

Set of APIs providing views of cash activity and cash balances retrievable by flexible set of parameters including account, currency and date.

Client Benefits

• Accurate reporting of client's domestic and foreign cash balances assisting in cash management.

• Increased efficiency and reduced query volumes through reduction of manual and email-based operations.

• Comprehensive data sets with customization and flexibility.

• Tailored API requests which allow for concise data extracts.

Data Availability

• The API will provide the current custody cash available balance intra-day as it gets updated as part of its lifecycle on State Street applications.

• The API will provide the custody cash available balance from the core authoritative source as available on State Street Custody applications.

• The API will provide the custody cash data for entity IDs in which the consumer is entitled.

• Net Pending Activity is not available in current release. It will default to null. Only settled balances and settled activity will be presented.

Note

For additional detail on field formats and codes, please reach out to api-support@statestreet.com or your client service representative.

Description

The SSGM Operations Hub Service 4.0 API is designed to get a relatively full list of Counterparty Data. These APIs is best suited for use when there is an internal downstream APP needs some Counterparty related data.

Client Benefits

• DIT will get the full list of the Counterparty data, so that vendor APP does not need to change regularly, so the overall efficiency is much higher *When an internal downstream APP needs some kind of Counterparty data, DIT will integrate and process the data well and then connect to the downstream APP, so that the timeline with changes will be shorter

Data Availability

• Near real-time, 7*24 data availability