# info.license.name
EVP Systems customer API documentation. Contact EVP Systems for licensing and integration terms.

# info.description
Machine-readable OpenAPI contract for EVP Everywhere. Canonical public routes are URL-versioned with /1.0, /1.1, /1.2, or /1.3 prefixes; this document lists paths without the version because the server variable supplies it.

Legacy unversioned routes and the deprecated ?version= query selector remain supported for legacy-compatible features. If a URL version and query-string version disagree, the API returns HTTP 400 with error text "URL version and query-string version conflict".

CostBasis, GiftVal, and CapWatch are available only on /1.3 versioned URLs and require the /1.3 URL prefix; they are not available on /1.0, /1.1, /1.2, or legacy unversioned routes. Hosted Try it out controls are disabled for all endpoints because authenticated browser calls require customer-specific credentials.

Request and response examples and XML field narratives are maintained in /docs/. Legacy RAML remains available at /api/api.raml but this OpenAPI document is the preferred machine-readable contract.

This public contract is generated from EVP Everywhere route, schema, and example metadata; implementation-only notes are intentionally omitted.

The existing /docs/ page remains useful for narrative XML examples, XSD links, data conventions, and migration notes. This OpenAPI document makes the machine-readable contract canonical and links back to /docs/.

# externalDocs.description
EVP Everywhere HTML documentation and examples.

# servers[].description
Version 1.3 EVP Everywhere API base URL. The version number is part of the URL path.

# tags[].description
EstateVal report lifecycle endpoints, plus version 1.3 CostBasis and GiftVal report lifecycle endpoints.

# tags[].description
Version 1.3 authenticated CapWatch security and action lookup endpoints.

# paths./estateval/report.get.description
Prices a single security without persisting data on the server. Rendered report outputs use PDF/RTF/TXT/XLSX formats where supported. CostBasis, GiftVal, and CapWatch are available only on version 1.3 and require the /1.3 URL prefix.

# paths./estateval/report.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./estateval/report.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./estateval/report.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./estateval/report.get.parameters[].description
Report response format. JSON and XML return structured report data. PDF, RTF, text, and Excel outputs return rendered report files where supported. Legacy compatibility outputs are intentionally not advertised for new integrations.

# paths./estateval/report.get.parameters[].description
When true with JSON/XML report output, renders foreign-price XML report data.

# paths./estateval/report.get.parameters[].description
CUSIP, ISIN, SEDOL, OCC option identifier, or ticker symbol. Defaults to IBM.

# paths./estateval/report.get.parameters[].description
YYYYMMDD valuation/holdings/gift date, depending on report type.

# paths./estateval/report.get.parameters[].description
YYYYMMDD second valuation date for apr or dst reports.

# paths./estateval/report.get.parameters[].description
Report selector. Public EstateVal values are dod, alt, apr, dst. dodclose is a legacy close-price Date of Death compatibility value. CostBasis/GiftVal selectors require the /1.3 URL prefix.

# paths./estateval/report.get.parameters[].description
Caller correlation value echoed in report metadata when present.

# paths./preferences.get.description
Returns approved account preference values for the authenticated account/application scope. XML configured="false" or JSON @configured="false" means the server returned the default value rather than an account-specific override.

# paths./preferences.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./preferences.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./preferences.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./preferences.get.parameters[].description
Response body format for JSON/XML endpoints.

# paths./preferences.put.description
Updates the small allowlist of approved account preferences for the authenticated account/application scope. Arbitrary preference editing is not supported. Request bodies may be JSON or XML using the existing EVP Everywhere input envelope.

# paths./preferences.put.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./preferences.put.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./preferences.put.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./preferences.put.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio.post.description
Creates a stored portfolio and optionally initializes it from the supplied XML/JSON body. Version 1.3 accepts CostBasis/GiftVal upload fields where present in portfolio data: costbasis-mode selects Pricing Date or As-of Date behavior, and lot-level costbasis-date / basis-date values use YYYYMMDD dates for CostBasis basis pricing.

# paths./portfolio.post.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio.post.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio.post.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio.post.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio.post.requestBody.content.text/xml.schema.description
EVP .evp XML portfolio document. See externalDocs and XSD links.

# paths./portfolio.get.description
Lists portfolios visible to the authenticated account. Supports pagination and filter arguments.

