Description

Readiness Status API is designed to provide a consistent RESTful interface for downstream applications to check FDL readiness status by business name, EOD date, and optional branch. The API returns a unified response envelope across success and error scenarios so clients can process responses with stable parsing logic and predictable codes.

The endpoint supports both single-record and list-style results, depending on whether the optional branch parameter is provided. This helps consumers use one endpoint for targeted checks and broader status queries.

Client Benefits

• Unified response envelope with consistent fields (success, code, message, data, timestamp)
• Clear business and technical code mapping for easier client-side handling and alerting
• Flexible query behavior for both branch-level checks and business-level aggregate checks

Data Availability

• Data is filtered by required businessName and eodDate parameters
• Branch-level readiness can be queried when branch is provided
• Response supports both ready and not-ready business states with explicit API codes

Description

Asset Management API is designed to manage smartcontract templates, tokenization of assets, fund setup with shared classes and also support balance inquiry. This API supports RESTful endpoints for different business services i.e. managing templates, managing tokenization of assets part of smartcontract deployments, and balance inquiry as well.

Consuming systems can make calls to register smartcontract templates, tokenize assets, setup funds in dap, etc. Below are the high level information for each APIs. * Smart Contracts - The API provides endpoints to register smartcontract templates. Provides business services to get smartcontract templates and the detail information. Also consuming systems can query templates by template id. Provides an option to manage the approval of a template. * Digital Assets - The API provides business services to deploy smartcontracts and create tokenize assets and also querying balance. It also provides all the deployed smartcontracts based on digital account of a client. Also consuming systems can get the details for a specific deployed instance. The API provides services to setup of funds with shared classes part of smartcontract deployment. Also consumers can get detail status, balance, etc. for the deployed asset.

Client Benefits

• Consumers can leverage the business services to register smartcontract templates.
• Smartcontract deployment to tokenize assets and fund setup with whitelisting.
• Get balance of tokenized assets.

Data Availability

• Records will be available for consumers as requested based on the request payloads.

Description

Transaction Management API is designed to manage subscription, redemption, transfer, deposit, and also supports balance query. This API supports RESTful endpoints to support the business functions.

Consuming systems can perform subscription i.e. minting of tokens, redemption i.e. burning of tokens, transfer of tokens between different parties. Below are the high level information for each APIs. * Transactions - The API provides endpoints to initiate business functions like subscription, redemption, transfer, deposit, etc 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.

Client Benefits

• Consumers can quickly use the APIs to 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

Notification Management API is designed to manage notifications related to accounts/wallet setup, tokenization of assets, transactions, etc. This API supports RESTful endpoints for publishing and receiving notifications.

Consuming systems can make calls to get events data for different operations in digital asset platform. Below are the high level information for each APIs. * Digital-Events - The API provides endpoints to publish notifications related to digital events. Provides business services to get notification details and the detail information. Also consuming systems can query notifications by notification/event id.

Client Benefits

• Consumers can leverage the business services to publish events and receive notifications/event details based on a notification id or event id.

Data Availability

• Records will be available for consumers as requested based on the request payloads.

Description

Cash Management API is designed to manage payment order intents for investor fund transfers. It covers the full lifecycle of a payment instruction: 1. Reconciliation — correlates an investor instruction to their third-party account using a Zilo-generated Transaction ID (MT910/DB API link). 2. Source-of-Funds (SoF) check — captures investor identity fields required for SoF verification. 3. Fund transfer initiation — moves funds from the investor collection account to the fund manager account via IBAN. 4. Pre-notification — generates and dispatches an ISO 20022 camt.057 NotificationToReceive message to the receiving bank.

Client Benefits

• Seamless payments and settlements for different types of digital usecases like subscription and redemption.
• 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

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

Webhook integration APIs is designed to receive all events generated by FenX platform and send events to Kafka topic for downstream processing. This API will return success or failure of webhook events publish to kafka along with the failure message.

This API can only be invoked from the FENX Platform and no individual users will be accessing this API.

Client Benefits

• The Webhook feature provided by the vendor ensures all the webhook events generated by FenX are shared to Statestreet KYC Team.

Data Availability

• Data is compartmentalized by environment
• Updates in real-time
• There is no persistant storage for this API and the processing happens asynchronously

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.