{"templateId":"markdown","versions":[{"version":"v1.39","label":"v1.39 STS","link":"/products/custody/data-export/overview","default":true,"active":true,"folderId":"c15a2701"},{"version":"v1.38","label":"v1.38 STS","link":"/products/custody/v1.38/data-export/overview","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.34","label":"v1.34 LTS","link":"/products/custody/v1.34/data-export/overview","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.26","label":"v1.26 LTS","link":"/products/custody/v1.26/data-export/overview","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.19","label":"v1.19 LTS","link":"/products/custody/v1.19/data-export/overview","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.15","label":"v1.15 LTS","link":"/products/custody/v1.15/data-export/overview","default":false,"active":false,"folderId":"c15a2701"}],"sharedDataIds":{"sidebar":"sidebar-products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Data export","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"data-export","__idx":0},"children":["Data export"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Executive summary"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The Portfolio Data Export Service generates reconciliation-grade financial reports from ","Ripple Custody"," as downloadable CSV or JSON files."]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The service offers two report types: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Position Reports"]}," (point-in-time balance snapshots) and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Movement Reports"]}," (transaction history over a date range)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Every export includes request metadata and financial control totals, so you can prove a file is complete and untampered."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The service exposes REST endpoints only, so you can automate extractions from your own scheduled jobs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The service enforces access per domain: you receive data only for domains where you hold a role with read access."]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Why this matters"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Finance, Compliance, and Operations teams need a standardized, auditable way to extract cross-system data for daily reconciliation, regulatory reporting, and audit evidence. The export service replaces custom database queries and one-off scripts with a single, consistent data contract that feeds your core banking system, data lake, and reconciliation pipelines directly—without post-processing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["For architects and operators"]},": Column order, names, and types are fixed contracts. Schema-breaking changes trigger a version bump and a changelog entry, so you can build stable downstream pipelines against these reports."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Availability"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The export service delivers REST APIs only in this release. A UI export experience and additional report types are planned for later phases. The service integrates ","Ripple Custody"," as its first data source."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-you-can-export","__idx":1},"children":["What you can export"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The service provides two report types. Each report is a separate endpoint that returns a single file per request."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Report"},"children":["Report"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What it contains"},"children":["What it contains"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Use it to"},"children":["Use it to"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/data-export/position-report"},"children":["Position Report"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A point-in-time balance snapshot. Each row is one account-and-asset balance as of a timestamp you choose."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Verify end-of-day balances against your core systems, calculate regulatory capital, and generate tax reporting."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/data-export/movement-report"},"children":["Movement Report"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A transaction history for a date range. Each row is one transfer, including amounts, fees, on-chain details, and counterparties."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reconcile movements for specific audit periods, remediate reconciliation breaks, and satisfy tax reporting requirements."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-the-service-works","__idx":2},"children":["How the service works"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You request a report by sending an authenticated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," request to the relevant endpoint with your scope and filters in the request body. The service authorizes the request, gathers the data, converts every financial value to human-readable decimal form, computes control totals, and returns the result as a CSV or JSON file."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart LR\n A[\"Your service or job\"] -->|\"1. POST request with filters\"| B[\"Export service\"]\n B -->|\"2. Verify domain access\"| C[\"Authorization\"]\n C -->|\"3. Gather data\"| D[\"Balances and transactions\"]\n D -->|\"4. Convert decimals + sum control totals\"| E[\"Report builder\"]\n E -->|\"5. Return CSV or JSON\"| A\n","diagramHtml":"

1. POST request with filters

2. Verify domain access

3. Gather data

4. Convert decimals + sum control totals

5. Return CSV or JSON

Your service or job

Export service

Authorization

Balances and transactions

Report builder

","diagramHtmlDark":"

1. POST request with filters

2. Verify domain access

3. Gather data

4. Convert decimals + sum control totals

5. Return CSV or JSON

Your service or job

Export service

Authorization

Balances and transactions

Report builder

"},"children":["flowchart LR\n A[\"Your service or job\"] -->|\"1. POST request with filters\"| B[\"Export service\"]\n B -->|\"2. Verify domain access\"| C[\"Authorization\"]\n C -->|\"3. Gather data\"| D[\"Balances and transactions\"]\n D -->|\"4. Convert decimals + sum control totals\"| E[\"Report builder\"]\n E -->|\"5. Return CSV or JSON\"| A\n"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request"]},": You send a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," request with a bearer token and a JSON body that defines the target domain, scope, and filters."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authorize"]},": The service verifies that you hold a role with read access in the target domain. It checks access ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["before"]}," running any data query."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Gather data"]},": The service reads balances or transactions for the accounts in scope. Position balances are read from historical balance records at the requested timestamp. The export service does not recalculate positions from transaction history. Movement data reflects recorded transfers."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Convert and verify"]},": The service converts every financial value from its raw blockchain denomination to its native decimal unit, and sums each financial column into a control total."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Return"]},": The service returns the report as a single file with a metadata header."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The service is synchronous: each request returns the complete file in one response, and there is no pagination. If a report would exceed an ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/data-export/reference#operational-limits"},"children":["operational limit"]},", the service rejects the request before it generates the file — narrow the scope with filters or a shorter date range, then request again."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-concepts","__idx":3},"children":["Key concepts"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"export-metadata","__idx":4},"children":["Export metadata"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every export carries a metadata header that identifies who generated it and with what parameters. This gives you a self-describing, auditable artifact."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Export ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A UUID for the export. The service also returns this value in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Export-Id"]}," response header for support tracing."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request author"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The identity that generated the export, in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["providerId:loginId"]}," form."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generation timestamp"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The UTC time when the service generated the export."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The exact set of filters the service applied to the request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Record count"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The number of rows in the report."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Control totals"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Financial column sums for reconciliation. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#control-totals"},"children":["Control totals"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"control-totals","__idx":5},"children":["Control totals"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every export includes financial control totals—the sums of each monetary column, computed as the service builds the file. This is a banking-standard integrity check."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When your downstream system ingests a report, it re-sums the same columns and compares its result against the control totals in the metadata header. If the totals and the record count match, the file is complete and uncorrupted. If they diverge, your system can reject the file and request a new export. Because the totals travel inside the file, you can verify integrity without calling back to the service."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Control totals are integrity checksums, not real-world monetary values. A single total can aggregate rows across multiple assets with different decimal scales, so the number doesn't represent a portfolio value or a per-asset total. Use it only to confirm that your extract matches the source, by re-summing the same column and comparing."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"financial-precision","__idx":6},"children":["Financial precision"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The service exports all amounts as decimal strings in the asset's native unit, with precision matching the asset's decimal places—for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["3.000000"]}," XRP rather than ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["3000000"]}," drops. It never exports raw blockchain denominations (except the Movement Report's explicit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rawTransactionValue"]}," column) or scientific notation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Financial values are always ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["strings"]},", in both CSV and JSON. Parse them as strings, never as floating-point numbers: bare numbers lose precision beyond roughly 15 significant digits, and some assets carry many more decimal places than that. For details, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/data-export/reference#financial-precision"},"children":["Financial precision"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"domain-scope-and-access-control","__idx":7},"children":["Domain scope and access control"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The service checks access against the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["target domain only"]},". To generate a report for a domain, you must hold a profile in that exact domain with a role that grants read access to the relevant entity type—accounts for Position Reports, transactions for Movement Reports. A profile in a parent domain doesn't grant access to its children."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To consolidate data across a domain tree, set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["includeChildDomains"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},". The service checks each child domain individually and includes only the ones you can access. It silently omits children you can't access—you receive a valid report for the domains you're entitled to."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the full access model, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/data-export/reference#access-control"},"children":["Access control"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"output-formats","__idx":8},"children":["Output formats"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The service provides two machine-readable formats. Select one with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["format"]}," field:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CSV"]},": UTF-8 with a byte order mark for spreadsheet compatibility. Financial values are quoted strings."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["JSON"]},": A metadata envelope with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," array of row objects."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the full format specification, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/data-export/reference#output-formats"},"children":["Output formats"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":9},"children":["Next steps"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Page"},"children":["Page"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/data-export/position-report"},"children":["Position Report"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generate a point-in-time balance snapshot, including request fields, filters, and output columns."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/data-export/movement-report"},"children":["Movement Report"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generate a transaction history for a date range, including status filters and output columns."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/data-export/reference"},"children":["Export reference"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Look up output formats, financial precision rules, access control, operational limits, and error responses."]}]}]}]}]}]},"headings":[{"value":"Data export","id":"data-export","depth":1},{"value":"What you can export","id":"what-you-can-export","depth":2},{"value":"How the service works","id":"how-the-service-works","depth":2},{"value":"Key concepts","id":"key-concepts","depth":2},{"value":"Export metadata","id":"export-metadata","depth":3},{"value":"Control totals","id":"control-totals","depth":3},{"value":"Financial precision","id":"financial-precision","depth":3},{"value":"Domain scope and access control","id":"domain-scope-and-access-control","depth":3},{"value":"Output formats","id":"output-formats","depth":3},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Data export"}},"lastModified":"2026-08-04T20:25:11.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/custody/data-export/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}