# paths./portfolio.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio.get.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}.get.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}.put.description
Replaces or updates a stored portfolio from XML/JSON body data. The renumber query parameter can request lot renumbering.

# paths./portfolio/{portfolio-id}.put.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}.put.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}.put.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}.put.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}.put.requestBody.content.text/xml.schema.description
EVP .evp XML portfolio document. See externalDocs and XSD links.

# paths./portfolio/{portfolio-id}.delete.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}.delete.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}.delete.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}.delete.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}/estateval/report.get.description
EstateVal supports full portfolio report creation, listing, retrieval, deletion, status, and single-lot incremental evaluation. Lists stored report runs and status metadata. CostBasis/GiftVal endpoints filter their fixed report type.

# paths./portfolio/{portfolio-id}/estateval/report.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/estateval/report.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/estateval/report.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/estateval/report.get.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}/estateval/report.post.summary
Create an EstateVal full-portfolio report

# paths./portfolio/{portfolio-id}/estateval/report.post.description
EstateVal supports full portfolio report creation, listing, retrieval, deletion, status, and single-lot incremental evaluation. Starts asynchronous full-portfolio report evaluation. Successful responses return HTTP 202 and a versioned Location header such as /1.3/portfolio/{portfolio-id}/estateval/report/{report-id}/status.

# paths./portfolio/{portfolio-id}/estateval/report.post.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/estateval/report.post.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/estateval/report.post.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/estateval/report.post.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}/estateval/report.post.parameters[].description
Optional caller-supplied report run correlation ID.

# paths./portfolio/{portfolio-id}/estateval/report.post.parameters[].description
Optional caller-observed lot count for progress/billing context.

# paths./portfolio/{portfolio-id}/estateval/report.post.parameters[].description
Optional caller-observed security count for progress/billing context.

# paths./portfolio/{portfolio-id}/estateval/report.post.parameters[].description
Force server-side rehydration instead of using stored fallback data.

# paths./portfolio/{portfolio-id}/estateval/report.post.parameters[].description
When true, stores the full-portfolio XML report using foreign-price report data for later JSON/XML retrieval.

# paths./portfolio/{portfolio-id}/estateval/report.post.responses.202.description
Report accepted for asynchronous processing.

# paths./portfolio/{portfolio-id}/estateval/report.post.responses.202.content.text/xml.example
<output version="1.3"><status>ok</status><report-id>0123456789abcdef0123456789abcdef</report-id></output>

# paths./portfolio/{portfolio-id}/estateval/report.post.responses.202.headers.Location.description
Versioned status URL for the accepted report.

# paths./portfolio/{portfolio-id}/estateval/report.put.summary
Create an EstateVal single-lot incremental report

# paths./portfolio/{portfolio-id}/estateval/report.put.description
Evaluates one lot against a stored portfolio and updates the portfolio/report history. CostBasis and GiftVal do not support this incremental endpoint.

# paths./portfolio/{portfolio-id}/estateval/report.put.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/estateval/report.put.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/estateval/report.put.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/estateval/report.put.parameters[].description
Report response format. JSON and XML return structured report data. PDF, RTF, text, and Excel outputs return rendered report files where supported. Legacy compatibility outputs are intentionally not advertised for new integrations.

# paths./portfolio/{portfolio-id}/estateval/report.put.parameters[].description
When true with JSON/XML report output, renders foreign-price XML report data.

# paths./portfolio/{portfolio-id}/estateval/report.put.parameters[].description
CUSIP, ISIN, SEDOL, OCC option identifier, or ticker symbol. Defaults to IBM.

# paths./portfolio/{portfolio-id}/estateval/report.put.parameters[].description
Lot number to evaluate. Defaults to first available/new lot behavior.

# paths./portfolio/{portfolio-id}/estateval/report.put.parameters[].description
Shares/par quantity for the selected lot.

# paths./portfolio/{portfolio-id}/estateval/report.put.parameters[].description
YYYYMMDD second valuation date for apr or dst reports.

# paths./portfolio/{portfolio-id}/estateval/report.put.parameters[].description
EstateVal single-lot incremental report selector. cst/gft are not supported here; use product full-report endpoints.

# paths./portfolio/{portfolio-id}/estateval/report.put.parameters[].description
Caller correlation value echoed in report metadata when present.

