{"templateId":"openapi_docs","versions":[{"version":"v1.40","label":"v1.40 STS","link":"/products/custody/devbox/requests","default":true,"active":false,"folderId":"c15a2701"},{"version":"v1.39","label":"v1.39 STS","link":"/products/custody/v1.39/devbox/requests","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.38","label":"v1.38 STS","link":"/products/custody/v1.38/devbox/requests","default":false,"active":true,"folderId":"c15a2701"},{"version":"v1.34","label":"v1.34 LTS","link":"/products/custody/v1.34/devbox/requests","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.26","label":"v1.26 LTS","link":"/products/custody/v1.26/devbox/requests","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.19","label":"v1.19 LTS","link":"/products/custody/v1.19/devbox/requests","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.15","label":"v1.15 LTS","link":"/products/custody/v1.15/devbox/requests","default":false,"active":false,"folderId":"c15a2701"}],"sharedDataIds":{"openAPIDocsStore":"oas-products/custody/@v1.38/devbox.json","sidebar":"sidebar-sidebar.yaml__products_custody_v1.38_devbox"},"props":{"definitionId":"products/custody/@v1.38/devbox.json","dynamicMarkdocComponents":[],"baseSlug":"/products/custody/v1.38/devbox","seo":{"title":"Requests","description":"A **request** allows to follow the progress of a user request and identify a possible failure. \r\n\r\nMost requests to the system return a `requestId` in the response body, which may be used to inquire on the status of the request.\r\n\r\nIt is also possible and encouraged to provide a user-defined requestId using the `requestId` HTTP header when submitting intents or when approving/refusing them, this has several advantages:\r\n- If the connection is interrupted between the request and the response the `requestId` will still be known by the caller, which can then check if the request has been submitted to Harmonize or not\r\n- If the caller retries to submit another request with an already-used `requestId`, Harmonize will prevent this by returning an error, in order to avoid the involuntary replay of a request\r\n\r\n**Users** satisfying any of the below conditions are allowed to read a **request** status:\r\n- user is the originator of the request (even if it does not have a read access to `requests`)\r\n- user is in the originator domain and has a role granting him read access to `requests`\r\n- user is in the target domain and has a role granting him read access to `requests`\r\n\r\nA **request** will return, in particular, the following fields:\r\n- `lastModifiedAt`, which tracks the last update timestamp of the request;\r\n- `status`, which may be `Processing`, `Succeeded` or `Failed`; a `Failed` status also exposes an additional field detailing the failure reason.\r\n- `history`, which tracks all the intermediate steps of the user request, with details regarding the source component, the status, an eventual hint in case of failure, and a timestamp;","siteUrl":"https://docs.ripple.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"requests","disableAutoScroll":true,"metadata":{"subType":"openapi-operation"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.ripple.com","port":4000,"ipAddress":"216.73.216.201"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main-enterprise-product-docs","PUBLIC_VAR_LQH":"Liquidity Hub","PUBLIC_VAR_LQHUI":"Liquidity Hub UI","PUBLIC_VAR_ODL":"On-Demand Liquidity","PUBLIC_VAR_RN":"RippleNet","PUBLIC_VAR_RNC":"RippleNet Cloud","PUBLIC_VAR_RNSERVER":"RippleNet Server","PUBLIC_VAR_ROSAPINAME":"RippleNet Orchestration","PUBLIC_VAR_RPD":"Payments Direct","PUBLIC_VAR_SL":"Smart Liquidation","PUBLIC_VAR_SLAPI":"Smart Liquidation API","PUBLIC_VAR_CUS":"Ripple Custody","PUBLIC_VAR_RPO":"RippleNet Payment Object","PUBLIC_VAR_RNH":"Payments Direct UI","PUBLIC_VAR_RPODL":"Ripple Payments ODL","PUBLIC_VAR_RP":"Ripple Payments","PUBLIC_VAR_RNAPI":"RippleNet Server API","PUBLIC_VAR_RIPPLE_USD":"Ripple USD","PUBLIC_VAR_RLUSD":"RLUSD","PUBLIC_VAR_RS":"Ripple Stablecoin","PUBLIC_VAR_RS_PLATFORM":"Ripple Mint","PUBLIC_VAR_RS_UI":"Ripple Mint UI","PUBLIC_VAR_RS_API":"Ripple Mint API"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/products/custody/v1.38/devbox/requests","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}