# paths./portfolio/{portfolio-id}/estateval/report.put.parameters[].description
Optional caller-supplied report run correlation ID.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}.get.description
EstateVal supports full portfolio report creation, listing, retrieval, deletion, status, and single-lot incremental evaluation. Retrieves completed report output. Pending reports return 404 Incomplete report-id; error reports return the stored error with optional billing details.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}.get.parameters[].description
Report response format. JSON and XML return structured report data. PDF, RTF, text, and Excel outputs return rendered report files where supported. Legacy compatibility outputs are intentionally not advertised for new integrations.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}.get.parameters[].description
When true with JSON/XML report output, renders foreign-price XML report data.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}.delete.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}.delete.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}.delete.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}.delete.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}/status.get.description
Returns pending progress, error details, or an ok status. In version 1.3 ok status may include report, disclaimers, billing data, and an optional busy-message headline for XML/JSON callers.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}/status.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}/status.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}/status.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}/status.get.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}/estateval/report/{report-id}/status.get.parameters[].description
Optional desktop busy display mode. Non-Progress values request a busy-message headline in the status response.

# paths./portfolio/{portfolio-id}/costbasis/report.get.description
CostBasis report lifecycle for uploaded portfolios. This product endpoint accepts only the cst report selector; omit report or use report=cst. Lists stored report runs and status metadata. CostBasis/GiftVal endpoints filter their fixed report type.

# paths./portfolio/{portfolio-id}/costbasis/report.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/costbasis/report.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/costbasis/report.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/costbasis/report.get.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}/costbasis/report.post.summary
Create a CostBasis full-portfolio report

# paths./portfolio/{portfolio-id}/costbasis/report.post.description
CostBasis report lifecycle for uploaded portfolios. This product endpoint accepts only the cst report selector; omit report or use report=cst. Starts asynchronous full-portfolio report evaluation. Successful responses return HTTP 202 and a versioned Location header such as /1.3/portfolio/{portfolio-id}/costbasis/report/{report-id}/status.

# paths./portfolio/{portfolio-id}/costbasis/report.post.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/costbasis/report.post.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/costbasis/report.post.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/costbasis/report.post.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}/costbasis/report.post.parameters[].description
Optional caller-supplied report run correlation ID.

# paths./portfolio/{portfolio-id}/costbasis/report.post.parameters[].description
Optional caller-observed lot count for progress/billing context.

# paths./portfolio/{portfolio-id}/costbasis/report.post.parameters[].description
Optional caller-observed security count for progress/billing context.

# paths./portfolio/{portfolio-id}/costbasis/report.post.parameters[].description
Force server-side rehydration instead of using stored fallback data.

# paths./portfolio/{portfolio-id}/costbasis/report.post.parameters[].description
When true, stores the full-portfolio XML report using foreign-price report data for later JSON/XML retrieval.

# paths./portfolio/{portfolio-id}/costbasis/report.post.responses.202.description
Report accepted for asynchronous processing.

# paths./portfolio/{portfolio-id}/costbasis/report.post.responses.202.content.text/xml.example
<output version="1.3"><status>ok</status><report-id>0123456789abcdef0123456789abcdef</report-id></output>

# paths./portfolio/{portfolio-id}/costbasis/report.post.responses.202.headers.Location.description
Versioned status URL for the accepted report.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}.get.description
CostBasis report lifecycle for uploaded portfolios. This product endpoint accepts only the cst report selector; omit report or use report=cst. Retrieves completed report output. Pending reports return 404 Incomplete report-id; error reports return the stored error with optional billing details.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}.get.parameters[].description
Report response format. JSON and XML return structured report data. PDF, RTF, text, and Excel outputs return rendered report files where supported. Legacy compatibility outputs are intentionally not advertised for new integrations.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}.get.parameters[].description
When true with JSON/XML report output, renders foreign-price XML report data.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}.delete.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}.delete.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}.delete.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}.delete.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}/status.get.description
Returns pending progress, error details, or an ok status. In version 1.3 ok status may include report, disclaimers, billing data, and an optional busy-message headline for XML/JSON callers.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}/status.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}/status.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}/status.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}/status.get.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}/costbasis/report/{report-id}/status.get.parameters[].description
Optional desktop busy display mode. Non-Progress values request a busy-message headline in the status response.

# paths./portfolio/{portfolio-id}/giftval/report.get.description
GiftVal report lifecycle for uploaded portfolios. This product endpoint accepts only the gft report selector; omit report or use report=gft. Lists stored report runs and status metadata. CostBasis/GiftVal endpoints filter their fixed report type.

# paths./portfolio/{portfolio-id}/giftval/report.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/giftval/report.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/giftval/report.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/giftval/report.get.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}/giftval/report.post.description
GiftVal report lifecycle for uploaded portfolios. This product endpoint accepts only the gft report selector; omit report or use report=gft. Starts asynchronous full-portfolio report evaluation. Successful responses return HTTP 202 and a versioned Location header such as /1.3/portfolio/{portfolio-id}/giftval/report/{report-id}/status.

# paths./portfolio/{portfolio-id}/giftval/report.post.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/giftval/report.post.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/giftval/report.post.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/giftval/report.post.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}/giftval/report.post.parameters[].description
Optional caller-supplied report run correlation ID.

# paths./portfolio/{portfolio-id}/giftval/report.post.parameters[].description
Optional caller-observed lot count for progress/billing context.

# paths./portfolio/{portfolio-id}/giftval/report.post.parameters[].description
Optional caller-observed security count for progress/billing context.

# paths./portfolio/{portfolio-id}/giftval/report.post.parameters[].description
Force server-side rehydration instead of using stored fallback data.

# paths./portfolio/{portfolio-id}/giftval/report.post.parameters[].description
When true, stores the full-portfolio XML report using foreign-price report data for later JSON/XML retrieval.

# paths./portfolio/{portfolio-id}/giftval/report.post.responses.202.description
Report accepted for asynchronous processing.

# paths./portfolio/{portfolio-id}/giftval/report.post.responses.202.content.text/xml.example
<output version="1.3"><status>ok</status><report-id>0123456789abcdef0123456789abcdef</report-id></output>

# paths./portfolio/{portfolio-id}/giftval/report.post.responses.202.headers.Location.description
Versioned status URL for the accepted report.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}.get.description
GiftVal report lifecycle for uploaded portfolios. This product endpoint accepts only the gft report selector; omit report or use report=gft. Retrieves completed report output. Pending reports return 404 Incomplete report-id; error reports return the stored error with optional billing details.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}.get.parameters[].description
Report response format. JSON and XML return structured report data. PDF, RTF, text, and Excel outputs return rendered report files where supported. Legacy compatibility outputs are intentionally not advertised for new integrations.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}.get.parameters[].description
When true with JSON/XML report output, renders foreign-price XML report data.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}.delete.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}.delete.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}.delete.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}.delete.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}/status.get.description
Returns pending progress, error details, or an ok status. In version 1.3 ok status may include report, disclaimers, billing data, and an optional busy-message headline for XML/JSON callers.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}/status.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}/status.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}/status.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}/status.get.parameters[].description
Response body format for JSON/XML endpoints.

# paths./portfolio/{portfolio-id}/giftval/report/{report-id}/status.get.parameters[].description
Optional desktop busy display mode. Non-Progress values request a busy-message headline in the status response.

# paths./capwatch/securities.get.description
Version 1.3-only endpoint for authenticated clients. Searches classic CapWatch capital-change securities by 6/8/9-character CUSIP prefix or target/initial name prefix.

# paths./capwatch/securities.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./capwatch/securities.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./capwatch/securities.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./capwatch/securities.get.parameters[].description
Response body format for JSON/XML endpoints.

# paths./capwatch/securities.get.parameters[].description
CUSIP prefix, target name prefix, or initial name prefix.

# paths./capwatch/securities.get.parameters[].description
Optional first capital-change date to include, YYYYMMDD.

# paths./capwatch/securities.get.parameters[].description
Optional last capital-change date to include, YYYYMMDD.

# paths./capwatch/securities/{cusip}/actions.get.description
Version 1.3-only endpoint for authenticated clients. Lists CapWatch actions for a target CUSIP, with legacy duplicate/update suppression. Successful calls may include informational usage metadata.

# paths./capwatch/securities/{cusip}/actions.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./capwatch/securities/{cusip}/actions.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./capwatch/securities/{cusip}/actions.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./capwatch/securities/{cusip}/actions.get.parameters[].description
Response body format for JSON/XML endpoints.

# paths./capwatch/securities/{cusip}/actions.get.parameters[].description
Optional first capital-change date to include, YYYYMMDD.

# paths./capwatch/securities/{cusip}/actions.get.parameters[].description
Optional last capital-change date to include, YYYYMMDD.

# paths./capwatch/actions/{number}.get.description
Version 1.3-only endpoint for authenticated clients. Returns CapWatch action detail text and display fields for an action number. Successful calls may include informational usage metadata.

# paths./capwatch/actions/{number}.get.parameters[].description
Optional caller-attribution e-mail for direct API integrations. Metadata only; not a credential.

# paths./capwatch/actions/{number}.get.parameters[].description
Optional Windows-account caller attribution. Used as a fallback when actor e-mail is absent.

# paths./capwatch/actions/{number}.get.parameters[].description
Legacy query-string version selector. Prefer the URL prefix, for example /1.3/portfolio. Unversioned legacy routes default to 1.0. If this conflicts with the URL prefix, the API returns HTTP 400.

# paths./capwatch/actions/{number}.get.parameters[].description
Response body format for JSON/XML endpoints.

# components.securitySchemes.basicAuth.description
EVP Systems Client Token and Account Information Key encoded as Basic auth credentials. The server also supports legacy DT0 headers for EstateVal clients; Basic auth is the public integration scheme documented here.

# components.responses.BadRequest.description
Bad request. Includes unknown version, URL/query version conflict, malformed identifiers/dates/counts, unsupported output format, and product/report selector mismatches.

# components.responses.BadRequest.content.application/json.example.output.error-text
URL version and query-string version conflict

# components.responses.BadRequest.content.text/xml.example
<output version="1.3"><status>error</status><error-code>400</error-code><error-text>URL version and query-string version conflict</error-text></output>

# components.responses.Unauthorized.description
Missing or invalid credentials. The response includes WWW-Authenticate: Basic realm=EVP Everywhere and normally has no JSON/XML error body.

# components.responses.Forbidden.description
Known credentials that are not authorized for the requested account/action.

# components.responses.Forbidden.content.application/json.example.output.error-text
Account is not authorized for this request

# components.responses.Forbidden.content.text/xml.example
<output version="1.3"><status>error</status><error-code>403</error-code><error-text>Account is not authorized for this request</error-text></output>

# components.responses.NotFound.description
Requested portfolio, report, or incomplete report output was not found.

# components.responses.NotFound.content.application/json.example.output.error-text
Portfolio, report, or completed report output was not found

# components.responses.NotFound.content.text/xml.example
<output version="1.3"><status>error</status><error-code>404</error-code><error-text>Portfolio, report, or completed report output was not found</error-text></output>

# components.responses.ServerError.description
Server-side report generation, conversion, storage, or unknown failure.

# components.responses.ServerError.content.text/xml.example
<output version="1.3"><status>error</status><error-code>500</error-code><error-text>Server error while generating report</error-text></output>

# components.schemas.OutputEnvelope.description
Standard EVP Everywhere JSON/XML response envelope. XML attributes appear as @-prefixed JSON keys. Literal field names such as status and portfolio-id are returned exactly as shown; brace-delimited values in examples are placeholders.

# components.schemas.OutputEnvelope.externalDocs.description
EVP Everywhere documentation and XML schema links

# components.schemas.ErrorEnvelope.description
Error envelope returned in the requested JSON/XML format when possible. 401 means credentials were missing or invalid; 403 means recognized credentials are not authorized for the requested account/action. Endpoint-specific 404 responses are used for missing route resources or report output that is not complete yet.

# components.schemas.ErrorEnvelope.properties.output.properties.error-text.example
URL version and query-string version conflict

# components.schemas.ErrorEnvelope.properties.output.properties.billing.description
Present only when a failed report attempt has usage metadata to return.

# components.schemas.ErrorEnvelope.example.output.error-text
URL version and query-string version conflict

# components.schemas.ReportOutputEnvelope.description
Structured report response envelope for JSON/XML outputs. Rendered report outputs use content types documented on each operation. XML schema: /api/1.3/XXX_report.xsd.

# components.schemas.ReportOutputEnvelope.properties.output.properties.report.description
Report metadata and holdings/pricing detail for XML/JSON report responses.

# components.schemas.PortfolioInput.description
Portfolio input envelope. JSON mirrors the EVP XML structure; XML details are defined by the XSD and /docs/ narrative examples. CostBasis portfolios may use portfolio-level costbasis-mode and lot-level costbasis-date / basis-date fields; GiftVal portfolios may use gift-basis and gift-accflag fields.

# components.x-evp-versioning.conflictErrorText
URL version and query-string version conflict