{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Lerian","description":"Documentation for Lerian's core banking platform: Midaz ledger, Tracer, Reporter, Matcher, Flowker, Lender, Brazilian payment rails, Access Manager, Console and APIs.","colors":{"primary":"#847000","light":"#feed02","dark":"#7a6e00"},"logo":{"light":"https://mintcdn.com/lerian-49cb71fc/5Pw5_1cckl5ZMv6f/images/logo/light.png?fit=max\u0026auto=format\u0026n=5Pw5_1cckl5ZMv6f\u0026q=85\u0026s=de7fc3e0093ffdf038e1e2f846026264","dark":"https://mintcdn.com/lerian-49cb71fc/5Pw5_1cckl5ZMv6f/images/logo/dark.png?fit=max\u0026auto=format\u0026n=5Pw5_1cckl5ZMv6f\u0026q=85\u0026s=ed46af54d1a048c270443b346f7bf0cf"},"favicon":"https://mintcdn.com/lerian-49cb71fc/7NrS5Dioky2Qpn5V/images/icons/lerian-favicon.png?fit=max\u0026auto=format\u0026n=7NrS5Dioky2Qpn5V\u0026q=85\u0026s=95a2179ffdca213c5d13d729e575b753","api":{"examples":{"languages":["bash","go","typescript","python"],"prefill":true}},"appearance":{"default":"dark"},"navbar":{"links":[{"icon":"newspaper","href":"https://blog.lerian.studio/","label":"Blog"}],"primary":{"type":"button","label":"Contact us","href":"https://lerian.studio/contact"}},"footer":{"socials":{"discord":"https://discord.gg/DnhqKwkGv3","github":"https://github.com/LerianStudio","linkedin":"https://www.linkedin.com/company/lerianstudio","instagram":"https://www.instagram.com/lerian.studio"},"links":[{"header":"Products","items":[{"label":"Midaz","href":"/en/products/midaz/what-is-midaz"},{"label":"Tracer","href":"/en/products/tracer/what-is-tracer"},{"label":"Matcher","href":"/en/products/matcher/what-is-matcher"},{"label":"Flowker","href":"/en/products/flowker/what-is-flowker"},{"label":"Lender","href":"/en/products/lender/what-is-lender"},{"label":"Reporter","href":"/en/products/reporter/what-is-reporter"}]},{"header":"Payments","items":[{"label":"Brazil Rails","href":"/en/rails/what-are-brazil-rails"},{"label":"Interfaces","href":"/en/interfaces/introduction"},{"label":"Pix","href":"/en/interfaces/pix/pix-overview"},{"label":"TED","href":"/en/interfaces/ted/ted-overview"}]},{"header":"Developers","items":[{"label":"API Reference","href":"/en/reference/introduction"},{"label":"Event streaming","href":"/en/reference/events/overview"},{"label":"News","href":"/en/news/news"}]},{"header":"Company","items":[{"label":"Blog","href":"https://blog.lerian.studio/"},{"label":"Contact","href":"https://lerian.studio/contact"},{"label":"GitHub","href":"https://github.com/LerianStudio"}]}]},"search":{"prompt":"Search Lerian docs"},"seo":{"metatags":{"og:site_name":"Lerian Docs","og:type":"website","twitter:card":"summary_large_image"},"organization":{"id":"https://lerian.studio/#organization","name":"Lerian","url":"https://lerian.studio","logo":"https://docs.lerian.studio/images/logo/light.png","sameAs":["https://github.com/LerianStudio","https://www.linkedin.com/company/lerianstudio","https://discord.gg/DnhqKwkGv3","https://www.instagram.com/lerian.studio/","https://blog.lerian.studio/"]},"indexing":"navigable"},"fonts":{"heading":{"family":"IBM Plex Sans"},"body":{"family":"IBM Plex Sans"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"errors":{"404":{"redirect":false,"description":"The page moved or never existed. Start from the [home page](/en/index) or the [API Reference](/en/reference/introduction)."}},"contextual":{"options":["copy","view","download-spec","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/LerianStudio"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/DnhqKwkGv3"}]},"languages":[{"language":"en","default":true,"href":"en"},{"language":"pt-BR","footer":{"socials":{"discord":"https://discord.gg/DnhqKwkGv3","github":"https://github.com/LerianStudio","linkedin":"https://www.linkedin.com/company/lerianstudio","instagram":"https://www.instagram.com/lerian.studio"},"links":[{"header":"Produtos","items":[{"label":"Midaz","href":"/pt/products/midaz/what-is-midaz"},{"label":"Tracer","href":"/pt/products/tracer/what-is-tracer"},{"label":"Matcher","href":"/pt/products/matcher/what-is-matcher"},{"label":"Flowker","href":"/pt/products/flowker/what-is-flowker"},{"label":"Lender","href":"/pt/products/lender/what-is-lender"},{"label":"Reporter","href":"/pt/products/reporter/what-is-reporter"}]},{"header":"Pagamentos","items":[{"label":"Trilhos Brasil","href":"/pt/rails/what-are-brazil-rails"},{"label":"Interfaces","href":"/pt/interfaces/introduction"},{"label":"Pix","href":"/pt/interfaces/pix/pix-overview"},{"label":"TED","href":"/pt/interfaces/ted/ted-overview"}]},{"header":"Desenvolvedores","items":[{"label":"Referência da API","href":"/pt/reference/introduction"},{"label":"Streaming de eventos","href":"/pt/reference/events/overview"},{"label":"Novidades","href":"/pt/news/news"}]},{"header":"Empresa","items":[{"label":"Blog","href":"https://blog.lerian.studio/"},{"label":"Contato","href":"https://lerian.studio/contact"},{"label":"GitHub","href":"https://github.com/LerianStudio"}]}]},"navbar":{"links":[{"icon":"newspaper","href":"https://blog.lerian.studio/","label":"Blog"}],"primary":{"type":"button","label":"Fale conosco","href":"https://lerian.studio/contact"}},"href":"pt"},{"language":"es","footer":{"socials":{"discord":"https://discord.gg/DnhqKwkGv3","github":"https://github.com/LerianStudio","linkedin":"https://www.linkedin.com/company/lerianstudio","instagram":"https://www.instagram.com/lerian.studio"},"links":[{"header":"Productos","items":[{"label":"Midaz","href":"/es/products/midaz/what-is-midaz"},{"label":"Tracer","href":"/es/products/tracer/what-is-tracer"},{"label":"Matcher","href":"/es/products/matcher/what-is-matcher"},{"label":"Flowker","href":"/es/products/flowker/what-is-flowker"},{"label":"Lender","href":"/es/products/lender/what-is-lender"},{"label":"Reporter","href":"/es/products/reporter/what-is-reporter"}]},{"header":"Pagos","items":[{"label":"Rieles Brasil","href":"/es/rails/what-are-brazil-rails"},{"label":"Interfaces","href":"/es/interfaces/introduction"},{"label":"Pix","href":"/es/interfaces/pix/pix-overview"},{"label":"TED","href":"/es/interfaces/ted/ted-overview"}]},{"header":"Desarrolladores","items":[{"label":"Referencia de API","href":"/es/reference/introduction"},{"label":"Streaming de eventos","href":"/es/reference/events/overview"},{"label":"Novedades","href":"/es/news/news"}]},{"header":"Empresa","items":[{"label":"Blog","href":"https://blog.lerian.studio/"},{"label":"Contacto","href":"https://lerian.studio/contact"},{"label":"GitHub","href":"https://github.com/LerianStudio"}]}]},"navbar":{"links":[{"icon":"newspaper","href":"https://blog.lerian.studio/","label":"Blog"}],"primary":{"type":"button","label":"Contáctanos","href":"https://lerian.studio/contact"}},"href":"es"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lerian-49cb71fc","hasAudioNarration":false,"actualSubdomain":"lerian-49cb71fc","customDomains":["docs.lerian.studio"],"gitSource":{"type":"github","owner":"lerianstudio","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adbf64eb26019a84172b27a","collectionId":"182c1ea8-f0f8-4010-82f1-78f78bc46637","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adbf64eb26019a84172b27a"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adbf64eb26019a84172b27a","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"en","tag":"API Reference","count":1981},{"language":"es","tag":"Referencia de API","count":1981},{"language":"pt-BR","tag":"Referência da API","count":1981},{"language":"en","tag":"Brazil Rails","count":797},{"language":"es","tag":"Rieles Brasil","count":797},{"language":"pt-BR","tag":"Trilhos Brasil","count":797},{"language":"en","tag":"Products","count":664},{"language":"es","tag":"Productos","count":664},{"language":"pt-BR","tag":"Produtos","count":664},{"language":"en","tag":"Interfaces","count":466},{"language":"es","tag":"Interfaces","count":466},{"language":"pt-BR","tag":"Interfaces","count":466},{"language":"en","tag":"Lerian Products","count":374},{"language":"es","tag":"Productos Lerian","count":374},{"language":"pt-BR","tag":"Produtos Lerian","count":374},{"language":"en","tag":"Midaz","count":344},{"language":"es","tag":"Midaz","count":344},{"language":"pt-BR","tag":"Midaz","count":344},{"language":"en","tag":"Platform","count":326},{"language":"es","tag":"Plataforma","count":326},{"language":"pt-BR","tag":"Plataforma","count":326},{"language":"en","tag":"Matcher","count":234},{"language":"es","tag":"Matcher","count":234},{"language":"pt-BR","tag":"Matcher","count":234},{"language":"en","tag":"SPI (Pix)","count":191},{"language":"es","tag":"SPI (Pix)","count":191},{"language":"pt-BR","tag":"SPI (Pix)","count":191},{"language":"en","tag":"Console","count":172},{"language":"es","tag":"Console","count":172},{"language":"pt-BR","tag":"Console","count":172}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"styles/styles.css","content":"a.link.nav-tabs-item{padding-left:.3rem!important;padding-right:.3rem!important;border-radius:.75rem!important}.sidebar>nav>a.group.flex.items-center,nav[data-level=\"0\"]>a.group.flex.items-center{padding-right:.25rem!important;padding-left:.25rem!important;border-radius:.75rem!important}a.group.flex.items-center:hover{text-shadow:none!important}.dark a.link.nav-anchor.group.flex.items-center:hover,a.group.flex.items-center:hover{background-color:#feed02!important;color:#000!important;border-radius:.75rem!important}.dark a.link.nav-anchor.group.flex.items-center:hover svg{background-color:#000!important;filter:none!important}.dark a.link.nav-anchor.group.flex.items-center:hover .bg-primary,.dark a.link.nav-anchor.group.flex.items-center:hover .dark\\:bg-primary-light,.dark a.link.nav-anchor.group.flex.items-center:hover svg.bg-primary,.dark a.link.nav-anchor.group.flex.items-center:hover svg.dark\\:bg-primary-light,.dark a.link.nav-anchor.group.flex.items-center:hover svg[style*=-webkit-mask],.dark a.link.nav-anchor.group.flex.items-center:hover svg[style*=mask]{background-color:#000!important}#pagination a:hover div,#pagination a:hover span,.dark a.link.nav-anchor.group.flex.items-center:hover div,.dark a.link.nav-anchor.group.flex.items-center:hover span{color:#000!important;-webkit-text-fill-color:#000!important;text-shadow:none!important}#pagination a:hover{border-radius:.75rem!important;transition:background-color .2s ease,border-color .2s ease}#pagination a:hover svg,#pagination a:hover svg *{color:#000!important;stroke:#000!important;fill:#000!important}#pagination a:hover,.dark #pagination a:hover{background-color:#feed02!important;border-color:#feed02!important}.dark #pagination a:hover div,.dark #pagination a:hover span,.dark #pagination a:hover svg,.dark #pagination a:hover svg *{color:#000!important;stroke:#000!important;fill:#000!important;-webkit-text-fill-color:#000!important}.nav-anchor img[src*=\"/images/icons/\"]{filter:grayscale(1)!important;opacity:.55!important}.nav-anchor.text-primary img[src*=\"/images/icons/\"],.nav-anchor:hover img[src*=\"/images/icons/\"],.nav-anchor[aria-current=location] img[src*=\"/images/icons/\"]{filter:none!important;opacity:1!important}a.link.nav-tabs-item[aria-current=location]{color:rgb(var(--primary))!important}.dark a.link.nav-tabs-item[aria-current=location]{color:rgb(var(--primary-light))!important}.landing-band{background-image:linear-gradient(to bottom right,#feed02,#f6ff86)}.dark .landing-band{background-image:linear-gradient(to bottom right,#0d0d11,#15151a)}"}],"page":{"pagePath":"en/reference/products/midaz/v2/create-holder","slug":"/en/reference/products/midaz/v2/create-holder","pageMetadata":{"title":"Create a Holder","description":null,"deprecated":null,"version":null,"sidebarTitle":"Create holder","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/holders","href":"/en/reference/products/midaz/v2/create-holder","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a Holder","description":null,"deprecated":null,"version":null,"sidebarTitle":"Create holder","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/holders","href":"/en/reference/products/midaz/v2/create-holder","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createHolderV2","parameters":["b5bf745d-7d6d-4228-a9b8-d53a64ac27cf","339e045f-0595-4a4b-ba6b-7ba7659a4107","a0686d80-b44c-46a3-ad9e-4ae05839b3d9"],"requestBody":"11db8cb9-d191-4ed2-b41f-5c216866e267","responses":{"201":"e66c0b26-bdbb-4986-9b88-deb28f1f99a0","422":"d085cdc6-1db0-46ce-aa4b-c94d9f04c1f9","500":"356f7a52-042f-4971-b7ab-076d9549904f","default":"b8939664-3a64-445c-8c53-241bc3f7920a"},"security":["bf96e9d3-833b-4faf-a318-7804886f19f2"],"summary":"Create a Holder","tags":["Holders (v2)"],"x-mint":{"href":"/en/reference/products/midaz/v2/create-holder"},"method":"post","type":"path","servers":["08e4c428-7a96-4d24-a5d8-99124c94d612"],"path":"/v2/organizations/{organization_id}/holders","baseUrlOptions":["https://ledger.sandbox.lerian.net"],"title":"Create a Holder","description":"","codeSamples":[],"requestExampleLanguages":["bash","go","typescript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.contact.mobilePhone":"+1555555555","body.contact.otherPhone":"+1555555555","body.contact.primaryEmail":"john.doe@example.com","body.contact.secondaryEmail":"john.doe@example.com","body.document":"12345678900","body.externalId.oneOf.0":"G4K7N8M2","body.legalPerson.activity":"Electronic devices development","body.legalPerson.foundingDate":"2025-01-01","body.legalPerson.representative.document":"12345678900","body.legalPerson.representative.email":"john.doe@example.com","body.legalPerson.representative.name":"John Doe","body.legalPerson.representative.role":"CFO","body.legalPerson.size":"Medium","body.legalPerson.status":"Active","body.legalPerson.tradeName":"Lerian Studio","body.legalPerson.type":"Limited Liability","body.name":"John Doe","body.naturalPerson.birthDate":"1990-01-01","body.naturalPerson.civilStatus":"Single","body.naturalPerson.fatherName":"John Doe","body.naturalPerson.favoriteName":"John","body.naturalPerson.gender":"Male","body.naturalPerson.motherName":"Jane Doe","body.naturalPerson.nationality":"Brazilian","body.naturalPerson.socialName":"John Doe","body.naturalPerson.status":"Active","body.type.oneOf.0":"NATURAL_PERSON"}]},"dependencies":{"parameters":{"b5bf745d-7d6d-4228-a9b8-d53a64ac27cf":{"description":"Organization ID (UUID)","in":"path","name":"organization_id","required":true,"schema":{"description":"Organization ID (UUID)","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"339e045f-0595-4a4b-ba6b-7ba7659a4107":{"description":"Idempotency key to safely retry the create; an identical retry returns the original holder","in":"header","name":"X-Idempotency","schema":{"description":"Idempotency key to safely retry the create; an identical retry returns the original holder","type":"string","uniqueKey":"","typeLabel":"string"}},"a0686d80-b44c-46a3-ad9e-4ae05839b3d9":{"description":"Idempotency slot TTL in seconds (default 300)","in":"header","name":"X-TTL","schema":{"description":"Idempotency slot TTL in seconds (default 300)","type":"string","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"addresses":{"additionalProperties":false,"properties":{"additional1":{"additionalProperties":false,"properties":{"city":{"examples":["New York"],"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"addresses.additional1.city","typeLabel":"string"},"country":{"examples":["US"],"maxLength":2,"minLength":2,"type":"string","isRequired":true,"uniqueKey":"addresses.additional1.country","typeLabel":"string"},"line1":{"examples":["123 Financial Avenue"],"maxLength":256,"type":"string","isRequired":true,"uniqueKey":"addresses.additional1.line1","typeLabel":"string"},"line2":{"oneOf":[{"examples":["Suite 1500"],"maxLength":256,"type":"string","isRequired":true,"uniqueKey":"addresses.additional1.line2.oneOf.0","typeLabel":"string"},{"examples":["Suite 1500"],"maxLength":256,"type":"null","isRequired":true,"uniqueKey":"addresses.additional1.line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"addresses.additional1.line2","typeLabel":"string | null"},"state":{"examples":["NY"],"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"addresses.additional1.state","typeLabel":"string"},"zipCode":{"examples":["10001"],"maxLength":20,"type":"string","isRequired":true,"uniqueKey":"addresses.additional1.zipCode","typeLabel":"string"},"description":{"examples":["Home"],"maxLength":100,"type":"string","uniqueKey":"addresses.additional1.description","typeLabel":"string"}},"required":["line1","line2","zipCode","city","state","country"],"type":"object","uniqueKey":"addresses.additional1","typeLabel":"object"},"additional2":{"additionalProperties":false,"properties":{"city":{"examples":["New York"],"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"addresses.additional2.city","typeLabel":"string"},"country":{"examples":["US"],"maxLength":2,"minLength":2,"type":"string","isRequired":true,"uniqueKey":"addresses.additional2.country","typeLabel":"string"},"line1":{"examples":["123 Financial Avenue"],"maxLength":256,"type":"string","isRequired":true,"uniqueKey":"addresses.additional2.line1","typeLabel":"string"},"line2":{"oneOf":[{"examples":["Suite 1500"],"maxLength":256,"type":"string","isRequired":true,"uniqueKey":"addresses.additional2.line2.oneOf.0","typeLabel":"string"},{"examples":["Suite 1500"],"maxLength":256,"type":"null","isRequired":true,"uniqueKey":"addresses.additional2.line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"addresses.additional2.line2","typeLabel":"string | null"},"state":{"examples":["NY"],"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"addresses.additional2.state","typeLabel":"string"},"zipCode":{"examples":["10001"],"maxLength":20,"type":"string","isRequired":true,"uniqueKey":"addresses.additional2.zipCode","typeLabel":"string"},"description":{"examples":["Home"],"maxLength":100,"type":"string","uniqueKey":"addresses.additional2.description","typeLabel":"string"}},"required":["line1","line2","zipCode","city","state","country"],"type":"object","uniqueKey":"addresses.additional2","typeLabel":"object"},"primary":{"additionalProperties":false,"properties":{"city":{"examples":["New York"],"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"addresses.primary.city","typeLabel":"string"},"country":{"examples":["US"],"maxLength":2,"minLength":2,"type":"string","isRequired":true,"uniqueKey":"addresses.primary.country","typeLabel":"string"},"line1":{"examples":["123 Financial Avenue"],"maxLength":256,"type":"string","isRequired":true,"uniqueKey":"addresses.primary.line1","typeLabel":"string"},"line2":{"oneOf":[{"examples":["Suite 1500"],"maxLength":256,"type":"string","isRequired":true,"uniqueKey":"addresses.primary.line2.oneOf.0","typeLabel":"string"},{"examples":["Suite 1500"],"maxLength":256,"type":"null","isRequired":true,"uniqueKey":"addresses.primary.line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"addresses.primary.line2","typeLabel":"string | null"},"state":{"examples":["NY"],"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"addresses.primary.state","typeLabel":"string"},"zipCode":{"examples":["10001"],"maxLength":20,"type":"string","isRequired":true,"uniqueKey":"addresses.primary.zipCode","typeLabel":"string"},"description":{"examples":["Home"],"maxLength":100,"type":"string","uniqueKey":"addresses.primary.description","typeLabel":"string"}},"required":["line1","line2","zipCode","city","state","country"],"type":"object","uniqueKey":"addresses.primary","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"addresses","typeLabel":"object"},"contact":{"additionalProperties":false,"properties":{"mobilePhone":{"examples":["+1555555555"],"maxLength":32,"type":"string","uniqueKey":"contact.mobilePhone","typeLabel":"string"},"otherPhone":{"examples":["+1555555555"],"maxLength":32,"type":"string","uniqueKey":"contact.otherPhone","typeLabel":"string"},"primaryEmail":{"examples":["john.doe@example.com"],"maxLength":256,"type":"string","uniqueKey":"contact.primaryEmail","typeLabel":"string"},"secondaryEmail":{"examples":["john.doe@example.com"],"maxLength":256,"type":"string","uniqueKey":"contact.secondaryEmail","typeLabel":"string"}},"type":"object","isRequired":true,"uniqueKey":"contact","typeLabel":"object"},"document":{"examples":["12345678900"],"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"document","typeLabel":"string"},"externalId":{"oneOf":[{"examples":["G4K7N8M2"],"maxLength":256,"type":"string","isRequired":true,"uniqueKey":"externalId.oneOf.0","typeLabel":"string"},{"examples":["G4K7N8M2"],"maxLength":256,"type":"null","isRequired":true,"uniqueKey":"externalId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"externalId","typeLabel":"string | null"},"legalPerson":{"additionalProperties":false,"properties":{"activity":{"examples":["Electronic devices development"],"maxLength":256,"type":"string","uniqueKey":"legalPerson.activity","typeLabel":"string"},"annualGrossRevenue":{"additionalProperties":false,"properties":{"currency":{"examples":["BRL"],"pattern":"^[A-Z]{3}$","type":"string","isRequired":true,"uniqueKey":"legalPerson.annualGrossRevenue.currency","typeLabel":"string"},"referenceDate":{"examples":["2026-06-30"],"format":"date","type":"string","isRequired":true,"uniqueKey":"legalPerson.annualGrossRevenue.referenceDate","typeLabel":"string\u003cdate>"},"value":{"examples":["12500.50"],"pattern":"^[0-9]{1,20}(\\.[0-9]{1,10})?$","type":"string","isRequired":true,"uniqueKey":"legalPerson.annualGrossRevenue.value","typeLabel":"string"}},"required":["value","currency","referenceDate"],"type":"object","uniqueKey":"legalPerson.annualGrossRevenue","typeLabel":"object"},"foundingDate":{"examples":["2025-01-01"],"format":"date","type":"string","uniqueKey":"legalPerson.foundingDate","typeLabel":"string\u003cdate>"},"representative":{"additionalProperties":false,"properties":{"document":{"examples":["12345678900"],"maxLength":100,"type":"string","uniqueKey":"legalPerson.representative.document","typeLabel":"string"},"email":{"examples":["john.doe@example.com"],"maxLength":256,"type":"string","uniqueKey":"legalPerson.representative.email","typeLabel":"string"},"name":{"examples":["John Doe"],"maxLength":256,"type":"string","uniqueKey":"legalPerson.representative.name","typeLabel":"string"},"role":{"examples":["CFO"],"maxLength":100,"type":"string","uniqueKey":"legalPerson.representative.role","typeLabel":"string"}},"type":"object","uniqueKey":"legalPerson.representative","typeLabel":"object"},"size":{"examples":["Medium"],"maxLength":100,"type":"string","uniqueKey":"legalPerson.size","typeLabel":"string"},"status":{"examples":["Active"],"maxLength":100,"type":"string","uniqueKey":"legalPerson.status","typeLabel":"string"},"totalAssets":{"additionalProperties":false,"properties":{"currency":{"examples":["BRL"],"pattern":"^[A-Z]{3}$","type":"string","isRequired":true,"uniqueKey":"legalPerson.totalAssets.currency","typeLabel":"string"},"referenceDate":{"examples":["2026-06-30"],"format":"date","type":"string","isRequired":true,"uniqueKey":"legalPerson.totalAssets.referenceDate","typeLabel":"string\u003cdate>"},"value":{"examples":["12500.50"],"pattern":"^[0-9]{1,20}(\\.[0-9]{1,10})?$","type":"string","isRequired":true,"uniqueKey":"legalPerson.totalAssets.value","typeLabel":"string"}},"required":["value","currency","referenceDate"],"type":"object","uniqueKey":"legalPerson.totalAssets","typeLabel":"object"},"tradeName":{"examples":["Lerian Studio"],"maxLength":256,"type":"string","uniqueKey":"legalPerson.tradeName","typeLabel":"string"},"type":{"examples":["Limited Liability"],"maxLength":100,"type":"string","uniqueKey":"legalPerson.type","typeLabel":"string"}},"type":"object","isRequired":true,"uniqueKey":"legalPerson","typeLabel":"object"},"metadata":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"metadata.additionalProperties","typeLabel":"any"},"type":"object","isRequired":true,"uniqueKey":"metadata","typeLabel":"object"},"name":{"examples":["John Doe"],"maxLength":256,"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"naturalPerson":{"additionalProperties":false,"properties":{"birthDate":{"examples":["1990-01-01"],"format":"date","type":"string","uniqueKey":"naturalPerson.birthDate","typeLabel":"string\u003cdate>"},"civilStatus":{"examples":["Single"],"maxLength":100,"type":"string","uniqueKey":"naturalPerson.civilStatus","typeLabel":"string"},"fatherName":{"examples":["John Doe"],"maxLength":256,"type":"string","uniqueKey":"naturalPerson.fatherName","typeLabel":"string"},"favoriteName":{"examples":["John"],"maxLength":256,"type":"string","uniqueKey":"naturalPerson.favoriteName","typeLabel":"string"},"gender":{"examples":["Male"],"maxLength":100,"type":"string","uniqueKey":"naturalPerson.gender","typeLabel":"string"},"monthlyGrossIncome":{"additionalProperties":false,"properties":{"currency":{"examples":["BRL"],"pattern":"^[A-Z]{3}$","type":"string","isRequired":true,"uniqueKey":"naturalPerson.monthlyGrossIncome.currency","typeLabel":"string"},"referenceDate":{"examples":["2026-06-30"],"format":"date","type":"string","isRequired":true,"uniqueKey":"naturalPerson.monthlyGrossIncome.referenceDate","typeLabel":"string\u003cdate>"},"value":{"examples":["12500.50"],"pattern":"^[0-9]{1,20}(\\.[0-9]{1,10})?$","type":"string","isRequired":true,"uniqueKey":"naturalPerson.monthlyGrossIncome.value","typeLabel":"string"}},"required":["value","currency","referenceDate"],"type":"object","uniqueKey":"naturalPerson.monthlyGrossIncome","typeLabel":"object"},"motherName":{"examples":["Jane Doe"],"maxLength":256,"type":"string","uniqueKey":"naturalPerson.motherName","typeLabel":"string"},"nationality":{"examples":["Brazilian"],"maxLength":100,"type":"string","uniqueKey":"naturalPerson.nationality","typeLabel":"string"},"socialName":{"examples":["John Doe"],"maxLength":256,"type":"string","uniqueKey":"naturalPerson.socialName","typeLabel":"string"},"status":{"examples":["Active"],"maxLength":100,"type":"string","uniqueKey":"naturalPerson.status","typeLabel":"string"}},"type":"object","isRequired":true,"uniqueKey":"naturalPerson","typeLabel":"object"},"type":{"oneOf":[{"examples":["NATURAL_PERSON"],"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"type.oneOf.0","typeLabel":"string"},{"examples":["NATURAL_PERSON"],"maxLength":100,"type":"null","isRequired":true,"uniqueKey":"type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"type","typeLabel":"string | null"}},"required":["externalId","type","name","document","addresses","contact","naturalPerson","legalPerson","metadata"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"addresses":{},"contact":{"mobilePhone":"+1555555555","otherPhone":"+1555555555","primaryEmail":"john.doe@example.com","secondaryEmail":"john.doe@example.com"},"document":"12345678900","externalId":"G4K7N8M2","legalPerson":{"activity":"Electronic devices development","foundingDate":"2025-01-01","representative":{"document":"12345678900","email":"john.doe@example.com","name":"John Doe","role":"CFO"},"size":"Medium","status":"Active","tradeName":"Lerian Studio","type":"Limited Liability"},"metadata":{},"name":"John Doe","naturalPerson":{"birthDate":"1990-01-01","civilStatus":"Single","fatherName":"John Doe","favoriteName":"John","gender":"Male","motherName":"Jane Doe","nationality":"Brazilian","socialName":"John Doe","status":"Active"},"type":"NATURAL_PERSON"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"e66c0b26-bdbb-4986-9b88-deb28f1f99a0":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"createdAt":{"examples":["2025-01-01T00:00:00Z"],"format":"date-time","type":"string","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"deletedAt":{"oneOf":[{"examples":["2025-01-01T00:00:00Z"],"format":"date-time","type":"string","isRequired":true,"uniqueKey":"deletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"examples":["2025-01-01T00:00:00Z"],"format":"date-time","type":"null","isRequired":true,"uniqueKey":"deletedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"deletedAt","typeLabel":"string\u003cdate-time> | null"},"updatedAt":{"examples":["2025-01-01T00:00:00Z"],"format":"date-time","type":"string","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"addresses":{"additionalProperties":false,"properties":{"additional1":{"additionalProperties":false,"properties":{"city":{"examples":["New York"],"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"addresses.additional1.city","typeLabel":"string"},"country":{"examples":["US"],"maxLength":2,"minLength":2,"type":"string","isRequired":true,"uniqueKey":"addresses.additional1.country","typeLabel":"string"},"line1":{"examples":["123 Financial Avenue"],"maxLength":256,"type":"string","isRequired":true,"uniqueKey":"addresses.additional1.line1","typeLabel":"string"},"line2":{"oneOf":[{"examples":["Suite 1500"],"maxLength":256,"type":"string","isRequired":true,"uniqueKey":"addresses.additional1.line2.oneOf.0","typeLabel":"string"},{"examples":["Suite 1500"],"maxLength":256,"type":"null","isRequired":true,"uniqueKey":"addresses.additional1.line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"addresses.additional1.line2","typeLabel":"string | null"},"state":{"examples":["NY"],"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"addresses.additional1.state","typeLabel":"string"},"zipCode":{"examples":["10001"],"maxLength":20,"type":"string","isRequired":true,"uniqueKey":"addresses.additional1.zipCode","typeLabel":"string"},"description":{"examples":["Home"],"maxLength":100,"type":"string","uniqueKey":"addresses.additional1.description","typeLabel":"string"}},"required":["line1","line2","zipCode","city","state","country"],"type":"object","uniqueKey":"addresses.additional1","typeLabel":"object"},"additional2":{"additionalProperties":false,"properties":{"city":{"examples":["New York"],"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"addresses.additional2.city","typeLabel":"string"},"country":{"examples":["US"],"maxLength":2,"minLength":2,"type":"string","isRequired":true,"uniqueKey":"addresses.additional2.country","typeLabel":"string"},"line1":{"examples":["123 Financial Avenue"],"maxLength":256,"type":"string","isRequired":true,"uniqueKey":"addresses.additional2.line1","typeLabel":"string"},"line2":{"oneOf":[{"examples":["Suite 1500"],"maxLength":256,"type":"string","isRequired":true,"uniqueKey":"addresses.additional2.line2.oneOf.0","typeLabel":"string"},{"examples":["Suite 1500"],"maxLength":256,"type":"null","isRequired":true,"uniqueKey":"addresses.additional2.line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"addresses.additional2.line2","typeLabel":"string | null"},"state":{"examples":["NY"],"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"addresses.additional2.state","typeLabel":"string"},"zipCode":{"examples":["10001"],"maxLength":20,"type":"string","isRequired":true,"uniqueKey":"addresses.additional2.zipCode","typeLabel":"string"},"description":{"examples":["Home"],"maxLength":100,"type":"string","uniqueKey":"addresses.additional2.description","typeLabel":"string"}},"required":["line1","line2","zipCode","city","state","country"],"type":"object","uniqueKey":"addresses.additional2","typeLabel":"object"},"primary":{"additionalProperties":false,"properties":{"city":{"examples":["New York"],"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"addresses.primary.city","typeLabel":"string"},"country":{"examples":["US"],"maxLength":2,"minLength":2,"type":"string","isRequired":true,"uniqueKey":"addresses.primary.country","typeLabel":"string"},"line1":{"examples":["123 Financial Avenue"],"maxLength":256,"type":"string","isRequired":true,"uniqueKey":"addresses.primary.line1","typeLabel":"string"},"line2":{"oneOf":[{"examples":["Suite 1500"],"maxLength":256,"type":"string","isRequired":true,"uniqueKey":"addresses.primary.line2.oneOf.0","typeLabel":"string"},{"examples":["Suite 1500"],"maxLength":256,"type":"null","isRequired":true,"uniqueKey":"addresses.primary.line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"addresses.primary.line2","typeLabel":"string | null"},"state":{"examples":["NY"],"maxLength":100,"type":"string","isRequired":true,"uniqueKey":"addresses.primary.state","typeLabel":"string"},"zipCode":{"examples":["10001"],"maxLength":20,"type":"string","isRequired":true,"uniqueKey":"addresses.primary.zipCode","typeLabel":"string"},"description":{"examples":["Home"],"maxLength":100,"type":"string","uniqueKey":"addresses.primary.description","typeLabel":"string"}},"required":["line1","line2","zipCode","city","state","country"],"type":"object","uniqueKey":"addresses.primary","typeLabel":"object"}},"type":"object","uniqueKey":"addresses","typeLabel":"object"},"contact":{"additionalProperties":false,"properties":{"mobilePhone":{"examples":["+1555555555"],"maxLength":32,"type":"string","uniqueKey":"contact.mobilePhone","typeLabel":"string"},"otherPhone":{"examples":["+1555555555"],"maxLength":32,"type":"string","uniqueKey":"contact.otherPhone","typeLabel":"string"},"primaryEmail":{"examples":["john.doe@example.com"],"maxLength":256,"type":"string","uniqueKey":"contact.primaryEmail","typeLabel":"string"},"secondaryEmail":{"examples":["john.doe@example.com"],"maxLength":256,"type":"string","uniqueKey":"contact.secondaryEmail","typeLabel":"string"}},"type":"object","uniqueKey":"contact","typeLabel":"object"},"document":{"examples":["12345678900"],"maxLength":100,"type":"string","uniqueKey":"document","typeLabel":"string"},"externalId":{"examples":["G4K7N8M2"],"maxLength":256,"type":"string","uniqueKey":"externalId","typeLabel":"string"},"id":{"examples":["00000000-0000-0000-0000-000000000000"],"format":"uuid","type":"string","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"legalPerson":{"additionalProperties":false,"properties":{"activity":{"examples":["Electronic devices development"],"maxLength":256,"type":"string","uniqueKey":"legalPerson.activity","typeLabel":"string"},"annualGrossRevenue":{"additionalProperties":false,"properties":{"currency":{"examples":["BRL"],"pattern":"^[A-Z]{3}$","type":"string","isRequired":true,"uniqueKey":"legalPerson.annualGrossRevenue.currency","typeLabel":"string"},"referenceDate":{"examples":["2026-06-30"],"format":"date","type":"string","isRequired":true,"uniqueKey":"legalPerson.annualGrossRevenue.referenceDate","typeLabel":"string\u003cdate>"},"value":{"examples":["12500.50"],"pattern":"^[0-9]{1,20}(\\.[0-9]{1,10})?$","type":"string","isRequired":true,"uniqueKey":"legalPerson.annualGrossRevenue.value","typeLabel":"string"}},"required":["value","currency","referenceDate"],"type":"object","uniqueKey":"legalPerson.annualGrossRevenue","typeLabel":"object"},"foundingDate":{"examples":["2025-01-01"],"format":"date","type":"string","uniqueKey":"legalPerson.foundingDate","typeLabel":"string\u003cdate>"},"representative":{"additionalProperties":false,"properties":{"document":{"examples":["12345678900"],"maxLength":100,"type":"string","uniqueKey":"legalPerson.representative.document","typeLabel":"string"},"email":{"examples":["john.doe@example.com"],"maxLength":256,"type":"string","uniqueKey":"legalPerson.representative.email","typeLabel":"string"},"name":{"examples":["John Doe"],"maxLength":256,"type":"string","uniqueKey":"legalPerson.representative.name","typeLabel":"string"},"role":{"examples":["CFO"],"maxLength":100,"type":"string","uniqueKey":"legalPerson.representative.role","typeLabel":"string"}},"type":"object","uniqueKey":"legalPerson.representative","typeLabel":"object"},"size":{"examples":["Medium"],"maxLength":100,"type":"string","uniqueKey":"legalPerson.size","typeLabel":"string"},"status":{"examples":["Active"],"maxLength":100,"type":"string","uniqueKey":"legalPerson.status","typeLabel":"string"},"totalAssets":{"additionalProperties":false,"properties":{"currency":{"examples":["BRL"],"pattern":"^[A-Z]{3}$","type":"string","isRequired":true,"uniqueKey":"legalPerson.totalAssets.currency","typeLabel":"string"},"referenceDate":{"examples":["2026-06-30"],"format":"date","type":"string","isRequired":true,"uniqueKey":"legalPerson.totalAssets.referenceDate","typeLabel":"string\u003cdate>"},"value":{"examples":["12500.50"],"pattern":"^[0-9]{1,20}(\\.[0-9]{1,10})?$","type":"string","isRequired":true,"uniqueKey":"legalPerson.totalAssets.value","typeLabel":"string"}},"required":["value","currency","referenceDate"],"type":"object","uniqueKey":"legalPerson.totalAssets","typeLabel":"object"},"tradeName":{"examples":["Lerian Studio"],"maxLength":256,"type":"string","uniqueKey":"legalPerson.tradeName","typeLabel":"string"},"type":{"examples":["Limited Liability"],"maxLength":100,"type":"string","uniqueKey":"legalPerson.type","typeLabel":"string"}},"type":"object","uniqueKey":"legalPerson","typeLabel":"object"},"metadata":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"metadata.additionalProperties","typeLabel":"any"},"type":"object","uniqueKey":"metadata","typeLabel":"object"},"name":{"examples":["John Doe"],"maxLength":256,"type":"string","uniqueKey":"name","typeLabel":"string"},"naturalPerson":{"additionalProperties":false,"properties":{"birthDate":{"examples":["1990-01-01"],"format":"date","type":"string","uniqueKey":"naturalPerson.birthDate","typeLabel":"string\u003cdate>"},"civilStatus":{"examples":["Single"],"maxLength":100,"type":"string","uniqueKey":"naturalPerson.civilStatus","typeLabel":"string"},"fatherName":{"examples":["John Doe"],"maxLength":256,"type":"string","uniqueKey":"naturalPerson.fatherName","typeLabel":"string"},"favoriteName":{"examples":["John"],"maxLength":256,"type":"string","uniqueKey":"naturalPerson.favoriteName","typeLabel":"string"},"gender":{"examples":["Male"],"maxLength":100,"type":"string","uniqueKey":"naturalPerson.gender","typeLabel":"string"},"monthlyGrossIncome":{"additionalProperties":false,"properties":{"currency":{"examples":["BRL"],"pattern":"^[A-Z]{3}$","type":"string","isRequired":true,"uniqueKey":"naturalPerson.monthlyGrossIncome.currency","typeLabel":"string"},"referenceDate":{"examples":["2026-06-30"],"format":"date","type":"string","isRequired":true,"uniqueKey":"naturalPerson.monthlyGrossIncome.referenceDate","typeLabel":"string\u003cdate>"},"value":{"examples":["12500.50"],"pattern":"^[0-9]{1,20}(\\.[0-9]{1,10})?$","type":"string","isRequired":true,"uniqueKey":"naturalPerson.monthlyGrossIncome.value","typeLabel":"string"}},"required":["value","currency","referenceDate"],"type":"object","uniqueKey":"naturalPerson.monthlyGrossIncome","typeLabel":"object"},"motherName":{"examples":["Jane Doe"],"maxLength":256,"type":"string","uniqueKey":"naturalPerson.motherName","typeLabel":"string"},"nationality":{"examples":["Brazilian"],"maxLength":100,"type":"string","uniqueKey":"naturalPerson.nationality","typeLabel":"string"},"socialName":{"examples":["John Doe"],"maxLength":256,"type":"string","uniqueKey":"naturalPerson.socialName","typeLabel":"string"},"status":{"examples":["Active"],"maxLength":100,"type":"string","uniqueKey":"naturalPerson.status","typeLabel":"string"}},"type":"object","uniqueKey":"naturalPerson","typeLabel":"object"},"type":{"examples":["NATURAL_PERSON"],"maxLength":100,"type":"string","uniqueKey":"type","typeLabel":"string"}},"required":["createdAt","updatedAt","deletedAt"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"createdAt":"2025-01-01T00:00:00Z","deletedAt":"2025-01-01T00:00:00Z","updatedAt":"2025-01-01T00:00:00Z","addresses":{"additional1":{"city":"New York","country":"US","line1":"123 Financial Avenue","line2":"Suite 1500","state":"NY","zipCode":"10001","description":"Home"},"additional2":{"city":"New York","country":"US","line1":"123 Financial Avenue","line2":"Suite 1500","state":"NY","zipCode":"10001","description":"Home"},"primary":{"city":"New York","country":"US","line1":"123 Financial Avenue","line2":"Suite 1500","state":"NY","zipCode":"10001","description":"Home"}},"contact":{"mobilePhone":"+1555555555","otherPhone":"+1555555555","primaryEmail":"john.doe@example.com","secondaryEmail":"john.doe@example.com"},"document":"12345678900","externalId":"G4K7N8M2","id":"00000000-0000-0000-0000-000000000000","legalPerson":{"activity":"Electronic devices development","annualGrossRevenue":{"currency":"BRL","referenceDate":"2026-06-30","value":"12500.50"},"foundingDate":"2025-01-01","representative":{"document":"12345678900","email":"john.doe@example.com","name":"John Doe","role":"CFO"},"size":"Medium","status":"Active","totalAssets":{"currency":"BRL","referenceDate":"2026-06-30","value":"12500.50"},"tradeName":"Lerian Studio","type":"Limited Liability"},"metadata":{},"name":"John Doe","naturalPerson":{"birthDate":"1990-01-01","civilStatus":"Single","fatherName":"John Doe","favoriteName":"John","gender":"Male","monthlyGrossIncome":{"currency":"BRL","referenceDate":"2026-06-30","value":"12500.50"},"motherName":"Jane Doe","nationality":"Brazilian","socialName":"John Doe","status":"Active"},"type":"NATURAL_PERSON"}}},"exampleType":"generated"}},"description":"Created","headers":{"X-Idempotency-Replayed":{"schema":{"type":"string"}}},"exampleType":"generated"},"d085cdc6-1db0-46ce-aa4b-c94d9f04c1f9":{"content":{"application/problem+json":{"schema":{"additionalProperties":true,"properties":{"code":{"description":"Stable, machine-readable domain error code scoped to the emitting service (format: \u003cSERVICE>-NNNN).","type":"string","uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","examples":["Property foo is required but is missing."],"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"oneOf":[{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].location","typeLabel":"string"},"message":{"description":"Error message text","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string"},"value":{"description":"The value at the given location","uniqueKey":"errors.oneOf.0.items.[INDEX].value","typeLabel":"any"}},"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"},"type":"null","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","examples":["https://example.com/error-log/abc123"],"format":"uri","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi>"},"status":{"description":"HTTP status code","examples":[400],"format":"int64","type":"integer","uniqueKey":"status","typeLabel":"integer\u003cint64>"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","examples":["Bad Request"],"type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","examples":["https://example.com/errors/example"],"format":"uri","type":"string","uniqueKey":"type","typeLabel":"string\u003curi>"},"upstream":{"additionalProperties":false,"properties":{"code":{"description":"The upstream provider's own error code, verbatim.","examples":["E4001"],"type":"string","uniqueKey":"upstream.code","typeLabel":"string"},"message":{"description":"The upstream provider's own error message, verbatim (bounded, never its raw response body).","examples":["account not found at provider"],"type":"string","uniqueKey":"upstream.message","typeLabel":"string"}},"type":"object","description":"RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one.","uniqueKey":"upstream","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"Property foo is required but is missing.","errors":[{"location":"\u003cstring>","message":"\u003cstring>","value":"\u003cunknown>"}],"instance":"https://example.com/error-log/abc123","status":400,"title":"Bad Request","type":"https://example.com/errors/example","upstream":{"code":"E4001","message":"account not found at provider"}}}},"exampleType":"generated"}},"description":"Unprocessable Entity","exampleType":"generated"},"356f7a52-042f-4971-b7ab-076d9549904f":{"content":{"application/problem+json":{"schema":{"additionalProperties":true,"properties":{"code":{"description":"Stable, machine-readable domain error code scoped to the emitting service (format: \u003cSERVICE>-NNNN).","type":"string","uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","examples":["Property foo is required but is missing."],"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"oneOf":[{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].location","typeLabel":"string"},"message":{"description":"Error message text","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string"},"value":{"description":"The value at the given location","uniqueKey":"errors.oneOf.0.items.[INDEX].value","typeLabel":"any"}},"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"},"type":"null","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","examples":["https://example.com/error-log/abc123"],"format":"uri","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi>"},"status":{"description":"HTTP status code","examples":[400],"format":"int64","type":"integer","uniqueKey":"status","typeLabel":"integer\u003cint64>"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","examples":["Bad Request"],"type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","examples":["https://example.com/errors/example"],"format":"uri","type":"string","uniqueKey":"type","typeLabel":"string\u003curi>"},"upstream":{"additionalProperties":false,"properties":{"code":{"description":"The upstream provider's own error code, verbatim.","examples":["E4001"],"type":"string","uniqueKey":"upstream.code","typeLabel":"string"},"message":{"description":"The upstream provider's own error message, verbatim (bounded, never its raw response body).","examples":["account not found at provider"],"type":"string","uniqueKey":"upstream.message","typeLabel":"string"}},"type":"object","description":"RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one.","uniqueKey":"upstream","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"Property foo is required but is missing.","errors":[{"location":"\u003cstring>","message":"\u003cstring>","value":"\u003cunknown>"}],"instance":"https://example.com/error-log/abc123","status":400,"title":"Bad Request","type":"https://example.com/errors/example","upstream":{"code":"E4001","message":"account not found at provider"}}}},"exampleType":"generated"}},"description":"Internal Server Error","exampleType":"generated"},"b8939664-3a64-445c-8c53-241bc3f7920a":{"content":{"application/problem+json":{"schema":{"additionalProperties":true,"properties":{"code":{"description":"Stable, machine-readable domain error code scoped to the emitting service (format: \u003cSERVICE>-NNNN).","type":"string","uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","examples":["Property foo is required but is missing."],"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"oneOf":[{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].location","typeLabel":"string"},"message":{"description":"Error message text","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string"},"value":{"description":"The value at the given location","uniqueKey":"errors.oneOf.0.items.[INDEX].value","typeLabel":"any"}},"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"},"type":"null","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","examples":["https://example.com/error-log/abc123"],"format":"uri","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi>"},"status":{"description":"HTTP status code","examples":[400],"format":"int64","type":"integer","uniqueKey":"status","typeLabel":"integer\u003cint64>"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","examples":["Bad Request"],"type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","examples":["https://example.com/errors/example"],"format":"uri","type":"string","uniqueKey":"type","typeLabel":"string\u003curi>"},"upstream":{"additionalProperties":false,"properties":{"code":{"description":"The upstream provider's own error code, verbatim.","examples":["E4001"],"type":"string","uniqueKey":"upstream.code","typeLabel":"string"},"message":{"description":"The upstream provider's own error message, verbatim (bounded, never its raw response body).","examples":["account not found at provider"],"type":"string","uniqueKey":"upstream.message","typeLabel":"string"}},"type":"object","description":"RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one.","uniqueKey":"upstream","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","detail":"Property foo is required but is missing.","errors":[{"location":"\u003cstring>","message":"\u003cstring>","value":"\u003cunknown>"}],"instance":"https://example.com/error-log/abc123","status":400,"title":"Bad Request","type":"https://example.com/errors/example","upstream":{"code":"E4001","message":"account not found at provider"}}}},"exampleType":"generated"}},"description":"Error","exampleType":"generated"}},"security":{"bf96e9d3-833b-4faf-a318-7804886f19f2":{"BearerAuth":{"bearerFormat":"JWT","description":"JWT bearer token issued by the identity provider.","scheme":"bearer","type":"http","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"08e4c428-7a96-4d24-a5d8-99124c94d612":{"url":"https://ledger.sandbox.lerian.net"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"JWT","description":"JWT bearer token issued by the identity provider.","scheme":"bearer","type":"http","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"JWT bearer token issued by the identity provider.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"en/openapi/v3-current/ledger.yaml"},"subdomain":"lerian-49cb71fc","siteName":"Lerian","title":"Create a Holder - Lerian","navMaps":{"firstHrefInVersion":{"v2":{"href":"/en/reference/products/midaz/v2/create-holder","matchLevel":0},"v1":{"href":"/en/reference/products/midaz/quick-start-guide","matchLevel":3}},"firstHrefInLanguage":{"en":{"href":"/en/reference/products/midaz/v2/create-holder","matchLevel":0},"pt-BR":{"href":"/pt/reference/products/midaz/v2/create-holder","matchLevel":1},"es":{"href":"/es/reference/products/midaz/v2/create-holder","matchLevel":1}}},"lastModified":"2026-10-24T00:07:15.319Z","originalFileLocation":"en/reference/products/midaz/v2/create-holder.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Lerian\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a Holder - Lerian\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Lerian Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lerian.studio/en/reference/products/midaz/v2/create-holder\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lerian-49cb71fc.mintlify.app/_mintlify/api/og/v2?division=CRM\u0026amp;title=Create+a+Holder\u0026amp;theme=3f503b0e4b30ffd40e70bfc6\u0026amp;signature=13e7045ac560f0c4fc877c8ede7ccf8d91e7620188c12be551d954bbf8738af5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a Holder - Lerian\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lerian-49cb71fc.mintlify.app/_mintlify/api/og/v2?division=CRM\u0026amp;title=Create+a+Holder\u0026amp;theme=3f503b0e4b30ffd40e70bfc6\u0026amp;signature=13e7045ac560f0c4fc877c8ede7ccf8d91e7620188c12be551d954bbf8738af5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Lerian\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#847000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.lerian.studio/en/reference/products/midaz/v2/create-holder\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/reference/products/midaz/v2/create-holder.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.lerian.studio/en/reference/products/midaz/v2/create-holder\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.lerian.studio/pt/reference/products/midaz/v2/create-holder\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.lerian.studio/es/reference/products/midaz/v2/create-holder\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.lerian.studio/en/reference/products/midaz/v2/create-holder\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://lerian.studio/#organization\",\"name\":\"Lerian\",\"url\":\"https://lerian.studio\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.lerian.studio/images/logo/light.png\"},\"sameAs\":[\"https://github.com/LerianStudio\",\"https://www.linkedin.com/company/lerianstudio\",\"https://discord.gg/DnhqKwkGv3\",\"https://www.instagram.com/lerian.studio/\",\"https://blog.lerian.studio/\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.lerian.studio#website\",\"name\":\"Lerian\",\"url\":\"https://docs.lerian.studio\",\"publisher\":{\"@id\":\"https://lerian.studio/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.lerian.studio/en/reference/products/midaz/v2/create-holder#webpage\",\"url\":\"https://docs.lerian.studio/en/reference/products/midaz/v2/create-holder\",\"name\":\"Create a Holder\",\"dateModified\":\"2026-10-24T00:07:15.319Z\",\"isPartOf\":{\"@id\":\"https://docs.lerian.studio#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lerian.studio/en/reference/products/midaz/v2/create-holder#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lerian.studio/en/reference/products/midaz/v2/create-holder#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CRM\",\"item\":\"https://docs.lerian.studio/en/reference/products/midaz/v2/provision-encryption\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a Holder\",\"item\":\"https://docs.lerian.studio/en/reference/products/midaz/v2/create-holder\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lerian.studio/en/reference/products/midaz/v2/create-holder#apireference\",\"headline\":\"Create a Holder\",\"name\":\"Create a Holder\",\"url\":\"https://docs.lerian.studio/en/reference/products/midaz/v2/create-holder\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lerian.studio/en/reference/products/midaz/v2/create-holder#webpage\"},\"dateModified\":\"2026-10-24T00:07:15.319Z\",\"publisher\":{\"@id\":\"https://lerian.studio/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.lerian.studio#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Lerian\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Lerian","nav":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/LerianStudio"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/DnhqKwkGv3"}]},"languages":[{"language":"en","default":true,"tabs":[{"tab":"Home","icon":"house-blank","pages":[{"title":"Home","href":"/en"}]},{"tab":"Start Here","icon":"rocket","pages":[{"title":"Start Here","href":"/en/start-here/welcome-to-our-guides"}]},{"tab":"Lerian Products","icon":"cubes","pages":[{"title":"Lerian Products","href":"/en/products/products-and-plugins"}]},{"tab":"Brazil Rails","icon":"money-bill-transfer","pages":[{"title":"Brazil Rails","href":"/en/rails/what-are-brazil-rails"}]},{"tab":"Integration Diagrams","icon":"diagram-project","pages":[{"title":"Integration Diagrams","href":"/en/diagrams/introduction"}]},{"tab":"API Reference","icon":"terminal","anchors":[{"anchor":"Introduction","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/hourglass-yellow.png","pages":[{"title":"Introduction","href":"/en/reference/introduction"}]},{"anchor":"Products","icon":"cubes","dropdowns":[{"dropdown":"Midaz","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/midaz-yellow.png","description":"Ledger, accounts, transactions, CRM, and fees","versions":[{"version":"v2","default":true,"tag":"Current","groups":[{"group":"Getting started","pages":[{"title":"Quick start guide","href":"/en/reference/products/midaz/quick-start-guide"}]},{"group":"Core","pages":[{"title":"List all organizations","deprecated":null,"version":null,"sidebarTitle":"List organizations","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations","href":"/en/reference/products/midaz/v2/list-organizations"},{"title":"Create a new organization","deprecated":null,"version":null,"sidebarTitle":"Create organization","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations","href":"/en/reference/products/midaz/v2/create-organization"},{"title":"Delete an organization","deprecated":null,"version":null,"sidebarTitle":"Delete organization","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{id}","href":"/en/reference/products/midaz/v2/delete-organization"},{"title":"Retrieve a specific organization","deprecated":null,"version":null,"sidebarTitle":"Get organization by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{id}","href":"/en/reference/products/midaz/v2/get-organization-by-id"},{"title":"Update an existing organization","deprecated":null,"version":null,"sidebarTitle":"Update organization","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{id}","href":"/en/reference/products/midaz/v2/update-organization"},{"title":"List all ledgers","deprecated":null,"version":null,"sidebarTitle":"List ledgers","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers","href":"/en/reference/products/midaz/v2/list-ledgers"},{"title":"Create a new ledger","deprecated":null,"version":null,"sidebarTitle":"Create ledger","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers","href":"/en/reference/products/midaz/v2/create-ledger"},{"title":"Delete a ledger","deprecated":null,"version":null,"sidebarTitle":"Delete ledger","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}","href":"/en/reference/products/midaz/v2/delete-ledger"},{"title":"Retrieve a specific ledger","deprecated":null,"version":null,"sidebarTitle":"Get ledger by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}","href":"/en/reference/products/midaz/v2/get-ledger-by-id"},{"title":"Update an existing ledger","deprecated":null,"version":null,"sidebarTitle":"Update ledger","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}","href":"/en/reference/products/midaz/v2/update-ledger"},{"title":"List all account types","deprecated":null,"version":null,"sidebarTitle":"List account types","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/account-types","href":"/en/reference/products/midaz/v2/list-account-types"},{"title":"Create a new account type","deprecated":null,"version":null,"sidebarTitle":"Create account type","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/account-types","href":"/en/reference/products/midaz/v2/create-account-type"},{"title":"Delete an account type","deprecated":null,"version":null,"sidebarTitle":"Delete account type","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{id}","href":"/en/reference/products/midaz/v2/delete-account-type"},{"title":"Retrieve a specific account type","deprecated":null,"version":null,"sidebarTitle":"Get account type by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{id}","href":"/en/reference/products/midaz/v2/get-account-type-by-id"},{"title":"Update an account type","deprecated":null,"version":null,"sidebarTitle":"Update account type","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{id}","href":"/en/reference/products/midaz/v2/update-account-type"},{"title":"List all accounts","deprecated":null,"version":null,"sidebarTitle":"List accounts","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts","href":"/en/reference/products/midaz/v2/list-accounts"},{"title":"Create a new account","deprecated":null,"version":null,"sidebarTitle":"Create account","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts","href":"/en/reference/products/midaz/v2/create-account"},{"title":"Retrieve an account by alias","deprecated":null,"version":null,"sidebarTitle":"Get account by alias","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}","href":"/en/reference/products/midaz/v2/get-account-by-alias"},{"title":"Get Balances using Alias","deprecated":null,"version":null,"sidebarTitle":"Get balances by alias","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances","href":"/en/reference/products/midaz/v2/get-balances-by-alias"},{"title":"Create single-use account block exceptions","deprecated":null,"version":null,"sidebarTitle":"Create account block exceptions","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/block-exceptions","href":"/en/reference/products/midaz/v2/create-account-block-exceptions"},{"title":"Retrieve an account by external code","deprecated":null,"version":null,"sidebarTitle":"Get account external by code","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/external/{code}","href":"/en/reference/products/midaz/v2/get-account-external-by-code"},{"title":"Get External balances using code","deprecated":null,"version":null,"sidebarTitle":"Get balances external by code","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/external/{code}/balances","href":"/en/reference/products/midaz/v2/get-balances-external-by-code"},{"title":"Get all balances by account id","deprecated":null,"version":null,"sidebarTitle":"Get all balances by account id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/balances","href":"/en/reference/products/midaz/v2/get-all-balances-by-account-id"},{"title":"Create Additional Balance","deprecated":null,"version":null,"sidebarTitle":"Create additional balance","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/balances","href":"/en/reference/products/midaz/v2/create-additional-balance"},{"title":"Get Account Balances history at date","deprecated":null,"version":null,"sidebarTitle":"Get account balances at timestamp","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/balances/history","href":"/en/reference/products/midaz/v2/get-account-balances-at-timestamp"},{"title":"Close an account","deprecated":null,"version":null,"sidebarTitle":"Close account","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/close","href":"/en/reference/products/midaz/v2/close-account"},{"title":"Get all Operations by account","deprecated":null,"version":null,"sidebarTitle":"Get all operations by account","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/operations","href":"/en/reference/products/midaz/v2/get-all-operations-by-account"},{"title":"Get Operation","deprecated":null,"version":null,"sidebarTitle":"Get operation by account","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/operations/{operation_id}","href":"/en/reference/products/midaz/v2/get-operation-by-account"},{"title":"Delete an account","deprecated":null,"version":null,"sidebarTitle":"Delete account","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{id}","href":"/en/reference/products/midaz/v2/delete-account"},{"title":"Retrieve a specific account","deprecated":null,"version":null,"sidebarTitle":"Get account by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{id}","href":"/en/reference/products/midaz/v2/get-account-by-id"},{"title":"Update an account","deprecated":null,"version":null,"sidebarTitle":"Update account","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{id}","href":"/en/reference/products/midaz/v2/update-account"},{"title":"List all assets","deprecated":null,"version":null,"sidebarTitle":"List assets","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/assets","href":"/en/reference/products/midaz/v2/list-assets"},{"title":"Create a new asset","deprecated":null,"version":null,"sidebarTitle":"Create asset","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/assets","href":"/en/reference/products/midaz/v2/create-asset"},{"title":"Delete an asset","deprecated":null,"version":null,"sidebarTitle":"Delete asset","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/assets/{id}","href":"/en/reference/products/midaz/v2/delete-asset"},{"title":"Retrieve a specific asset","deprecated":null,"version":null,"sidebarTitle":"Get asset by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/assets/{id}","href":"/en/reference/products/midaz/v2/get-asset-by-id"},{"title":"Update an asset","deprecated":null,"version":null,"sidebarTitle":"Update asset","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/assets/{id}","href":"/en/reference/products/midaz/v2/update-asset"},{"title":"Get all balances","deprecated":null,"version":null,"sidebarTitle":"Get all balances","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/balances","href":"/en/reference/products/midaz/v2/get-all-balances"},{"title":"Delete Balance by account","deprecated":null,"version":null,"sidebarTitle":"Delete balance","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id}","href":"/en/reference/products/midaz/v2/delete-balance"},{"title":"Get Balance by id","deprecated":null,"version":null,"sidebarTitle":"Get balance by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id}","href":"/en/reference/products/midaz/v2/get-balance-by-id"},{"title":"Update Balance","deprecated":null,"version":null,"sidebarTitle":"Update balance","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id}","href":"/en/reference/products/midaz/v2/update-balance"},{"title":"Get Balance history at date","deprecated":null,"version":null,"sidebarTitle":"Get balance at timestamp","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id}/history","href":"/en/reference/products/midaz/v2/get-balance-at-timestamp"},{"title":"Get ledger current position per asset","deprecated":null,"version":null,"sidebarTitle":"Get dashboard assets","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/dashboard/assets","href":"/en/reference/products/midaz/v2/get-dashboard-assets"},{"title":"Get ledger dashboard metrics","deprecated":null,"version":null,"sidebarTitle":"Get dashboard metrics","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/dashboard/metrics","href":"/en/reference/products/midaz/v2/get-dashboard-metrics"},{"title":"Get ledger dashboard volume series","deprecated":null,"version":null,"sidebarTitle":"Get dashboard volume","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/dashboard/volume","href":"/en/reference/products/midaz/v2/get-dashboard-volume"},{"title":"Retrieve all operation routes","deprecated":null,"version":null,"sidebarTitle":"List operation routes","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes","href":"/en/reference/products/midaz/v2/list-operation-routes"},{"title":"Create Operation Route","deprecated":null,"version":null,"sidebarTitle":"Create operation route","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes","href":"/en/reference/products/midaz/v2/create-operation-route"},{"title":"Delete an operation route","deprecated":null,"version":null,"sidebarTitle":"Delete operation route","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}","href":"/en/reference/products/midaz/v2/delete-operation-route"},{"title":"Retrieve a specific operation route","deprecated":null,"version":null,"sidebarTitle":"Get operation route by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}","href":"/en/reference/products/midaz/v2/get-operation-route-by-id"},{"title":"Update an operation route","deprecated":null,"version":null,"sidebarTitle":"Update operation route","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}","href":"/en/reference/products/midaz/v2/update-operation-route"},{"title":"List all portfolios","deprecated":null,"version":null,"sidebarTitle":"List portfolios","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/portfolios","href":"/en/reference/products/midaz/v2/list-portfolios"},{"title":"Create a new portfolio","deprecated":null,"version":null,"sidebarTitle":"Create portfolio","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/portfolios","href":"/en/reference/products/midaz/v2/create-portfolio"},{"title":"Delete a portfolio","deprecated":null,"version":null,"sidebarTitle":"Delete portfolio","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{id}","href":"/en/reference/products/midaz/v2/delete-portfolio"},{"title":"Retrieve a specific portfolio","deprecated":null,"version":null,"sidebarTitle":"Get portfolio by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{id}","href":"/en/reference/products/midaz/v2/get-portfolio-by-id"},{"title":"Update a portfolio","deprecated":null,"version":null,"sidebarTitle":"Update portfolio","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{id}","href":"/en/reference/products/midaz/v2/update-portfolio"},{"title":"List all segments","deprecated":null,"version":null,"sidebarTitle":"List segments","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/segments","href":"/en/reference/products/midaz/v2/list-segments"},{"title":"Create a new segment","deprecated":null,"version":null,"sidebarTitle":"Create segment","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/segments","href":"/en/reference/products/midaz/v2/create-segment"},{"title":"Delete a segment","deprecated":null,"version":null,"sidebarTitle":"Delete segment","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/segments/{id}","href":"/en/reference/products/midaz/v2/delete-segment"},{"title":"Retrieve a specific segment","deprecated":null,"version":null,"sidebarTitle":"Get segment by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/segments/{id}","href":"/en/reference/products/midaz/v2/get-segment-by-id"},{"title":"Update a segment","deprecated":null,"version":null,"sidebarTitle":"Update segment","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/segments/{id}","href":"/en/reference/products/midaz/v2/update-segment"},{"title":"Get ledger settings","deprecated":null,"version":null,"sidebarTitle":"Get ledger settings","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/settings","href":"/en/reference/products/midaz/v2/get-ledger-settings"},{"title":"Update ledger settings","deprecated":null,"version":null,"sidebarTitle":"Update ledger settings","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/settings","href":"/en/reference/products/midaz/v2/update-ledger-settings"},{"title":"Get all Transaction Routes","deprecated":null,"version":null,"sidebarTitle":"List transaction routes","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes","href":"/en/reference/products/midaz/v2/list-transaction-routes"},{"title":"Create Transaction Route","deprecated":null,"version":null,"sidebarTitle":"Create transaction route","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes","href":"/en/reference/products/midaz/v2/create-transaction-route"},{"title":"Delete Transaction Route by ID","deprecated":null,"version":null,"sidebarTitle":"Delete transaction route","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}","href":"/en/reference/products/midaz/v2/delete-transaction-route"},{"title":"Get Transaction Route by ID","deprecated":null,"version":null,"sidebarTitle":"Get transaction route by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}","href":"/en/reference/products/midaz/v2/get-transaction-route-by-id"},{"title":"Update Transaction Route","deprecated":null,"version":null,"sidebarTitle":"Update transaction route","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}","href":"/en/reference/products/midaz/v2/update-transaction-route"},{"title":"Get all Transactions","deprecated":null,"version":null,"sidebarTitle":"Get all transactions","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions","href":"/en/reference/products/midaz/v2/get-all-transactions"},{"title":"Get a Transaction by ID","deprecated":null,"version":null,"sidebarTitle":"Get transaction","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}","href":"/en/reference/products/midaz/v2/get-transaction"},{"title":"Update a Transaction","deprecated":null,"version":null,"sidebarTitle":"Update transaction","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}","href":"/en/reference/products/midaz/v2/update-transaction"},{"title":"Cancel a pending Transaction (v2)","deprecated":null,"version":null,"sidebarTitle":"Cancel transaction","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/cancel","href":"/en/reference/products/midaz/v2/cancel-transaction"},{"title":"Commit a Transaction (v2)","deprecated":null,"version":null,"sidebarTitle":"Commit transaction","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/commit","href":"/en/reference/products/midaz/v2/commit-transaction"},{"title":"Update an Operation","deprecated":null,"version":null,"sidebarTitle":"Update operation","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}","href":"/en/reference/products/midaz/v2/update-operation"},{"title":"Revert a Transaction (v2)","deprecated":null,"version":null,"sidebarTitle":"Revert transaction","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/revert","href":"/en/reference/products/midaz/v2/revert-transaction"},{"title":"List the organization Operation Routes","deprecated":null,"version":null,"sidebarTitle":"List organization operation routes","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/operation-routes","href":"/en/reference/products/midaz/v2/list-organization-operation-routes"},{"title":"Create an organization Operation Route","deprecated":null,"version":null,"sidebarTitle":"Create organization operation route","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/operation-routes","href":"/en/reference/products/midaz/v2/create-organization-operation-route"},{"title":"Delete an organization Operation Route by ID","deprecated":null,"version":null,"sidebarTitle":"Delete organization operation route","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/operation-routes/{operation_route_id}","href":"/en/reference/products/midaz/v2/delete-organization-operation-route"},{"title":"Get an organization Operation Route by ID","deprecated":null,"version":null,"sidebarTitle":"Get organization operation route by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/operation-routes/{operation_route_id}","href":"/en/reference/products/midaz/v2/get-organization-operation-route-by-id"},{"title":"Update an organization Operation Route","deprecated":null,"version":null,"sidebarTitle":"Update organization operation route","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/operation-routes/{operation_route_id}","href":"/en/reference/products/midaz/v2/update-organization-operation-route"},{"title":"List the organization Transaction Routes","deprecated":null,"version":null,"sidebarTitle":"List organization transaction routes","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/transaction-routes","href":"/en/reference/products/midaz/v2/list-organization-transaction-routes"},{"title":"Create an organization Transaction Route","deprecated":null,"version":null,"sidebarTitle":"Create organization transaction route","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/transaction-routes","href":"/en/reference/products/midaz/v2/create-organization-transaction-route"},{"title":"Delete an organization Transaction Route by ID","deprecated":null,"version":null,"sidebarTitle":"Delete organization transaction route","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/transaction-routes/{transaction_route_id}","href":"/en/reference/products/midaz/v2/delete-organization-transaction-route"},{"title":"Get an organization Transaction Route by ID","deprecated":null,"version":null,"sidebarTitle":"Get organization transaction route by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/transaction-routes/{transaction_route_id}","href":"/en/reference/products/midaz/v2/get-organization-transaction-route-by-id"},{"title":"Update an organization Transaction Route","deprecated":null,"version":null,"sidebarTitle":"Update organization transaction route","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/transaction-routes/{transaction_route_id}","href":"/en/reference/products/midaz/v2/update-organization-transaction-route"},{"title":"Get all Metadata Indexes","deprecated":null,"version":null,"sidebarTitle":"Get all metadata indexes","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/settings/metadata-indexes","href":"/en/reference/products/midaz/v2/get-all-metadata-indexes"},{"title":"Create Metadata Index","deprecated":null,"version":null,"sidebarTitle":"Create metadata index","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/settings/metadata-indexes/entities/{entity_name}","href":"/en/reference/products/midaz/v2/create-metadata-index"},{"title":"Delete Metadata Index","deprecated":null,"version":null,"sidebarTitle":"Delete metadata index","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/settings/metadata-indexes/entities/{entity_name}/key/{index_key}","href":"/en/reference/products/midaz/v2/delete-metadata-index"},{"title":"Create an atomic batch of Transactions (v2)","deprecated":null,"version":null,"sidebarTitle":"Create transaction batch","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/transactions/batch","href":"/en/reference/products/midaz/v2/create-transaction-batch"},{"title":"Create a Transaction using the v2 block model","deprecated":null,"version":null,"sidebarTitle":"Create transaction block","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/transactions/block","href":"/en/reference/products/midaz/v2/create-transaction-block"},{"title":"Create a Transaction using the v2 direct model","deprecated":null,"version":null,"sidebarTitle":"Create transaction direct","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/transactions/direct","href":"/en/reference/products/midaz/v2/create-transaction-direct"},{"title":"Create a Transaction using the v2 hold model","deprecated":null,"version":null,"sidebarTitle":"Create transaction hold","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/transactions/hold","href":"/en/reference/products/midaz/v2/create-transaction-hold"},{"title":"Create a Transaction using the v2 unblock model","deprecated":null,"version":null,"sidebarTitle":"Create transaction unblock","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/transactions/unblock","href":"/en/reference/products/midaz/v2/create-transaction-unblock"}]},{"group":"CRM","pages":[{"title":"Provision an Organization for Envelope Encryption","deprecated":null,"version":null,"sidebarTitle":"Provision encryption","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/encryption/provision","href":"/en/reference/products/midaz/v2/provision-encryption"},{"title":"Get Provisioning Status","deprecated":null,"version":null,"sidebarTitle":"Get provisioning status","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/encryption/status","href":"/en/reference/products/midaz/v2/get-provisioning-status"},{"title":"List Holders","description":null,"deprecated":null,"version":null,"sidebarTitle":"List holders","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/holders","href":"/en/reference/products/midaz/v2/list-holders"},{"title":"Create a Holder","deprecated":null,"version":null,"sidebarTitle":"Create holder","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/holders","href":"/en/reference/products/midaz/v2/create-holder"},{"title":"Create an Instrument Account","description":"Creates an instrument linking a ledger account to its holder and banking details. A ledger account already linked to another instrument (CRM-0013) is refused with 409, and so is a bank account already registered to another live instrument of the organization (CRM-0043): the same bankId and account, on the same branch (leading zeros ignored when both branches are numeric) or where one of them has no branch, whatever the type.","deprecated":null,"version":null,"sidebarTitle":"Create instrument","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/holders/{holder_id}/instruments","href":"/en/reference/products/midaz/v2/create-instrument"},{"title":"Delete an Instrument","deprecated":null,"version":null,"sidebarTitle":"Delete instrument","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/holders/{holder_id}/instruments/{instrument_id}","href":"/en/reference/products/midaz/v2/delete-instrument"},{"title":"Retrieve Instrument details","deprecated":null,"version":null,"sidebarTitle":"Get instrument by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/holders/{holder_id}/instruments/{instrument_id}","href":"/en/reference/products/midaz/v2/get-instrument-by-id"},{"title":"Update an Instrument","deprecated":null,"version":null,"sidebarTitle":"Update instrument","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/holders/{holder_id}/instruments/{instrument_id}","href":"/en/reference/products/midaz/v2/update-instrument"},{"title":"Delete a Related Party","deprecated":null,"version":null,"sidebarTitle":"Delete related party","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/holders/{holder_id}/instruments/{instrument_id}/related-parties/{related_party_id}","href":"/en/reference/products/midaz/v2/delete-related-party"},{"title":"Delete a Holder","deprecated":null,"version":null,"sidebarTitle":"Delete holder","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/holders/{id}","href":"/en/reference/products/midaz/v2/delete-holder"},{"title":"Retrieve Holder details","deprecated":null,"version":null,"sidebarTitle":"Get holder by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/holders/{id}","href":"/en/reference/products/midaz/v2/get-holder-by-id"},{"title":"Update a Holder","deprecated":null,"version":null,"sidebarTitle":"Update holder","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/holders/{id}","href":"/en/reference/products/midaz/v2/update-holder"},{"title":"List Accounts by Holder","deprecated":null,"version":null,"sidebarTitle":"List accounts by holder","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/holders/{id}/accounts","href":"/en/reference/products/midaz/v2/list-accounts-by-holder"},{"title":"List Instruments","deprecated":null,"version":null,"sidebarTitle":"List instruments","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/instruments","href":"/en/reference/products/midaz/v2/list-instruments"},{"title":"Open a holder-owned account (with optional instrument)","deprecated":null,"version":null,"sidebarTitle":"Create holder account","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/holders/{id}/accounts","href":"/en/reference/products/midaz/v2/create-holder-account"},{"title":"List Protection Audit Events","deprecated":null,"version":null,"sidebarTitle":"Get audit events","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/protection/audit","href":"/en/reference/products/midaz/v2/get-audit-events"}]},{"group":"Fees","pages":[{"title":"Get all billing packages of a ledger","deprecated":null,"version":null,"sidebarTitle":"Get all billing packages","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/billing-packages","href":"/en/reference/products/midaz/v2/get-all-billing-packages"},{"title":"Create a BillingPackage","deprecated":null,"version":null,"sidebarTitle":"Create billing package","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/billing-packages","href":"/en/reference/products/midaz/v2/create-billing-package"},{"title":"SoftDelete a BillingPackage by ID","deprecated":null,"version":null,"sidebarTitle":"Delete billing package","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/billing-packages/{id}","href":"/en/reference/products/midaz/v2/delete-billing-package"},{"title":"Get billing package","deprecated":null,"version":null,"sidebarTitle":"Get billing package by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/billing-packages/{id}","href":"/en/reference/products/midaz/v2/get-billing-package-by-id"},{"title":"Update a billing package","deprecated":null,"version":null,"sidebarTitle":"Update billing package","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/billing-packages/{id}","href":"/en/reference/products/midaz/v2/update-billing-package"},{"title":"Calculate billing","deprecated":null,"version":null,"sidebarTitle":"Calculate billing","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/billing/calculate","href":"/en/reference/products/midaz/v2/calculate-billing"},{"title":"Create a fee estimate calculation","deprecated":null,"version":null,"sidebarTitle":"Estimate fee calculation","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/estimates","href":"/en/reference/products/midaz/v2/estimate-fee-calculation"},{"title":"List the fee debts of a ledger, oldest first","deprecated":null,"version":null,"sidebarTitle":"List the fee debts of a ledger oldest first","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/fee-debts","href":"/en/reference/products/midaz/v2/list-the-fee-debts-of-a-ledger-oldest-first"},{"title":"Collect a balance's open fee debts","deprecated":null,"version":null,"sidebarTitle":"Collect a balance s open fee debts","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/fee-debts/collect","href":"/en/reference/products/midaz/v2/collect-a-balance-s-open-fee-debts"},{"title":"Get a fee debt","deprecated":null,"version":null,"sidebarTitle":"Get a fee debt","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/fee-debts/{debt_id}","href":"/en/reference/products/midaz/v2/get-a-fee-debt"},{"title":"Get all packages of a ledger","deprecated":null,"version":null,"sidebarTitle":"Get all packages","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/packages","href":"/en/reference/products/midaz/v2/get-all-packages"},{"title":"Create a Package","deprecated":null,"version":null,"sidebarTitle":"Create package","openapi":"/en/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/packages","href":"/en/reference/products/midaz/v2/create-package"},{"title":"SoftDelete a Package by ID","deprecated":null,"version":null,"sidebarTitle":"Delete package","openapi":"/en/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/packages/{id}","href":"/en/reference/products/midaz/v2/delete-package"},{"title":"Get package","deprecated":null,"version":null,"sidebarTitle":"Get package by id","openapi":"/en/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/packages/{id}","href":"/en/reference/products/midaz/v2/get-package-by-id"},{"title":"Update a package","deprecated":null,"version":null,"sidebarTitle":"Update package","openapi":"/en/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/packages/{id}","href":"/en/reference/products/midaz/v2/update-package"}]},{"group":"Error handling","pages":[{"title":"Midaz error list","href":"/en/reference/products/midaz/error-list"}]},{"group":"Events","pages":[{"title":"Midaz events","href":"/en/reference/events/midaz"}]}]},{"version":"v1","tag":"Compatibility","pages":[{"title":"v1","href":"/en/reference/products/midaz/quick-start-guide"}]}]},{"dropdown":"Tracer","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/tracer-yellow.png","description":"Transaction validation, rules, limits, and audit","groups":[{"group":"Getting started","pages":[{"title":"Tracer API quick start","href":"/en/reference/products/tracer/tracer-api-quick-start"}]},{"group":"Validations API","pages":[{"title":"Validate a transaction","deprecated":null,"version":null,"sidebarTitle":"Validate transaction","openapi":"/en/openapi/v3-current/tracer.yaml post /v1/validations","href":"/en/reference/products/tracer/validate-transaction"},{"title":"List transaction validation records","deprecated":null,"version":null,"sidebarTitle":"List validations","openapi":"/en/openapi/v3-current/tracer.yaml get /v1/validations","href":"/en/reference/products/tracer/list-validations"},{"title":"Get a transaction validation record by ID","deprecated":null,"version":null,"sidebarTitle":"Retrieve validation","openapi":"/en/openapi/v3-current/tracer.yaml get /v1/validations/{id}","href":"/en/reference/products/tracer/retrieve-validation"}]},{"group":"Rules API","pages":[{"title":"Create a new fraud rule","deprecated":null,"version":null,"sidebarTitle":"Create rule","openapi":"/en/openapi/v3-current/tracer.yaml post /v1/rules","href":"/en/reference/products/tracer/create-rule"},{"title":"List fraud rules","deprecated":null,"version":null,"sidebarTitle":"List rules","openapi":"/en/openapi/v3-current/tracer.yaml get /v1/rules","href":"/en/reference/products/tracer/list-rules"},{"title":"Get a fraud rule by ID","deprecated":null,"version":null,"sidebarTitle":"Retrieve rule","openapi":"/en/openapi/v3-current/tracer.yaml get /v1/rules/{id}","href":"/en/reference/products/tracer/retrieve-rule"},{"title":"Partially update an existing fraud rule","deprecated":null,"version":null,"sidebarTitle":"Update rule","openapi":"/en/openapi/v3-current/tracer.yaml patch /v1/rules/{id}","href":"/en/reference/products/tracer/update-rule"},{"title":"Delete a fraud rule","deprecated":null,"version":null,"sidebarTitle":"Delete rule","openapi":"/en/openapi/v3-current/tracer.yaml delete /v1/rules/{id}","href":"/en/reference/products/tracer/delete-rule"},{"title":"Activate a fraud rule","deprecated":null,"version":null,"sidebarTitle":"Activate rule","openapi":"/en/openapi/v3-current/tracer.yaml post /v1/rules/{id}/activate","href":"/en/reference/products/tracer/activate-rule"},{"title":"Deactivate a fraud rule","deprecated":null,"version":null,"sidebarTitle":"Deactivate rule","openapi":"/en/openapi/v3-current/tracer.yaml post /v1/rules/{id}/deactivate","href":"/en/reference/products/tracer/deactivate-rule"},{"title":"Transition a rule back to draft","deprecated":null,"version":null,"sidebarTitle":"Draft rule","openapi":"/en/openapi/v3-current/tracer.yaml post /v1/rules/{id}/draft","href":"/en/reference/products/tracer/draft-rule"}]},{"group":"Limits API","pages":[{"title":"Create a new spending limit","deprecated":null,"version":null,"sidebarTitle":"Create limit","openapi":"/en/openapi/v3-current/tracer.yaml post /v1/limits","href":"/en/reference/products/tracer/create-limit"},{"title":"List spending limits","deprecated":null,"version":null,"sidebarTitle":"List limits","openapi":"/en/openapi/v3-current/tracer.yaml get /v1/limits","href":"/en/reference/products/tracer/list-limits"},{"title":"Get a spending limit by ID","deprecated":null,"version":null,"sidebarTitle":"Retrieve limit","openapi":"/en/openapi/v3-current/tracer.yaml get /v1/limits/{id}","href":"/en/reference/products/tracer/retrieve-limit"},{"title":"Partially update an existing spending limit","deprecated":null,"version":null,"sidebarTitle":"Update limit","openapi":"/en/openapi/v3-current/tracer.yaml patch /v1/limits/{id}","href":"/en/reference/products/tracer/update-limit"},{"title":"Delete a spending limit","deprecated":null,"version":null,"sidebarTitle":"Delete limit","openapi":"/en/openapi/v3-current/tracer.yaml delete /v1/limits/{id}","href":"/en/reference/products/tracer/delete-limit"},{"title":"Activate a spending limit","deprecated":null,"version":null,"sidebarTitle":"Activate limit","openapi":"/en/openapi/v3-current/tracer.yaml post /v1/limits/{id}/activate","href":"/en/reference/products/tracer/activate-limit"},{"title":"Deactivate a spending limit","deprecated":null,"version":null,"sidebarTitle":"Deactivate limit","openapi":"/en/openapi/v3-current/tracer.yaml post /v1/limits/{id}/deactivate","href":"/en/reference/products/tracer/deactivate-limit"},{"title":"Transition a limit back to draft","deprecated":null,"version":null,"sidebarTitle":"Draft limit","openapi":"/en/openapi/v3-current/tracer.yaml post /v1/limits/{id}/draft","href":"/en/reference/products/tracer/draft-limit"},{"title":"Get usage snapshot for a limit","deprecated":null,"version":null,"sidebarTitle":"Retrieve limit usage","openapi":"/en/openapi/v3-current/tracer.yaml get /v1/limits/{id}/usage","href":"/en/reference/products/tracer/retrieve-limit-usage"}]},{"group":"Audit Events API","pages":[{"title":"List audit events","deprecated":null,"version":null,"sidebarTitle":"List audit events","openapi":"/en/openapi/v3-current/tracer.yaml get /v1/audit-events","href":"/en/reference/products/tracer/list-audit-events"},{"title":"Get an audit event by ID","deprecated":null,"version":null,"sidebarTitle":"Retrieve audit event","openapi":"/en/openapi/v3-current/tracer.yaml get /v1/audit-events/{id}","href":"/en/reference/products/tracer/retrieve-audit-event"},{"title":"Verify audit event hash chain integrity","deprecated":null,"version":null,"sidebarTitle":"Verify audit event","openapi":"/en/openapi/v3-current/tracer.yaml get /v1/audit-events/{id}/verify","href":"/en/reference/products/tracer/verify-audit-event"}]},{"group":"Dashboards API","pages":[{"title":"Get dashboard flagged-traffic breakdown","deprecated":null,"version":null,"sidebarTitle":"Get dashboard fraud types","openapi":"/en/openapi/v3-current/tracer.yaml get /v1/dashboard/fraud-types","href":"/en/reference/products/tracer/get-dashboard-fraud-types"},{"title":"Get dashboard headline metrics","deprecated":null,"version":null,"sidebarTitle":"Get dashboard metrics","openapi":"/en/openapi/v3-current/tracer.yaml get /v1/dashboard/metrics","href":"/en/reference/products/tracer/get-dashboard-metrics"},{"title":"Get the busiest rules in the window","deprecated":null,"version":null,"sidebarTitle":"Get dashboard top rules","openapi":"/en/openapi/v3-current/tracer.yaml get /v1/dashboard/top-rules","href":"/en/reference/products/tracer/get-dashboard-top-rules"},{"title":"Get dashboard volume series","deprecated":null,"version":null,"sidebarTitle":"Get dashboard volume","openapi":"/en/openapi/v3-current/tracer.yaml get /v1/dashboard/volume","href":"/en/reference/products/tracer/get-dashboard-volume"}]},{"group":"Error handling","pages":[{"title":"Tracer error list","href":"/en/reference/products/tracer/tracer-error-list"}]},{"group":"Events","pages":[{"title":"Tracer events","href":"/en/reference/events/tracer"}]}]},{"dropdown":"Matcher","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/matcher-yellow.png","description":"Reconciliation, matching rules, and exceptions","groups":[{"group":"Getting started","pages":[{"title":"Matcher API quick start","href":"/en/reference/products/matcher/matcher-developer-quick-start"}]},{"group":"Configuration Contexts API","pages":[{"title":"List reconciliation contexts","deprecated":null,"version":null,"sidebarTitle":"List contexts","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts","href":"/en/reference/products/matcher/list-contexts"},{"title":"Create a reconciliation context","deprecated":null,"version":null,"sidebarTitle":"Create context","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/contexts","href":"/en/reference/products/matcher/create-context"},{"title":"Get a reconciliation context","deprecated":null,"version":null,"sidebarTitle":"Retrieve context","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}","href":"/en/reference/products/matcher/retrieve-context"},{"title":"Update a reconciliation context","deprecated":null,"version":null,"sidebarTitle":"Update context","openapi":"/en/openapi/v3-current/matcher.yaml patch /v1/contexts/{contextId}","href":"/en/reference/products/matcher/update-context"},{"title":"Clone a reconciliation context","deprecated":null,"version":null,"sidebarTitle":"Clone context","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/clone","href":"/en/reference/products/matcher/clone-context"},{"title":"Get context setup progress","deprecated":null,"version":null,"sidebarTitle":"Get setup progress","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/setup-progress","href":"/en/reference/products/matcher/get-setup-progress"},{"title":"Archive a reconciliation context","deprecated":null,"version":null,"sidebarTitle":"Archive context","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/archive","href":"/en/reference/products/matcher/archive-context"},{"title":"Restore an archived reconciliation context","deprecated":null,"version":null,"sidebarTitle":"Restore context","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/restore","href":"/en/reference/products/matcher/restore-context"}]},{"group":"Configuration Match Rules API","pages":[{"title":"List match rules","deprecated":null,"version":null,"sidebarTitle":"List match rules","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/rules","href":"/en/reference/products/matcher/list-match-rules"},{"title":"Create a match rule","deprecated":null,"version":null,"sidebarTitle":"Create match rule","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/rules","href":"/en/reference/products/matcher/create-match-rule"},{"title":"Get a match rule","deprecated":null,"version":null,"sidebarTitle":"Retrieve match rule","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/rules/{ruleId}","href":"/en/reference/products/matcher/retrieve-match-rule"},{"title":"Update a match rule","deprecated":null,"version":null,"sidebarTitle":"Update match rule","openapi":"/en/openapi/v3-current/matcher.yaml patch /v1/contexts/{contextId}/rules/{ruleId}","href":"/en/reference/products/matcher/update-match-rule"},{"title":"Delete a match rule","deprecated":null,"version":null,"sidebarTitle":"Delete match rule","openapi":"/en/openapi/v3-current/matcher.yaml delete /v1/contexts/{contextId}/rules/{ruleId}","href":"/en/reference/products/matcher/delete-match-rule"},{"title":"Reorder match rules","deprecated":null,"version":null,"sidebarTitle":"Reorder match rules","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/rules/reorder","href":"/en/reference/products/matcher/reorder-match-rules"}]},{"group":"Configuration Sources API","pages":[{"title":"List reconciliation sources","deprecated":null,"version":null,"sidebarTitle":"List sources","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/sources","href":"/en/reference/products/matcher/list-sources"},{"title":"Create a reconciliation source","deprecated":null,"version":null,"sidebarTitle":"Create source","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/sources","href":"/en/reference/products/matcher/create-source"},{"title":"Get a reconciliation source","deprecated":null,"version":null,"sidebarTitle":"Retrieve source","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/sources/{sourceId}","href":"/en/reference/products/matcher/retrieve-source"},{"title":"Update a reconciliation source","deprecated":null,"version":null,"sidebarTitle":"Update source","openapi":"/en/openapi/v3-current/matcher.yaml patch /v1/contexts/{contextId}/sources/{sourceId}","href":"/en/reference/products/matcher/update-source"},{"title":"Delete a source binding","deprecated":null,"version":null,"sidebarTitle":"Delete source binding","openapi":"/en/openapi/v3-current/matcher.yaml delete /v1/contexts/{contextId}/sources/{sourceId}/bindings/{bindingId}","href":"/en/reference/products/matcher/delete-source-binding"},{"title":"List source bindings","deprecated":null,"version":null,"sidebarTitle":"List source bindings","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/sources/{sourceId}/bindings","href":"/en/reference/products/matcher/list-source-bindings"},{"title":"Get a source binding","deprecated":null,"version":null,"sidebarTitle":"Get source binding","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/sources/{sourceId}/bindings/{bindingId}","href":"/en/reference/products/matcher/get-source-binding"},{"title":"Update a source binding","deprecated":null,"version":null,"sidebarTitle":"Update source binding","openapi":"/en/openapi/v3-current/matcher.yaml patch /v1/contexts/{contextId}/sources/{sourceId}/bindings/{bindingId}","href":"/en/reference/products/matcher/update-source-binding"},{"title":"Archive a reconciliation source","deprecated":null,"version":null,"sidebarTitle":"Archive source","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/sources/{sourceId}/archive","href":"/en/reference/products/matcher/archive-source"},{"title":"Create a source binding","deprecated":null,"version":null,"sidebarTitle":"Create source binding","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/sources/{sourceId}/bindings","href":"/en/reference/products/matcher/create-source-binding"},{"title":"Restore an archived reconciliation source","deprecated":null,"version":null,"sidebarTitle":"Restore source","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/sources/{sourceId}/restore","href":"/en/reference/products/matcher/restore-source"}]},{"group":"Configuration Field Maps API","pages":[{"title":"Get a field map by source","deprecated":null,"version":null,"sidebarTitle":"Retrieve field map by source","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/sources/{sourceId}/field-maps","href":"/en/reference/products/matcher/retrieve-field-map-by-source"},{"title":"Create a field map","deprecated":null,"version":null,"sidebarTitle":"Create field map","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/sources/{sourceId}/field-maps","href":"/en/reference/products/matcher/create-field-map"},{"title":"Update a field map","deprecated":null,"version":null,"sidebarTitle":"Update field map","openapi":"/en/openapi/v3-current/matcher.yaml patch /v1/field-maps/{fieldMapId}","href":"/en/reference/products/matcher/update-field-map"},{"title":"Delete a field map","deprecated":null,"version":null,"sidebarTitle":"Delete field map","openapi":"/en/openapi/v3-current/matcher.yaml delete /v1/field-maps/{fieldMapId}","href":"/en/reference/products/matcher/delete-field-map"},{"title":"List field maps for a context","deprecated":null,"version":null,"sidebarTitle":"List context field maps","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/field-maps","href":"/en/reference/products/matcher/list-context-field-maps"}]},{"group":"Configuration Fee Schedules API","pages":[{"title":"List fee schedules","deprecated":null,"version":null,"sidebarTitle":"List fee schedules","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/fee-schedules","href":"/en/reference/products/matcher/list-fee-schedules"},{"title":"Create a fee schedule","deprecated":null,"version":null,"sidebarTitle":"Create fee schedule","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/fee-schedules","href":"/en/reference/products/matcher/create-fee-schedule"},{"title":"Get a fee schedule","deprecated":null,"version":null,"sidebarTitle":"Retrieve fee schedule","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/fee-schedules/{scheduleId}","href":"/en/reference/products/matcher/retrieve-fee-schedule"},{"title":"Update a fee schedule","deprecated":null,"version":null,"sidebarTitle":"Update fee schedule","openapi":"/en/openapi/v3-current/matcher.yaml patch /v1/fee-schedules/{scheduleId}","href":"/en/reference/products/matcher/update-fee-schedule"},{"title":"Delete a fee schedule","deprecated":null,"version":null,"sidebarTitle":"Delete fee schedule","openapi":"/en/openapi/v3-current/matcher.yaml delete /v1/fee-schedules/{scheduleId}","href":"/en/reference/products/matcher/delete-fee-schedule"},{"title":"Simulate fee calculation","deprecated":null,"version":null,"sidebarTitle":"Simulate fee schedule","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/fee-schedules/{scheduleId}/simulate","href":"/en/reference/products/matcher/simulate-fee-schedule"}]},{"group":"Configuration Fee Rules API","pages":[{"title":"List fee rules","deprecated":null,"version":null,"sidebarTitle":"List fee rules","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/fee-rules","href":"/en/reference/products/matcher/list-fee-rules"},{"title":"Create a fee rule","deprecated":null,"version":null,"sidebarTitle":"Create fee rule","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/fee-rules","href":"/en/reference/products/matcher/create-fee-rule"},{"title":"Get a fee rule","deprecated":null,"version":null,"sidebarTitle":"Retrieve fee rule","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/fee-rules/{feeRuleId}","href":"/en/reference/products/matcher/retrieve-fee-rule"},{"title":"Update a fee rule","deprecated":null,"version":null,"sidebarTitle":"Update fee rule","openapi":"/en/openapi/v3-current/matcher.yaml patch /v1/fee-rules/{feeRuleId}","href":"/en/reference/products/matcher/update-fee-rule"},{"title":"Delete a fee rule","deprecated":null,"version":null,"sidebarTitle":"Delete fee rule","openapi":"/en/openapi/v3-current/matcher.yaml delete /v1/fee-rules/{feeRuleId}","href":"/en/reference/products/matcher/delete-fee-rule"}]},{"group":"Configuration Schedules API","pages":[{"title":"List schedules for a context","deprecated":null,"version":null,"sidebarTitle":"List schedules","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/schedules","href":"/en/reference/products/matcher/list-schedules"},{"title":"Create a schedule","deprecated":null,"version":null,"sidebarTitle":"Create schedule","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/schedules","href":"/en/reference/products/matcher/create-schedule"},{"title":"Get a schedule","deprecated":null,"version":null,"sidebarTitle":"Retrieve schedule","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/schedules/{scheduleId}","href":"/en/reference/products/matcher/retrieve-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"sidebarTitle":"Update schedule","openapi":"/en/openapi/v3-current/matcher.yaml patch /v1/contexts/{contextId}/schedules/{scheduleId}","href":"/en/reference/products/matcher/update-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"sidebarTitle":"Delete schedule","openapi":"/en/openapi/v3-current/matcher.yaml delete /v1/contexts/{contextId}/schedules/{scheduleId}","href":"/en/reference/products/matcher/delete-schedule"}]},{"group":"Exception workflow","pages":[{"title":"List exceptions","deprecated":null,"version":null,"sidebarTitle":"List exceptions","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/exceptions","href":"/en/reference/products/matcher/list-exceptions"},{"title":"Get exception","deprecated":null,"version":null,"sidebarTitle":"Retrieve exception","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/exceptions/{exceptionId}","href":"/en/reference/products/matcher/retrieve-exception"},{"title":"Get exception history","deprecated":null,"version":null,"sidebarTitle":"Retrieve exception history","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/exceptions/{exceptionId}/history","href":"/en/reference/products/matcher/retrieve-exception-history"},{"title":"Adjust entry for an exception","deprecated":null,"version":null,"sidebarTitle":"Adjust entry exception","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/adjust-entry","href":"/en/reference/products/matcher/adjust-entry-exception"},{"title":"Dispatch exception to external system","deprecated":null,"version":null,"sidebarTitle":"Dispatch exception","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/dispatch","href":"/en/reference/products/matcher/dispatch-exception"},{"title":"Force match an exception","deprecated":null,"version":null,"sidebarTitle":"Force match exception","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/force-match","href":"/en/reference/products/matcher/force-match-exception"},{"title":"Process exception callback","deprecated":null,"version":null,"sidebarTitle":"Process exception callback","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/callback","href":"/en/reference/products/matcher/process-exception-callback"},{"title":"Assign an exception","deprecated":null,"version":null,"sidebarTitle":"Assign exception","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/assign","href":"/en/reference/products/matcher/assign-exception"},{"title":"Resolve an exception","deprecated":null,"version":null,"sidebarTitle":"Resolve exception","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/resolve","href":"/en/reference/products/matcher/resolve-exception"}]},{"group":"Bulk actions","pages":[{"title":"Bulk assign exceptions","deprecated":null,"version":null,"sidebarTitle":"Bulk assign exceptions","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/exceptions/bulk/assign","href":"/en/reference/products/matcher/bulk-assign-exceptions"},{"title":"Bulk resolve exceptions","deprecated":null,"version":null,"sidebarTitle":"Bulk resolve exceptions","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/exceptions/bulk/resolve","href":"/en/reference/products/matcher/bulk-resolve-exceptions"},{"title":"Bulk dispatch exceptions","deprecated":null,"version":null,"sidebarTitle":"Bulk dispatch exceptions","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/exceptions/bulk/dispatch","href":"/en/reference/products/matcher/bulk-dispatch-exceptions"},{"title":"Select exception ids by filter","deprecated":null,"version":null,"sidebarTitle":"Select exception ids","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/exceptions/ids","href":"/en/reference/products/matcher/select-exception-ids"}]},{"group":"Comments","pages":[{"title":"List exception comments","deprecated":null,"version":null,"sidebarTitle":"List exception comments","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/exceptions/{exceptionId}/comments","href":"/en/reference/products/matcher/list-exception-comments"},{"title":"Add a comment to an exception","deprecated":null,"version":null,"sidebarTitle":"Add exception comment","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/comments","href":"/en/reference/products/matcher/add-exception-comment"},{"title":"Delete an exception comment","deprecated":null,"version":null,"sidebarTitle":"Delete exception comment","openapi":"/en/openapi/v3-current/matcher.yaml delete /v1/exceptions/{exceptionId}/comments/{commentId}","href":"/en/reference/products/matcher/delete-exception-comment"}]},{"group":"Callback credentials","pages":[{"title":"Revoke a callback credential","deprecated":null,"version":null,"sidebarTitle":"Revoke callback credential","openapi":"/en/openapi/v3-current/matcher.yaml delete /v1/exceptions/callbacks/credentials/{credentialId}","href":"/en/reference/products/matcher/revoke-callback-credential"},{"title":"List callback credentials","deprecated":null,"version":null,"sidebarTitle":"List callback credentials","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/exceptions/callbacks/credentials","href":"/en/reference/products/matcher/list-callback-credentials"},{"title":"Mint a callback credential","deprecated":null,"version":null,"sidebarTitle":"Mint callback credential","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/exceptions/callbacks/credentials","href":"/en/reference/products/matcher/mint-callback-credential"},{"title":"Rotate a callback credential","deprecated":null,"version":null,"sidebarTitle":"Rotate callback credential","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/exceptions/callbacks/credentials/{credentialId}/rotate","href":"/en/reference/products/matcher/rotate-callback-credential"}]},{"group":"Disputes API","pages":[{"title":"List disputes","deprecated":null,"version":null,"sidebarTitle":"List disputes","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/disputes","href":"/en/reference/products/matcher/list-disputes"},{"title":"Get a dispute","deprecated":null,"version":null,"sidebarTitle":"Retrieve dispute","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/disputes/{disputeId}","href":"/en/reference/products/matcher/retrieve-dispute"},{"title":"Open a dispute","deprecated":null,"version":null,"sidebarTitle":"Open dispute","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/disputes","href":"/en/reference/products/matcher/open-dispute"},{"title":"Close a dispute","deprecated":null,"version":null,"sidebarTitle":"Close dispute","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/disputes/{disputeId}/close","href":"/en/reference/products/matcher/close-dispute"},{"title":"Submit evidence to a dispute","deprecated":null,"version":null,"sidebarTitle":"Submit evidence","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/disputes/{disputeId}/evidence","href":"/en/reference/products/matcher/submit-evidence"},{"title":"Upload an evidence file to a dispute","deprecated":null,"version":null,"sidebarTitle":"Upload evidence","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/disputes/{disputeId}/evidence/upload","href":"/en/reference/products/matcher/upload-evidence"}]},{"group":"Export Jobs API","pages":[{"title":"Create an export job","deprecated":null,"version":null,"sidebarTitle":"Create export job","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/export-jobs","href":"/en/reference/products/matcher/create-export-job"},{"title":"List export jobs","deprecated":null,"version":null,"sidebarTitle":"List export jobs","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/export-jobs","href":"/en/reference/products/matcher/list-export-jobs"},{"title":"List export jobs by context","deprecated":null,"version":null,"sidebarTitle":"List export jobs by context","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/export-jobs","href":"/en/reference/products/matcher/list-export-jobs-by-context"},{"title":"Get export job status","deprecated":null,"version":null,"sidebarTitle":"Retrieve export job","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/export-jobs/{jobId}","href":"/en/reference/products/matcher/retrieve-export-job"},{"title":"Cancel an export job","deprecated":null,"version":null,"sidebarTitle":"Cancel export job","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/export-jobs/{jobId}/cancel","href":"/en/reference/products/matcher/cancel-export-job"},{"title":"Download export file","deprecated":null,"version":null,"sidebarTitle":"Download export job","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/export-jobs/{jobId}/download","href":"/en/reference/products/matcher/download-export-job"}]},{"group":"Governance API","pages":[{"title":"List audit logs","deprecated":null,"version":null,"sidebarTitle":"List audit logs","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/governance/audit-logs","href":"/en/reference/products/matcher/list-audit-logs"},{"title":"Get audit log by ID","deprecated":null,"version":null,"sidebarTitle":"Retrieve audit log","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/governance/audit-logs/{id}","href":"/en/reference/products/matcher/retrieve-audit-log"},{"title":"List audit logs by entity","deprecated":null,"version":null,"sidebarTitle":"List audit logs by entity","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/governance/entities/{entityType}/{entityId}/audit-logs","href":"/en/reference/products/matcher/list-audit-logs-by-entity"},{"title":"Upsert an actor mapping","deprecated":null,"version":null,"sidebarTitle":"Upsert actor mapping","openapi":"/en/openapi/v3-current/matcher.yaml put /v1/governance/actor-mappings/{actorId}","href":"/en/reference/products/matcher/upsert-actor-mapping"},{"title":"Get an actor mapping","deprecated":null,"version":null,"sidebarTitle":"Get actor mapping","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/governance/actor-mappings/{actorId}","href":"/en/reference/products/matcher/get-actor-mapping"},{"title":"Delete an actor mapping","deprecated":null,"version":null,"sidebarTitle":"Delete actor mapping","openapi":"/en/openapi/v3-current/matcher.yaml delete /v1/governance/actor-mappings/{actorId}","href":"/en/reference/products/matcher/delete-actor-mapping"},{"title":"Pseudonymize an actor","deprecated":null,"version":null,"sidebarTitle":"Pseudonymize actor","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/governance/actor-mappings/{actorId}/pseudonymize","href":"/en/reference/products/matcher/pseudonymize-actor"},{"title":"List audit log archives","deprecated":null,"version":null,"sidebarTitle":"List archives","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/governance/archives","href":"/en/reference/products/matcher/list-archives"},{"title":"Download an audit log archive","deprecated":null,"version":null,"sidebarTitle":"Download archive","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/governance/archives/{id}/download","href":"/en/reference/products/matcher/download-archive"},{"title":"List actor mappings","deprecated":null,"version":null,"sidebarTitle":"List actor mappings","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/governance/actor-mappings","href":"/en/reference/products/matcher/list-actor-mappings"},{"title":"Verify audit log chain integrity","deprecated":null,"version":null,"sidebarTitle":"Verify audit log chain","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/governance/audit-logs/verify","href":"/en/reference/products/matcher/verify-audit-log-chain"}]},{"group":"Ingestion jobs","pages":[{"title":"List ingestion jobs for a context","deprecated":null,"version":null,"sidebarTitle":"List ingestion jobs","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/imports/contexts/{contextId}/jobs","href":"/en/reference/products/matcher/list-ingestion-jobs"},{"title":"Get ingestion job status","deprecated":null,"version":null,"sidebarTitle":"Retrieve ingestion job","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/imports/contexts/{contextId}/jobs/{jobId}","href":"/en/reference/products/matcher/retrieve-ingestion-job"},{"title":"List transactions for a job","deprecated":null,"version":null,"sidebarTitle":"List job transactions","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/imports/contexts/{contextId}/jobs/{jobId}/transactions","href":"/en/reference/products/matcher/list-job-transactions"},{"title":"Upload transaction file","deprecated":null,"version":null,"sidebarTitle":"Upload transaction file","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/sources/{sourceId}/upload","href":"/en/reference/products/matcher/upload-transaction-file"},{"title":"Ignore a transaction","deprecated":null,"version":null,"sidebarTitle":"Ignore transaction","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/transactions/{transactionId}/ignore","href":"/en/reference/products/matcher/ignore-transaction"},{"title":"Preview a transaction file","deprecated":null,"version":null,"sidebarTitle":"Preview upload","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/sources/{sourceId}/preview","href":"/en/reference/products/matcher/preview-upload"},{"title":"Search transactions","deprecated":null,"version":null,"sidebarTitle":"Search transactions","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/imports/contexts/{contextId}/transactions/search","href":"/en/reference/products/matcher/search-transactions"},{"title":"List per-row import errors for a job","deprecated":null,"version":null,"sidebarTitle":"List ingestion job errors","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/imports/contexts/{contextId}/jobs/{jobId}/errors","href":"/en/reference/products/matcher/list-ingestion-job-errors"}]},{"group":"Layouts and formats","pages":[{"title":"Delete an operator fixed-width layout template","deprecated":null,"version":null,"sidebarTitle":"Delete layout template","openapi":"/en/openapi/v3-current/matcher.yaml delete /v1/imports/formats/templates/{templateId}","href":"/en/reference/products/matcher/delete-layout-template"},{"title":"Browse the supported format catalog","deprecated":null,"version":null,"sidebarTitle":"Browse format catalog","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/imports/formats","href":"/en/reference/products/matcher/browse-format-catalog"},{"title":"List operator fixed-width layout templates","deprecated":null,"version":null,"sidebarTitle":"List layout templates","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/imports/formats/templates","href":"/en/reference/products/matcher/list-layout-templates"},{"title":"Get an operator fixed-width layout template","deprecated":null,"version":null,"sidebarTitle":"Get layout template","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/imports/formats/templates/{templateId}","href":"/en/reference/products/matcher/get-layout-template"},{"title":"Propose a config-only field-map/dialect mapping for a source sample","deprecated":null,"version":null,"sidebarTitle":"Propose mapping","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/sources/{sourceId}/mapping-proposal","href":"/en/reference/products/matcher/propose-mapping"},{"title":"Submit an operator fixed-width layout template","deprecated":null,"version":null,"sidebarTitle":"Submit layout template","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/imports/formats/templates","href":"/en/reference/products/matcher/submit-layout-template"},{"title":"Replace an operator fixed-width layout template","deprecated":null,"version":null,"sidebarTitle":"Update layout template","openapi":"/en/openapi/v3-current/matcher.yaml put /v1/imports/formats/templates/{templateId}","href":"/en/reference/products/matcher/update-layout-template"}]},{"group":"Extraction reviews","pages":[{"title":"List AI extraction reviews (the human-review queue)","deprecated":null,"version":null,"sidebarTitle":"List extraction reviews","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/imports/contexts/{contextId}/extraction-reviews","href":"/en/reference/products/matcher/list-extraction-reviews"},{"title":"Get a single AI extraction review","deprecated":null,"version":null,"sidebarTitle":"Get extraction review","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/imports/contexts/{contextId}/extraction-reviews/{reviewId}","href":"/en/reference/products/matcher/get-extraction-review"},{"title":"Approve an AI extraction review (ingest the candidates)","deprecated":null,"version":null,"sidebarTitle":"Approve extraction review","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/extraction-reviews/{reviewId}/approve","href":"/en/reference/products/matcher/approve-extraction-review"},{"title":"Reject an AI extraction review (discard the candidates)","deprecated":null,"version":null,"sidebarTitle":"Reject extraction review","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/extraction-reviews/{reviewId}/reject","href":"/en/reference/products/matcher/reject-extraction-review"}]},{"group":"Document extraction","pages":[{"title":"Enqueue a document for AI extraction (human-review required)","deprecated":null,"version":null,"sidebarTitle":"Extract document","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/sources/{sourceId}/extract-document","href":"/en/reference/products/matcher/extract-document"},{"title":"Trigger a manual fetch-and-ingest from an external transport","deprecated":null,"version":null,"sidebarTitle":"Fetch trigger","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/sources/{sourceId}/fetch","href":"/en/reference/products/matcher/fetch-trigger"}]},{"group":"Match runs","pages":[{"title":"Trigger a matching run","deprecated":null,"version":null,"sidebarTitle":"Run match","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/matching/contexts/{contextId}/run","href":"/en/reference/products/matcher/run-match"},{"title":"List match runs","deprecated":null,"version":null,"sidebarTitle":"List match runs","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/matching/contexts/{contextId}/runs","href":"/en/reference/products/matcher/list-match-runs"},{"title":"Get match run","deprecated":null,"version":null,"sidebarTitle":"Retrieve match run","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/matching/runs/{runId}","href":"/en/reference/products/matcher/retrieve-match-run"},{"title":"Get match run results","deprecated":null,"version":null,"sidebarTitle":"List match run groups","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/matching/runs/{runId}/groups","href":"/en/reference/products/matcher/list-match-run-groups"}]},{"group":"Manual matching and adjustments","pages":[{"title":"Create a manual match","deprecated":null,"version":null,"sidebarTitle":"Create manual match","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/matching/manual","href":"/en/reference/products/matcher/create-manual-match"},{"title":"Break/Unmatch a match group","deprecated":null,"version":null,"sidebarTitle":"Unmatch group","openapi":"/en/openapi/v3-current/matcher.yaml delete /v1/matching/groups/{matchGroupId}","href":"/en/reference/products/matcher/unmatch-group"},{"title":"Create an adjustment","deprecated":null,"version":null,"sidebarTitle":"Create adjustment","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/matching/adjustments","href":"/en/reference/products/matcher/create-adjustment"},{"title":"List recorded adjustments","deprecated":null,"version":null,"sidebarTitle":"List recorded adjustments","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/matching/contexts/{contextId}/adjustments","href":"/en/reference/products/matcher/list-recorded-adjustments"}]},{"group":"Candidates and open items","pages":[{"title":"List match candidates for a transaction","deprecated":null,"version":null,"sidebarTitle":"List match candidates","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/matching/candidates","href":"/en/reference/products/matcher/list-match-candidates"},{"title":"List open items","deprecated":null,"version":null,"sidebarTitle":"List open items","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/matching/contexts/{contextId}/open-items","href":"/en/reference/products/matcher/list-open-items"}]},{"group":"Rule suggestions","pages":[{"title":"List AI match-rule suggestions (the human-review queue)","deprecated":null,"version":null,"sidebarTitle":"List match rule suggestions","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/matching/contexts/{contextId}/rule-suggestions","href":"/en/reference/products/matcher/list-match-rule-suggestions"},{"title":"Produce AI match-rule suggestions (human-review required)","deprecated":null,"version":null,"sidebarTitle":"Suggest match rules","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/matching/contexts/{contextId}/rule-suggestions","href":"/en/reference/products/matcher/suggest-match-rules"},{"title":"Approve an AI match-rule suggestion (create the rule)","deprecated":null,"version":null,"sidebarTitle":"Approve match rule suggestion","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/matching/contexts/{contextId}/rule-suggestions/{suggestionId}/approve","href":"/en/reference/products/matcher/approve-match-rule-suggestion"},{"title":"Reject an AI match-rule suggestion (discard it)","deprecated":null,"version":null,"sidebarTitle":"Reject match rule suggestion","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/matching/contexts/{contextId}/rule-suggestions/{suggestionId}/reject","href":"/en/reference/products/matcher/reject-match-rule-suggestion"},{"title":"Simulate a match rule against a context (read-only dry run)","deprecated":null,"version":null,"sidebarTitle":"Simulate match rule","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/matching/simulate","href":"/en/reference/products/matcher/simulate-match-rule"}]},{"group":"Dashboard and metrics","pages":[{"title":"Get all dashboard aggregates","deprecated":null,"version":null,"sidebarTitle":"Get dashboard aggregates","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard","href":"/en/reference/products/matcher/get-dashboard-aggregates"},{"title":"Get comprehensive dashboard metrics","deprecated":null,"version":null,"sidebarTitle":"Get dashboard metrics","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/metrics","href":"/en/reference/products/matcher/get-dashboard-metrics"},{"title":"Get match rate statistics","deprecated":null,"version":null,"sidebarTitle":"Get match rate stats","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/match-rate","href":"/en/reference/products/matcher/get-match-rate-stats"},{"title":"Get SLA statistics","deprecated":null,"version":null,"sidebarTitle":"Get sla stats","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/sla","href":"/en/reference/products/matcher/get-sla-stats"},{"title":"Get volume statistics","deprecated":null,"version":null,"sidebarTitle":"Get volume stats","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/volume","href":"/en/reference/products/matcher/get-volume-stats"},{"title":"Get source breakdown","deprecated":null,"version":null,"sidebarTitle":"Get source breakdown","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/source-breakdown","href":"/en/reference/products/matcher/get-source-breakdown"},{"title":"Get cash impact summary","deprecated":null,"version":null,"sidebarTitle":"Get cash impact","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/cash-impact","href":"/en/reference/products/matcher/get-cash-impact"},{"title":"Count matches","deprecated":null,"version":null,"sidebarTitle":"Count matches","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/matches/count","href":"/en/reference/products/matcher/count-matches"},{"title":"Count transactions","deprecated":null,"version":null,"sidebarTitle":"Count transactions","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/transactions/count","href":"/en/reference/products/matcher/count-transactions"},{"title":"Count exceptions","deprecated":null,"version":null,"sidebarTitle":"Count exceptions","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/exceptions/count","href":"/en/reference/products/matcher/count-exceptions"},{"title":"Count unmatched items","deprecated":null,"version":null,"sidebarTitle":"Count unmatched","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/unmatched/count","href":"/en/reference/products/matcher/count-unmatched"}]},{"group":"Reports","pages":[{"title":"List matched transactions report","deprecated":null,"version":null,"sidebarTitle":"List matched report","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/matched","href":"/en/reference/products/matcher/list-matched-report"},{"title":"List unmatched transactions report","deprecated":null,"version":null,"sidebarTitle":"List unmatched report","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/unmatched","href":"/en/reference/products/matcher/list-unmatched-report"},{"title":"Get reconciliation summary report","deprecated":null,"version":null,"sidebarTitle":"Get summary report","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/summary","href":"/en/reference/products/matcher/get-summary-report"},{"title":"List variance report","deprecated":null,"version":null,"sidebarTitle":"List variance report","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/variance","href":"/en/reference/products/matcher/list-variance-report"}]},{"group":"Exports","pages":[{"title":"Export matched transactions report","deprecated":null,"version":null,"sidebarTitle":"Export matched report","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/matched/export","href":"/en/reference/products/matcher/export-matched-report"},{"title":"Export unmatched transactions report","deprecated":null,"version":null,"sidebarTitle":"Export unmatched report","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/unmatched/export","href":"/en/reference/products/matcher/export-unmatched-report"},{"title":"Export summary report","deprecated":null,"version":null,"sidebarTitle":"Export summary report","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/summary/export","href":"/en/reference/products/matcher/export-summary-report"},{"title":"Export variance report","deprecated":null,"version":null,"sidebarTitle":"Export variance report","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/variance/export","href":"/en/reference/products/matcher/export-variance-report"},{"title":"Export exceptions report","deprecated":null,"version":null,"sidebarTitle":"Export exceptions report","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/exceptions/export","href":"/en/reference/products/matcher/export-exceptions-report"}]},{"group":"Discovery status","pages":[{"title":"Get discovery status","deprecated":null,"version":null,"sidebarTitle":"Discovery status","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/discovery/status","href":"/en/reference/products/matcher/discovery-status"}]},{"group":"Discovery connections","pages":[{"title":"List discovered connections","deprecated":null,"version":null,"sidebarTitle":"List discovery connections","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/discovery/connections","href":"/en/reference/products/matcher/list-discovery-connections"},{"title":"Get a discovered connection","deprecated":null,"version":null,"sidebarTitle":"Retrieve discovery connection","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/discovery/connections/{connectionId}","href":"/en/reference/products/matcher/retrieve-discovery-connection"},{"title":"Get connection schema","deprecated":null,"version":null,"sidebarTitle":"Get connection schema","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/discovery/connections/{connectionId}/schema","href":"/en/reference/products/matcher/get-connection-schema"},{"title":"Get connection schema history","deprecated":null,"version":null,"sidebarTitle":"Get connection schema history","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/discovery/connections/{connectionId}/schema/history","href":"/en/reference/products/matcher/get-connection-schema-history"},{"title":"Test a connection","deprecated":null,"version":null,"sidebarTitle":"Test discovery connection","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/discovery/connections/{connectionId}/test","href":"/en/reference/products/matcher/test-discovery-connection"},{"title":"Refresh discovery","deprecated":null,"version":null,"sidebarTitle":"Refresh discovery","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/discovery/refresh","href":"/en/reference/products/matcher/refresh-discovery"},{"title":"Delete discovery connection","deprecated":null,"version":null,"sidebarTitle":"Delete discovery connection","openapi":"/en/openapi/v3-current/matcher.yaml delete /v1/discovery/connections/{connectionId}","href":"/en/reference/products/matcher/delete-discovery-connection"},{"title":"List connector types","deprecated":null,"version":null,"sidebarTitle":"List discovery connector types","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/discovery/connector-types","href":"/en/reference/products/matcher/list-discovery-connector-types"},{"title":"Update discovery connection","deprecated":null,"version":null,"sidebarTitle":"Update discovery connection","openapi":"/en/openapi/v3-current/matcher.yaml patch /v1/discovery/connections/{connectionId}","href":"/en/reference/products/matcher/update-discovery-connection"},{"title":"Create discovery connection","deprecated":null,"version":null,"sidebarTitle":"Create discovery connection","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/discovery/connections","href":"/en/reference/products/matcher/create-discovery-connection"},{"title":"Create REST discovery connection","deprecated":null,"version":null,"sidebarTitle":"Create rest discovery connection","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/discovery/rest-connections","href":"/en/reference/products/matcher/create-rest-discovery-connection"}]},{"group":"Extractions","pages":[{"title":"Start a connection extraction","deprecated":null,"version":null,"sidebarTitle":"Create extraction","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/discovery/connections/{connectionId}/extractions","href":"/en/reference/products/matcher/create-extraction"},{"title":"Get an extraction request","deprecated":null,"version":null,"sidebarTitle":"Retrieve extraction","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/discovery/extractions/{extractionId}","href":"/en/reference/products/matcher/retrieve-extraction"}]},{"group":"Aggregator connections","pages":[{"title":"Delete aggregator connection","deprecated":null,"version":null,"sidebarTitle":"Delete aggregator connection","openapi":"/en/openapi/v3-current/matcher.yaml delete /v1/discovery/aggregator-connections/{id}","href":"/en/reference/products/matcher/delete-aggregator-connection"},{"title":"List aggregator connections","deprecated":null,"version":null,"sidebarTitle":"List aggregator connections","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/discovery/aggregator-connections","href":"/en/reference/products/matcher/list-aggregator-connections"},{"title":"Get aggregator connection","deprecated":null,"version":null,"sidebarTitle":"Get aggregator connection","openapi":"/en/openapi/v3-current/matcher.yaml get /v1/discovery/aggregator-connections/{id}","href":"/en/reference/products/matcher/get-aggregator-connection"},{"title":"Create aggregator connection","deprecated":null,"version":null,"sidebarTitle":"Create aggregator connection","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/discovery/aggregator-connections","href":"/en/reference/products/matcher/create-aggregator-connection"},{"title":"Test aggregator connection credentials","deprecated":null,"version":null,"sidebarTitle":"Test aggregator connection","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/discovery/aggregator-connections/test","href":"/en/reference/products/matcher/test-aggregator-connection"},{"title":"Mint aggregator consent token","deprecated":null,"version":null,"sidebarTitle":"Mint aggregator consent token","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/discovery/aggregator-connections/{id}/connect-token","href":"/en/reference/products/matcher/mint-aggregator-consent-token"},{"title":"Update aggregator connection","deprecated":null,"version":null,"sidebarTitle":"Update aggregator connection","openapi":"/en/openapi/v3-current/matcher.yaml put /v1/discovery/aggregator-connections/{id}","href":"/en/reference/products/matcher/update-aggregator-connection"}]},{"group":"Aggregator webhooks","pages":[{"title":"Receive an aggregator webhook","deprecated":null,"version":null,"sidebarTitle":"Receive aggregator webhook","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/discovery/webhooks/{provider}/{webhookToken}","href":"/en/reference/products/matcher/receive-aggregator-webhook"},{"title":"Mint an aggregator webhook token","deprecated":null,"version":null,"sidebarTitle":"Mint aggregator webhook token","openapi":"/en/openapi/v3-current/matcher.yaml post /v1/discovery/webhooks/tokens","href":"/en/reference/products/matcher/mint-aggregator-webhook-token"}]},{"group":"Error handling","pages":[{"title":"Matcher error list","href":"/en/reference/products/matcher/matcher-error-list"}]},{"group":"Events","pages":[{"title":"Matcher events","href":"/en/reference/events/matcher"}]}]},{"dropdown":"Flowker","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/flowker-yellow.png","description":"Workflow catalog, executions, and schedules","groups":[{"group":"Catalog API","pages":[{"title":"List Catalog Executors","deprecated":null,"version":null,"sidebarTitle":"List catalog executors","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/catalog/executors","href":"/en/reference/products/flowker/list-catalog-executors"},{"title":"Get a Catalog Executor","deprecated":null,"version":null,"sidebarTitle":"Get catalog executor","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/catalog/executors/{id}","href":"/en/reference/products/flowker/get-catalog-executor"},{"title":"Validate a Node Configuration","deprecated":null,"version":null,"sidebarTitle":"Validate executor config","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/catalog/executors/{id}/validate","href":"/en/reference/products/flowker/validate-executor-config"},{"title":"List Catalog Providers","deprecated":null,"version":null,"sidebarTitle":"List catalog providers","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/catalog/providers","href":"/en/reference/products/flowker/list-catalog-providers"},{"title":"Get a Catalog Provider","deprecated":null,"version":null,"sidebarTitle":"Get catalog provider","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/catalog/providers/{id}","href":"/en/reference/products/flowker/get-catalog-provider"},{"title":"List Executors by Provider","deprecated":null,"version":null,"sidebarTitle":"List executors by provider","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/catalog/providers/{id}/executors","href":"/en/reference/products/flowker/list-executors-by-provider"},{"title":"List Catalog Triggers","deprecated":null,"version":null,"sidebarTitle":"List catalog triggers","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/catalog/triggers","href":"/en/reference/products/flowker/list-catalog-triggers"},{"title":"Get a Catalog Trigger","deprecated":null,"version":null,"sidebarTitle":"Get catalog trigger","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/catalog/triggers/{id}","href":"/en/reference/products/flowker/get-catalog-trigger"},{"title":"List Catalog Templates","deprecated":null,"version":null,"sidebarTitle":"List catalog templates","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/catalog/templates","href":"/en/reference/products/flowker/list-catalog-templates"},{"title":"Get a Catalog Template","deprecated":null,"version":null,"sidebarTitle":"Get catalog template","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/catalog/templates/{id}","href":"/en/reference/products/flowker/get-catalog-template"},{"title":"Validate Catalog Template Parameters","deprecated":null,"version":null,"sidebarTitle":"Validate catalog template params","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/catalog/templates/{id}/validate","href":"/en/reference/products/flowker/validate-catalog-template-params"}]},{"group":"Workflows API","pages":[{"title":"List Workflows","deprecated":null,"version":null,"sidebarTitle":"List workflows","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/workflows","href":"/en/reference/products/flowker/list-workflows"},{"title":"Create a Workflow","deprecated":null,"version":null,"sidebarTitle":"Create workflow","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/workflows","href":"/en/reference/products/flowker/create-workflow"},{"title":"Get a Workflow","deprecated":null,"version":null,"sidebarTitle":"Get workflow","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/workflows/{id}","href":"/en/reference/products/flowker/get-workflow"},{"title":"Update a Workflow","deprecated":null,"version":null,"sidebarTitle":"Update workflow","openapi":"/en/openapi/v3-current/flowker.yaml put /v1/workflows/{id}","href":"/en/reference/products/flowker/update-workflow"},{"title":"Delete a Workflow","deprecated":null,"version":null,"sidebarTitle":"Delete workflow","openapi":"/en/openapi/v3-current/flowker.yaml delete /v1/workflows/{id}","href":"/en/reference/products/flowker/delete-workflow"},{"title":"Activate a Workflow","deprecated":null,"version":null,"sidebarTitle":"Activate workflow","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/activate","href":"/en/reference/products/flowker/activate-workflow"},{"title":"Deactivate a Workflow","deprecated":null,"version":null,"sidebarTitle":"Deactivate workflow","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/deactivate","href":"/en/reference/products/flowker/deactivate-workflow"},{"title":"Move a Workflow to Draft","deprecated":null,"version":null,"sidebarTitle":"Move workflow to draft","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/draft","href":"/en/reference/products/flowker/move-workflow-to-draft"},{"title":"Clone a Workflow","deprecated":null,"version":null,"sidebarTitle":"Clone workflow","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/clone","href":"/en/reference/products/flowker/clone-workflow"}]},{"group":"Schedule API","pages":[{"title":"List Upcoming Scheduled Occurrences","deprecated":null,"version":null,"sidebarTitle":"List upcoming scheduled occurrences","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/workflows/{id}/schedule/upcoming","href":"/en/reference/products/flowker/list-upcoming-scheduled-occurrences"},{"title":"List Skipped Scheduled Occurrences","deprecated":null,"version":null,"sidebarTitle":"List skipped scheduled occurrences","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/workflows/{id}/schedule/skipped","href":"/en/reference/products/flowker/list-skipped-scheduled-occurrences"},{"title":"List Parked Scheduled Occurrences","deprecated":null,"version":null,"sidebarTitle":"List parked scheduled occurrences","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/workflows/{id}/schedule/missed","href":"/en/reference/products/flowker/list-parked-scheduled-occurrences"},{"title":"Count Pending-Review Occurrences","deprecated":null,"version":null,"sidebarTitle":"Count pending review occurrences","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/workflows/schedule/pending-review-counts","href":"/en/reference/products/flowker/count-pending-review-occurrences"},{"title":"Run a Parked Occurrence","deprecated":null,"version":null,"sidebarTitle":"Run parked occurrence","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/schedule/missed/{occurrenceId}/run","href":"/en/reference/products/flowker/run-parked-occurrence"},{"title":"Discard a Parked Occurrence","deprecated":null,"version":null,"sidebarTitle":"Discard parked occurrence","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/schedule/missed/{occurrenceId}/discard","href":"/en/reference/products/flowker/discard-parked-occurrence"},{"title":"Discard All Parked Occurrences","deprecated":null,"version":null,"sidebarTitle":"Discard all parked occurrences","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/schedule/missed/discard-all","href":"/en/reference/products/flowker/discard-all-parked-occurrences"}]},{"group":"Executions API","pages":[{"title":"Execute a Workflow","deprecated":null,"version":null,"sidebarTitle":"Execute workflow","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/workflows/{workflowId}/executions","href":"/en/reference/products/flowker/execute-workflow"},{"title":"List Executions","deprecated":null,"version":null,"sidebarTitle":"List executions","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/executions","href":"/en/reference/products/flowker/list-executions"},{"title":"Get an Execution Status","deprecated":null,"version":null,"sidebarTitle":"Get execution status","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/executions/{id}","href":"/en/reference/products/flowker/get-execution-status"},{"title":"Get Execution Results","deprecated":null,"version":null,"sidebarTitle":"Get execution results","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/executions/{id}/results","href":"/en/reference/products/flowker/get-execution-results"},{"title":"Preview an Executor Request","deprecated":null,"version":null,"sidebarTitle":"Preview executor request","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/workflows/preview-request","href":"/en/reference/products/flowker/preview-executor-request"}]},{"group":"Dashboards API","pages":[{"title":"Get Dashboard Workflow Summary","deprecated":null,"version":null,"sidebarTitle":"Get dashboard workflow summary","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/dashboards/workflows/summary","href":"/en/reference/products/flowker/get-dashboard-workflow-summary"},{"title":"Get Dashboard Execution Summary","deprecated":null,"version":null,"sidebarTitle":"Get dashboard execution summary","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/dashboards/executions","href":"/en/reference/products/flowker/get-dashboard-execution-summary"}]},{"group":"Executor Configurations API","pages":[{"title":"List Executor Configurations","deprecated":null,"version":null,"sidebarTitle":"List executor configurations","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/executors","href":"/en/reference/products/flowker/list-executor-configurations"},{"title":"Get an Executor Configuration","deprecated":null,"version":null,"sidebarTitle":"Get executor configuration","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/executors/{id}","href":"/en/reference/products/flowker/get-executor-configuration"},{"title":"Update an Executor Configuration","deprecated":null,"version":null,"sidebarTitle":"Update executor configuration","openapi":"/en/openapi/v3-current/flowker.yaml patch /v1/executors/{id}","href":"/en/reference/products/flowker/update-executor-configuration"},{"title":"Delete an Executor Configuration","deprecated":null,"version":null,"sidebarTitle":"Delete executor configuration","openapi":"/en/openapi/v3-current/flowker.yaml delete /v1/executors/{id}","href":"/en/reference/products/flowker/delete-executor-configuration"}]},{"group":"Provider Configurations API","pages":[{"title":"List Provider Configurations","deprecated":null,"version":null,"sidebarTitle":"List provider configurations","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/provider-configurations","href":"/en/reference/products/flowker/list-provider-configurations"},{"title":"Create a Provider Configuration","deprecated":null,"version":null,"sidebarTitle":"Create provider configuration","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/provider-configurations","href":"/en/reference/products/flowker/create-provider-configuration"},{"title":"Get a Provider Configuration","deprecated":null,"version":null,"sidebarTitle":"Get provider configuration","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/provider-configurations/{id}","href":"/en/reference/products/flowker/get-provider-configuration"},{"title":"Update a Provider Configuration","deprecated":null,"version":null,"sidebarTitle":"Update provider configuration","openapi":"/en/openapi/v3-current/flowker.yaml patch /v1/provider-configurations/{id}","href":"/en/reference/products/flowker/update-provider-configuration"},{"title":"Delete a Provider Configuration","deprecated":null,"version":null,"sidebarTitle":"Delete provider configuration","openapi":"/en/openapi/v3-current/flowker.yaml delete /v1/provider-configurations/{id}","href":"/en/reference/products/flowker/delete-provider-configuration"},{"title":"Enable a Provider Configuration","deprecated":null,"version":null,"sidebarTitle":"Enable provider configuration","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/provider-configurations/{id}/enable","href":"/en/reference/products/flowker/enable-provider-configuration"},{"title":"Disable a Provider Configuration","deprecated":null,"version":null,"sidebarTitle":"Disable provider configuration","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/provider-configurations/{id}/disable","href":"/en/reference/products/flowker/disable-provider-configuration"}]},{"group":"Schema Registry API","pages":[{"title":"List OpenAPI Spec Versions","deprecated":null,"version":null,"sidebarTitle":"List openapi spec versions","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/catalog/openapi-versions/{service}","href":"/en/reference/products/flowker/list-openapi-spec-versions"},{"title":"Upload an OpenAPI Spec Version","deprecated":null,"version":null,"sidebarTitle":"Upload openapi spec version","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/catalog/openapi-specs/{service}/{version}","href":"/en/reference/products/flowker/upload-openapi-spec-version"},{"title":"Pin an OpenAPI Spec Version","deprecated":null,"version":null,"sidebarTitle":"Pin openapi spec version","openapi":"/en/openapi/v3-current/flowker.yaml put /v1/catalog/openapi-version-pins/{service}","href":"/en/reference/products/flowker/pin-openapi-spec-version"}]},{"group":"OpenAPI Schemas API","pages":[{"title":"List External OpenAPI Schemas","deprecated":null,"version":null,"sidebarTitle":"List openapi schemas","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/openapi-schemas","href":"/en/reference/products/flowker/list-openapi-schemas"},{"title":"Get an External OpenAPI Schema","deprecated":null,"version":null,"sidebarTitle":"Get openapi schema","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/openapi-schemas/{id}","href":"/en/reference/products/flowker/get-openapi-schema"},{"title":"Upload an External OpenAPI Schema","deprecated":null,"version":null,"sidebarTitle":"Upload openapi schema","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/openapi-schemas","href":"/en/reference/products/flowker/upload-openapi-schema"},{"title":"Delete an External OpenAPI Schema","deprecated":null,"version":null,"sidebarTitle":"Delete openapi schema","openapi":"/en/openapi/v3-current/flowker.yaml delete /v1/openapi-schemas/{id}","href":"/en/reference/products/flowker/delete-openapi-schema"},{"title":"List External OpenAPI Schema References","deprecated":null,"version":null,"sidebarTitle":"List openapi schema references","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/openapi-schemas/{id}/references","href":"/en/reference/products/flowker/list-openapi-schema-references"},{"title":"Derive an Operation Schema","deprecated":null,"version":null,"sidebarTitle":"Derive openapi operation schema","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/openapi-schemas/{id}/operation-schema","href":"/en/reference/products/flowker/derive-openapi-operation-schema"}]},{"group":"XSD Schemas API","pages":[{"title":"List XSD Schemas","deprecated":null,"version":null,"sidebarTitle":"List xsd schemas","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/xsd-schemas","href":"/en/reference/products/flowker/list-xsd-schemas"},{"title":"Get an XSD Schema","deprecated":null,"version":null,"sidebarTitle":"Get xsd schema","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/xsd-schemas/{id}","href":"/en/reference/products/flowker/get-xsd-schema"},{"title":"Upload an XSD Schema","deprecated":null,"version":null,"sidebarTitle":"Upload xsd schema","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/xsd-schemas","href":"/en/reference/products/flowker/upload-xsd-schema"},{"title":"Delete an XSD Schema","deprecated":null,"version":null,"sidebarTitle":"Delete xsd schema","openapi":"/en/openapi/v3-current/flowker.yaml delete /v1/xsd-schemas/{id}","href":"/en/reference/products/flowker/delete-xsd-schema"},{"title":"List XSD Schema References","deprecated":null,"version":null,"sidebarTitle":"List xsd schema references","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/xsd-schemas/{id}/references","href":"/en/reference/products/flowker/list-xsd-schema-references"}]},{"group":"Webhooks API","pages":[{"title":"Trigger a Webhook","deprecated":null,"version":null,"sidebarTitle":"Trigger webhook","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/webhooks/{path}","href":"/en/reference/products/flowker/trigger-webhook"},{"title":"Trigger a Webhook (GET)","deprecated":null,"version":null,"sidebarTitle":"Trigger webhook get","openapi":"/en/openapi/v3-current/flowker.yaml get /v1/webhooks/{path}","href":"/en/reference/products/flowker/trigger-webhook-get"},{"title":"Trigger a Webhook (PUT)","deprecated":null,"version":null,"sidebarTitle":"Trigger webhook put","openapi":"/en/openapi/v3-current/flowker.yaml put /v1/webhooks/{path}","href":"/en/reference/products/flowker/trigger-webhook-put"},{"title":"Trigger a Webhook (PATCH)","deprecated":null,"version":null,"sidebarTitle":"Trigger webhook patch","openapi":"/en/openapi/v3-current/flowker.yaml patch /v1/webhooks/{path}","href":"/en/reference/products/flowker/trigger-webhook-patch"},{"title":"Trigger a Webhook (DELETE)","deprecated":null,"version":null,"sidebarTitle":"Trigger webhook delete","openapi":"/en/openapi/v3-current/flowker.yaml delete /v1/webhooks/{path}","href":"/en/reference/products/flowker/trigger-webhook-delete"},{"title":"Trigger a Webhook from Streaming Hub","deprecated":null,"version":null,"sidebarTitle":"Trigger webhook from streaming hub","openapi":"/en/openapi/v3-current/flowker.yaml post /v1/hub/webhooks/{path}","href":"/en/reference/products/flowker/trigger-webhook-from-streaming-hub"}]},{"group":"Error handling","pages":[{"title":"Flowker error list","href":"/en/reference/products/flowker/flowker-error-list"}]}]},{"dropdown":"Lender","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/core-banking-yellow.png","description":"Loan products, applications, and servicing","groups":[{"group":"Brazil loan products","pages":[{"title":"List loan products (BR alias)","deprecated":null,"version":null,"sidebarTitle":"List loan products br","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/br/loan-products","href":"/en/reference/products/lender/list-loan-products-br"},{"title":"Create loan product (BR alias)","deprecated":null,"version":null,"sidebarTitle":"Create loan product br","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/br/loan-products","href":"/en/reference/products/lender/create-loan-product-br"},{"title":"Get loan product (BR alias)","deprecated":null,"version":null,"sidebarTitle":"Get loan product br","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/br/loan-products/{id}","href":"/en/reference/products/lender/get-loan-product-br"},{"title":"Activate loan product (BR alias)","deprecated":null,"version":null,"sidebarTitle":"Activate loan product br","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/br/loan-products/{id}/activate","href":"/en/reference/products/lender/activate-loan-product-br"},{"title":"Create loan product version (BR alias)","deprecated":null,"version":null,"sidebarTitle":"Create loan product version br","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/br/loan-products/{id}/versions","href":"/en/reference/products/lender/create-loan-product-version-br"},{"title":"Promote a loan product version to current (BR alias)","deprecated":null,"version":null,"sidebarTitle":"Promote a loan product version to current br alias","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/br/loan-products/{id}/promote","href":"/en/reference/products/lender/promote-a-loan-product-version-to-current-br-alias"},{"title":"Declare the BR norm classification of a loan product version","deprecated":null,"version":null,"sidebarTitle":"Declare the br norm classification of a loan product version","openapi":"/en/openapi/v3-current/lender.yaml put /api/v1/br/loan-product-versions/{id}/norm-classification","href":"/en/reference/products/lender/declare-the-br-norm-classification-of-a-loan-product-version"}]},{"group":"Consignado operations","pages":[{"title":"List open extraordinary-collection instructions","deprecated":null,"version":null,"sidebarTitle":"List open extraordinary collection instructions","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/br/consignado/collection-instructions","href":"/en/reference/products/lender/list-open-extraordinary-collection-instructions"},{"title":"Ingest the collection agent's Arquivo de Baixa Extraordinária","deprecated":null,"version":null,"sidebarTitle":"Ingest the collection agent s arquivo de baixa extraordinaria","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/br/consignado/collection-settlements","href":"/en/reference/products/lender/ingest-the-collection-agent-s-arquivo-de-baixa-extraordinaria"},{"title":"List refused lines of the collection agent's own settlement files","deprecated":null,"version":null,"sidebarTitle":"List refused lines of the collection agent s own settlement files","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/br/consignado/collection-settlements/refused","href":"/en/reference/products/lender/list-refused-lines-of-the-collection-agent-s-own-settlement-files"},{"title":"List consignado contract divergences","deprecated":null,"version":null,"sidebarTitle":"List consignado contract divergences","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/internal/br/consignado/divergences","href":"/en/reference/products/lender/list-consignado-contract-divergences"},{"title":"Get consignado contract divergence detail","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract divergence","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/internal/br/consignado/divergences/{id}","href":"/en/reference/products/lender/get-consignado-contract-divergence"},{"title":"Assign consignado contract divergence","deprecated":null,"version":null,"sidebarTitle":"Assign consignado contract divergence","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/divergences/{id}/assign","href":"/en/reference/products/lender/assign-consignado-contract-divergence"},{"title":"Dispose consignado contract divergence","deprecated":null,"version":null,"sidebarTitle":"Dispose consignado contract divergence","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/divergences/{id}/dispose","href":"/en/reference/products/lender/dispose-consignado-contract-divergence"},{"title":"Requeue consignado contract divergence","deprecated":null,"version":null,"sidebarTitle":"Requeue consignado contract divergence","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/divergences/{id}/requeue","href":"/en/reference/products/lender/requeue-consignado-contract-divergence"},{"title":"Create a consignado compensating adjustment","deprecated":null,"version":null,"sidebarTitle":"Create consignado compensating adjustment","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/compensating-adjustments","href":"/en/reference/products/lender/create-consignado-compensating-adjustment"},{"title":"Preview a consignado compensating adjustment","deprecated":null,"version":null,"sidebarTitle":"Preview consignado compensating adjustment","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/compensating-adjustments/preview","href":"/en/reference/products/lender/preview-consignado-compensating-adjustment"},{"title":"Attach evidence to a consignado compensating adjustment","deprecated":null,"version":null,"sidebarTitle":"Attach consignado compensating adjustment evidence","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/compensating-adjustments/{id}/evidence","href":"/en/reference/products/lender/attach-consignado-compensating-adjustment-evidence"},{"title":"Reconcile a consignado compensating adjustment","deprecated":null,"version":null,"sidebarTitle":"Reconcile consignado compensating adjustment","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/compensating-adjustments/{id}/reconcile","href":"/en/reference/products/lender/reconcile-consignado-compensating-adjustment"},{"title":"Appoint the tenant's extraordinary-collection agent","deprecated":null,"version":null,"sidebarTitle":"Appoint the tenant s extraordinary collection agent","openapi":"/en/openapi/v3-current/lender.yaml put /api/v1/internal/br/consignado/collection-agent-channel","href":"/en/reference/products/lender/appoint-the-tenant-s-extraordinary-collection-agent"},{"title":"List quarantined extraordinary-collection settlement lines","deprecated":null,"version":null,"sidebarTitle":"List quarantined extraordinary collection settlement lines","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/internal/br/consignado/collection-settlements/quarantined","href":"/en/reference/products/lender/list-quarantined-extraordinary-collection-settlement-lines"},{"title":"Read the inbound-portability lineage of a contract","deprecated":null,"version":null,"sidebarTitle":"Read the inbound portability lineage of a contract","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/internal/br/consignado/contracts/{numeroContrato}/portability-inbound","href":"/en/reference/products/lender/read-the-inbound-portability-lineage-of-a-contract"},{"title":"Requeue a quarantined consignado inbox item","deprecated":null,"version":null,"sidebarTitle":"Requeue a quarantined consignado inbox item","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/inboxes/{inbox}/{id}/requeue","href":"/en/reference/products/lender/requeue-a-quarantined-consignado-inbox-item"},{"title":"List over-deduction refunds owed to workers","deprecated":null,"version":null,"sidebarTitle":"List over deduction refunds owed to workers","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/internal/br/consignado/overdeduction-refunds","href":"/en/reference/products/lender/list-over-deduction-refunds-owed-to-workers"},{"title":"Record that an over-deduction refund was returned","deprecated":null,"version":null,"sidebarTitle":"Record that an over deduction refund was returned","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/overdeduction-refunds/{id}/dispose","href":"/en/reference/products/lender/record-that-an-over-deduction-refund-was-returned"}]},{"group":"Loan product lifecycle","pages":[{"title":"List loan products","deprecated":null,"version":null,"sidebarTitle":"List loan products","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-products","href":"/en/reference/products/lender/list-loan-products"},{"title":"Create loan product","deprecated":null,"version":null,"sidebarTitle":"Create loan product","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-products","href":"/en/reference/products/lender/create-loan-product"},{"title":"Get loan product","deprecated":null,"version":null,"sidebarTitle":"Get loan product","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-products/{id}","href":"/en/reference/products/lender/get-loan-product"},{"title":"Activate loan product","deprecated":null,"version":null,"sidebarTitle":"Activate loan product","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/activate","href":"/en/reference/products/lender/activate-loan-product"},{"title":"Create loan product version","deprecated":null,"version":null,"sidebarTitle":"Create loan product version","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/versions","href":"/en/reference/products/lender/create-loan-product-version"},{"title":"Promote a loan product version to current","deprecated":null,"version":null,"sidebarTitle":"Promote a loan product version to current","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/promote","href":"/en/reference/products/lender/promote-a-loan-product-version-to-current"}]},{"group":"Product versions","pages":[{"title":"List loan product versions","deprecated":null,"version":null,"sidebarTitle":"List loan product versions","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-product-versions","href":"/en/reference/products/lender/list-loan-product-versions"},{"title":"Get loan product version","deprecated":null,"version":null,"sidebarTitle":"Get loan product version","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-product-versions/{id}","href":"/en/reference/products/lender/get-loan-product-version"},{"title":"Declare charge model revision","deprecated":null,"version":null,"sidebarTitle":"Declare charge model revision","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-product-versions/{id}/charge-templates","href":"/en/reference/products/lender/declare-charge-model-revision"}]},{"group":"Product configuration","pages":[{"title":"Create loan product accounting profile","deprecated":null,"version":null,"sidebarTitle":"Create loan product accounting profile","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/accounting-profiles","href":"/en/reference/products/lender/create-loan-product-accounting-profile"},{"title":"Supersede loan product chart of accounts","deprecated":null,"version":null,"sidebarTitle":"Supersede loan product chart of accounts","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/accounting-profiles/supersessions","href":"/en/reference/products/lender/supersede-loan-product-chart-of-accounts"},{"title":"Settle a chart change onto every contract's balances","deprecated":null,"version":null,"sidebarTitle":"Settle a chart change onto every contract s balances","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/accounting-profiles/supersessions/sweeps","href":"/en/reference/products/lender/settle-a-chart-change-onto-every-contract-s-balances"},{"title":"Apply inherited loan product charge","deprecated":null,"version":null,"sidebarTitle":"Create loan product charges","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/charges","href":"/en/reference/products/lender/create-loan-product-charges"},{"title":"Get loan product floating rate table","deprecated":null,"version":null,"sidebarTitle":"List loan product floating rates","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-products/{id}/floating-rates","href":"/en/reference/products/lender/list-loan-product-floating-rates"}]},{"group":"Floating-rate tables","pages":[{"title":"List floating-rate tables","deprecated":null,"version":null,"sidebarTitle":"List floating rate tables","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/rate-tables","href":"/en/reference/products/lender/list-floating-rate-tables"},{"title":"Create floating-rate table","deprecated":null,"version":null,"sidebarTitle":"Create floating rate table","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/rate-tables","href":"/en/reference/products/lender/create-floating-rate-table"},{"title":"Get floating-rate table","deprecated":null,"version":null,"sidebarTitle":"Get floating rate table","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/rate-tables/{id}","href":"/en/reference/products/lender/get-floating-rate-table"},{"title":"Append floating-rate period","deprecated":null,"version":null,"sidebarTitle":"Append floating rate period","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/rate-tables/{id}/periods","href":"/en/reference/products/lender/append-floating-rate-period"}]},{"group":"Document templates","pages":[{"title":"List document template versions","deprecated":null,"version":null,"sidebarTitle":"List document template versions","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-products/{productId}/document-templates","href":"/en/reference/products/lender/list-document-template-versions"},{"title":"Create document template draft","deprecated":null,"version":null,"sidebarTitle":"Create document template draft","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-products/{productId}/document-templates","href":"/en/reference/products/lender/create-document-template-draft"},{"title":"Get active document template","deprecated":null,"version":null,"sidebarTitle":"Get active document template","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-products/{productId}/document-templates/active","href":"/en/reference/products/lender/get-active-document-template"},{"title":"Get document template version","deprecated":null,"version":null,"sidebarTitle":"Get document template version","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-products/{productId}/document-templates/{templateId}","href":"/en/reference/products/lender/get-document-template-version"},{"title":"Publish document template","deprecated":null,"version":null,"sidebarTitle":"Publish document template","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-products/{productId}/document-templates/{templateId}/publish","href":"/en/reference/products/lender/publish-document-template"}]},{"group":"Loan Applications","pages":[{"title":"List loan applications","deprecated":null,"version":null,"sidebarTitle":"List loan applications","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-applications","href":"/en/reference/products/lender/list-loan-applications"},{"title":"Create loan application","deprecated":null,"version":null,"sidebarTitle":"Create loan application","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-applications","href":"/en/reference/products/lender/create-loan-application"},{"title":"Get loan application","deprecated":null,"version":null,"sidebarTitle":"Get loan application","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-applications/{id}","href":"/en/reference/products/lender/get-loan-application"},{"title":"Preview amortisation schedule","deprecated":null,"version":null,"sidebarTitle":"Preview loan schedule","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-applications/preview-schedule","href":"/en/reference/products/lender/preview-loan-schedule"},{"title":"Approve loan application","deprecated":null,"version":null,"sidebarTitle":"Approve loan application","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-applications/{id}/approve","href":"/en/reference/products/lender/approve-loan-application"},{"title":"Disburse loan application","deprecated":null,"version":null,"sidebarTitle":"Disburse loan application","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-applications/{id}/disburse","href":"/en/reference/products/lender/disburse-loan-application"},{"title":"Reject loan application","deprecated":null,"version":null,"sidebarTitle":"Reject loan application","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-applications/{id}/reject","href":"/en/reference/products/lender/reject-loan-application"},{"title":"Withdraw loan application","deprecated":null,"version":null,"sidebarTitle":"Withdraw loan application","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-applications/{id}/withdraw","href":"/en/reference/products/lender/withdraw-loan-application"},{"title":"Ingest BR capitalization clause consent","deprecated":null,"version":null,"sidebarTitle":"Ingest capitalization clause consent","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/br/loan-applications/{id}/capitalization-consents","href":"/en/reference/products/lender/ingest-capitalization-clause-consent"}]},{"group":"Credit instruments","pages":[{"title":"List credit instruments","deprecated":null,"version":null,"sidebarTitle":"List credit instruments","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-applications/{applicationId}/credit-instruments","href":"/en/reference/products/lender/list-credit-instruments"},{"title":"Issue credit instrument","deprecated":null,"version":null,"sidebarTitle":"Issue credit instrument","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-applications/{applicationId}/credit-instruments","href":"/en/reference/products/lender/issue-credit-instrument"},{"title":"Download credit instrument","deprecated":null,"version":null,"sidebarTitle":"Download credit instrument","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-applications/{applicationId}/credit-instruments/{instrumentId}/download","href":"/en/reference/products/lender/download-credit-instrument"}]},{"group":"Regulatory disclosures and risk","pages":[{"title":"Get loan account CET disclosure","deprecated":null,"version":null,"sidebarTitle":"Get loan account cet disclosure","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/br/loan-accounts/{id}/cet-disclosure","href":"/en/reference/products/lender/get-loan-account-cet-disclosure"},{"title":"Get credit operation descriptor","deprecated":null,"version":null,"sidebarTitle":"Get loan account credit operation descriptor","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/br/loan-accounts/{id}/credit-descriptor","href":"/en/reference/products/lender/get-loan-account-credit-operation-descriptor"},{"title":"Get loan account PDD stage","deprecated":null,"version":null,"sidebarTitle":"Get loan account pdd stage","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/br/loan-accounts/{id}/pdd-stage","href":"/en/reference/products/lender/get-loan-account-pdd-stage"},{"title":"Apply loan account PDD stage transition","deprecated":null,"version":null,"sidebarTitle":"Apply loan account pdd stage transition","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/br/loan-accounts/{id}/pdd-stage/transitions","href":"/en/reference/products/lender/apply-loan-account-pdd-stage-transition"},{"title":"Publish a PDD stage ladder version","deprecated":null,"version":null,"sidebarTitle":"Publish a pdd stage ladder version","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/br/pdd-stage-ladders","href":"/en/reference/products/lender/publish-a-pdd-stage-ladder-version"},{"title":"Get the PDD stage ladder in force","deprecated":null,"version":null,"sidebarTitle":"Get the pdd stage ladder in force","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/br/pdd-stage-ladders/in-force","href":"/en/reference/products/lender/get-the-pdd-stage-ladder-in-force"},{"title":"List qualitative problem-asset assessments","deprecated":null,"version":null,"sidebarTitle":"List qualitative problem asset assessments","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/br/loan-accounts/{id}/problem-asset-assessments","href":"/en/reference/products/lender/list-qualitative-problem-asset-assessments"},{"title":"Declare a qualitative problem-asset assessment","deprecated":null,"version":null,"sidebarTitle":"Declare a qualitative problem asset assessment","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/br/loan-accounts/{id}/problem-asset-assessments","href":"/en/reference/products/lender/declare-a-qualitative-problem-asset-assessment"},{"title":"List contracts overdue for problem-asset re-assessment","deprecated":null,"version":null,"sidebarTitle":"List contracts overdue for problem asset re assessment","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/br/problem-asset-reassessment-overdue","href":"/en/reference/products/lender/list-contracts-overdue-for-problem-asset-re-assessment"},{"title":"Set the problem-asset re-assessment horizon of a loan product version","deprecated":null,"version":null,"sidebarTitle":"Set the problem asset re assessment horizon of a loan product version","openapi":"/en/openapi/v3-current/lender.yaml put /api/v1/br/loan-product-versions/{id}/problem-asset-reassessment-horizon","href":"/en/reference/products/lender/set-the-problem-asset-re-assessment-horizon-of-a-loan-product-version"}]},{"group":"Payoff and prepayment","pages":[{"title":"Get payoff statement","deprecated":null,"version":null,"sidebarTitle":"Get payoff statement","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/br/loan-accounts/{id}/payoff-statements/{quote_id}","href":"/en/reference/products/lender/get-payoff-statement"},{"title":"Create prepayment quote","deprecated":null,"version":null,"sidebarTitle":"Create prepayment quote","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/br/loan-accounts/{id}/prepayment-quote","href":"/en/reference/products/lender/create-prepayment-quote"},{"title":"Prepay loan account (BR alias)","deprecated":null,"version":null,"sidebarTitle":"Prepay loan account br","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/br/loan-accounts/{id}/prepayments","href":"/en/reference/products/lender/prepay-loan-account-br"},{"title":"Prepay loan account","deprecated":null,"version":null,"sidebarTitle":"Prepay loan account","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-accounts/{id}/prepayments","href":"/en/reference/products/lender/prepay-loan-account"}]},{"group":"Account overview and audit","pages":[{"title":"List loan accounts","deprecated":null,"version":null,"sidebarTitle":"List loan accounts","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-accounts","href":"/en/reference/products/lender/list-loan-accounts"},{"title":"Get active loan account","deprecated":null,"version":null,"sidebarTitle":"Get active loan account","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-accounts/{id}","href":"/en/reference/products/lender/get-active-loan-account"},{"title":"List loan account audit events","deprecated":null,"version":null,"sidebarTitle":"List loan account audit events huma","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-accounts/{id}/audit-events","href":"/en/reference/products/lender/list-loan-account-audit-events-huma"}]},{"group":"Charges and schedule","pages":[{"title":"List active loan charges","deprecated":null,"version":null,"sidebarTitle":"List active loan charges","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-accounts/{id}/charges","href":"/en/reference/products/lender/list-active-loan-charges"},{"title":"Reschedule loan account","deprecated":null,"version":null,"sidebarTitle":"Reschedule loan account","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-accounts/{id}/reschedules","href":"/en/reference/products/lender/reschedule-loan-account"},{"title":"Get active loan schedule","deprecated":null,"version":null,"sidebarTitle":"Get active loan schedule","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-accounts/{id}/schedule","href":"/en/reference/products/lender/get-active-loan-schedule"}]},{"group":"Repayments","pages":[{"title":"Preview repayment allocation","deprecated":null,"version":null,"sidebarTitle":"Preview repayment","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-accounts/{id}/preview-repayment","href":"/en/reference/products/lender/preview-repayment"},{"title":"Record repayment","deprecated":null,"version":null,"sidebarTitle":"Record repayment","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-accounts/{id}/repayments","href":"/en/reference/products/lender/record-repayment"}]},{"group":"Transactions","pages":[{"title":"List active loan transactions","deprecated":null,"version":null,"sidebarTitle":"List active loan transactions","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-accounts/{id}/transactions","href":"/en/reference/products/lender/list-active-loan-transactions"},{"title":"Reverse loan account transaction","deprecated":null,"version":null,"sidebarTitle":"Reverse loan account transaction","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/loan-accounts/{id}/transactions/{transactionId}/reverse","href":"/en/reference/products/lender/reverse-loan-account-transaction"}]},{"group":"Returned payment receivables","pages":[{"title":"List returned payment receivables","deprecated":null,"version":null,"sidebarTitle":"List returned payment receivables","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/returned-payment-receivables","href":"/en/reference/products/lender/list-returned-payment-receivables"},{"title":"Get returned payment receivable","deprecated":null,"version":null,"sidebarTitle":"Get returned payment receivable","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/returned-payment-receivables/{id}","href":"/en/reference/products/lender/get-returned-payment-receivable"},{"title":"Record a returned payment receivable collection","deprecated":null,"version":null,"sidebarTitle":"Record a returned payment receivable collection","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/returned-payment-receivables/{id}/collections","href":"/en/reference/products/lender/record-a-returned-payment-receivable-collection"}]},{"group":"Assignment funds","pages":[{"title":"List assignment funds","deprecated":null,"version":null,"sidebarTitle":"List assignment funds","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/assignment/funds","href":"/en/reference/products/lender/list-assignment-funds"},{"title":"Register or update an assignment fund","deprecated":null,"version":null,"sidebarTitle":"Register or update an assignment fund","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/assignment/funds","href":"/en/reference/products/lender/register-or-update-an-assignment-fund"},{"title":"Get assignment fund","deprecated":null,"version":null,"sidebarTitle":"Get assignment fund","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/assignment/funds/{fundId}","href":"/en/reference/products/lender/get-assignment-fund"},{"title":"List assignment candidates with eligibility verdicts","deprecated":null,"version":null,"sidebarTitle":"List assignment candidates with eligibility verdicts","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/assignment/funds/{fundId}/candidates","href":"/en/reference/products/lender/list-assignment-candidates-with-eligibility-verdicts"},{"title":"List assignment fund document template versions","deprecated":null,"version":null,"sidebarTitle":"List assignment fund document template versions","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/assignment/funds/{fundId}/document-templates","href":"/en/reference/products/lender/list-assignment-fund-document-template-versions"},{"title":"Create assignment fund document template draft","deprecated":null,"version":null,"sidebarTitle":"Create assignment fund document template draft","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/assignment/funds/{fundId}/document-templates","href":"/en/reference/products/lender/create-assignment-fund-document-template-draft"},{"title":"Get active assignment fund document template","deprecated":null,"version":null,"sidebarTitle":"Get active assignment fund document template","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/assignment/funds/{fundId}/document-templates/active","href":"/en/reference/products/lender/get-active-assignment-fund-document-template"},{"title":"Get assignment fund document template version","deprecated":null,"version":null,"sidebarTitle":"Get assignment fund document template version","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/assignment/funds/{fundId}/document-templates/{templateId}","href":"/en/reference/products/lender/get-assignment-fund-document-template-version"},{"title":"Publish assignment fund document template","deprecated":null,"version":null,"sidebarTitle":"Publish assignment fund document template","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/assignment/funds/{fundId}/document-templates/{templateId}/publish","href":"/en/reference/products/lender/publish-assignment-fund-document-template"}]},{"group":"Assignment sets","pages":[{"title":"List assignment sets","deprecated":null,"version":null,"sidebarTitle":"List assignment sets","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/assignment/sets","href":"/en/reference/products/lender/list-assignment-sets"},{"title":"Assemble an assignment set","deprecated":null,"version":null,"sidebarTitle":"Assemble an assignment set","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/assignment/sets","href":"/en/reference/products/lender/assemble-an-assignment-set"},{"title":"Get assignment set","deprecated":null,"version":null,"sidebarTitle":"Get assignment set","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/assignment/sets/{setId}","href":"/en/reference/products/lender/get-assignment-set"},{"title":"Score an assignment set against its fund's rule","deprecated":null,"version":null,"sidebarTitle":"Score an assignment set against its fund s rule","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/eligibility","href":"/en/reference/products/lender/score-an-assignment-set-against-its-fund-s-rule"},{"title":"Approve an assignment set","deprecated":null,"version":null,"sidebarTitle":"Approve an assignment set","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/approve","href":"/en/reference/products/lender/approve-an-assignment-set"},{"title":"Discard an assignment set","deprecated":null,"version":null,"sidebarTitle":"Discard an assignment set","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/discard","href":"/en/reference/products/lender/discard-an-assignment-set"},{"title":"Record the assignment set's endorsement term","deprecated":null,"version":null,"sidebarTitle":"Record the assignment set s endorsement term","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/term","href":"/en/reference/products/lender/record-the-assignment-set-s-endorsement-term"},{"title":"Download the offer file of an approved assignment set","deprecated":null,"version":null,"sidebarTitle":"Download the offer file of an approved assignment set","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/assignment/sets/{setId}/offer-file","href":"/en/reference/products/lender/download-the-offer-file-of-an-approved-assignment-set"},{"title":"Ingest the fund administrator's return file for an assignment set","deprecated":null,"version":null,"sidebarTitle":"Ingest the fund administrator s return file for an assignment set","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/remessa","href":"/en/reference/products/lender/ingest-the-fund-administrator-s-return-file-for-an-assignment-set"},{"title":"Record an externally-observed fact about an assignment set","deprecated":null,"version":null,"sidebarTitle":"Record an externally observed fact about an assignment set","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/facts","href":"/en/reference/products/lender/record-an-externally-observed-fact-about-an-assignment-set"},{"title":"End one receivable's funding obligation before its term","deprecated":null,"version":null,"sidebarTitle":"End one receivable s funding obligation before its term","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/funding-payoff","href":"/en/reference/products/lender/end-one-receivable-s-funding-obligation-before-its-term"}]},{"group":"Assignment exceptions and registry","pages":[{"title":"List the assignment exception queue","deprecated":null,"version":null,"sidebarTitle":"List the assignment exception queue","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/assignment/exceptions","href":"/en/reference/products/lender/list-the-assignment-exception-queue"},{"title":"Record a disposition against one exception case","deprecated":null,"version":null,"sidebarTitle":"Record a disposition against one exception case","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/assignment/exceptions/{caseId}/resolve","href":"/en/reference/products/lender/record-a-disposition-against-one-exception-case"},{"title":"Get receivable assignment dossier","deprecated":null,"version":null,"sidebarTitle":"Get receivable assignment dossier","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/assignment/receivables/{receivableRef}/dossier","href":"/en/reference/products/lender/get-receivable-assignment-dossier"},{"title":"Register a receivable's credit instrument at the registradora","deprecated":null,"version":null,"sidebarTitle":"Register a receivable s credit instrument at the registradora","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/assignment/receivables/{receivableRef}/registry-registration","href":"/en/reference/products/lender/register-a-receivable-s-credit-instrument-at-the-registradora"}]},{"group":"Accounting","pages":[{"title":"List accounting profiles","deprecated":null,"version":null,"sidebarTitle":"List accounting profiles","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/accounting-profiles","href":"/en/reference/products/lender/list-accounting-profiles"},{"title":"Create accrual run","deprecated":null,"version":null,"sidebarTitle":"Create accrual run","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/accrual-runs","href":"/en/reference/products/lender/create-accrual-run"},{"title":"List accrual runs","deprecated":null,"version":null,"sidebarTitle":"List accrual runs","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/accrual-runs","href":"/en/reference/products/lender/list-accrual-runs"},{"title":"Get accrual run","deprecated":null,"version":null,"sidebarTitle":"Get accrual run","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/accrual-runs/{id}","href":"/en/reference/products/lender/get-accrual-run"},{"title":"List accrual run decisions","deprecated":null,"version":null,"sidebarTitle":"List accrual run decisions","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/accrual-runs/{id}/items","href":"/en/reference/products/lender/list-accrual-run-decisions"},{"title":"Retry accrual run items","deprecated":null,"version":null,"sidebarTitle":"Retry accrual run items","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/accrual-runs/{id}/retry","href":"/en/reference/products/lender/retry-accrual-run-items"},{"title":"Get journal reference by correlation id","deprecated":null,"version":null,"sidebarTitle":"Get journal reference","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/journal-references","href":"/en/reference/products/lender/get-journal-reference"},{"title":"Get journal reference by id","deprecated":null,"version":null,"sidebarTitle":"Get journal reference by id","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/journal-references/{id}","href":"/en/reference/products/lender/get-journal-reference-by-id"},{"title":"Reconcile a contract's deferred origination fee","deprecated":null,"version":null,"sidebarTitle":"Reconcile a contract s deferred origination fee","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/loan-accounts/{id}/deferred-fee-reconciliation","href":"/en/reference/products/lender/reconcile-a-contract-s-deferred-origination-fee"}]},{"group":"Portfolio dashboards","pages":[{"title":"Get portfolio dashboard","deprecated":null,"version":null,"sidebarTitle":"Get portfolio dashboard","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/dashboard/portfolio","href":"/en/reference/products/lender/get-portfolio-dashboard"},{"title":"List delinquent loans","deprecated":null,"version":null,"sidebarTitle":"List delinquent loans","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/dashboard/delinquent-loans","href":"/en/reference/products/lender/list-delinquent-loans"},{"title":"List delinquent loans (Brazil)","deprecated":null,"version":null,"sidebarTitle":"List delinquent loans brazil","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/br/dashboard/delinquent-loans","href":"/en/reference/products/lender/list-delinquent-loans-brazil"}]},{"group":"Jurisdictions","pages":[{"title":"List registered jurisdictions","deprecated":null,"version":null,"sidebarTitle":"List jurisdictions","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/jurisdictions","href":"/en/reference/products/lender/list-jurisdictions"},{"title":"Get jurisdiction by code","deprecated":null,"version":null,"sidebarTitle":"Get jurisdiction","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/jurisdictions/{code}","href":"/en/reference/products/lender/get-jurisdiction"}]},{"group":"Tax","pages":[{"title":"Preview jurisdiction tax amounts","deprecated":null,"version":null,"sidebarTitle":"Preview tax","openapi":"/en/openapi/v3-current/lender.yaml post /api/v1/br/tax/preview","href":"/en/reference/products/lender/preview-tax"}]},{"group":"Session","pages":[{"title":"Get current session","deprecated":null,"version":null,"sidebarTitle":"Get current session","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/me","href":"/en/reference/products/lender/get-current-session"}]},{"group":"Streaming","pages":[{"title":"List quarantined inbound records","deprecated":null,"version":null,"sidebarTitle":"List quarantined inbound records","openapi":"/en/openapi/v3-current/lender.yaml get /api/v1/internal/streaming/discards","href":"/en/reference/products/lender/list-quarantined-inbound-records"}]},{"group":"Error handling","pages":[{"title":"Lender error list","href":"/en/reference/products/lender/lender-error-list"}]},{"group":"Events","pages":[{"title":"Lender events","href":"/en/reference/events/lender"}]}]},{"dropdown":"Reporter","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/reporter-yellow.png","description":"Report templates, generation, and deadlines","groups":[{"group":"Getting started","pages":[{"title":"Reporter API quick start","href":"/en/reference/products/reporter/reporter-developer-quick-start"}]},{"group":"Templates API","pages":[{"title":"Create a template","deprecated":null,"version":null,"sidebarTitle":"Upload template","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/templates","href":"/en/reference/products/reporter/upload-template"},{"title":"List templates","deprecated":null,"version":null,"sidebarTitle":"List templates","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/templates","href":"/en/reference/products/reporter/list-templates"},{"title":"Get a template","deprecated":null,"version":null,"sidebarTitle":"Retrieve template details","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/templates/{id}","href":"/en/reference/products/reporter/retrieve-template-details"},{"title":"Update a template","deprecated":null,"version":null,"sidebarTitle":"Update templates","openapi":"/en/openapi/v3-current/reporter.yaml patch /v1/templates/{id}","href":"/en/reference/products/reporter/update-templates"},{"title":"Delete a template","deprecated":null,"version":null,"sidebarTitle":"Delete template","openapi":"/en/openapi/v3-current/reporter.yaml delete /v1/templates/{id}","href":"/en/reference/products/reporter/delete-template"},{"title":"Get a template's content","deprecated":null,"version":null,"sidebarTitle":"Get template content","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/templates/{id}/content","href":"/en/reference/products/reporter/get-template-content"},{"title":"List the report families in use","deprecated":null,"version":null,"sidebarTitle":"List report families","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/templates/categories","href":"/en/reference/products/reporter/list-report-families"},{"title":"File many templates under one report family","deprecated":null,"version":null,"sidebarTitle":"Assign report family","openapi":"/en/openapi/v3-current/reporter.yaml patch /v1/templates/category","href":"/en/reference/products/reporter/assign-report-family"},{"title":"Preview a template","deprecated":null,"version":null,"sidebarTitle":"Preview template","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/templates/preview","href":"/en/reference/products/reporter/preview-template"}]},{"group":"Template Builder API","pages":[{"title":"Get template block configuration","deprecated":null,"version":null,"sidebarTitle":"List block definitions","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/templates/blocks-config","href":"/en/reference/products/reporter/list-block-definitions"},{"title":"Get template filters","deprecated":null,"version":null,"sidebarTitle":"List filter definitions","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/templates/filters","href":"/en/reference/products/reporter/list-filter-definitions"},{"title":"Generate template code","deprecated":null,"version":null,"sidebarTitle":"Generate template code","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/templates/generate-code","href":"/en/reference/products/reporter/generate-template-code"},{"title":"Validate template blocks","deprecated":null,"version":null,"sidebarTitle":"Validate template blocks","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/templates/validate","href":"/en/reference/products/reporter/validate-template-blocks"}]},{"group":"Reports API","pages":[{"title":"Create a report","deprecated":null,"version":null,"sidebarTitle":"Create report","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/reports","href":"/en/reference/products/reporter/create-report"},{"title":"Get a report","deprecated":null,"version":null,"sidebarTitle":"Check report status","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/reports/{id}","href":"/en/reference/products/reporter/check-report-status"},{"title":"List reports","deprecated":null,"version":null,"sidebarTitle":"Retrieve reports","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/reports","href":"/en/reference/products/reporter/retrieve-reports"},{"title":"Download a report","deprecated":null,"version":null,"sidebarTitle":"Download report","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/reports/{id}/download","href":"/en/reference/products/reporter/download-report"}]},{"group":"Deadlines API","pages":[{"title":"Create a deadline","deprecated":null,"version":null,"sidebarTitle":"Create deadline","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/deadlines","href":"/en/reference/products/reporter/create-deadline"},{"title":"List deadlines","deprecated":null,"version":null,"sidebarTitle":"Retrieve deadlines","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/deadlines","href":"/en/reference/products/reporter/retrieve-deadlines"},{"title":"List deadline notifications","deprecated":null,"version":null,"sidebarTitle":"Retrieve deadline notifications","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/deadlines/notifications","href":"/en/reference/products/reporter/retrieve-deadline-notifications"},{"title":"Update a deadline","deprecated":null,"version":null,"sidebarTitle":"Update deadline","openapi":"/en/openapi/v3-current/reporter.yaml patch /v1/deadlines/{id}","href":"/en/reference/products/reporter/update-deadline"},{"title":"Delete a deadline","deprecated":null,"version":null,"sidebarTitle":"Delete deadline","openapi":"/en/openapi/v3-current/reporter.yaml delete /v1/deadlines/{id}","href":"/en/reference/products/reporter/delete-deadline"},{"title":"Set deadline delivery state","deprecated":null,"version":null,"sidebarTitle":"Deliver deadline","openapi":"/en/openapi/v3-current/reporter.yaml patch /v1/deadlines/{id}/deliver","href":"/en/reference/products/reporter/deliver-deadline"}]},{"group":"Data Sources API","pages":[{"title":"Create a data source","deprecated":null,"version":null,"sidebarTitle":"Create data source","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/data-sources","href":"/en/reference/products/reporter/create-data-source"},{"title":"List data sources","deprecated":null,"version":null,"sidebarTitle":"List data sources","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/data-sources","href":"/en/reference/products/reporter/list-data-sources"},{"title":"Get a data source","deprecated":null,"version":null,"sidebarTitle":"Retrieve data source","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/data-sources/{dataSourceId}","href":"/en/reference/products/reporter/retrieve-data-source"},{"title":"Update a data source","deprecated":null,"version":null,"sidebarTitle":"Update data source","openapi":"/en/openapi/v3-current/reporter.yaml patch /v1/data-sources/{dataSourceId}","href":"/en/reference/products/reporter/update-data-source"},{"title":"Delete a data source","deprecated":null,"version":null,"sidebarTitle":"Delete data source","openapi":"/en/openapi/v3-current/reporter.yaml delete /v1/data-sources/{dataSourceId}","href":"/en/reference/products/reporter/delete-data-source"},{"title":"Get a data source schema","deprecated":null,"version":null,"sidebarTitle":"Get data source schema","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/data-sources/{dataSourceId}/schema","href":"/en/reference/products/reporter/get-data-source-schema"},{"title":"Test a data source connection","deprecated":null,"version":null,"sidebarTitle":"Test data source connection","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/data-sources/{dataSourceId}/test-connection","href":"/en/reference/products/reporter/test-data-source-connection"}]},{"group":"Institutions API","pages":[{"title":"Register an institution","deprecated":null,"version":null,"sidebarTitle":"Create institution","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/institutions","href":"/en/reference/products/reporter/create-institution"},{"title":"List institutions","deprecated":null,"version":null,"sidebarTitle":"List institutions","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/institutions","href":"/en/reference/products/reporter/list-institutions"},{"title":"Get an institution","deprecated":null,"version":null,"sidebarTitle":"Get institution","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/institutions/{institutionId}","href":"/en/reference/products/reporter/get-institution"},{"title":"Replace an institution","deprecated":null,"version":null,"sidebarTitle":"Replace institution","openapi":"/en/openapi/v3-current/reporter.yaml put /v1/institutions/{institutionId}","href":"/en/reference/products/reporter/replace-institution"},{"title":"Delete an institution","deprecated":null,"version":null,"sidebarTitle":"Delete institution","openapi":"/en/openapi/v3-current/reporter.yaml delete /v1/institutions/{institutionId}","href":"/en/reference/products/reporter/delete-institution"},{"title":"Propose institutions from Midaz","deprecated":null,"version":null,"sidebarTitle":"Propose institutions","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/institutions/proposals","href":"/en/reference/products/reporter/propose-institutions"}]},{"group":"Regulatory Catalog API","pages":[{"title":"List the regulatory documents this deployment can file","deprecated":null,"version":null,"sidebarTitle":"List regulatory documents","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/regulatory/documents","href":"/en/reference/products/reporter/list-regulatory-documents"},{"title":"Get one regulatory document","deprecated":null,"version":null,"sidebarTitle":"Get regulatory document","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/regulatory/documents/{documentId}","href":"/en/reference/products/reporter/get-regulatory-document"},{"title":"Get what a document's file needs","deprecated":null,"version":null,"sidebarTitle":"Get document contract","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/regulatory/documents/{documentId}/contract","href":"/en/reference/products/reporter/get-document-contract"}]},{"group":"Regulatory Subscriptions API","pages":[{"title":"Activate a regulatory document","deprecated":null,"version":null,"sidebarTitle":"Create subscription","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/regulatory/subscriptions","href":"/en/reference/products/reporter/create-subscription"},{"title":"List the documents this tenant files","deprecated":null,"version":null,"sidebarTitle":"List subscriptions","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/regulatory/subscriptions","href":"/en/reference/products/reporter/list-subscriptions"},{"title":"Get one activated document","deprecated":null,"version":null,"sidebarTitle":"Get subscription","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/regulatory/subscriptions/{subscriptionId}","href":"/en/reference/products/reporter/get-subscription"},{"title":"Set the institution that files a subscription","deprecated":null,"version":null,"sidebarTitle":"Set subscription institution","openapi":"/en/openapi/v3-current/reporter.yaml put /v1/regulatory/subscriptions/{subscriptionId}/institution","href":"/en/reference/products/reporter/set-subscription-institution"},{"title":"Adopt another version of the subscribed document","deprecated":null,"version":null,"sidebarTitle":"Adopt document version","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/regulatory/subscriptions/{subscriptionId}/adopt","href":"/en/reference/products/reporter/adopt-document-version"},{"title":"Stop filing a document","deprecated":null,"version":null,"sidebarTitle":"Deactivate subscription","openapi":"/en/openapi/v3-current/reporter.yaml delete /v1/regulatory/subscriptions/{subscriptionId}","href":"/en/reference/products/reporter/deactivate-subscription"},{"title":"Reactivate a deactivated subscription","deprecated":null,"version":null,"sidebarTitle":"Reactivate subscription","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/regulatory/subscriptions/{subscriptionId}/reactivate","href":"/en/reference/products/reporter/reactivate-subscription"}]},{"group":"Regulatory Bindings API","pages":[{"title":"Get the mapping in force","deprecated":null,"version":null,"sidebarTitle":"Get subscription mapping","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/regulatory/subscriptions/{subscriptionId}/binding","href":"/en/reference/products/reporter/get-subscription-mapping"},{"title":"Replace the mapping","deprecated":null,"version":null,"sidebarTitle":"Replace subscription mapping","openapi":"/en/openapi/v3-current/reporter.yaml put /v1/regulatory/subscriptions/{subscriptionId}/binding","href":"/en/reference/products/reporter/replace-subscription-mapping"},{"title":"Check the mapping against the databases as they are now","deprecated":null,"version":null,"sidebarTitle":"Check mapping readiness","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/regulatory/subscriptions/{subscriptionId}/gaps","href":"/en/reference/products/reporter/check-mapping-readiness"}]},{"group":"Regulatory Reports API","pages":[{"title":"Generate a filing of a subscribed document","deprecated":null,"version":null,"sidebarTitle":"Create regulatory report","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/regulatory/reports","href":"/en/reference/products/reporter/create-regulatory-report"},{"title":"Correct a draft and re-render it","deprecated":null,"version":null,"sidebarTitle":"Correct regulatory report","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/regulatory/reports/{reportId}/overrides","href":"/en/reference/products/reporter/correct-regulatory-report"},{"title":"Read the trail of corrections","deprecated":null,"version":null,"sidebarTitle":"List report corrections","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/regulatory/reports/{reportId}/overrides","href":"/en/reference/products/reporter/list-report-corrections"},{"title":"Approve a draft as the filing","deprecated":null,"version":null,"sidebarTitle":"Approve regulatory report","openapi":"/en/openapi/v3-current/reporter.yaml post /v1/regulatory/reports/{reportId}/approve","href":"/en/reference/products/reporter/approve-regulatory-report"},{"title":"Read what a report was made of, frozen","deprecated":null,"version":null,"sidebarTitle":"Get report provenance","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/regulatory/reports/{reportId}/provenance","href":"/en/reference/products/reporter/get-report-provenance"}]},{"group":"Metrics API","pages":[{"title":"Get system metrics","deprecated":null,"version":null,"sidebarTitle":"Get metrics","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/metrics","href":"/en/reference/products/reporter/get-metrics"}]},{"group":"Streaming API","pages":[{"title":"Get the streaming event manifest","deprecated":null,"version":null,"sidebarTitle":"Get streaming events","openapi":"/en/openapi/v3-current/reporter.yaml get /v1/streaming/events","href":"/en/reference/products/reporter/get-streaming-events"}]},{"group":"Error handling","pages":[{"title":"Reporter error list","href":"/en/reference/products/reporter/reporter-error-list"}]},{"group":"Events","pages":[{"title":"Reporter events","href":"/en/reference/events/reporter"}]}]}]},{"anchor":"Brazil Rails","icon":"money-bill-transfer","dropdowns":[{"dropdown":"SPB (TED)","icon":"building-columns","description":"TED messaging with BACEN over the SPB rail","groups":[{"group":"Audit","pages":[{"title":"List audit records","deprecated":null,"version":null,"sidebarTitle":"List audit records","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/audit-records","href":"/en/reference/rails/spb/list-audit-records"},{"title":"List audit records for an operation","deprecated":null,"version":null,"sidebarTitle":"List audit records for operation","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/operations/{operationId}/audit-records","href":"/en/reference/rails/spb/list-audit-records-for-operation"}]},{"group":"Capabilities","pages":[{"title":"List STR capabilities","deprecated":null,"version":null,"sidebarTitle":"List capabilities","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/capabilities","href":"/en/reference/rails/spb/list-capabilities"},{"title":"Get capability by ID","deprecated":null,"version":null,"sidebarTitle":"Get capability","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/capabilities/{capabilityId}","href":"/en/reference/rails/spb/get-capability"}]},{"group":"Certificates","pages":[{"title":"List certificate state","deprecated":null,"version":null,"sidebarTitle":"List certificates","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/certificates","href":"/en/reference/rails/spb/list-certificates"},{"title":"Activate ICP-Brasil certificate on the RSFN (GEN0006)","deprecated":null,"version":null,"sidebarTitle":"Activate certificate","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/certificates/activate","href":"/en/reference/rails/spb/activate-certificate"},{"title":"Rotate ICP-Brasil certificate","deprecated":null,"version":null,"sidebarTitle":"Rotate certificate","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/certificates/rotate","href":"/en/reference/rails/spb/rotate-certificate"}]},{"group":"Compulsory deposits (RCO)","pages":[{"title":"List third-party compulsory deposits","deprecated":null,"version":null,"sidebarTitle":"List rco advices","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/rco-advices","href":"/en/reference/rails/spb/list-rco-advices"},{"title":"Ask for the compulsory period calendar or read a filing back","deprecated":null,"version":null,"sidebarTitle":"Create rco filing query","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/rco-filing-queries","href":"/en/reference/rails/spb/create-rco-filing-query"},{"title":"List compulsory periods and their requirements","deprecated":null,"version":null,"sidebarTitle":"List rco filings","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/rco-filings","href":"/en/reference/rails/spb/list-rco-filings"},{"title":"File the compulsory statement (RCO0002)","deprecated":null,"version":null,"sidebarTitle":"Create rco filing","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/rco-filings","href":"/en/reference/rails/spb/create-rco-filing"},{"title":"List commanded compulsory movements","deprecated":null,"version":null,"sidebarTitle":"List rco movements","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/rco-movements","href":"/en/reference/rails/spb/list-rco-movements"},{"title":"Command a compulsory-account movement","deprecated":null,"version":null,"sidebarTitle":"Create rco movement","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/rco-movements","href":"/en/reference/rails/spb/create-rco-movement"},{"title":"Read one commanded compulsory movement","deprecated":null,"version":null,"sidebarTitle":"Get rco movement","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/rco-movements/{numCtrlIF}","href":"/en/reference/rails/spb/get-rco-movement"},{"title":"Run a compulsory compliance read","deprecated":null,"version":null,"sidebarTitle":"Create rco report query","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/rco-report-queries","href":"/en/reference/rails/spb/create-rco-report-query"}]},{"group":"Messages","pages":[{"title":"Initiate connectivity (ECO) test","deprecated":null,"version":null,"sidebarTitle":"Create connectivity test","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/connectivity-tests","href":"/en/reference/rails/spb/create-connectivity-test"},{"title":"List STR messages","deprecated":null,"version":null,"sidebarTitle":"List messages","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/messages","href":"/en/reference/rails/spb/list-messages"},{"title":"Compose and send a curated STR message","deprecated":null,"version":null,"sidebarTitle":"Compose str message","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/messages/compose","href":"/en/reference/rails/spb/compose-str-message"},{"title":"Get STR message detail","deprecated":null,"version":null,"sidebarTitle":"Get message status","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/messages/{nuOp}","href":"/en/reference/rails/spb/get-message-status"},{"title":"Get the signed STR message frame","deprecated":null,"version":null,"sidebarTitle":"Get message frame","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/messages/{nuOp}/frame","href":"/en/reference/rails/spb/get-message-frame"}]},{"group":"Emission approvals","pages":[{"title":"List emissions pending maker-checker approval","deprecated":null,"version":null,"sidebarTitle":"List emission approvals","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/emission-approvals","href":"/en/reference/rails/spb/list-emission-approvals"},{"title":"Approve (sign) a parked emission","deprecated":null,"version":null,"sidebarTitle":"Approve emission","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/emission-approvals/{id}/approve","href":"/en/reference/rails/spb/approve-emission"},{"title":"Deny a parked emission","deprecated":null,"version":null,"sidebarTitle":"Deny emission","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/emission-approvals/{id}/deny","href":"/en/reference/rails/spb/deny-emission"}]},{"group":"Event deliveries","pages":[{"title":"List event deliveries","deprecated":null,"version":null,"sidebarTitle":"List event deliveries","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/event-deliveries","href":"/en/reference/rails/spb/list-event-deliveries"},{"title":"Get event delivery","deprecated":null,"version":null,"sidebarTitle":"Get event delivery","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/event-deliveries/{deliveryId}","href":"/en/reference/rails/spb/get-event-delivery"},{"title":"Retry event delivery","deprecated":null,"version":null,"sidebarTitle":"Retry event delivery","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/event-deliveries/{deliveryId}/retry","href":"/en/reference/rails/spb/retry-event-delivery"}]},{"group":"Events","pages":[{"title":"List event catalog","deprecated":null,"version":null,"sidebarTitle":"List event catalog","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/events/catalog","href":"/en/reference/rails/spb/list-event-catalog"}]},{"group":"GEN notices","pages":[{"title":"List inbound GEN notices","deprecated":null,"version":null,"sidebarTitle":"List gen notices","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/gen-notices","href":"/en/reference/rails/spb/list-gen-notices"}]},{"group":"Governance","pages":[{"title":"Read the live alçada governance config","deprecated":null,"version":null,"sidebarTitle":"Get str governance","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/governance","href":"/en/reference/rails/spb/get-str-governance"},{"title":"Replace the alçada governance config","deprecated":null,"version":null,"sidebarTitle":"Put str governance","openapi":"/en/openapi/v3-current/spb.yaml put /v1/str/governance","href":"/en/reference/rails/spb/put-str-governance"}]},{"group":"Operational intelligence","pages":[{"title":"Get operational aggregates","deprecated":null,"version":null,"sidebarTitle":"Get operational aggregates","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/operational-aggregates","href":"/en/reference/rails/spb/get-operational-aggregates"},{"title":"Get operational summary","deprecated":null,"version":null,"sidebarTitle":"Get operational summary","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/operational-summary","href":"/en/reference/rails/spb/get-operational-summary"}]},{"group":"Operations","pages":[{"title":"List operations","deprecated":null,"version":null,"sidebarTitle":"List operations","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/operations","href":"/en/reference/rails/spb/list-operations"},{"title":"Set Conta-PI auto-transfer configuration","deprecated":null,"version":null,"sidebarTitle":"Create auto transfer config","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/operations/auto-transfer-config","href":"/en/reference/rails/spb/create-auto-transfer-config"},{"title":"Create bank transfer operation","deprecated":null,"version":null,"sidebarTitle":"Create bank transfer operation","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/operations/bank-transfers","href":"/en/reference/rails/spb/create-bank-transfer-operation"},{"title":"Create bank transfer cancellation operation","deprecated":null,"version":null,"sidebarTitle":"Create bank transfer cancellation operation","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/operations/bank-transfers/{operationId}/cancellations","href":"/en/reference/rails/spb/create-bank-transfer-cancellation-operation"},{"title":"Create bank transfer return operation","deprecated":null,"version":null,"sidebarTitle":"Create bank transfer return operation","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/operations/bank-transfers/{operationId}/returns","href":"/en/reference/rails/spb/create-bank-transfer-return-operation"},{"title":"Create IBS repasse operation","deprecated":null,"version":null,"sidebarTitle":"Create ibs repasse operation","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/operations/ibs-repasses","href":"/en/reference/rails/spb/create-ibs-repasse-operation"},{"title":"Create SILOC operational deposit (LDL0022)","deprecated":null,"version":null,"sidebarTitle":"Create ldl deposit","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/operations/ldl-deposits","href":"/en/reference/rails/spb/create-ldl-deposit"},{"title":"Create LDL settlement transfer (LDL0004/0006/0008/0011/0014)","deprecated":null,"version":null,"sidebarTitle":"Create ldl settlement","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/operations/ldl-settlements","href":"/en/reference/rails/spb/create-ldl-settlement"},{"title":"Create Conta-PI liquidity transfer","deprecated":null,"version":null,"sidebarTitle":"Create liquidity transfer operation","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/operations/liquidity-transfers","href":"/en/reference/rails/spb/create-liquidity-transfer-operation"},{"title":"Get Conta-PI liquidity transfer status","deprecated":null,"version":null,"sidebarTitle":"Get liquidity transfer","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/operations/liquidity-transfers/{operationId}","href":"/en/reference/rails/spb/get-liquidity-transfer"},{"title":"Create LTR transfer (LTR0003/0004/0006)","deprecated":null,"version":null,"sidebarTitle":"Create ltr transfer","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/operations/ltr-transfers","href":"/en/reference/rails/spb/create-ltr-transfer"},{"title":"Create SME electronic-money movement","deprecated":null,"version":null,"sidebarTitle":"Create sme transfer operation","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/operations/sme-transfers","href":"/en/reference/rails/spb/create-sme-transfer-operation"},{"title":"Get SME electronic-money movement status","deprecated":null,"version":null,"sidebarTitle":"Get sme transfer","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/operations/sme-transfers/{operationId}","href":"/en/reference/rails/spb/get-sme-transfer"},{"title":"Get operation detail","deprecated":null,"version":null,"sidebarTitle":"Get operation","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/operations/{operationId}","href":"/en/reference/rails/spb/get-operation"},{"title":"List operation timeline","deprecated":null,"version":null,"sidebarTitle":"Get operation timeline","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/operations/{operationId}/timeline","href":"/en/reference/rails/spb/get-operation-timeline"},{"title":"List stuck operations (operator dashboard)","deprecated":null,"version":null,"sidebarTitle":"List stuck operations","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/stuck-operations","href":"/en/reference/rails/spb/list-stuck-operations"},{"title":"Ask to close a deadline-expired transfer as failed","deprecated":null,"version":null,"sidebarTitle":"Submit stuck operation action","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/stuck-operations/actions","href":"/en/reference/rails/spb/submit-stuck-operation-action"},{"title":"Approve closing a deadline-expired transfer as failed","deprecated":null,"version":null,"sidebarTitle":"Approve stuck operation action","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/stuck-operations/actions/{railActionRef}/approve","href":"/en/reference/rails/spb/approve-stuck-operation-action"}]},{"group":"Readiness","pages":[{"title":"Get service readiness","deprecated":null,"version":null,"sidebarTitle":"Get readiness","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/readiness","href":"/en/reference/rails/spb/get-readiness"}]},{"group":"Reconciliation","pages":[{"title":"List quarantined inbound frames (operator triage)","deprecated":null,"version":null,"sidebarTitle":"List inbound quarantine","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/inbound-quarantine","href":"/en/reference/rails/spb/list-inbound-quarantine"},{"title":"Replay one quarantined inbound frame","deprecated":null,"version":null,"sidebarTitle":"Replay inbound quarantine frame","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/inbound-quarantine/{parkKey}/replay","href":"/en/reference/rails/spb/replay-inbound-quarantine-frame"},{"title":"List reconciliation cases","deprecated":null,"version":null,"sidebarTitle":"List reconciliation cases","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/reconciliations","href":"/en/reference/rails/spb/list-reconciliation-cases"},{"title":"Get reconciliation case","deprecated":null,"version":null,"sidebarTitle":"Get reconciliation case","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/reconciliations/{reconciliationId}","href":"/en/reference/rails/spb/get-reconciliation-case"},{"title":"Create reconciliation action","deprecated":null,"version":null,"sidebarTitle":"Create reconciliation action","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/reconciliations/{reconciliationId}/actions","href":"/en/reference/rails/spb/create-reconciliation-action"}]},{"group":"Rediscounts (RDC)","pages":[{"title":"Command a rediscount operation","deprecated":null,"version":null,"sidebarTitle":"Create rediscount","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/operations/rediscounts","href":"/en/reference/rails/spb/create-rediscount"},{"title":"Read rediscount operation status","deprecated":null,"version":null,"sidebarTitle":"Get rediscount","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/operations/rediscounts/{operationId}","href":"/en/reference/rails/spb/get-rediscount"},{"title":"Submit a rediscount query","deprecated":null,"version":null,"sidebarTitle":"Create rediscount query","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/rediscount-queries","href":"/en/reference/rails/spb/create-rediscount-query"},{"title":"Read rediscount query result","deprecated":null,"version":null,"sidebarTitle":"Get rediscount query","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/rediscount-queries/{nuOp}","href":"/en/reference/rails/spb/get-rediscount-query"}]},{"group":"Reports","pages":[{"title":"Movimento financeiro report","deprecated":null,"version":null,"sidebarTitle":"Get report movement","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/reports/movement","href":"/en/reference/rails/spb/get-report-movement"},{"title":"Transações rejeitadas report","deprecated":null,"version":null,"sidebarTitle":"Get report rejected","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/reports/rejected","href":"/en/reference/rails/spb/get-report-rejected"},{"title":"Volumetria report","deprecated":null,"version":null,"sidebarTitle":"Get report volumetria","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/reports/volumetria","href":"/en/reference/rails/spb/get-report-volumetria"}]},{"group":"Reserve queries","pages":[{"title":"Submit STR0013 reserve-account balance query","deprecated":null,"version":null,"sidebarTitle":"Create reserve balance query","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/reserve-balance-queries","href":"/en/reference/rails/spb/create-reserve-balance-query"},{"title":"Read STR0013 reserve-balance query result","deprecated":null,"version":null,"sidebarTitle":"Get reserve balance query","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/reserve-balance-queries/{id}","href":"/en/reference/rails/spb/get-reserve-balance-query"},{"title":"Submit STR0014 reserve-account statement query (message-mode)","deprecated":null,"version":null,"sidebarTitle":"Create reserve statement query","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/reserve-statement-queries","href":"/en/reference/rails/spb/create-reserve-statement-query"},{"title":"Read STR0014 reserve-statement query result (message-mode)","deprecated":null,"version":null,"sidebarTitle":"Get reserve statement query","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/reserve-statement-queries/{id}","href":"/en/reference/rails/spb/get-reserve-statement-query"}]},{"group":"Responsibles","pages":[{"title":"Update participant responsibles (GEN0019)","deprecated":null,"version":null,"sidebarTitle":"Update responsibles","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/responsibles","href":"/en/reference/rails/spb/update-responsibles"}]},{"group":"Schedule","pages":[{"title":"Get operating-schedule windows","deprecated":null,"version":null,"sidebarTitle":"Get schedule","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/schedule","href":"/en/reference/rails/spb/get-schedule"}]},{"group":"Schedule queries","pages":[{"title":"Submit STR0001 schedule query","deprecated":null,"version":null,"sidebarTitle":"Create schedule query","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/schedule-queries","href":"/en/reference/rails/spb/create-schedule-query"},{"title":"Read STR0001 schedule-query result","deprecated":null,"version":null,"sidebarTitle":"Get schedule query","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/schedule-queries/{id}","href":"/en/reference/rails/spb/get-schedule-query"}]},{"group":"Settings","pages":[{"title":"Get channel settings","deprecated":null,"version":null,"sidebarTitle":"Get settings","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/settings","href":"/en/reference/rails/spb/get-settings"},{"title":"Update channel settings","deprecated":null,"version":null,"sidebarTitle":"Update settings","openapi":"/en/openapi/v3-current/spb.yaml patch /v1/str/settings","href":"/en/reference/rails/spb/update-settings"}]},{"group":"BACEN charges (SLB)","pages":[{"title":"Pay BACEN an amount SLB never demanded","deprecated":null,"version":null,"sidebarTitle":"Create slb bacen payment","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/slb-bacen-payments","href":"/en/reference/rails/spb/create-slb-bacen-payment"},{"title":"Submit SLB0006 entry query","deprecated":null,"version":null,"sidebarTitle":"Create slb entry query","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/slb-entry-queries","href":"/en/reference/rails/spb/create-slb-entry-query"},{"title":"Read SLB0006 entry query result","deprecated":null,"version":null,"sidebarTitle":"Get slb entry query","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/slb-entry-queries/{nuOp}","href":"/en/reference/rails/spb/get-slb-entry-query"},{"title":"List outstanding SLB charges","deprecated":null,"version":null,"sidebarTitle":"List slb obligations","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/slb-obligations","href":"/en/reference/rails/spb/list-slb-obligations"},{"title":"Read one SLB charge","deprecated":null,"version":null,"sidebarTitle":"Get slb obligation","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/slb-obligations/{numCtrlSLB}","href":"/en/reference/rails/spb/get-slb-obligation"},{"title":"Authorise payment of an SLB charge","deprecated":null,"version":null,"sidebarTitle":"Create slb payment","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/slb-payments","href":"/en/reference/rails/spb/create-slb-payment"},{"title":"Read an SLB payment","deprecated":null,"version":null,"sidebarTitle":"Get slb payment","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/slb-payments/{nuOp}","href":"/en/reference/rails/spb/get-slb-payment"}]},{"group":"SME queries","pages":[{"title":"List received electronic-money advices","deprecated":null,"version":null,"sidebarTitle":"List sme advices","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/sme-advices","href":"/en/reference/rails/spb/list-sme-advices"},{"title":"Submit SME0003 CCME statement (extrato) query","deprecated":null,"version":null,"sidebarTitle":"Create sme statement query","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/sme-statement-queries","href":"/en/reference/rails/spb/create-sme-statement-query"},{"title":"Read SME0003 CCME statement (extrato) query result","deprecated":null,"version":null,"sidebarTitle":"Get sme statement query","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/sme-statement-queries/{nuOp}","href":"/en/reference/rails/spb/get-sme-statement-query"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"sidebarTitle":"List event webhooks","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/webhooks","href":"/en/reference/rails/spb/list-event-webhooks"},{"title":"Register webhook endpoint","deprecated":null,"version":null,"sidebarTitle":"Create event webhook","openapi":"/en/openapi/v3-current/spb.yaml post /v1/str/webhooks","href":"/en/reference/rails/spb/create-event-webhook"},{"title":"Delete webhook endpoint","deprecated":null,"version":null,"sidebarTitle":"Delete event webhook","openapi":"/en/openapi/v3-current/spb.yaml delete /v1/str/webhooks/{webhookId}","href":"/en/reference/rails/spb/delete-event-webhook"},{"title":"Get webhook endpoint","deprecated":null,"version":null,"sidebarTitle":"Get event webhook","openapi":"/en/openapi/v3-current/spb.yaml get /v1/str/webhooks/{webhookId}","href":"/en/reference/rails/spb/get-event-webhook"},{"title":"Update webhook endpoint","deprecated":null,"version":null,"sidebarTitle":"Update event webhook","openapi":"/en/openapi/v3-current/spb.yaml patch /v1/str/webhooks/{webhookId}","href":"/en/reference/rails/spb/update-event-webhook"}]},{"group":"Error handling","pages":[{"title":"SPB error list","href":"/en/reference/rails/spb/spb-error-list"}]}]},{"dropdown":"SPI (Pix)","icon":"bolt","description":"Pix messaging with BACEN over the SPI rail","groups":[{"group":"SPI · Account and settlement reports","pages":[{"title":"Request a Conta PI account report","deprecated":null,"version":null,"sidebarTitle":"Create account report request","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/account-reports/requests","href":"/en/reference/rails/spi/spi/create-account-report-request"},{"title":"Read a Conta PI balance (camt.053 result)","deprecated":null,"version":null,"sidebarTitle":"Get account report balance","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/account-reports/{correlationId}/balance","href":"/en/reference/rails/spi/spi/get-account-report-balance"},{"title":"Read a Conta PI extrato (camt.052 RCO lançamentos result)","deprecated":null,"version":null,"sidebarTitle":"Get account report extract","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/account-reports/{correlationId}/extract","href":"/en/reference/rails/spi/spi/get-account-report-extract"},{"title":"Report internally settled Pix transactions (MED 2.0)","deprecated":null,"version":null,"sidebarTitle":"Create settlement report","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/settlement-reports","href":"/en/reference/rails/spi/spi/create-settlement-report"}]},{"group":"SPI · Operations and recovery","pages":[{"title":"Initiate SPI connectivity test","deprecated":null,"version":null,"sidebarTitle":"Create connectivity test","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/connectivity-tests","href":"/en/reference/rails/spi/spi/create-connectivity-test"},{"title":"Create structured operation","deprecated":null,"version":null,"sidebarTitle":"Create structured operation","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/operations","href":"/en/reference/rails/spi/spi/create-structured-operation"},{"title":"List stuck operations (operator dashboard)","deprecated":null,"version":null,"sidebarTitle":"List stuck operations","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/operations/stuck","href":"/en/reference/rails/spi/spi/list-stuck-operations"},{"title":"Submit an operator verb against a stuck row","deprecated":null,"version":null,"sidebarTitle":"Submit stuck operation action","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/operations/stuck/actions","href":"/en/reference/rails/spi/spi/submit-stuck-operation-action"},{"title":"Get operation evidence","deprecated":null,"version":null,"sidebarTitle":"Get operation evidence","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/operations/{operationId}/evidence","href":"/en/reference/rails/spi/spi/get-operation-evidence"},{"title":"Request recovery action","deprecated":null,"version":null,"sidebarTitle":"Request recovery","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/operations/{operationId}/recovery/actions","href":"/en/reference/rails/spi/spi/request-recovery"},{"title":"Evaluate recovery eligibility","deprecated":null,"version":null,"sidebarTitle":"Evaluate recovery","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/operations/{operationId}/recovery/evaluate","href":"/en/reference/rails/spi/spi/evaluate-recovery"},{"title":"Manually resolve operation","deprecated":null,"version":null,"sidebarTitle":"Manual resolve operation","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/operations/{operationId}/recovery/manual-resolution","href":"/en/reference/rails/spi/spi/manual-resolve-operation"},{"title":"Get operation timeline","deprecated":null,"version":null,"sidebarTitle":"Get operation timeline","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/operations/{operationId}/timeline","href":"/en/reference/rails/spi/spi/get-operation-timeline"},{"title":"Execute recovery action","deprecated":null,"version":null,"sidebarTitle":"Execute recovery","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/recovery/actions/{recoveryActionId}/execute","href":"/en/reference/rails/spi/spi/execute-recovery"}]},{"group":"SPI · Mandates","pages":[{"title":"List recorded Pix Automático mandate operations (internal operator read)","deprecated":null,"version":null,"sidebarTitle":"List mandates","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/mandates","href":"/en/reference/rails/spi/spi/list-mandates"},{"title":"Request confirmation of a Pix Automático mandate (pain.009)","deprecated":null,"version":null,"sidebarTitle":"Create mandate request","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/mandates","href":"/en/reference/rails/spi/spi/create-mandate-request"},{"title":"Cancel a Pix Automático mandate (pain.011)","deprecated":null,"version":null,"sidebarTitle":"Create mandate cancellation","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/mandates/cancellations","href":"/en/reference/rails/spi/spi/create-mandate-cancellation"},{"title":"Accept or reject a Pix Automático mandate (pain.012)","deprecated":null,"version":null,"sidebarTitle":"Create mandate resolution","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/mandates/resolutions","href":"/en/reference/rails/spi/spi/create-mandate-resolution"},{"title":"Inspect a recorded Pix Automático mandate operation (internal operator read)","deprecated":null,"version":null,"sidebarTitle":"Get mandate","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/mandates/{mandateId}","href":"/en/reference/rails/spi/spi/get-mandate"}]},{"group":"SPI · Responsible parties","pages":[{"title":"Register Conta PI responsible contacts","deprecated":null,"version":null,"sidebarTitle":"Register responsibles","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/responsibles","href":"/en/reference/rails/spi/spi/register-responsibles"},{"title":"Get a participant's last-known Conta-PI responsibles","deprecated":null,"version":null,"sidebarTitle":"Get responsibles","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/responsibles/{ispb}","href":"/en/reference/rails/spi/spi/get-responsibles"}]},{"group":"SPI · Schedules","pages":[{"title":"List recorded Pix Automático schedule operations (internal operator read)","deprecated":null,"version":null,"sidebarTitle":"List schedules","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/scheduled-payments","href":"/en/reference/rails/spi/spi/list-schedules"},{"title":"Schedule a Pix Automático payment instruction (pain.013)","deprecated":null,"version":null,"sidebarTitle":"Create scheduled payment","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/scheduled-payments","href":"/en/reference/rails/spi/spi/create-scheduled-payment"},{"title":"Request cancellation of a Pix Automático schedule (camt.055)","deprecated":null,"version":null,"sidebarTitle":"Create schedule cancellation","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/scheduled-payments/cancellations","href":"/en/reference/rails/spi/spi/create-schedule-cancellation"},{"title":"Resolve a received cancellation request (camt.029)","deprecated":null,"version":null,"sidebarTitle":"Create schedule cancellation resolution","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/scheduled-payments/cancellations/resolutions","href":"/en/reference/rails/spi/spi/create-schedule-cancellation-resolution"},{"title":"Accept or reject a Pix Automático scheduled payment (pain.014)","deprecated":null,"version":null,"sidebarTitle":"Create scheduled payment resolution","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/scheduled-payments/resolutions","href":"/en/reference/rails/spi/spi/create-scheduled-payment-resolution"},{"title":"Inspect a recorded Pix Automático schedule operation (internal operator read)","deprecated":null,"version":null,"sidebarTitle":"Get schedule","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/scheduled-payments/{scheduleId}","href":"/en/reference/rails/spi/spi/get-schedule"}]},{"group":"SPI · Approvals","pages":[{"title":"Create approval request","deprecated":null,"version":null,"sidebarTitle":"Create approval","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/approvals","href":"/en/reference/rails/spi/spi/create-approval"},{"title":"Get approval","deprecated":null,"version":null,"sidebarTitle":"Get approval","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/approvals/{approvalId}","href":"/en/reference/rails/spi/spi/get-approval"},{"title":"Decide approval","deprecated":null,"version":null,"sidebarTitle":"Decide approval","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/approvals/{approvalId}/decision","href":"/en/reference/rails/spi/spi/decide-approval"}]},{"group":"SPI · Capabilities","pages":[{"title":"List SPI capabilities","deprecated":null,"version":null,"sidebarTitle":"List spi capabilities","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/capabilities","href":"/en/reference/rails/spi/spi/list-spi-capabilities"},{"title":"Get SPI capability by ID","deprecated":null,"version":null,"sidebarTitle":"Get spi capability","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/capabilities/{capabilityId}","href":"/en/reference/rails/spi/spi/get-spi-capability"}]},{"group":"SPI · Certificates","pages":[{"title":"List Pix certificates","deprecated":null,"version":null,"sidebarTitle":"List pix certificates","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/certificates","href":"/en/reference/rails/spi/spi/list-pix-certificates"},{"title":"Upload a Pix certificate (public .cer)","deprecated":null,"version":null,"sidebarTitle":"Upload pix certificate","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/certificates","href":"/en/reference/rails/spi/spi/upload-pix-certificate"},{"title":"Deactivate a Pix certificate","deprecated":null,"version":null,"sidebarTitle":"Deactivate pix certificate","openapi":"/en/openapi/v3-current/spi.yaml delete /api/v1/spi/certificates/{id}","href":"/en/reference/rails/spi/spi/deactivate-pix-certificate"},{"title":"Get a Pix certificate with its audit trail","deprecated":null,"version":null,"sidebarTitle":"Get pix certificate","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/certificates/{id}","href":"/en/reference/rails/spi/spi/get-pix-certificate"}]},{"group":"SPI · Evidence","pages":[{"title":"Create evidence export job","deprecated":null,"version":null,"sidebarTitle":"Create evidence export","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/evidence/exports","href":"/en/reference/rails/spi/spi/create-evidence-export"},{"title":"Get evidence export job","deprecated":null,"version":null,"sidebarTitle":"Get evidence export","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/evidence/exports/{exportId}","href":"/en/reference/rails/spi/spi/get-evidence-export"}]},{"group":"SPI · Messages","pages":[{"title":"List parked ICOM messages","deprecated":null,"version":null,"sidebarTitle":"List parked icom messages","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/icom/parked","href":"/en/reference/rails/spi/spi/list-parked-icom-messages"},{"title":"Get one parked ICOM message","deprecated":null,"version":null,"sidebarTitle":"Get parked icom message","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/icom/parked/{resourceId}","href":"/en/reference/rails/spi/spi/get-parked-icom-message"},{"title":"Replay a parked ICOM message","deprecated":null,"version":null,"sidebarTitle":"Replay parked icom message","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/icom/parked/{resourceId}/replay","href":"/en/reference/rails/spi/spi/replay-parked-icom-message"},{"title":"List the SPI message log","deprecated":null,"version":null,"sidebarTitle":"List message log","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/messages","href":"/en/reference/rails/spi/spi/list-message-log"},{"title":"Decide a parked inbound Pix","deprecated":null,"version":null,"sidebarTitle":"Process inbound message","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/messages/inbound/process","href":"/en/reference/rails/spi/spi/process-inbound-message"},{"title":"Validate inbound message","deprecated":null,"version":null,"sidebarTitle":"Validate inbound message","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/messages/inbound/validate","href":"/en/reference/rails/spi/spi/validate-inbound-message"},{"title":"Inspect a message-log entry and its correspondent","deprecated":null,"version":null,"sidebarTitle":"Get message log detail","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/messages/{messageRecordId}","href":"/en/reference/rails/spi/spi/get-message-log-detail"}]},{"group":"SPI · Payments","pages":[{"title":"List payments sent and received","deprecated":null,"version":null,"sidebarTitle":"List payments","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/payments","href":"/en/reference/rails/spi/spi/list-payments"},{"title":"Create payment","deprecated":null,"version":null,"sidebarTitle":"Create payment","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/payments","href":"/en/reference/rails/spi/spi/create-payment"},{"title":"Get payment","deprecated":null,"version":null,"sidebarTitle":"Get payment","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/payments/{endToEndID}","href":"/en/reference/rails/spi/spi/get-payment"},{"title":"Get payment history","deprecated":null,"version":null,"sidebarTitle":"Get payment history","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/payments/{endToEndID}/history","href":"/en/reference/rails/spi/spi/get-payment-history"},{"title":"Initiate payment return","deprecated":null,"version":null,"sidebarTitle":"Initiate payment return","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/payments/{endToEndID}/returns","href":"/en/reference/rails/spi/spi/initiate-payment-return"},{"title":"Get payment return status","deprecated":null,"version":null,"sidebarTitle":"Get payment return status","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/payments/{endToEndID}/returns/status","href":"/en/reference/rails/spi/spi/get-payment-return-status"},{"title":"Consultar Pix recebidos","deprecated":null,"version":null,"sidebarTitle":"List received pix","openapi":"/en/openapi/v3-current/spi.yaml post /api/v1/spi/pix","href":"/en/reference/rails/spi/spi/list-received-pix"},{"title":"List arriving Pix awaiting a funding decision","deprecated":null,"version":null,"sidebarTitle":"List pix awaiting funding","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/pix/awaiting-funding","href":"/en/reference/rails/spi/spi/list-pix-awaiting-funding"},{"title":"Solicitar devolução","deprecated":null,"version":null,"sidebarTitle":"Request devolucao","openapi":"/en/openapi/v3-current/spi.yaml put /api/v1/spi/pix/{e2eid}/devolucao/{id}","href":"/en/reference/rails/spi/spi/request-devolucao"}]},{"group":"SPI · Reports","pages":[{"title":"Conta-PI balance-window report","deprecated":null,"version":null,"sidebarTitle":"Get spi report balances","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/reports/balances","href":"/en/reference/rails/spi/spi/get-spi-report-balances"},{"title":"Conta-PI extract-list report","deprecated":null,"version":null,"sidebarTitle":"Get spi report extracts","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/reports/extracts","href":"/en/reference/rails/spi/spi/get-spi-report-extracts"},{"title":"SPI rejected-payments report","deprecated":null,"version":null,"sidebarTitle":"Get spi report rejected","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/reports/rejected","href":"/en/reference/rails/spi/spi/get-spi-report-rejected"},{"title":"SPI volumetria report (COUNT-only)","deprecated":null,"version":null,"sidebarTitle":"Get spi report volumetria","openapi":"/en/openapi/v3-current/spi.yaml get /api/v1/spi/reports/volumetria","href":"/en/reference/rails/spi/spi/get-spi-report-volumetria"}]},{"group":"SPI · Internal","pages":[{"title":"Internal rail inbound callback","deprecated":null,"version":null,"sidebarTitle":"Rail inbound callback","openapi":"/en/openapi/v3-current/spi.yaml post /internal/v1/spi/rail/inbound","href":"/en/reference/rails/spi/spi/rail-inbound-callback"}]},{"group":"DICT · Claims","pages":[{"title":"List claims","deprecated":null,"version":null,"sidebarTitle":"List claims","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/claims","href":"/en/reference/rails/spi/dict/list-claims"},{"title":"Get claim","deprecated":null,"version":null,"sidebarTitle":"Get claim","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/claims/{claimID}","href":"/en/reference/rails/spi/dict/get-claim"},{"title":"Acknowledge claim","deprecated":null,"version":null,"sidebarTitle":"Acknowledge claim","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/claims/{claimID}/acknowledge","href":"/en/reference/rails/spi/dict/acknowledge-claim"},{"title":"Cancel claim","deprecated":null,"version":null,"sidebarTitle":"Cancel claim","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/claims/{claimID}/cancel","href":"/en/reference/rails/spi/dict/cancel-claim"},{"title":"Complete claim","deprecated":null,"version":null,"sidebarTitle":"Complete claim","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/claims/{claimID}/complete","href":"/en/reference/rails/spi/dict/complete-claim"},{"title":"Confirm claim","deprecated":null,"version":null,"sidebarTitle":"Confirm claim","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/claims/{claimID}/confirm","href":"/en/reference/rails/spi/dict/confirm-claim"},{"title":"Reject claim (decline)","deprecated":null,"version":null,"sidebarTitle":"Reject claim","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/claims/{claimID}/reject","href":"/en/reference/rails/spi/dict/reject-claim"},{"title":"Process claim deadlines","deprecated":null,"version":null,"sidebarTitle":"Process claim deadlines","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/internal/claims/process-deadlines","href":"/en/reference/rails/spi/dict/process-claim-deadlines"},{"title":"Initiate claim","deprecated":null,"version":null,"sidebarTitle":"Initiate claim","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/participants/{participantISPB}/claims","href":"/en/reference/rails/spi/dict/initiate-claim"}]},{"group":"DICT · Statistics","pages":[{"title":"Get BACEN entry antifraud statistics","deprecated":null,"version":null,"sidebarTitle":"Get entry statistics","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/entries/{key}/statistics","href":"/en/reference/rails/spi/dict/get-entry-statistics"},{"title":"Get BACEN person antifraud statistics","deprecated":null,"version":null,"sidebarTitle":"Get person statistics","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/persons/statistics","href":"/en/reference/rails/spi/dict/get-person-statistics"},{"title":"List watched CPFs/CNPJs","deprecated":null,"version":null,"sidebarTitle":"List person watchlist","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/persons/watchlist","href":"/en/reference/rails/spi/dict/list-person-watchlist"},{"title":"Watch a CPF/CNPJ for antifraud signal","deprecated":null,"version":null,"sidebarTitle":"Add person watchlist document","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/persons/watchlist","href":"/en/reference/rails/spi/dict/add-person-watchlist-document"},{"title":"Stop watching a CPF/CNPJ","deprecated":null,"version":null,"sidebarTitle":"Remove person watchlist document","openapi":"/en/openapi/v3-current/spi-dict.yaml delete /api/v1/dict/persons/watchlist/{id}","href":"/en/reference/rails/spi/dict/remove-person-watchlist-document"}]},{"group":"DICT · Fraud markers","pages":[{"title":"List fraud markers","deprecated":null,"version":null,"sidebarTitle":"List fraud markers","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/fraud-markers","href":"/en/reference/rails/spi/dict/list-fraud-markers"},{"title":"Create fraud marker","deprecated":null,"version":null,"sidebarTitle":"Create fraud marker","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/fraud-markers","href":"/en/reference/rails/spi/dict/create-fraud-marker"},{"title":"Fraud marker statistics","deprecated":null,"version":null,"sidebarTitle":"Fraud marker stats","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/fraud-markers/stats","href":"/en/reference/rails/spi/dict/fraud-marker-stats"},{"title":"Get fraud marker","deprecated":null,"version":null,"sidebarTitle":"Get fraud marker","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/fraud-markers/{id}","href":"/en/reference/rails/spi/dict/get-fraud-marker"},{"title":"Cancel fraud marker","deprecated":null,"version":null,"sidebarTitle":"Cancel fraud marker","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/fraud-markers/{id}/cancel","href":"/en/reference/rails/spi/dict/cancel-fraud-marker"}]},{"group":"DICT · Funds recoveries","pages":[{"title":"List DICT funds recoveries","deprecated":null,"version":null,"sidebarTitle":"List funds recoveries","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/funds-recoveries","href":"/en/reference/rails/spi/dict/list-funds-recoveries"},{"title":"Create DICT funds recovery","deprecated":null,"version":null,"sidebarTitle":"Create funds recovery","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/funds-recoveries","href":"/en/reference/rails/spi/dict/create-funds-recovery"},{"title":"Take in client-supplied funds-recovery ids","deprecated":null,"version":null,"sidebarTitle":"Intake funds recoveries","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/funds-recoveries/intake","href":"/en/reference/rails/spi/dict/intake-funds-recoveries"},{"title":"Get DICT funds recovery","deprecated":null,"version":null,"sidebarTitle":"Get funds recovery","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/funds-recoveries/{id}","href":"/en/reference/rails/spi/dict/get-funds-recovery"},{"title":"Correct an open funds recovery","deprecated":null,"version":null,"sidebarTitle":"Update funds recovery","openapi":"/en/openapi/v3-current/spi-dict.yaml put /api/v1/dict/funds-recoveries/{id}","href":"/en/reference/rails/spi/dict/update-funds-recovery"},{"title":"Cancel DICT funds recovery","deprecated":null,"version":null,"sidebarTitle":"Cancel funds recovery","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/funds-recoveries/{id}/cancel","href":"/en/reference/rails/spi/dict/cancel-funds-recovery"},{"title":"List a funds recovery's infraction reports","deprecated":null,"version":null,"sidebarTitle":"List funds recovery infraction reports","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/funds-recoveries/{id}/infraction-reports","href":"/en/reference/rails/spi/dict/list-funds-recovery-infraction-reports"},{"title":"Request the refund of a funds recovery","deprecated":null,"version":null,"sidebarTitle":"Create funds recovery refund","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/funds-recoveries/{id}/refund","href":"/en/reference/rails/spi/dict/create-funds-recovery-refund"},{"title":"List a funds recovery's refunds","deprecated":null,"version":null,"sidebarTitle":"List funds recovery refunds","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/funds-recoveries/{id}/refunds","href":"/en/reference/rails/spi/dict/list-funds-recovery-refunds"},{"title":"Get DICT funds-recovery tracking graph","deprecated":null,"version":null,"sidebarTitle":"Get funds recovery tracking graph","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/funds-recoveries/{id}/tracking-graph","href":"/en/reference/rails/spi/dict/get-funds-recovery-tracking-graph"}]},{"group":"DICT · Infractions","pages":[{"title":"List DICT infractions","deprecated":null,"version":null,"sidebarTitle":"List infractions","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/infractions","href":"/en/reference/rails/spi/dict/list-infractions"},{"title":"Get DICT infraction","deprecated":null,"version":null,"sidebarTitle":"Get infraction","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/infractions/{id}","href":"/en/reference/rails/spi/dict/get-infraction"},{"title":"Acknowledge DICT infraction","deprecated":null,"version":null,"sidebarTitle":"Acknowledge infraction","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/infractions/{id}/acknowledge","href":"/en/reference/rails/spi/dict/acknowledge-infraction"},{"title":"Cancel DICT infraction","deprecated":null,"version":null,"sidebarTitle":"Cancel infraction","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/infractions/{id}/cancel","href":"/en/reference/rails/spi/dict/cancel-infraction"},{"title":"Close DICT infraction","deprecated":null,"version":null,"sidebarTitle":"Close infraction","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/infractions/{id}/close","href":"/en/reference/rails/spi/dict/close-infraction"},{"title":"Refresh DICT infraction from BACEN","deprecated":null,"version":null,"sidebarTitle":"Refresh infraction","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/infractions/{id}/refresh","href":"/en/reference/rails/spi/dict/refresh-infraction"}]},{"group":"DICT · Internal","pages":[{"title":"Apply a judicial block on a PIX key","deprecated":null,"version":null,"sidebarTitle":"Apply key judicial block","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/internal/keys/block","href":"/en/reference/rails/spi/dict/apply-key-judicial-block"},{"title":"Cleanup orphaned PIX keys","deprecated":null,"version":null,"sidebarTitle":"Cleanup orphaned keys","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/internal/keys/cleanup-orphaned","href":"/en/reference/rails/spi/dict/cleanup-orphaned-keys"},{"title":"Lift a judicial block on a PIX key","deprecated":null,"version":null,"sidebarTitle":"Lift key judicial block","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/internal/keys/unblock","href":"/en/reference/rails/spi/dict/lift-key-judicial-block"},{"title":"Read DICT request-limiting buckets","deprecated":null,"version":null,"sidebarTitle":"Read dict policy buckets","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/internal/policies","href":"/en/reference/rails/spi/dict/read-dict-policy-buckets"},{"title":"Release an end user's DICT key queries","deprecated":null,"version":null,"sidebarTitle":"Unblock dict query payer","openapi":"/en/openapi/v3-current/spi-dict.yaml delete /api/v1/dict/internal/query-blocks","href":"/en/reference/rails/spi/dict/unblock-dict-query-payer"},{"title":"Block an end user's DICT key queries","deprecated":null,"version":null,"sidebarTitle":"Block dict query payer","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/internal/query-blocks","href":"/en/reference/rails/spi/dict/block-dict-query-payer"},{"title":"Read DICT query-monitoring indicators","deprecated":null,"version":null,"sidebarTitle":"Read dict query monitor","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/internal/query-monitor","href":"/en/reference/rails/spi/dict/read-dict-query-monitor"},{"title":"Trigger DICT reconciliation","deprecated":null,"version":null,"sidebarTitle":"Trigger reconciliation","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/internal/reconciliation/run","href":"/en/reference/rails/spi/dict/trigger-reconciliation"},{"title":"Reconcile DICT keys against a BACEN event-list","deprecated":null,"version":null,"sidebarTitle":"Run events reconciliation","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/internal/reconciliation/run-events","href":"/en/reference/rails/spi/dict/run-events-reconciliation"}]},{"group":"DICT · Keys","pages":[{"title":"Delete PIX key","deprecated":null,"version":null,"sidebarTitle":"Delete key","openapi":"/en/openapi/v3-current/spi-dict.yaml delete /api/v1/dict/keys","href":"/en/reference/rails/spi/dict/delete-key"},{"title":"List PIX keys","deprecated":null,"version":null,"sidebarTitle":"List keys","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/keys","href":"/en/reference/rails/spi/dict/list-keys"},{"title":"Register PIX key","deprecated":null,"version":null,"sidebarTitle":"Register key","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/keys","href":"/en/reference/rails/spi/dict/register-key"},{"title":"Batch check PIX key existence","deprecated":null,"version":null,"sidebarTitle":"Check keys","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/keys/check","href":"/en/reference/rails/spi/dict/check-keys"},{"title":"Lookup PIX key","deprecated":null,"version":null,"sidebarTitle":"Lookup key","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/keys/lookup","href":"/en/reference/rails/spi/dict/lookup-key"},{"title":"Search PIX keys","deprecated":null,"version":null,"sidebarTitle":"Search keys","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/keys/search","href":"/en/reference/rails/spi/dict/search-keys"},{"title":"PIX key statistics","deprecated":null,"version":null,"sidebarTitle":"Key stats","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/keys/stats","href":"/en/reference/rails/spi/dict/key-stats"},{"title":"Update PIX key","deprecated":null,"version":null,"sidebarTitle":"Update key","openapi":"/en/openapi/v3-current/spi-dict.yaml put /api/v1/dict/keys/{key}","href":"/en/reference/rails/spi/dict/update-key"}]},{"group":"DICT · Operations","pages":[{"title":"List DICT poll feed states","deprecated":null,"version":null,"sidebarTitle":"List dict discovery feeds","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/discovery-feeds","href":"/en/reference/rails/spi/dict/list-dict-discovery-feeds"},{"title":"Abandon one unreadable record on a DICT poll feed","deprecated":null,"version":null,"sidebarTitle":"Abandon dict discovery feed record","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/discovery-feeds/{feed}/abandon-record","href":"/en/reference/rails/spi/dict/abandon-dict-discovery-feed-record"},{"title":"Unblock a frozen DICT poll feed","deprecated":null,"version":null,"sidebarTitle":"Unblock dict discovery feed","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/discovery-feeds/{feed}/unblock","href":"/en/reference/rails/spi/dict/unblock-dict-discovery-feed"},{"title":"List DICT MED operation statuses","deprecated":null,"version":null,"sidebarTitle":"List regulatory operations","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/operations","href":"/en/reference/rails/spi/dict/list-regulatory-operations"},{"title":"Get DICT MED operation status","deprecated":null,"version":null,"sidebarTitle":"Get regulatory operation","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/operations/{id}","href":"/en/reference/rails/spi/dict/get-regulatory-operation"},{"title":"Resolve a MANUAL_REVIEW DICT MED operation","deprecated":null,"version":null,"sidebarTitle":"Resolve regulatory operation","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/operations/{operationId}/resolution","href":"/en/reference/rails/spi/dict/resolve-regulatory-operation"}]},{"group":"DICT · Refunds","pages":[{"title":"List DICT refunds","deprecated":null,"version":null,"sidebarTitle":"List refunds","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/refunds","href":"/en/reference/rails/spi/dict/list-refunds"},{"title":"Create DICT refund","deprecated":null,"version":null,"sidebarTitle":"Create refund","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/refunds","href":"/en/reference/rails/spi/dict/create-refund"},{"title":"Get DICT refund","deprecated":null,"version":null,"sidebarTitle":"Get refund","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/refunds/{id}","href":"/en/reference/rails/spi/dict/get-refund"},{"title":"Cancel DICT refund","deprecated":null,"version":null,"sidebarTitle":"Cancel refund","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/refunds/{id}/cancel","href":"/en/reference/rails/spi/dict/cancel-refund"},{"title":"Close DICT refund","deprecated":null,"version":null,"sidebarTitle":"Close refund","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/refunds/{id}/close","href":"/en/reference/rails/spi/dict/close-refund"},{"title":"Refresh DICT refund from BACEN","deprecated":null,"version":null,"sidebarTitle":"Refresh refund","openapi":"/en/openapi/v3-current/spi-dict.yaml post /api/v1/dict/refunds/{id}/refresh","href":"/en/reference/rails/spi/dict/refresh-refund"}]},{"group":"DICT · Reports","pages":[{"title":"DICT claims-summary report (COUNT-only)","deprecated":null,"version":null,"sidebarTitle":"Get dict report claims summary","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/reports/claims-summary","href":"/en/reference/rails/spi/dict/get-dict-report-claims-summary"},{"title":"DICT keys-summary report (COUNT-only)","deprecated":null,"version":null,"sidebarTitle":"Get dict report keys summary","openapi":"/en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/reports/keys-summary","href":"/en/reference/rails/spi/dict/get-dict-report-keys-summary"}]},{"group":"BR Code · BR Code","pages":[{"title":"List BR Code payloads","deprecated":null,"version":null,"sidebarTitle":"List br code payloads","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/","href":"/en/reference/rails/spi/brcode/list-br-code-payloads"},{"title":"Generate BR Code","deprecated":null,"version":null,"sidebarTitle":"Generate br code","openapi":"/en/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/","href":"/en/reference/rails/spi/brcode/generate-br-code"},{"title":"BR Code payload JWK Set","deprecated":null,"version":null,"sidebarTitle":"Get br code jwks","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/.well-known/jwks.json","href":"/en/reference/rails/spi/brcode/get-br-code-jwks"},{"title":"Decode BR Code","deprecated":null,"version":null,"sidebarTitle":"Decode br code","openapi":"/en/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/decode","href":"/en/reference/rails/spi/brcode/decode-br-code"},{"title":"Get BR Code info","deprecated":null,"version":null,"sidebarTitle":"Get br code info","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/info/{payload}","href":"/en/reference/rails/spi/brcode/get-br-code-info"},{"title":"Validate BR Code","deprecated":null,"version":null,"sidebarTitle":"Validate br code","openapi":"/en/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/validate","href":"/en/reference/rails/spi/brcode/validate-br-code"},{"title":"Get BR Code payload","deprecated":null,"version":null,"sidebarTitle":"Get br code payload","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/{id}","href":"/en/reference/rails/spi/brcode/get-br-code-payload"}]},{"group":"BR Code · Charges","pages":[{"title":"Download the CNAB 750 settlement file","deprecated":null,"version":null,"sidebarTitle":"Download liquidacoes","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/arquivos/liquidacoes","href":"/en/reference/rails/spi/brcode/download-liquidacoes"},{"title":"Get file batch status","deprecated":null,"version":null,"sidebarTitle":"Get file batch","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/arquivos/{id}","href":"/en/reference/rails/spi/brcode/get-file-batch"},{"title":"Download the CNAB 750 retorno","deprecated":null,"version":null,"sidebarTitle":"Download file batch retorno","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/arquivos/{id}/retorno","href":"/en/reference/rails/spi/brcode/download-file-batch-retorno"},{"title":"Reconcile charge","deprecated":null,"version":null,"sidebarTitle":"Reconcile charge","openapi":"/en/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/charges/reconcile","href":"/en/reference/rails/spi/brcode/reconcile-charge"},{"title":"Get recebedor profile","deprecated":null,"version":null,"sidebarTitle":"Get recebedor profile","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/recebedores/{chave}","href":"/en/reference/rails/spi/brcode/get-recebedor-profile"},{"title":"Register recebedor profile","deprecated":null,"version":null,"sidebarTitle":"Upsert recebedor profile","openapi":"/en/openapi/v3-current/spi-brcode.yaml put /api/v1/brcode/recebedores/{chave}","href":"/en/reference/rails/spi/brcode/upsert-recebedor-profile"}]},{"group":"BR Code · COB","pages":[{"title":"List immediate charges","deprecated":null,"version":null,"sidebarTitle":"List cob","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/cob","href":"/en/reference/rails/spi/brcode/list-cob"},{"title":"Create immediate charge (PSP-generated txid)","deprecated":null,"version":null,"sidebarTitle":"Post cob","openapi":"/en/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/cob","href":"/en/reference/rails/spi/brcode/post-cob"},{"title":"Retrieve immediate charge","deprecated":null,"version":null,"sidebarTitle":"Get cob","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/cob/{txid}","href":"/en/reference/rails/spi/brcode/get-cob"},{"title":"Revise immediate charge","deprecated":null,"version":null,"sidebarTitle":"Patch cob","openapi":"/en/openapi/v3-current/spi-brcode.yaml patch /api/v1/brcode/cob/{txid}","href":"/en/reference/rails/spi/brcode/patch-cob"},{"title":"Create immediate charge (idempotent txid)","deprecated":null,"version":null,"sidebarTitle":"Put cob","openapi":"/en/openapi/v3-current/spi-brcode.yaml put /api/v1/brcode/cob/{txid}","href":"/en/reference/rails/spi/brcode/put-cob"}]},{"group":"BR Code · COB R","pages":[{"title":"List recurring charges","deprecated":null,"version":null,"sidebarTitle":"List cob r","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/cobr","href":"/en/reference/rails/spi/brcode/list-cob-r"},{"title":"Create recurring charge (PSP-generated txid)","deprecated":null,"version":null,"sidebarTitle":"Post cob r","openapi":"/en/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/cobr","href":"/en/reference/rails/spi/brcode/post-cob-r"},{"title":"Retrieve recurring charge","deprecated":null,"version":null,"sidebarTitle":"Get cob r","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/cobr/{txid}","href":"/en/reference/rails/spi/brcode/get-cob-r"},{"title":"Revise recurring charge (cancel)","deprecated":null,"version":null,"sidebarTitle":"Patch cob r","openapi":"/en/openapi/v3-current/spi-brcode.yaml patch /api/v1/brcode/cobr/{txid}","href":"/en/reference/rails/spi/brcode/patch-cob-r"},{"title":"Create recurring charge (idempotent txid)","deprecated":null,"version":null,"sidebarTitle":"Put cob r","openapi":"/en/openapi/v3-current/spi-brcode.yaml put /api/v1/brcode/cobr/{txid}","href":"/en/reference/rails/spi/brcode/put-cob-r"},{"title":"Request settlement retry","deprecated":null,"version":null,"sidebarTitle":"Post cob r retentativa","openapi":"/en/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/cobr/{txid}/retentativa/{data}","href":"/en/reference/rails/spi/brcode/post-cob-r-retentativa"}]},{"group":"BR Code · COB V","pages":[{"title":"List due-date charges","deprecated":null,"version":null,"sidebarTitle":"List cob v","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/cobv","href":"/en/reference/rails/spi/brcode/list-cob-v"},{"title":"Retrieve due-date charge","deprecated":null,"version":null,"sidebarTitle":"Get cob v","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/cobv/{txid}","href":"/en/reference/rails/spi/brcode/get-cob-v"},{"title":"Revise due-date charge","deprecated":null,"version":null,"sidebarTitle":"Patch cob v","openapi":"/en/openapi/v3-current/spi-brcode.yaml patch /api/v1/brcode/cobv/{txid}","href":"/en/reference/rails/spi/brcode/patch-cob-v"},{"title":"Create due-date charge (idempotent txid)","deprecated":null,"version":null,"sidebarTitle":"Put cob v","openapi":"/en/openapi/v3-current/spi-brcode.yaml put /api/v1/brcode/cobv/{txid}","href":"/en/reference/rails/spi/brcode/put-cob-v"}]},{"group":"BR Code · Location","pages":[{"title":"List locations","deprecated":null,"version":null,"sidebarTitle":"List location","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/loc","href":"/en/reference/rails/spi/brcode/list-location"},{"title":"Create payload location","deprecated":null,"version":null,"sidebarTitle":"Create location","openapi":"/en/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/loc","href":"/en/reference/rails/spi/brcode/create-location"},{"title":"Retrieve location","deprecated":null,"version":null,"sidebarTitle":"Get location","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/loc/{id}","href":"/en/reference/rails/spi/brcode/get-location"},{"title":"Unlink charge from a location","deprecated":null,"version":null,"sidebarTitle":"Delete location tx id","openapi":"/en/openapi/v3-current/spi-brcode.yaml delete /api/v1/brcode/loc/{id}/txid","href":"/en/reference/rails/spi/brcode/delete-location-tx-id"},{"title":"List recurrence locations","deprecated":null,"version":null,"sidebarTitle":"List location rec","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/locrec","href":"/en/reference/rails/spi/brcode/list-location-rec"},{"title":"Create recurrence location","deprecated":null,"version":null,"sidebarTitle":"Create location rec","openapi":"/en/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/locrec","href":"/en/reference/rails/spi/brcode/create-location-rec"},{"title":"Retrieve recurrence location","deprecated":null,"version":null,"sidebarTitle":"Get location rec","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/locrec/{id}","href":"/en/reference/rails/spi/brcode/get-location-rec"},{"title":"Unlink recurrence from a location","deprecated":null,"version":null,"sidebarTitle":"Delete location rec id rec","openapi":"/en/openapi/v3-current/spi-brcode.yaml delete /api/v1/brcode/locrec/{id}/idRec","href":"/en/reference/rails/spi/brcode/delete-location-rec-id-rec"}]},{"group":"BR Code · COB V batches","pages":[{"title":"List due-date charge batches","deprecated":null,"version":null,"sidebarTitle":"List lote cob v","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/lotecobv","href":"/en/reference/rails/spi/brcode/list-lote-cob-v"},{"title":"Retrieve due-date charge batch","deprecated":null,"version":null,"sidebarTitle":"Get lote cob v","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/lotecobv/{id}","href":"/en/reference/rails/spi/brcode/get-lote-cob-v"},{"title":"Revise due-date charge batch","deprecated":null,"version":null,"sidebarTitle":"Patch lote cob v","openapi":"/en/openapi/v3-current/spi-brcode.yaml patch /api/v1/brcode/lotecobv/{id}","href":"/en/reference/rails/spi/brcode/patch-lote-cob-v"},{"title":"Create due-date charge batch","deprecated":null,"version":null,"sidebarTitle":"Put lote cob v","openapi":"/en/openapi/v3-current/spi-brcode.yaml put /api/v1/brcode/lotecobv/{id}","href":"/en/reference/rails/spi/brcode/put-lote-cob-v"}]},{"group":"BR Code · COB V payload","pages":[{"title":"Resolve CobV payload (JWS)","deprecated":null,"version":null,"sidebarTitle":"Resolve cob v payload","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/payload/cobv/{locator}","href":"/en/reference/rails/spi/brcode/resolve-cob-v-payload"}]},{"group":"BR Code · REC payload","pages":[{"title":"Resolve Rec payload (JWS)","deprecated":null,"version":null,"sidebarTitle":"Resolve rec payload","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/payload/rec/{recUrlAccessToken}","href":"/en/reference/rails/spi/brcode/resolve-rec-payload"}]},{"group":"BR Code · COB payload","pages":[{"title":"Resolve Cob payload (JWS)","deprecated":null,"version":null,"sidebarTitle":"Resolve cob payload","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/payload/{locator}","href":"/en/reference/rails/spi/brcode/resolve-cob-payload"}]},{"group":"BR Code · REC","pages":[{"title":"List recurrences (Pix Automático)","deprecated":null,"version":null,"sidebarTitle":"List rec","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/rec","href":"/en/reference/rails/spi/brcode/list-rec"},{"title":"Create recurrence (Pix Automático)","deprecated":null,"version":null,"sidebarTitle":"Post rec","openapi":"/en/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/rec","href":"/en/reference/rails/spi/brcode/post-rec"},{"title":"Retrieve recurrence (Pix Automático)","deprecated":null,"version":null,"sidebarTitle":"Get rec","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/rec/{idRec}","href":"/en/reference/rails/spi/brcode/get-rec"},{"title":"Revise recurrence (Pix Automático)","deprecated":null,"version":null,"sidebarTitle":"Patch rec","openapi":"/en/openapi/v3-current/spi-brcode.yaml patch /api/v1/brcode/rec/{idRec}","href":"/en/reference/rails/spi/brcode/patch-rec"}]},{"group":"BR Code · Solic REC","pages":[{"title":"Create recurrence request (Pix Automático)","deprecated":null,"version":null,"sidebarTitle":"Post solic rec","openapi":"/en/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/solicrec","href":"/en/reference/rails/spi/brcode/post-solic-rec"},{"title":"Retrieve recurrence request (Pix Automático)","deprecated":null,"version":null,"sidebarTitle":"Get solic rec","openapi":"/en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/solicrec/{idSolicRec}","href":"/en/reference/rails/spi/brcode/get-solic-rec"},{"title":"Revise (cancel) recurrence request (Pix Automático)","deprecated":null,"version":null,"sidebarTitle":"Patch solic rec","openapi":"/en/openapi/v3-current/spi-brcode.yaml patch /api/v1/brcode/solicrec/{idSolicRec}","href":"/en/reference/rails/spi/brcode/patch-solic-rec"}]},{"group":"Core · Operations","pages":[{"title":"Orchestrate Core operation","deprecated":null,"version":null,"sidebarTitle":"Orchestrate operation","openapi":"/en/openapi/v3-current/spi-core.yaml post /api/v1/core/operations/","href":"/en/reference/rails/spi/core/orchestrate-operation"}]},{"group":"Core · Participants","pages":[{"title":"List participants","deprecated":null,"version":null,"sidebarTitle":"List participants","openapi":"/en/openapi/v3-current/spi-core.yaml get /api/v1/core/participants/","href":"/en/reference/rails/spi/core/list-participants"},{"title":"Request registration of an indirect participant","deprecated":null,"version":null,"sidebarTitle":"Register participant","openapi":"/en/openapi/v3-current/spi-core.yaml post /api/v1/core/participants/","href":"/en/reference/rails/spi/core/register-participant"},{"title":"Register the direct participant this rail operates as","deprecated":null,"version":null,"sidebarTitle":"Register direct participant","openapi":"/en/openapi/v3-current/spi-core.yaml post /api/v1/core/participants/direct","href":"/en/reference/rails/spi/core/register-direct-participant"},{"title":"Get participant","deprecated":null,"version":null,"sidebarTitle":"Get participant","openapi":"/en/openapi/v3-current/spi-core.yaml get /api/v1/core/participants/{ispb}","href":"/en/reference/rails/spi/core/get-participant"},{"title":"Activate participant","deprecated":null,"version":null,"sidebarTitle":"Activate participant","openapi":"/en/openapi/v3-current/spi-core.yaml post /api/v1/core/participants/{ispb}/activate","href":"/en/reference/rails/spi/core/activate-participant"},{"title":"Update the participant's MED 2.0 regulator contact","deprecated":null,"version":null,"sidebarTitle":"Update participant contact","openapi":"/en/openapi/v3-current/spi-core.yaml put /api/v1/core/participants/{ispb}/contact","href":"/en/reference/rails/spi/core/update-participant-contact"},{"title":"Offboard participant","deprecated":null,"version":null,"sidebarTitle":"Offboard participant","openapi":"/en/openapi/v3-current/spi-core.yaml post /api/v1/core/participants/{ispb}/offboard","href":"/en/reference/rails/spi/core/offboard-participant"},{"title":"Suspend participant","deprecated":null,"version":null,"sidebarTitle":"Suspend participant","openapi":"/en/openapi/v3-current/spi-core.yaml post /api/v1/core/participants/{ispb}/suspend","href":"/en/reference/rails/spi/core/suspend-participant"},{"title":"Confirm portability relationship end (reda.031)","deprecated":null,"version":null,"sidebarTitle":"Confirm portability relationship end","openapi":"/en/openapi/v3-current/spi-core.yaml post /api/v1/core/participants/{ispb}/portability/confirm","href":"/en/reference/rails/spi/core/confirm-portability-relationship-end"}]},{"group":"Core · Routing","pages":[{"title":"Resolve payment routing","deprecated":null,"version":null,"sidebarTitle":"Resolve routing","openapi":"/en/openapi/v3-current/spi-core.yaml post /api/v1/core/routing/resolve","href":"/en/reference/rails/spi/core/resolve-routing"}]},{"group":"Error handling","pages":[{"title":"SPI error list","href":"/en/reference/rails/spi/spi-error-list"}]}]},{"dropdown":"SLC","icon":"credit-card","description":"Card settlement messaging over the SLC rail","groups":[{"group":"Administration","pages":[{"title":"List effective tenant config","deprecated":null,"version":null,"sidebarTitle":"List tenant config","openapi":"/en/openapi/v3-current/slc.yaml get /admin/config","href":"/en/reference/rails/slc/list-tenant-config"},{"title":"Reset one tenant config key","deprecated":null,"version":null,"sidebarTitle":"Reset tenant config","openapi":"/en/openapi/v3-current/slc.yaml delete /admin/config/{key}","href":"/en/reference/rails/slc/reset-tenant-config"},{"title":"Get one tenant config key","deprecated":null,"version":null,"sidebarTitle":"Get tenant config","openapi":"/en/openapi/v3-current/slc.yaml get /admin/config/{key}","href":"/en/reference/rails/slc/get-tenant-config"},{"title":"Set one tenant config key","deprecated":null,"version":null,"sidebarTitle":"Set tenant config","openapi":"/en/openapi/v3-current/slc.yaml put /admin/config/{key}","href":"/en/reference/rails/slc/set-tenant-config"},{"title":"List dead letters","deprecated":null,"version":null,"sidebarTitle":"List dead letters","openapi":"/en/openapi/v3-current/slc.yaml get /admin/dlq/{queue}","href":"/en/reference/rails/slc/list-dead-letters"},{"title":"Replay a dead letter","deprecated":null,"version":null,"sidebarTitle":"Replay dead letter","openapi":"/en/openapi/v3-current/slc.yaml post /admin/dlq/{queue}/{id}/replay","href":"/en/reference/rails/slc/replay-dead-letter"},{"title":"Redispatch an outbox entry","deprecated":null,"version":null,"sidebarTitle":"Redispatch outbox entry","openapi":"/en/openapi/v3-current/slc.yaml post /admin/outbox/{id}/redispatch","href":"/en/reference/rails/slc/redispatch-outbox-entry"}]},{"group":"Clearing","pages":[{"title":"List clearing positions","deprecated":null,"version":null,"sidebarTitle":"List clearing positions","openapi":"/en/openapi/v3-current/slc.yaml get /v1/clearing/positions","href":"/en/reference/rails/slc/list-clearing-positions"}]},{"group":"Settlement schedule","pages":[{"title":"Get the settlement grid this instance is enforcing","deprecated":null,"version":null,"sidebarTitle":"Get schedule","openapi":"/en/openapi/v3-current/slc.yaml get /v1/schedule","href":"/en/reference/rails/slc/get-schedule"}]},{"group":"Funding","pages":[{"title":"List recorded client deposit acks across settlement instructions","deprecated":null,"version":null,"sidebarTitle":"List funding acks","openapi":"/en/openapi/v3-current/slc.yaml get /v1/funding/acks","href":"/en/reference/rails/slc/list-funding-acks"},{"title":"Record a client settlement-deposit ack","deprecated":null,"version":null,"sidebarTitle":"Record funding ack","openapi":"/en/openapi/v3-current/slc.yaml post /v1/funding/settlement-instructions/{instructionId}/ack","href":"/en/reference/rails/slc/record-funding-ack"},{"title":"List the client deposit acks recorded for a settlement instruction","deprecated":null,"version":null,"sidebarTitle":"List settlement instruction acks","openapi":"/en/openapi/v3-current/slc.yaml get /v1/funding/settlement-instructions/{instructionId}/acks","href":"/en/reference/rails/slc/list-settlement-instruction-acks"}]},{"group":"LBTR","pages":[{"title":"List the settlement results the câmara announced","deprecated":null,"version":null,"sidebarTitle":"List lbtr results","openapi":"/en/openapi/v3-current/slc.yaml get /v1/lbtr/results","href":"/en/reference/rails/slc/list-lbtr-results"},{"title":"Read one announced settlement result","deprecated":null,"version":null,"sidebarTitle":"Get lbtr result","openapi":"/en/openapi/v3-current/slc.yaml get /v1/lbtr/results/{resultId}","href":"/en/reference/rails/slc/get-lbtr-result"},{"title":"Confirm or diverge from an announced settlement result","deprecated":null,"version":null,"sidebarTitle":"Decide lbtr result","openapi":"/en/openapi/v3-current/slc.yaml post /v1/lbtr/results/{resultId}/decision","href":"/en/reference/rails/slc/decide-lbtr-result"},{"title":"List the announced operations between this bank's own non-liquidantes","deprecated":null,"version":null,"sidebarTitle":"List lbtr non settlor operations","openapi":"/en/openapi/v3-current/slc.yaml get /v1/lbtr/nonliquidante-operations","href":"/en/reference/rails/slc/list-lbtr-non-settlor-operations"},{"title":"Read one announced operation between two non-liquidantes","deprecated":null,"version":null,"sidebarTitle":"Get lbtr non settlor operation","openapi":"/en/openapi/v3-current/slc.yaml get /v1/lbtr/nonliquidante-operations/{operationId}","href":"/en/reference/rails/slc/get-lbtr-non-settlor-operation"},{"title":"Confirm or reject an announced operation between two non-liquidantes","deprecated":null,"version":null,"sidebarTitle":"Decide lbtr non settlor operation","openapi":"/en/openapi/v3-current/slc.yaml post /v1/lbtr/nonliquidante-operations/{operationId}/decision","href":"/en/reference/rails/slc/decide-lbtr-non-settlor-operation"},{"title":"Ask the câmara for this institution's LBTR position","deprecated":null,"version":null,"sidebarTitle":"Submit lbtr position query","openapi":"/en/openapi/v3-current/slc.yaml post /v1/lbtr/position-queries","href":"/en/reference/rails/slc/submit-lbtr-position-query"},{"title":"List the commands this institution sent to the câmara","deprecated":null,"version":null,"sidebarTitle":"List lbtr commands","openapi":"/en/openapi/v3-current/slc.yaml get /v1/lbtr/commands","href":"/en/reference/rails/slc/list-lbtr-commands"},{"title":"Read one command and the câmara's answer to it","deprecated":null,"version":null,"sidebarTitle":"Get lbtr command","openapi":"/en/openapi/v3-current/slc.yaml get /v1/lbtr/commands/{commandId}","href":"/en/reference/rails/slc/get-lbtr-command"}]},{"group":"Connectivity","pages":[{"title":"List cancellation repasses awaiting manual reconciliation","deprecated":null,"version":null,"sidebarTitle":"List cancellation relay intents","openapi":"/en/openapi/v3-current/slc.yaml get /v1/connectivity/cancellation-relay-intents","href":"/en/reference/rails/slc/list-cancellation-relay-intents"},{"title":"Record what was established about an unresolved cancellation repasse","deprecated":null,"version":null,"sidebarTitle":"Resolve cancellation relay intents","openapi":"/en/openapi/v3-current/slc.yaml post /v1/connectivity/cancellation-relay-intents/resolve","href":"/en/reference/rails/slc/resolve-cancellation-relay-intents"},{"title":"Trigger a credit-dispatch catch-up drain","deprecated":null,"version":null,"sidebarTitle":"Recovery dispatch","openapi":"/en/openapi/v3-current/slc.yaml post /v1/connectivity/dispatch","href":"/en/reference/rails/slc/recovery-dispatch"},{"title":"Trigger an ASLC022 forward-to-domicile catch-up drain","deprecated":null,"version":null,"sidebarTitle":"Recovery forward","openapi":"/en/openapi/v3-current/slc.yaml post /v1/connectivity/forward","href":"/en/reference/rails/slc/recovery-forward"},{"title":"Un-park operations held after exhausting their outbound attempt budget","deprecated":null,"version":null,"sidebarTitle":"Recovery unpark","openapi":"/en/openapi/v3-current/slc.yaml post /v1/connectivity/unpark","href":"/en/reference/rails/slc/recovery-unpark"},{"title":"Retransmit a QUEUED operation","deprecated":null,"version":null,"sidebarTitle":"Connectivity retransmit operation","openapi":"/en/openapi/v3-current/slc.yaml post /v1/connectivity/operations/{id}/retransmit","href":"/en/reference/rails/slc/connectivity-retransmit-operation"},{"title":"Report an operation's transmission status","deprecated":null,"version":null,"sidebarTitle":"Connectivity operation transmission status","openapi":"/en/openapi/v3-current/slc.yaml get /v1/connectivity/operations/{id}/transmission-status","href":"/en/reference/rails/slc/connectivity-operation-transmission-status"},{"title":"Trigger a return-poll catch-up drain","deprecated":null,"version":null,"sidebarTitle":"Recovery repoll","openapi":"/en/openapi/v3-current/slc.yaml post /v1/connectivity/repoll","href":"/en/reference/rails/slc/recovery-repoll"},{"title":"Reprocess pending returns for one participant","deprecated":null,"version":null,"sidebarTitle":"Recovery reprocess","openapi":"/en/openapi/v3-current/slc.yaml post /v1/connectivity/reprocess/{participantIspb}","href":"/en/reference/rails/slc/recovery-reprocess"},{"title":"Trigger an ASLC028 status-relay catch-up drain","deprecated":null,"version":null,"sidebarTitle":"Recovery status relay","openapi":"/en/openapi/v3-current/slc.yaml post /v1/connectivity/status-relay","href":"/en/reference/rails/slc/recovery-status-relay"},{"title":"Test connectivity to Núclea for a participant","deprecated":null,"version":null,"sidebarTitle":"Test connectivity","openapi":"/en/openapi/v3-current/slc.yaml post /v1/participants/{participantIspb}/test-connectivity","href":"/en/reference/rails/slc/test-connectivity"}]},{"group":"Operations","pages":[{"title":"List settlement operations","deprecated":null,"version":null,"sidebarTitle":"List operations","openapi":"/en/openapi/v3-current/slc.yaml get /v1/operations","href":"/en/reference/rails/slc/list-operations"},{"title":"Create a settlement operation","deprecated":null,"version":null,"sidebarTitle":"Create operation","openapi":"/en/openapi/v3-current/slc.yaml post /v1/operations","href":"/en/reference/rails/slc/create-operation"},{"title":"Cancel a pending settlement operation","deprecated":null,"version":null,"sidebarTitle":"Cancel operation","openapi":"/en/openapi/v3-current/slc.yaml delete /v1/operations/{operationId}","href":"/en/reference/rails/slc/cancel-operation"},{"title":"Get a settlement operation","deprecated":null,"version":null,"sidebarTitle":"Get operation","openapi":"/en/openapi/v3-current/slc.yaml get /v1/operations/{operationId}","href":"/en/reference/rails/slc/get-operation"},{"title":"Advance an operation via audited admin override","deprecated":null,"version":null,"sidebarTitle":"Advance operation","openapi":"/en/openapi/v3-current/slc.yaml post /v1/operations/{operationId}/advance","href":"/en/reference/rails/slc/advance-operation"},{"title":"Get operation state history","deprecated":null,"version":null,"sidebarTitle":"Get operation history","openapi":"/en/openapi/v3-current/slc.yaml get /v1/operations/{operationId}/history","href":"/en/reference/rails/slc/get-operation-history"},{"title":"Reconcile an operation against the counterpart's settlement status","deprecated":null,"version":null,"sidebarTitle":"Reconcile operation","openapi":"/en/openapi/v3-current/slc.yaml post /v1/operations/{operationId}/reconcile","href":"/en/reference/rails/slc/reconcile-operation"},{"title":"Re-queue a stuck operation","deprecated":null,"version":null,"sidebarTitle":"Requeue operation","openapi":"/en/openapi/v3-current/slc.yaml post /v1/operations/{operationId}/requeue","href":"/en/reference/rails/slc/requeue-operation"},{"title":"Retry a rejected operation","deprecated":null,"version":null,"sidebarTitle":"Retry operation","openapi":"/en/openapi/v3-current/slc.yaml post /v1/operations/{operationId}/retry","href":"/en/reference/rails/slc/retry-operation"},{"title":"Submit a batch of settlement operations","deprecated":null,"version":null,"sidebarTitle":"Create operations batch","openapi":"/en/openapi/v3-current/slc.yaml post /v1/operations/batch","href":"/en/reference/rails/slc/create-operations-batch"},{"title":"Look up an operation by NUliquid","deprecated":null,"version":null,"sidebarTitle":"Get operation by n uliquid","openapi":"/en/openapi/v3-current/slc.yaml get /v1/operations/nuliquid/{nuliquid}","href":"/en/reference/rails/slc/get-operation-by-n-uliquid"}]},{"group":"Files","pages":[{"title":"Intake an ASLC file","deprecated":null,"version":null,"sidebarTitle":"Intake file","openapi":"/en/openapi/v3-current/slc.yaml post /v1/files","href":"/en/reference/rails/slc/intake-file"},{"title":"Get a file status","deprecated":null,"version":null,"sidebarTitle":"Get file","openapi":"/en/openapi/v3-current/slc.yaml get /v1/files/{id}","href":"/en/reference/rails/slc/get-file"}]},{"group":"Participants","pages":[{"title":"List participants","deprecated":null,"version":null,"sidebarTitle":"List participants","openapi":"/en/openapi/v3-current/slc.yaml get /v1/participants","href":"/en/reference/rails/slc/list-participants"},{"title":"Create a participant","deprecated":null,"version":null,"sidebarTitle":"Create participant","openapi":"/en/openapi/v3-current/slc.yaml post /v1/participants","href":"/en/reference/rails/slc/create-participant"},{"title":"Delete a participant","deprecated":null,"version":null,"sidebarTitle":"Delete participant","openapi":"/en/openapi/v3-current/slc.yaml delete /v1/participants/{id}","href":"/en/reference/rails/slc/delete-participant"},{"title":"Get a participant","deprecated":null,"version":null,"sidebarTitle":"Get participant","openapi":"/en/openapi/v3-current/slc.yaml get /v1/participants/{id}","href":"/en/reference/rails/slc/get-participant"},{"title":"Update a participant","deprecated":null,"version":null,"sidebarTitle":"Update participant","openapi":"/en/openapi/v3-current/slc.yaml put /v1/participants/{id}","href":"/en/reference/rails/slc/update-participant"},{"title":"Get a participant's operational status","deprecated":null,"version":null,"sidebarTitle":"Get participant operational status","openapi":"/en/openapi/v3-current/slc.yaml get /v1/participants/{id}/operational-status","href":"/en/reference/rails/slc/get-participant-operational-status"}]},{"group":"Arrangements","pages":[{"title":"List a participant's arrangements","deprecated":null,"version":null,"sidebarTitle":"List arrangements","openapi":"/en/openapi/v3-current/slc.yaml get /v1/participants/{id}/arrangements","href":"/en/reference/rails/slc/list-arrangements"},{"title":"Create an arrangement","deprecated":null,"version":null,"sidebarTitle":"Create arrangement","openapi":"/en/openapi/v3-current/slc.yaml post /v1/participants/{id}/arrangements","href":"/en/reference/rails/slc/create-arrangement"},{"title":"Delete an arrangement","deprecated":null,"version":null,"sidebarTitle":"Delete arrangement","openapi":"/en/openapi/v3-current/slc.yaml delete /v1/participants/{id}/arrangements/{arrangementId}","href":"/en/reference/rails/slc/delete-arrangement"},{"title":"Get an arrangement","deprecated":null,"version":null,"sidebarTitle":"Get arrangement","openapi":"/en/openapi/v3-current/slc.yaml get /v1/participants/{id}/arrangements/{arrangementId}","href":"/en/reference/rails/slc/get-arrangement"},{"title":"Update an arrangement","deprecated":null,"version":null,"sidebarTitle":"Update arrangement","openapi":"/en/openapi/v3-current/slc.yaml put /v1/participants/{id}/arrangements/{arrangementId}","href":"/en/reference/rails/slc/update-arrangement"}]},{"group":"Reports","pages":[{"title":"List generated reports","deprecated":null,"version":null,"sidebarTitle":"List reports","openapi":"/en/openapi/v3-current/slc.yaml get /v1/reports","href":"/en/reference/rails/slc/list-reports"}]},{"group":"Signing keys","pages":[{"title":"Complete a BYOK Model-A signing-key import (SaaS)","deprecated":null,"version":null,"sidebarTitle":"Signing key import","openapi":"/en/openapi/v3-current/slc.yaml post /v1/signing-key","href":"/en/reference/rails/slc/signing-key-import"},{"title":"Start a BYOK Model-A signing-key import (SaaS)","deprecated":null,"version":null,"sidebarTitle":"Signing key import params","openapi":"/en/openapi/v3-current/slc.yaml post /v1/signing-key/import-params","href":"/en/reference/rails/slc/signing-key-import-params"}]},{"group":"XSD schemas","pages":[{"title":"List embedded XSD schema types","deprecated":null,"version":null,"sidebarTitle":"List xsd schemas","openapi":"/en/openapi/v3-current/slc.yaml get /v1/xsd-schemas","href":"/en/reference/rails/slc/list-xsd-schemas"},{"title":"Get one embedded XSD schema","deprecated":null,"version":null,"sidebarTitle":"Get xsd schema","openapi":"/en/openapi/v3-current/slc.yaml get /v1/xsd-schemas/{type}","href":"/en/reference/rails/slc/get-xsd-schema"}]},{"group":"Webhooks","pages":[{"title":"List webhook subscriptions","deprecated":null,"version":null,"sidebarTitle":"List webhooks","openapi":"/en/openapi/v3-current/slc.yaml get /webhooks","href":"/en/reference/rails/slc/list-webhooks"},{"title":"Register a webhook subscription","deprecated":null,"version":null,"sidebarTitle":"Create webhook","openapi":"/en/openapi/v3-current/slc.yaml post /webhooks","href":"/en/reference/rails/slc/create-webhook"},{"title":"Deactivate a webhook subscription","deprecated":null,"version":null,"sidebarTitle":"Delete webhook","openapi":"/en/openapi/v3-current/slc.yaml delete /webhooks/{id}","href":"/en/reference/rails/slc/delete-webhook"},{"title":"Update a webhook subscription","deprecated":null,"version":null,"sidebarTitle":"Update webhook","openapi":"/en/openapi/v3-current/slc.yaml put /webhooks/{id}","href":"/en/reference/rails/slc/update-webhook"},{"title":"List a webhook's delivery history","deprecated":null,"version":null,"sidebarTitle":"List webhook deliveries","openapi":"/en/openapi/v3-current/slc.yaml get /webhooks/{id}/deliveries","href":"/en/reference/rails/slc/list-webhook-deliveries"},{"title":"Replay a failed webhook delivery","deprecated":null,"version":null,"sidebarTitle":"Replay webhook delivery","openapi":"/en/openapi/v3-current/slc.yaml post /webhooks/{id}/deliveries/{deliveryId}/replay","href":"/en/reference/rails/slc/replay-webhook-delivery"},{"title":"Send a synthetic test event to a webhook","deprecated":null,"version":null,"sidebarTitle":"Test webhook","openapi":"/en/openapi/v3-current/slc.yaml post /webhooks/{id}/test","href":"/en/reference/rails/slc/test-webhook"}]},{"group":"Error handling","pages":[{"title":"SLC error list","href":"/en/reference/rails/slc/slc-error-list"}]}]},{"dropdown":"SILOC","icon":"barcode","description":"Deferred settlement messaging over SILOC","groups":[{"group":"Integration","pages":[{"title":"List settlement-coverage capabilities","deprecated":null,"version":null,"sidebarTitle":"List capabilities","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/capabilities","href":"/en/reference/rails/siloc/list-capabilities"},{"title":"Get notification configuration","deprecated":null,"version":null,"sidebarTitle":"Get notification config","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/notifications/config","href":"/en/reference/rails/siloc/get-notification-config"},{"title":"Update notification configuration","deprecated":null,"version":null,"sidebarTitle":"Update notification config","openapi":"/en/openapi/v3-current/siloc.yaml put /api/v1/siloc/notifications/config","href":"/en/reference/rails/siloc/update-notification-config"}]},{"group":"Connectivity","pages":[{"title":"List regulated certificates","deprecated":null,"version":null,"sidebarTitle":"List certificates","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/certificates","href":"/en/reference/rails/siloc/list-certificates"},{"title":"Register a certificate reference","deprecated":null,"version":null,"sidebarTitle":"Register certificate","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/certificates","href":"/en/reference/rails/siloc/register-certificate"},{"title":"Get a certificate","deprecated":null,"version":null,"sidebarTitle":"Get certificate","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/certificates/{certificateId}","href":"/en/reference/rails/siloc/get-certificate"},{"title":"Revoke a certificate","deprecated":null,"version":null,"sidebarTitle":"Revoke certificate","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/certificates/{certificateId}/revoke","href":"/en/reference/rails/siloc/revoke-certificate"},{"title":"List parked relay failures","deprecated":null,"version":null,"sidebarTitle":"List relay failures","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/dlq/relay-failures","href":"/en/reference/rails/siloc/list-relay-failures"},{"title":"Replay a parked relay failure","deprecated":null,"version":null,"sidebarTitle":"Replay relay failure","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/dlq/relay-failures/{id}/replay","href":"/en/reference/rails/siloc/replay-relay-failure"},{"title":"List relayed card-domain messages","deprecated":null,"version":null,"sidebarTitle":"List relayed messages","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/relay/messages","href":"/en/reference/rails/siloc/list-relayed-messages"},{"title":"Get the card-domain relay status","deprecated":null,"version":null,"sidebarTitle":"Get relay status","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/relay/status","href":"/en/reference/rails/siloc/get-relay-status"},{"title":"List parked deferred inbound messages","deprecated":null,"version":null,"sidebarTitle":"List parked deferred inbound messages","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/dlq/deferred","href":"/en/reference/rails/siloc/list-parked-deferred-inbound-messages"},{"title":"List quarantined inbound frames","deprecated":null,"version":null,"sidebarTitle":"List quarantined inbound frames","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/dlq/quarantine","href":"/en/reference/rails/siloc/list-quarantined-inbound-frames"},{"title":"Resolve a quarantined inbound frame","deprecated":null,"version":null,"sidebarTitle":"Resolve a quarantined inbound frame","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/dlq/quarantine/{id}/resolve","href":"/en/reference/rails/siloc/resolve-a-quarantined-inbound-frame"}]},{"group":"Homologation","pages":[{"title":"List homologation scenarios","deprecated":null,"version":null,"sidebarTitle":"List homologation scenarios","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/homologation/scenarios","href":"/en/reference/rails/siloc/list-homologation-scenarios"},{"title":"Get a homologation scenario","deprecated":null,"version":null,"sidebarTitle":"Get a homologation scenario","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/homologation/scenarios/{scenarioId}","href":"/en/reference/rails/siloc/get-a-homologation-scenario"},{"title":"Run a homologation scenario","deprecated":null,"version":null,"sidebarTitle":"Run a homologation scenario","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/homologation/scenarios/{scenarioId}/runs","href":"/en/reference/rails/siloc/run-a-homologation-scenario"},{"title":"List a homologation scenario's runs","deprecated":null,"version":null,"sidebarTitle":"List a homologation scenario s runs","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/homologation/scenarios/{scenarioId}/runs","href":"/en/reference/rails/siloc/list-a-homologation-scenario-s-runs"}]},{"group":"Participants","pages":[{"title":"List participants","deprecated":null,"version":null,"sidebarTitle":"List participants","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/participants","href":"/en/reference/rails/siloc/list-participants"},{"title":"Register a participant","deprecated":null,"version":null,"sidebarTitle":"Register participant","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/participants","href":"/en/reference/rails/siloc/register-participant"},{"title":"Get a participant","deprecated":null,"version":null,"sidebarTitle":"Get participant","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/participants/{participantId}","href":"/en/reference/rails/siloc/get-participant"},{"title":"Update a participant","deprecated":null,"version":null,"sidebarTitle":"Update participant","openapi":"/en/openapi/v3-current/siloc.yaml put /api/v1/siloc/participants/{participantId}","href":"/en/reference/rails/siloc/update-participant"},{"title":"Get a participant's operational status","deprecated":null,"version":null,"sidebarTitle":"Get participant status","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/participants/{participantId}/status","href":"/en/reference/rails/siloc/get-participant-status"},{"title":"Request this participant to become operante","deprecated":null,"version":null,"sidebarTitle":"Request this participant to become operante","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/operative-status-changes","href":"/en/reference/rails/siloc/request-this-participant-to-become-operante"},{"title":"Read one PAG0202 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0202 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/operative-status-changes/{id}","href":"/en/reference/rails/siloc/read-one-pag0202-instruction-and-its-answer"},{"title":"Request this participant to become inoperante","deprecated":null,"version":null,"sidebarTitle":"Request this participant to become inoperante","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/inoperative-status-changes","href":"/en/reference/rails/siloc/request-this-participant-to-become-inoperante"},{"title":"Read one PAG0201 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0201 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/inoperative-status-changes/{id}","href":"/en/reference/rails/siloc/read-one-pag0201-instruction-and-its-answer"},{"title":"Withdraw a situação change registered in the Câmara PAG","deprecated":null,"version":null,"sidebarTitle":"Cancel status change","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/status-change-cancellations","href":"/en/reference/rails/siloc/cancel-status-change"},{"title":"Read one PAG0203 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0203 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/status-change-cancellations/{id}","href":"/en/reference/rails/siloc/read-one-pag0203-instruction-and-its-answer"}]},{"group":"Cycles and settlement","pages":[{"title":"List OT settlement cycles","deprecated":null,"version":null,"sidebarTitle":"List cycles","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/cycles","href":"/en/reference/rails/siloc/list-cycles"},{"title":"Get an OT settlement cycle","deprecated":null,"version":null,"sidebarTitle":"Get cycle","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/cycles/{cycleId}","href":"/en/reference/rails/siloc/get-cycle"},{"title":"Get a cycle's reconciliation result","deprecated":null,"version":null,"sidebarTitle":"Get cycle reconciliation","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/cycles/{cycleId}/reconciliation","href":"/en/reference/rails/siloc/get-cycle-reconciliation"},{"title":"Get a cycle's recálculo round chain","deprecated":null,"version":null,"sidebarTitle":"Get cycle recalculations","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/cycles/{cycleId}/recalculations","href":"/en/reference/rails/siloc/get-cycle-recalculations"},{"title":"List OT settlement instructions (obligations)","deprecated":null,"version":null,"sidebarTitle":"List settlement instructions","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/settlement-instructions","href":"/en/reference/rails/siloc/list-settlement-instructions"},{"title":"Get an OT settlement instruction","deprecated":null,"version":null,"sidebarTitle":"Get settlement instruction","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/settlement-instructions/{instructionId}","href":"/en/reference/rails/siloc/get-settlement-instruction"},{"title":"Ingest a semantic ROC revision","deprecated":null,"version":null,"sidebarTitle":"Ingest roc","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/rocs","href":"/en/reference/rails/siloc/ingest-roc"},{"title":"Confirm or dispute the day's net result","deprecated":null,"version":null,"sidebarTitle":"Confirm or dispute the day s net result","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/net-result-confirmations","href":"/en/reference/rails/siloc/confirm-or-dispute-the-day-s-net-result"},{"title":"Read one LDL0003 command and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl0003 command and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/net-result-confirmations/{id}","href":"/en/reference/rails/siloc/read-one-ldl0003-command-and-its-answer"},{"title":"Ask the câmara for the net position","deprecated":null,"version":null,"sidebarTitle":"Ask the camara for the net position","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/net-position-queries","href":"/en/reference/rails/siloc/ask-the-camara-for-the-net-position"},{"title":"Read one LDL0026 command and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl0026 command and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/net-position-queries/{id}","href":"/en/reference/rails/siloc/read-one-ldl0026-command-and-its-answer"},{"title":"Withdraw balance from the settlement account","deprecated":null,"version":null,"sidebarTitle":"Withdraw balance from the settlement account","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/camara-withdrawals","href":"/en/reference/rails/siloc/withdraw-balance-from-the-settlement-account"},{"title":"Read one LDL0032 command and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl0032 command and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/camara-withdrawals/{id}","href":"/en/reference/rails/siloc/read-one-ldl0032-command-and-its-answer"},{"title":"List câmara bilateral settlement balances","deprecated":null,"version":null,"sidebarTitle":"List camara bilateral settlement balances","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/bilateral-balances","href":"/en/reference/rails/siloc/list-camara-bilateral-settlement-balances"}]},{"group":"Transfers","pages":[{"title":"Transfer funds between client accounts","deprecated":null,"version":null,"sidebarTitle":"Transfer funds between client accounts","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/client-account-transfers","href":"/en/reference/rails/siloc/transfer-funds-between-client-accounts"},{"title":"Read one PAG0108 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0108 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/client-account-transfers/{id}","href":"/en/reference/rails/siloc/read-one-pag0108-instruction-and-its-answer"},{"title":"Transfer funds on behalf of a non-account holder","deprecated":null,"version":null,"sidebarTitle":"Transfer funds on behalf of a non account holder","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/non-account-holder-transfers","href":"/en/reference/rails/siloc/transfer-funds-on-behalf-of-a-non-account-holder"},{"title":"Read one PAG0107 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0107 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/non-account-holder-transfers/{id}","href":"/en/reference/rails/siloc/read-one-pag0107-instruction-and-its-answer"},{"title":"Transfer funds for a client at a non-reserve-holding institution","deprecated":null,"version":null,"sidebarTitle":"Transfer to non reserve institution","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/non-reserve-institution-transfers","href":"/en/reference/rails/siloc/transfer-to-non-reserve-institution"},{"title":"Read one PAG0134 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0134 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/non-reserve-institution-transfers/{id}","href":"/en/reference/rails/siloc/read-one-pag0134-instruction-and-its-answer"},{"title":"Transfer funds from a client to an institution for a retail operation","deprecated":null,"version":null,"sidebarTitle":"Transfer retail client to institution","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/retail-client-to-institution-transfers","href":"/en/reference/rails/siloc/transfer-retail-client-to-institution"},{"title":"Read one PAG0142 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0142 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/retail-client-to-institution-transfers/{id}","href":"/en/reference/rails/siloc/read-one-pag0142-instruction-and-its-answer"},{"title":"Transfer funds from an institution to a client for a retail operation","deprecated":null,"version":null,"sidebarTitle":"Transfer retail institution to client","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/retail-institution-to-client-transfers","href":"/en/reference/rails/siloc/transfer-retail-institution-to-client"},{"title":"Read one PAG0143 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0143 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/retail-institution-to-client-transfers/{id}","href":"/en/reference/rails/siloc/read-one-pag0143-instruction-and-its-answer"},{"title":"Transfer funds out of a salary account","deprecated":null,"version":null,"sidebarTitle":"Transfer funds out of a salary account","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/salary-account-transfers","href":"/en/reference/rails/siloc/transfer-funds-out-of-a-salary-account"},{"title":"Read one PAG0137 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0137 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/salary-account-transfers/{id}","href":"/en/reference/rails/siloc/read-one-pag0137-instruction-and-its-answer"},{"title":"Transfer funds for a payroll-loan credit","deprecated":null,"version":null,"sidebarTitle":"Transfer funds for a payroll loan credit","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/payroll-loan-credit-transfers","href":"/en/reference/rails/siloc/transfer-funds-for-a-payroll-loan-credit"},{"title":"Read one PAG0141 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0141 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/payroll-loan-credit-transfers/{id}","href":"/en/reference/rails/siloc/read-one-pag0141-instruction-and-its-answer"},{"title":"Transfer funds for a judicial deposit","deprecated":null,"version":null,"sidebarTitle":"Transfer funds for a judicial deposit","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/judicial-deposit-transfers","href":"/en/reference/rails/siloc/transfer-funds-for-a-judicial-deposit"},{"title":"Read one PAG0121 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0121 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/judicial-deposit-transfers/{id}","href":"/en/reference/rails/siloc/read-one-pag0121-instruction-and-its-answer"},{"title":"Transfer funds for a judicial release","deprecated":null,"version":null,"sidebarTitle":"Transfer funds for a judicial release","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/judicial-release-transfers","href":"/en/reference/rails/siloc/transfer-funds-for-a-judicial-release"},{"title":"Read one PAG0151 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0151 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/judicial-release-transfers/{id}","href":"/en/reference/rails/siloc/read-one-pag0151-instruction-and-its-answer"},{"title":"Transfer funds to settle a barcoded document","deprecated":null,"version":null,"sidebarTitle":"Transfer funds to settle a barcoded document","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/barcode-document-settlements","href":"/en/reference/rails/siloc/transfer-funds-to-settle-a-barcoded-document"},{"title":"Read one PAG0122 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0122 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/barcode-document-settlements/{id}","href":"/en/reference/rails/siloc/read-one-pag0122-instruction-and-its-answer"},{"title":"Return funds received in error","deprecated":null,"version":null,"sidebarTitle":"Return funds received in error","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/undue-transfer-refunds","href":"/en/reference/rails/siloc/return-funds-received-in-error"},{"title":"Read one PAG0111 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0111 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/undue-transfer-refunds/{id}","href":"/en/reference/rails/siloc/read-one-pag0111-instruction-and-its-answer"}]},{"group":"Collateral","pages":[{"title":"List câmara collateral advisories","deprecated":null,"version":null,"sidebarTitle":"List camara collateral advisories","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/collateral/advisories","href":"/en/reference/rails/siloc/list-camara-collateral-advisories"},{"title":"Query the assets the câmara accepts as collateral","deprecated":null,"version":null,"sidebarTitle":"Query the assets the camara accepts as collateral","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/eligible-collateral-queries","href":"/en/reference/rails/siloc/query-the-assets-the-camara-accepts-as-collateral"},{"title":"Read one LDL1013 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1013 request and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/eligible-collateral-queries/{id}","href":"/en/reference/rails/siloc/read-one-ldl1013-request-and-its-answer"},{"title":"Ask the câmara to accept a collateral deposit","deprecated":null,"version":null,"sidebarTitle":"Ask the camara to accept a collateral deposit","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/deposit-acceptance-requests","href":"/en/reference/rails/siloc/ask-the-camara-to-accept-a-collateral-deposit"},{"title":"Read one LDL1002 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1002 request and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/deposit-acceptance-requests/{id}","href":"/en/reference/rails/siloc/read-one-ldl1002-request-and-its-answer"},{"title":"Request a collateral deposit the câmara already accepted","deprecated":null,"version":null,"sidebarTitle":"Request collateral deposit","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/deposit-requests","href":"/en/reference/rails/siloc/request-collateral-deposit"},{"title":"Read one LDL1003 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1003 request and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/deposit-requests/{id}","href":"/en/reference/rails/siloc/read-one-ldl1003-request-and-its-answer"},{"title":"Query the assets deposited at the câmara","deprecated":null,"version":null,"sidebarTitle":"Query the assets deposited at the camara","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/deposited-asset-queries","href":"/en/reference/rails/siloc/query-the-assets-deposited-at-the-camara"},{"title":"Read one LDL1012 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1012 request and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/deposited-asset-queries/{id}","href":"/en/reference/rails/siloc/read-one-ldl1012-request-and-its-answer"},{"title":"Move collateral between holders or purposes","deprecated":null,"version":null,"sidebarTitle":"Move collateral between holders or purposes","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/collateral-movements","href":"/en/reference/rails/siloc/move-collateral-between-holders-or-purposes"},{"title":"Read one LDL1016 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1016 request and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/collateral-movements/{id}","href":"/en/reference/rails/siloc/read-one-ldl1016-request-and-its-answer"},{"title":"Move one holder's collateral by asset number","deprecated":null,"version":null,"sidebarTitle":"Move one holder s collateral by asset number","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/same-holder-collateral-movements","href":"/en/reference/rails/siloc/move-one-holder-s-collateral-by-asset-number"},{"title":"Read one LDL1017 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1017 request and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/same-holder-collateral-movements/{id}","href":"/en/reference/rails/siloc/read-one-ldl1017-request-and-its-answer"},{"title":"Ask the câmara to accept a collateral withdrawal","deprecated":null,"version":null,"sidebarTitle":"Ask the camara to accept a collateral withdrawal","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/withdrawal-acceptance-requests","href":"/en/reference/rails/siloc/ask-the-camara-to-accept-a-collateral-withdrawal"},{"title":"Read one LDL1006 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1006 request and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/withdrawal-acceptance-requests/{id}","href":"/en/reference/rails/siloc/read-one-ldl1006-request-and-its-answer"},{"title":"Confirm a guarantee issuance or amendment","deprecated":null,"version":null,"sidebarTitle":"Confirm a guarantee issuance or amendment","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/guarantee-issuance-confirmations","href":"/en/reference/rails/siloc/confirm-a-guarantee-issuance-or-amendment"},{"title":"Read one LDL1019 command and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1019 command and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/guarantee-issuance-confirmations/{id}","href":"/en/reference/rails/siloc/read-one-ldl1019-command-and-its-answer"},{"title":"Ask to amend a guarantee's maturity or amount","deprecated":null,"version":null,"sidebarTitle":"Ask to amend a guarantee s maturity or amount","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/guarantee-maturity-amendments","href":"/en/reference/rails/siloc/ask-to-amend-a-guarantee-s-maturity-or-amount"},{"title":"Read one LDL1010 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1010 request and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/guarantee-maturity-amendments/{id}","href":"/en/reference/rails/siloc/read-one-ldl1010-request-and-its-answer"},{"title":"Query the reference prices the câmara used on a day","deprecated":null,"version":null,"sidebarTitle":"Query reference prices","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/price-history-queries","href":"/en/reference/rails/siloc/query-reference-prices"},{"title":"Read one LDL1015 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1015 request and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/price-history-queries/{id}","href":"/en/reference/rails/siloc/read-one-ldl1015-request-and-its-answer"}]},{"group":"Card route","pages":[{"title":"List the card-route commands Lerian SLC issued","deprecated":null,"version":null,"sidebarTitle":"List the card route commands lerian slc issued","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/card-commands","href":"/en/reference/rails/siloc/list-the-card-route-commands-lerian-slc-issued"},{"title":"Read one card-route command","deprecated":null,"version":null,"sidebarTitle":"Read one card route command","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/card-commands/{id}","href":"/en/reference/rails/siloc/read-one-card-route-command"},{"title":"Confirm or diverge from an announced LBTR result","deprecated":null,"version":null,"sidebarTitle":"Confirm or diverge from an announced lbtr result","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/ltr-result-decisions","href":"/en/reference/rails/siloc/confirm-or-diverge-from-an-announced-lbtr-result"},{"title":"Read one LTR0002 decision and its state","deprecated":null,"version":null,"sidebarTitle":"Read one ltr0002 decision and its state","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/ltr-result-decisions/{id}","href":"/en/reference/rails/siloc/read-one-ltr0002-decision-and-its-state"},{"title":"Confirm or reject a settlement between two non-settling members","deprecated":null,"version":null,"sidebarTitle":"Decide non settling member settlement","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/ltr-nonliquidante-decisions","href":"/en/reference/rails/siloc/decide-non-settling-member-settlement"},{"title":"Read one LTR0008 decision and its state","deprecated":null,"version":null,"sidebarTitle":"Read one ltr0008 decision and its state","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/ltr-nonliquidante-decisions/{id}","href":"/en/reference/rails/siloc/read-one-ltr0008-decision-and-its-state"},{"title":"Ask the câmara for the institution's LBTR position","deprecated":null,"version":null,"sidebarTitle":"Ask the camara for the institution s lbtr position","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/ltr-position-queries","href":"/en/reference/rails/siloc/ask-the-camara-for-the-institution-s-lbtr-position"},{"title":"Read one LTR0009 query and its state","deprecated":null,"version":null,"sidebarTitle":"Read one ltr0009 query and its state","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/ltr-position-queries/{id}","href":"/en/reference/rails/siloc/read-one-ltr0009-query-and-its-state"}]},{"group":"Entries and statements","pages":[{"title":"Query the entries the Câmara PAG holds","deprecated":null,"version":null,"sidebarTitle":"Query the entries the camara pag holds","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/entry-queries","href":"/en/reference/rails/siloc/query-the-entries-the-camara-pag-holds"},{"title":"Read one PAG0113 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0113 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/entry-queries/{id}","href":"/en/reference/rails/siloc/read-one-pag0113-instruction-and-its-answer"},{"title":"Cancel a pending entry in the Câmara PAG","deprecated":null,"version":null,"sidebarTitle":"Cancel a pending entry in the camara pag","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/pending-entry-cancellations","href":"/en/reference/rails/siloc/cancel-a-pending-entry-in-the-camara-pag"},{"title":"Read one PAG0112 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0112 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/pending-entry-cancellations/{id}","href":"/en/reference/rails/siloc/read-one-pag0112-instruction-and-its-answer"},{"title":"Query the synthetic statement in the Câmara PAG","deprecated":null,"version":null,"sidebarTitle":"Query the synthetic statement in the camara pag","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/synthetic-statement-queries","href":"/en/reference/rails/siloc/query-the-synthetic-statement-in-the-camara-pag"},{"title":"Read one PAG0114 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0114 instruction and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/synthetic-statement-queries/{id}","href":"/en/reference/rails/siloc/read-one-pag0114-instruction-and-its-answer"}]},{"group":"Advices and notices","pages":[{"title":"List the advices the SILOC câmara sent this institution","deprecated":null,"version":null,"sidebarTitle":"List camara advices","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/advices","href":"/en/reference/rails/siloc/list-camara-advices"},{"title":"List the PAG transfer credit notices the câmara sent this institution","deprecated":null,"version":null,"sidebarTitle":"List transfer credit notices","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/advices/transfer-credit-notices","href":"/en/reference/rails/siloc/list-transfer-credit-notices"},{"title":"List file-availability notices from other participants","deprecated":null,"version":null,"sidebarTitle":"List file notices","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/file-notices","href":"/en/reference/rails/siloc/list-file-notices"}]},{"group":"Alerts and audit","pages":[{"title":"List operational alerts","deprecated":null,"version":null,"sidebarTitle":"List alerts","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/alerts","href":"/en/reference/rails/siloc/list-alerts"},{"title":"Acknowledge an operational alert","deprecated":null,"version":null,"sidebarTitle":"Acknowledge an operational alert","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/alerts/{id}/acknowledge","href":"/en/reference/rails/siloc/acknowledge-an-operational-alert"},{"title":"List audit records","deprecated":null,"version":null,"sidebarTitle":"List audit records","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/audit-records","href":"/en/reference/rails/siloc/list-audit-records"},{"title":"List outbound messages of every code","deprecated":null,"version":null,"sidebarTitle":"List outbound messages of every code","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/messages","href":"/en/reference/rails/siloc/list-outbound-messages-of-every-code"},{"title":"Read one outbound message, whatever its code","deprecated":null,"version":null,"sidebarTitle":"Read one outbound message whatever its code","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/messages/{id}","href":"/en/reference/rails/siloc/read-one-outbound-message-whatever-its-code"}]},{"group":"Schedule","pages":[{"title":"Get the business-day calendar","deprecated":null,"version":null,"sidebarTitle":"Get business day calendar","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/schedule/calendar","href":"/en/reference/rails/siloc/get-business-day-calendar"},{"title":"List OT cycle windows","deprecated":null,"version":null,"sidebarTitle":"List schedule windows","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/schedule/windows","href":"/en/reference/rails/siloc/list-schedule-windows"},{"title":"Record a contingency schedule change","deprecated":null,"version":null,"sidebarTitle":"Record schedule change","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/schedule/changes","href":"/en/reference/rails/siloc/record-schedule-change"},{"title":"List contingency schedule changes","deprecated":null,"version":null,"sidebarTitle":"List schedule changes","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/schedule/changes","href":"/en/reference/rails/siloc/list-schedule-changes"},{"title":"List the grades de horário the câmara published","deprecated":null,"version":null,"sidebarTitle":"List schedule grids","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/schedule/grids","href":"/en/reference/rails/siloc/list-schedule-grids"},{"title":"Get the câmara's last session announcements","deprecated":null,"version":null,"sidebarTitle":"Get the camara s last session announcements","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/schedule/camara-session","href":"/en/reference/rails/siloc/get-the-camara-s-last-session-announcements"},{"title":"Ask the câmara for its LDL schedule grid","deprecated":null,"version":null,"sidebarTitle":"Ask the camara for its ldl schedule grid","openapi":"/en/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/schedule-queries","href":"/en/reference/rails/siloc/ask-the-camara-for-its-ldl-schedule-grid"},{"title":"Read one schedule query and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one schedule query and its answer","openapi":"/en/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/schedule-queries/{id}","href":"/en/reference/rails/siloc/read-one-schedule-query-and-its-answer"}]},{"group":"Error handling","pages":[{"title":"SILOC error list","href":"/en/reference/rails/siloc/siloc-error-list"}]}]},{"dropdown":"STA","icon":"file-arrow-up","description":"File transfer with BACEN over the STA rail","groups":[{"group":"Credentials","pages":[{"title":"List credentials","deprecated":null,"version":null,"sidebarTitle":"Get credentials","openapi":"/en/openapi/v3-current/sta.yaml get /v1/credentials","href":"/en/reference/rails/sta/get-credentials"},{"title":"Create a credential","deprecated":null,"version":null,"sidebarTitle":"Post credentials","openapi":"/en/openapi/v3-current/sta.yaml post /v1/credentials","href":"/en/reference/rails/sta/post-credentials"},{"title":"Read a credential","deprecated":null,"version":null,"sidebarTitle":"Get credentials id","openapi":"/en/openapi/v3-current/sta.yaml get /v1/credentials/{id}","href":"/en/reference/rails/sta/get-credentials-id"},{"title":"Revoke a credential (LOCAL-only soft-delete)","deprecated":null,"version":null,"sidebarTitle":"Delete credentials id","openapi":"/en/openapi/v3-current/sta.yaml delete /v1/credentials/{id}","href":"/en/reference/rails/sta/delete-credentials-id"},{"title":"Update a credential (LOCAL-only)","deprecated":null,"version":null,"sidebarTitle":"Patch credentials id","openapi":"/en/openapi/v3-current/sta.yaml patch /v1/credentials/{id}","href":"/en/reference/rails/sta/patch-credentials-id"},{"title":"Rotate the password for a credential","deprecated":null,"version":null,"sidebarTitle":"Post credentials id rotate","openapi":"/en/openapi/v3-current/sta.yaml post /v1/credentials/{id}/rotate","href":"/en/reference/rails/sta/post-credentials-id-rotate"},{"title":"Test BACEN STA connectivity for a credential","deprecated":null,"version":null,"sidebarTitle":"Post credentials id test","openapi":"/en/openapi/v3-current/sta.yaml post /v1/credentials/{id}/test","href":"/en/reference/rails/sta/post-credentials-id-test"}]},{"group":"Inbound source configurations","pages":[{"title":"List inbound source configs","deprecated":null,"version":null,"sidebarTitle":"Get inbound source configs","openapi":"/en/openapi/v3-current/sta.yaml get /v1/inbound-source-configs","href":"/en/reference/rails/sta/get-inbound-source-configs"},{"title":"Create an inbound source config","deprecated":null,"version":null,"sidebarTitle":"Post inbound source configs","openapi":"/en/openapi/v3-current/sta.yaml post /v1/inbound-source-configs","href":"/en/reference/rails/sta/post-inbound-source-configs"},{"title":"Read an inbound source config","deprecated":null,"version":null,"sidebarTitle":"Get inbound source configs id","openapi":"/en/openapi/v3-current/sta.yaml get /v1/inbound-source-configs/{id}","href":"/en/reference/rails/sta/get-inbound-source-configs-id"},{"title":"Delete an inbound source config","deprecated":null,"version":null,"sidebarTitle":"Delete inbound source configs id","openapi":"/en/openapi/v3-current/sta.yaml delete /v1/inbound-source-configs/{id}","href":"/en/reference/rails/sta/delete-inbound-source-configs-id"},{"title":"Update an inbound source config","deprecated":null,"version":null,"sidebarTitle":"Patch inbound source configs id","openapi":"/en/openapi/v3-current/sta.yaml patch /v1/inbound-source-configs/{id}","href":"/en/reference/rails/sta/patch-inbound-source-configs-id"},{"title":"Trigger an inbound poll","deprecated":null,"version":null,"sidebarTitle":"Post inbound source configs id trigger poll","openapi":"/en/openapi/v3-current/sta.yaml post /v1/inbound-source-configs/{id}/trigger-poll","href":"/en/reference/rails/sta/post-inbound-source-configs-id-trigger-poll"}]},{"group":"Transfers","pages":[{"title":"Mark an inbound transfer for urgent processing","deprecated":null,"version":null,"sidebarTitle":"Post inbound transfers id mark urgent","openapi":"/en/openapi/v3-current/sta.yaml post /v1/inbound/transfers/{id}/mark-urgent","href":"/en/reference/rails/sta/post-inbound-transfers-id-mark-urgent"},{"title":"List transfers","deprecated":null,"version":null,"sidebarTitle":"Get transfers","openapi":"/en/openapi/v3-current/sta.yaml get /v1/transfers","href":"/en/reference/rails/sta/get-transfers"},{"title":"Create outbound transfer","deprecated":null,"version":null,"sidebarTitle":"Post transfers","openapi":"/en/openapi/v3-current/sta.yaml post /v1/transfers","href":"/en/reference/rails/sta/post-transfers"},{"title":"Read a transfer","deprecated":null,"version":null,"sidebarTitle":"Get transfers id","openapi":"/en/openapi/v3-current/sta.yaml get /v1/transfers/{id}","href":"/en/reference/rails/sta/get-transfers-id"},{"title":"Cancel a non-terminal transfer","deprecated":null,"version":null,"sidebarTitle":"Post transfers id cancel","openapi":"/en/openapi/v3-current/sta.yaml post /v1/transfers/{id}/cancel","href":"/en/reference/rails/sta/post-transfers-id-cancel"},{"title":"Retry a stalled outbound transfer","deprecated":null,"version":null,"sidebarTitle":"Post transfers id retry","openapi":"/en/openapi/v3-current/sta.yaml post /v1/transfers/{id}/retry","href":"/en/reference/rails/sta/post-transfers-id-retry"}]},{"group":"Audit","pages":[{"title":"List transfer history","deprecated":null,"version":null,"sidebarTitle":"Get audit transfer history","openapi":"/en/openapi/v3-current/sta.yaml get /v1/audit/transfer-history","href":"/en/reference/rails/sta/get-audit-transfer-history"},{"title":"Read a transfer history entry","deprecated":null,"version":null,"sidebarTitle":"Get audit transfer history id","openapi":"/en/openapi/v3-current/sta.yaml get /v1/audit/transfer-history/{id}","href":"/en/reference/rails/sta/get-audit-transfer-history-id"},{"title":"List credential access logs","deprecated":null,"version":null,"sidebarTitle":"Get audit credential access logs","openapi":"/en/openapi/v3-current/sta.yaml get /v1/audit/credential-access-logs","href":"/en/reference/rails/sta/get-audit-credential-access-logs"},{"title":"Read a credential access log entry","deprecated":null,"version":null,"sidebarTitle":"Get audit credential access logs id","openapi":"/en/openapi/v3-current/sta.yaml get /v1/audit/credential-access-logs/{id}","href":"/en/reference/rails/sta/get-audit-credential-access-logs-id"},{"title":"List audit exports","deprecated":null,"version":null,"sidebarTitle":"Get audit exports","openapi":"/en/openapi/v3-current/sta.yaml get /v1/audit/exports","href":"/en/reference/rails/sta/get-audit-exports"},{"title":"Create an audit export","deprecated":null,"version":null,"sidebarTitle":"Post audit exports","openapi":"/en/openapi/v3-current/sta.yaml post /v1/audit/exports","href":"/en/reference/rails/sta/post-audit-exports"},{"title":"Read an audit export","deprecated":null,"version":null,"sidebarTitle":"Get audit exports id","openapi":"/en/openapi/v3-current/sta.yaml get /v1/audit/exports/{id}","href":"/en/reference/rails/sta/get-audit-exports-id"},{"title":"Download an audit export object","deprecated":null,"version":null,"sidebarTitle":"Get audit exports id download","openapi":"/en/openapi/v3-current/sta.yaml get /v1/audit/exports/{id}/download","href":"/en/reference/rails/sta/get-audit-exports-id-download"}]},{"group":"Error handling","pages":[{"title":"STA error list","href":"/en/reference/rails/sta/sta-error-list"}]}]},{"dropdown":"SISBAJUD","icon":"gavel","description":"Judicial asset orders over the SISBAJUD rail","groups":[{"group":"SISBAJUD Mensageria · Institutions","pages":[{"title":"Create institution config and provision keys","deprecated":null,"version":null,"sidebarTitle":"Create institution config and provision keys","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions","href":"/en/reference/rails/sisbajud/mensageria/create-institution-config-and-provision-keys"},{"title":"Get institution config by id","deprecated":null,"version":null,"sidebarTitle":"Get institution config by id","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}","href":"/en/reference/rails/sisbajud/mensageria/get-institution-config-by-id"},{"title":"Update institution config by id","deprecated":null,"version":null,"sidebarTitle":"Update institution config by id","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml patch /v1/institutions/{institutionId}","href":"/en/reference/rails/sisbajud/mensageria/update-institution-config-by-id"}]},{"group":"SISBAJUD Mensageria · Orders and files","pages":[{"title":"List orders (admin)","deprecated":null,"version":null,"sidebarTitle":"List orders admin","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/orders","href":"/en/reference/rails/sisbajud/mensageria/list-orders-admin"},{"title":"Get order detail (admin)","deprecated":null,"version":null,"sidebarTitle":"Get order detail admin","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/orders/{id}","href":"/en/reference/rails/sisbajud/mensageria/get-order-detail-admin"},{"title":"List files (admin)","deprecated":null,"version":null,"sidebarTitle":"List files admin","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/files","href":"/en/reference/rails/sisbajud/mensageria/list-files-admin"},{"title":"Get file detail (admin)","deprecated":null,"version":null,"sidebarTitle":"Get file detail admin","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/files/{id}","href":"/en/reference/rails/sisbajud/mensageria/get-file-detail-admin"},{"title":"List orders awaiting a human decision (admin)","deprecated":null,"version":null,"sidebarTitle":"List orders awaiting a human decision admin","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/awaiting-decision-orders","href":"/en/reference/rails/sisbajud/mensageria/list-orders-awaiting-a-human-decision-admin"},{"title":"List failed orders (admin)","deprecated":null,"version":null,"sidebarTitle":"List failed orders admin","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/failed-orders","href":"/en/reference/rails/sisbajud/mensageria/list-failed-orders-admin"},{"title":"Get processing stats (admin)","deprecated":null,"version":null,"sidebarTitle":"Get processing stats admin","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/stats","href":"/en/reference/rails/sisbajud/mensageria/get-processing-stats-admin"}]},{"group":"SISBAJUD Mensageria · Monitoring","pages":[{"title":"Get SLA status (admin)","deprecated":null,"version":null,"sidebarTitle":"Get sla status admin","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/sla-status","href":"/en/reference/rails/sisbajud/mensageria/get-sla-status-admin"},{"title":"Verify audit trail integrity (admin)","deprecated":null,"version":null,"sidebarTitle":"Verify audit trail integrity admin","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/audit/verify","href":"/en/reference/rails/sisbajud/mensageria/verify-audit-trail-integrity-admin"}]},{"group":"SISBAJUD Mensageria · Return files","pages":[{"title":"Force a return-file generation","deprecated":null,"version":null,"sidebarTitle":"Force a return file generation","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/return-file/generate","href":"/en/reference/rails/sisbajud/mensageria/force-a-return-file-generation"},{"title":"Release a failed return file's judicial orders","deprecated":null,"version":null,"sidebarTitle":"Release a failed return file s judicial orders","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/return-file/{id}/reconsolidate","href":"/en/reference/rails/sisbajud/mensageria/release-a-failed-return-file-s-judicial-orders"},{"title":"Resolve a stuck return-file transmission","deprecated":null,"version":null,"sidebarTitle":"Resolve a stuck return file transmission","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/return-file/{id}/resolve-transmission","href":"/en/reference/rails/sisbajud/mensageria/resolve-a-stuck-return-file-transmission"}]},{"group":"SISBAJUD Mensageria · LGPD requests","pages":[{"title":"Create an LGPD data-subject request","deprecated":null,"version":null,"sidebarTitle":"Create an lgpd data subject request","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/lgpd/requests","href":"/en/reference/rails/sisbajud/mensageria/create-an-lgpd-data-subject-request"},{"title":"Record the resolution of an LGPD request","deprecated":null,"version":null,"sidebarTitle":"Record the resolution of an lgpd request","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/lgpd/requests/{id}/resolve","href":"/en/reference/rails/sisbajud/mensageria/record-the-resolution-of-an-lgpd-request"},{"title":"Export a data subject's records","deprecated":null,"version":null,"sidebarTitle":"Export a data subject s records","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/lgpd/subject-data","href":"/en/reference/rails/sisbajud/mensageria/export-a-data-subject-s-records"}]},{"group":"SISBAJUD Mensageria · Security","pages":[{"title":"Rotate an institution's KEK","deprecated":null,"version":null,"sidebarTitle":"Rotate an institution s kek","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/security/kek:rotate","href":"/en/reference/rails/sisbajud/mensageria/rotate-an-institution-s-kek"},{"title":"Rotate an institution's tokenization keyset","deprecated":null,"version":null,"sidebarTitle":"Rotate an institution s tokenization keyset","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/security/keyset:rotate","href":"/en/reference/rails/sisbajud/mensageria/rotate-an-institution-s-tokenization-keyset"}]},{"group":"SISBAJUD Mensageria · Compliance","pages":[{"title":"Register a justification on a non-compliance log","deprecated":null,"version":null,"sidebarTitle":"Register a justification on a non compliance log","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/non-compliance-logs/{id}/justification","href":"/en/reference/rails/sisbajud/mensageria/register-a-justification-on-a-non-compliance-log"}]},{"group":"SISBAJUD Mensageria · Lerian STA dead-letter","pages":[{"title":"Record the human treatment of a parked STA event","deprecated":null,"version":null,"sidebarTitle":"Record the human treatment of a parked sta event","openapi":"/en/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/sta-dlq/{eventId}/acknowledge","href":"/en/reference/rails/sisbajud/mensageria/record-the-human-treatment-of-a-parked-sta-event"}]},{"group":"SISBAJUD executor · Institutions and Midaz connector","pages":[{"title":"Create institution config and provision keys","deprecated":null,"version":null,"sidebarTitle":"Create institution config and provision keys","openapi":"/en/openapi/v3-current/sisbajud-executor.yaml post /v1/institutions","href":"/en/reference/rails/sisbajud/executor/create-institution-config-and-provision-keys"},{"title":"Get institution config by id","deprecated":null,"version":null,"sidebarTitle":"Get institution config by id","openapi":"/en/openapi/v3-current/sisbajud-executor.yaml get /v1/institutions/{institutionId}","href":"/en/reference/rails/sisbajud/executor/get-institution-config-by-id"},{"title":"Update institution config by id","deprecated":null,"version":null,"sidebarTitle":"Update institution config by id","openapi":"/en/openapi/v3-current/sisbajud-executor.yaml patch /v1/institutions/{institutionId}","href":"/en/reference/rails/sisbajud/executor/update-institution-config-by-id"},{"title":"Replace the institution's connector configuration","deprecated":null,"version":null,"sidebarTitle":"Replace the institution s connector configuration","openapi":"/en/openapi/v3-current/sisbajud-executor.yaml put /v1/institutions/{institutionId}/connector-config","href":"/en/reference/rails/sisbajud/executor/replace-the-institution-s-connector-configuration"},{"title":"Write the institution's connector credentials","deprecated":null,"version":null,"sidebarTitle":"Write the institution s connector credentials","openapi":"/en/openapi/v3-current/sisbajud-executor.yaml put /v1/institutions/{institutionId}/connector-credentials","href":"/en/reference/rails/sisbajud/executor/write-the-institution-s-connector-credentials"}]},{"group":"SISBAJUD executor · Orders that need attention","pages":[{"title":"List executor failed orders","deprecated":null,"version":null,"sidebarTitle":"List executor failed orders","openapi":"/en/openapi/v3-current/sisbajud-executor.yaml get /v1/institutions/{institutionId}/executor/failed-orders","href":"/en/reference/rails/sisbajud/executor/list-executor-failed-orders"},{"title":"List executor human decisions","deprecated":null,"version":null,"sidebarTitle":"List executor human decisions","openapi":"/en/openapi/v3-current/sisbajud-executor.yaml get /v1/institutions/{institutionId}/executor/human-decisions","href":"/en/reference/rails/sisbajud/executor/list-executor-human-decisions"}]},{"group":"SISBAJUD executor · Ledger routing","pages":[{"title":"Preflight the tenant's ledger routing configuration (admin)","deprecated":null,"version":null,"sidebarTitle":"Preflight the tenant s ledger routing configuration admin","openapi":"/en/openapi/v3-current/sisbajud-executor.yaml get /v1/admin/ledger-routing/preflight","href":"/en/reference/rails/sisbajud/executor/preflight-the-tenant-s-ledger-routing-configuration-admin"}]},{"group":"SISBAJUD executor · Security","pages":[{"title":"Rotate an institution's connector-credentials KEK","deprecated":null,"version":null,"sidebarTitle":"Rotate an institution s connector credentials kek","openapi":"/en/openapi/v3-current/sisbajud-executor.yaml post /v1/institutions/{institutionId}/security/credential-kek:rotate","href":"/en/reference/rails/sisbajud/executor/rotate-an-institution-s-connector-credentials-kek"}]},{"group":"SISBAJUD executor · Audit","pages":[{"title":"Verify audit trail integrity (admin)","deprecated":null,"version":null,"sidebarTitle":"Verify audit trail integrity admin","openapi":"/en/openapi/v3-current/sisbajud-executor.yaml get /v1/admin/audit/verify","href":"/en/reference/rails/sisbajud/executor/verify-audit-trail-integrity-admin"}]},{"group":"Error handling","pages":[{"title":"SISBAJUD error list","href":"/en/reference/rails/sisbajud/sisbajud-error-list"}]}]},{"dropdown":"BC Correios","icon":"envelope","description":"Correspondence with BACEN over BC Correio","groups":[{"group":"Mails","pages":[{"title":"List or search mails","deprecated":null,"version":null,"sidebarTitle":"List or search mails","openapi":"/en/openapi/v3-current/bc-correios.yaml get /api/v1/correios/mails","href":"/en/reference/rails/bc-correios/list-or-search-mails"},{"title":"Count mails","deprecated":null,"version":null,"sidebarTitle":"Count mails","openapi":"/en/openapi/v3-current/bc-correios.yaml get /api/v1/correios/mails/count","href":"/en/reference/rails/bc-correios/count-mails"},{"title":"Send message to BCB","deprecated":null,"version":null,"sidebarTitle":"Send message to bcb","openapi":"/en/openapi/v3-current/bc-correios.yaml post /api/v1/correios/mails/send","href":"/en/reference/rails/bc-correios/send-message-to-bcb"},{"title":"Get mail by ID","deprecated":null,"version":null,"sidebarTitle":"Get mail by id","openapi":"/en/openapi/v3-current/bc-correios.yaml get /api/v1/correios/mails/{id}","href":"/en/reference/rails/bc-correios/get-mail-by-id"},{"title":"Get AI analysis status","deprecated":null,"version":null,"sidebarTitle":"Get ai analysis status","openapi":"/en/openapi/v3-current/bc-correios.yaml get /api/v1/correios/mails/{id}/ai-status","href":"/en/reference/rails/bc-correios/get-ai-analysis-status"},{"title":"Archive mail","deprecated":null,"version":null,"sidebarTitle":"Archive mail","openapi":"/en/openapi/v3-current/bc-correios.yaml put /api/v1/correios/mails/{id}/archive","href":"/en/reference/rails/bc-correios/archive-mail"},{"title":"Download attachment","deprecated":null,"version":null,"sidebarTitle":"Download attachment","openapi":"/en/openapi/v3-current/bc-correios.yaml get /api/v1/correios/mails/{id}/attachments/{attachmentId}","href":"/en/reference/rails/bc-correios/download-attachment"},{"title":"Mark mail as read","deprecated":null,"version":null,"sidebarTitle":"Mark mail as read","openapi":"/en/openapi/v3-current/bc-correios.yaml put /api/v1/correios/mails/{id}/read","href":"/en/reference/rails/bc-correios/mark-mail-as-read"},{"title":"Trigger AI re-analysis","deprecated":null,"version":null,"sidebarTitle":"Trigger ai re analysis","openapi":"/en/openapi/v3-current/bc-correios.yaml post /api/v1/correios/mails/{id}/reanalyze","href":"/en/reference/rails/bc-correios/trigger-ai-re-analysis"},{"title":"Restore mail","deprecated":null,"version":null,"sidebarTitle":"Restore mail","openapi":"/en/openapi/v3-current/bc-correios.yaml put /api/v1/correios/mails/{id}/restore","href":"/en/reference/rails/bc-correios/restore-mail"}]},{"group":"Settings","pages":[{"title":"Get tenant settings","deprecated":null,"version":null,"sidebarTitle":"Get tenant settings","openapi":"/en/openapi/v3-current/bc-correios.yaml get /api/v1/correios/settings","href":"/en/reference/rails/bc-correios/get-tenant-settings"},{"title":"Create tenant settings","deprecated":null,"version":null,"sidebarTitle":"Create tenant settings","openapi":"/en/openapi/v3-current/bc-correios.yaml post /api/v1/correios/settings","href":"/en/reference/rails/bc-correios/create-tenant-settings"},{"title":"Update tenant settings","deprecated":null,"version":null,"sidebarTitle":"Update tenant settings","openapi":"/en/openapi/v3-current/bc-correios.yaml patch /api/v1/correios/settings","href":"/en/reference/rails/bc-correios/update-tenant-settings"},{"title":"Update retention policy","deprecated":null,"version":null,"sidebarTitle":"Update retention policy","openapi":"/en/openapi/v3-current/bc-correios.yaml patch /api/v1/correios/settings/retention","href":"/en/reference/rails/bc-correios/update-retention-policy"},{"title":"Test AI provider connection","deprecated":null,"version":null,"sidebarTitle":"Test ai provider connection","openapi":"/en/openapi/v3-current/bc-correios.yaml post /api/v1/correios/settings/test-ai-connection","href":"/en/reference/rails/bc-correios/test-ai-provider-connection"},{"title":"Test BCB connection","deprecated":null,"version":null,"sidebarTitle":"Test bcb connection","openapi":"/en/openapi/v3-current/bc-correios.yaml post /api/v1/correios/settings/test-connection","href":"/en/reference/rails/bc-correios/test-bcb-connection"}]},{"group":"Audit","pages":[{"title":"Query audit trail","deprecated":null,"version":null,"sidebarTitle":"Query audit trail","openapi":"/en/openapi/v3-current/bc-correios.yaml get /api/v1/correios/audit","href":"/en/reference/rails/bc-correios/query-audit-trail"},{"title":"Export audit trail","deprecated":null,"version":null,"sidebarTitle":"Export audit trail","openapi":"/en/openapi/v3-current/bc-correios.yaml get /api/v1/correios/audit/export","href":"/en/reference/rails/bc-correios/export-audit-trail"}]},{"group":"Dashboard","pages":[{"title":"Dashboard category breakdown","deprecated":null,"version":null,"sidebarTitle":"Dashboard category breakdown","openapi":"/en/openapi/v3-current/bc-correios.yaml get /api/v1/correios/dashboard/categories","href":"/en/reference/rails/bc-correios/dashboard-category-breakdown"},{"title":"Dashboard summary","deprecated":null,"version":null,"sidebarTitle":"Dashboard summary","openapi":"/en/openapi/v3-current/bc-correios.yaml get /api/v1/correios/dashboard/summary","href":"/en/reference/rails/bc-correios/dashboard-summary"}]},{"group":"Error handling","pages":[{"title":"BC Correios error list","href":"/en/reference/rails/bc-correios/bc-correios-error-list"}]}]},{"dropdown":"SRC","icon":"shield-halved","description":"Restriction consultations with BACEN over BC Protege+","groups":[{"group":"Consultations","pages":[{"title":"List consultations","deprecated":null,"version":null,"sidebarTitle":"List consultations","openapi":"/en/openapi/v3-current/src.yaml get /v1/src/consultations","href":"/en/reference/rails/src/list-consultations"},{"title":"Create a consultation","deprecated":null,"version":null,"sidebarTitle":"Create a consultation","openapi":"/en/openapi/v3-current/src.yaml post /v1/src/consultations","href":"/en/reference/rails/src/create-a-consultation"},{"title":"Search consultations","deprecated":null,"version":null,"sidebarTitle":"Search consultations","openapi":"/en/openapi/v3-current/src.yaml post /v1/src/consultations/search","href":"/en/reference/rails/src/search-consultations"},{"title":"Retrieve a consultation","deprecated":null,"version":null,"sidebarTitle":"Retrieve a consultation","openapi":"/en/openapi/v3-current/src.yaml get /v1/src/consultations/{id}","href":"/en/reference/rails/src/retrieve-a-consultation"}]},{"group":"Institution records","pages":[{"title":"Register an institution record","deprecated":null,"version":null,"sidebarTitle":"Register an institution record","openapi":"/en/openapi/v3-current/src.yaml post /v1/src/consultations/{id}/institution-record","href":"/en/reference/rails/src/register-an-institution-record"}]},{"group":"Evidence","pages":[{"title":"Search the evidence trail","deprecated":null,"version":null,"sidebarTitle":"Search the evidence trail","openapi":"/en/openapi/v3-current/src.yaml post /v1/src/evidence","href":"/en/reference/rails/src/search-the-evidence-trail"},{"title":"Retrieve a consultation's evidence trail","deprecated":null,"version":null,"sidebarTitle":"Retrieve a consultations evidence trail","openapi":"/en/openapi/v3-current/src.yaml get /v1/src/evidence/consultations/{id}","href":"/en/reference/rails/src/retrieve-a-consultations-evidence-trail"},{"title":"Correct an evidence record","deprecated":null,"version":null,"sidebarTitle":"Correct an evidence record","openapi":"/en/openapi/v3-current/src.yaml post /v1/src/evidence/consultations/{id}/corrections","href":"/en/reference/rails/src/correct-an-evidence-record"},{"title":"Search evidence records","deprecated":null,"version":null,"sidebarTitle":"Search evidence records","openapi":"/en/openapi/v3-current/src.yaml post /v1/src/evidence/records","href":"/en/reference/rails/src/search-evidence-records"}]},{"group":"Dashboard","pages":[{"title":"Retrieve the consultation dashboard","deprecated":null,"version":null,"sidebarTitle":"Retrieve the consultation dashboard","openapi":"/en/openapi/v3-current/src.yaml get /v1/src/dashboard/consultations","href":"/en/reference/rails/src/retrieve-the-consultation-dashboard"}]},{"group":"Credentials","pages":[{"title":"Retrieve the credential status","deprecated":null,"version":null,"sidebarTitle":"Retrieve the credential status","openapi":"/en/openapi/v3-current/src.yaml get /v1/src/credentials","href":"/en/reference/rails/src/retrieve-the-credential-status"}]},{"group":"Operator cases","pages":[{"title":"List operator cases","deprecated":null,"version":null,"sidebarTitle":"List operator cases","openapi":"/en/openapi/v3-current/src.yaml get /v1/src/operator/cases","href":"/en/reference/rails/src/list-operator-cases"},{"title":"Retrieve an operator case","deprecated":null,"version":null,"sidebarTitle":"Retrieve an operator case","openapi":"/en/openapi/v3-current/src.yaml get /v1/src/operator/cases/{leg}/{caseId}","href":"/en/reference/rails/src/retrieve-an-operator-case"},{"title":"Close a credential-operation case","deprecated":null,"version":null,"sidebarTitle":"Close a credential operation case","openapi":"/en/openapi/v3-current/src.yaml post /v1/src/operator/credential-operations/{caseId}/closure","href":"/en/reference/rails/src/close-a-credential-operation-case"},{"title":"Acknowledge an invalid-dispatch case","deprecated":null,"version":null,"sidebarTitle":"Acknowledge an invalid dispatch case","openapi":"/en/openapi/v3-current/src.yaml post /v1/src/operator/invalid-dispatches/{caseId}/closure","href":"/en/reference/rails/src/acknowledge-an-invalid-dispatch-case"},{"title":"Close an orphan-response case","deprecated":null,"version":null,"sidebarTitle":"Close an orphan response case","openapi":"/en/openapi/v3-current/src.yaml post /v1/src/operator/orphan-responses/{caseId}/closure","href":"/en/reference/rails/src/close-an-orphan-response-case"}]},{"group":"Error handling","pages":[{"title":"SRC error list","href":"/en/reference/rails/src/src-error-list"}]}]},{"dropdown":"Consignado CLT (Dataprev)","icon":"hand-holding-dollar","description":"Payroll loan registration with Dataprev","groups":[{"group":"Tenant setup and credentials","pages":[{"title":"Get the Dataprev credential status","deprecated":null,"version":null,"sidebarTitle":"Get credential status","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/credentials/dataprev","href":"/en/reference/rails/consignado/get-credential-status"},{"title":"Upload or rotate the Dataprev client certificate","deprecated":null,"version":null,"sidebarTitle":"Put certificate","openapi":"/en/openapi/v3-current/consignado.yaml put /v1/credentials/dataprev/certificate","href":"/en/reference/rails/consignado/put-certificate"},{"title":"Set the tenant's Dataprev codigoSolicitante","deprecated":null,"version":null,"sidebarTitle":"Put codigo solicitante","openapi":"/en/openapi/v3-current/consignado.yaml put /v1/credentials/dataprev/codigo-solicitante","href":"/en/reference/rails/consignado/put-codigo-solicitante"},{"title":"Upload or rotate the Dataprev OAuth2 credentials","deprecated":null,"version":null,"sidebarTitle":"Put oauth","openapi":"/en/openapi/v3-current/consignado.yaml put /v1/credentials/dataprev/oauth","href":"/en/reference/rails/consignado/put-oauth"},{"title":"Set the tenant worker portal base URL","deprecated":null,"version":null,"sidebarTitle":"Put portal base url","openapi":"/en/openapi/v3-current/consignado.yaml put /v1/credentials/dataprev/portal-base-url","href":"/en/reference/rails/consignado/put-portal-base-url"},{"title":"Revoke the Dataprev credentials","deprecated":null,"version":null,"sidebarTitle":"Revoke credentials","openapi":"/en/openapi/v3-current/consignado.yaml delete /v1/credentials/dataprev","href":"/en/reference/rails/consignado/revoke-credentials"},{"title":"List the tenant's registered originadores","deprecated":null,"version":null,"sidebarTitle":"List consignado originadores","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/originadores","href":"/en/reference/rails/consignado/list-consignado-originadores"},{"title":"Register a new originador","deprecated":null,"version":null,"sidebarTitle":"Create consignado originador","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/originadores","href":"/en/reference/rails/consignado/create-consignado-originador"},{"title":"Deactivate an originador","deprecated":null,"version":null,"sidebarTitle":"Deactivate consignado originador","openapi":"/en/openapi/v3-current/consignado.yaml delete /v1/consignado/originadores/{id}","href":"/en/reference/rails/consignado/deactivate-consignado-originador"}]},{"group":"Worker data and margin","pages":[{"title":"Fetch a worker's available consignable margin","deprecated":null,"version":null,"sidebarTitle":"Fetch consignado worker margin","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/workers/margin","href":"/en/reference/rails/consignado/fetch-consignado-worker-margin"},{"title":"Read the loans closed by employment-link termination","deprecated":null,"version":null,"sidebarTitle":"List consignado employment terminations","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/employment-status/terminations","href":"/en/reference/rails/consignado/list-consignado-employment-terminations"},{"title":"Read workers with a new employment bond after a termination-closed contract","deprecated":null,"version":null,"sidebarTitle":"List consignado vinculos novos","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/trabalhadores/vinculos-novos","href":"/en/reference/rails/consignado/list-consignado-vinculos-novos"},{"title":"List a worker's authorized employment bonds","deprecated":null,"version":null,"sidebarTitle":"List consignado fgts autorizados","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/fgts/autorizados","href":"/en/reference/rails/consignado/list-consignado-fgts-autorizados"},{"title":"Read a worker's consignable FGTS balance","deprecated":null,"version":null,"sidebarTitle":"Read consignado fgts saldo","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/fgts/saldo","href":"/en/reference/rails/consignado/read-consignado-fgts-saldo"}]},{"group":"Auctions and proposals","pages":[{"title":"List the worker loan requests open for the leilão","deprecated":null,"version":null,"sidebarTitle":"List consignado solicitacoes","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/leilao/solicitacoes","href":"/en/reference/rails/consignado/list-consignado-solicitacoes"},{"title":"Submit a one-or-two proposal set to the payroll rail","deprecated":null,"version":null,"sidebarTitle":"Submit consignado bid","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/leilao/solicitacoes/{id_solicitacao}/propostas","href":"/en/reference/rails/consignado/submit-consignado-bid"},{"title":"List the inbound portability requests open for the leilão","deprecated":null,"version":null,"sidebarTitle":"List consignado portabilidade solicitacoes","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/leilao/portabilidade/solicitacoes","href":"/en/reference/rails/consignado/list-consignado-portabilidade-solicitacoes"},{"title":"Respond to an inbound portability leilão solicitação","deprecated":null,"version":null,"sidebarTitle":"Respond consignado portability auction","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas","href":"/en/reference/rails/consignado/respond-consignado-portability-auction"},{"title":"Read one page of a portability's efetivação status","deprecated":null,"version":null,"sidebarTitle":"List consignado portabilidade efetivacoes","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/portabilidade/efetivacoes","href":"/en/reference/rails/consignado/list-consignado-portabilidade-efetivacoes"},{"title":"List the credits this tenant bid on and where each bid stands","deprecated":null,"version":null,"sidebarTitle":"List consignado bid submissions","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/bid-submissions","href":"/en/reference/rails/consignado/list-consignado-bid-submissions"}]},{"group":"Contract registration and documents","pages":[{"title":"Averbar a signed consignado contract on the payroll rail","deprecated":null,"version":null,"sidebarTitle":"Averbar consignado contract","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/averbacao","href":"/en/reference/rails/consignado/averbar-consignado-contract"},{"title":"List the tenant's averbação operations","deprecated":null,"version":null,"sidebarTitle":"List consignado averbacao operations","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/averbacao-operations","href":"/en/reference/rails/consignado/list-consignado-averbacao-operations"},{"title":"Get one contract's averbação operation","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract averbacao operation","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/averbacao","href":"/en/reference/rails/consignado/get-consignado-contract-averbacao-operation"},{"title":"Read the cadastro stored with a consignado averbação","deprecated":null,"version":null,"sidebarTitle":"Read the cadastro stored with a consignado averbacao","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/dados-cadastrais","href":"/en/reference/rails/consignado/read-the-cadastro-stored-with-a-consignado-averbacao"},{"title":"Import a contract already averbado outside this gateway","deprecated":null,"version":null,"sidebarTitle":"Import consignado contract","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/import","href":"/en/reference/rails/consignado/import-consignado-contract"},{"title":"Attach the signed CCB for an already-averbado contract","deprecated":null,"version":null,"sidebarTitle":"Attach consignado ccb","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/ccb-attachment","href":"/en/reference/rails/consignado/attach-consignado-ccb"},{"title":"List confirmed consignado contract registrations","deprecated":null,"version":null,"sidebarTitle":"List consignado contract registrations","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/contract-registrations","href":"/en/reference/rails/consignado/list-consignado-contract-registrations"},{"title":"Get current consignado contract registration evidence","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract registration","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/contract-registrations/{numero_contrato}","href":"/en/reference/rails/consignado/get-consignado-contract-registration"},{"title":"Download the rail's document for a contract","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract rail document","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/rail-document","href":"/en/reference/rails/consignado/get-consignado-contract-rail-document"},{"title":"Read one averbado contract's loan status on the rail","deprecated":null,"version":null,"sidebarTitle":"Get consignado rail loan","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/rail-loan","href":"/en/reference/rails/consignado/get-consignado-rail-loan"},{"title":"Download a retained consignado contract artifact","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract artifact","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/artifacts/{artifact_type}","href":"/en/reference/rails/consignado/get-consignado-contract-artifact"},{"title":"Confirm a disbursement already paid to the worker","deprecated":null,"version":null,"sidebarTitle":"Confirm consignado disbursement","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/disbursement-confirmation","href":"/en/reference/rails/consignado/confirm-consignado-disbursement"},{"title":"List the disbursement confirmations recorded for this tenant","deprecated":null,"version":null,"sidebarTitle":"List consignado disbursement confirmations","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/disbursement-confirmations","href":"/en/reference/rails/consignado/list-consignado-disbursement-confirmations"}]},{"group":"Contract corrections","pages":[{"title":"Record a correction to a registered contract","deprecated":null,"version":null,"sidebarTitle":"Record consignado contract correction","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/corrections","href":"/en/reference/rails/consignado/record-consignado-contract-correction"},{"title":"List one contract's correction chain","deprecated":null,"version":null,"sidebarTitle":"List consignado contract corrections","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/corrections","href":"/en/reference/rails/consignado/list-consignado-contract-corrections"},{"title":"Download the corrected resource a correction fact names","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract correction","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/corrections/{correction_id}","href":"/en/reference/rails/consignado/get-consignado-contract-correction"}]},{"group":"Contract lifecycle","pages":[{"title":"Suspend payroll deduction for an averbado contract","deprecated":null,"version":null,"sidebarTitle":"Suspend consignado contract","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/suspend","href":"/en/reference/rails/consignado/suspend-consignado-contract"},{"title":"Reactivate a suspended contract","deprecated":null,"version":null,"sidebarTitle":"Reactivate consignado contract","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/reactivate","href":"/en/reference/rails/consignado/reactivate-consignado-contract"},{"title":"Alter the mutable terms of an averbado contract","deprecated":null,"version":null,"sidebarTitle":"Alter consignado contract terms","openapi":"/en/openapi/v3-current/consignado.yaml patch /v1/consignado/contracts/{numero_contrato}/terms","href":"/en/reference/rails/consignado/alter-consignado-contract-terms"},{"title":"Read the exclusion this gateway holds for a contract","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract exclusion","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/exclusion","href":"/en/reference/rails/consignado/get-consignado-contract-exclusion"},{"title":"Remove an averbado contract from the payroll registry","deprecated":null,"version":null,"sidebarTitle":"Excluir consignado contract","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/exclusion","href":"/en/reference/rails/consignado/excluir-consignado-contract"},{"title":"List the tenant's exclusion operations","deprecated":null,"version":null,"sidebarTitle":"List consignado exclusion operations","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/exclusion-operations","href":"/en/reference/rails/consignado/list-consignado-exclusion-operations"},{"title":"Get one exclusion operation's audit trail","deprecated":null,"version":null,"sidebarTitle":"Get consignado exclusion operation audit","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/exclusion-operations/{request_ref}/audit","href":"/en/reference/rails/consignado/get-consignado-exclusion-operation-audit"},{"title":"Suspend one or more competências by early payment","deprecated":null,"version":null,"sidebarTitle":"Incluir consignado antecipacao parcela","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/antecipacao","href":"/en/reference/rails/consignado/incluir-consignado-antecipacao-parcela"},{"title":"Withdraw a competência's early-payment suspension","deprecated":null,"version":null,"sidebarTitle":"Excluir consignado antecipacao parcela","openapi":"/en/openapi/v3-current/consignado.yaml put /v1/consignado/contracts/{numero_contrato}/antecipacao/{competencia}","href":"/en/reference/rails/consignado/excluir-consignado-antecipacao-parcela"},{"title":"List what each averbado contract of this tenant still owes","deprecated":null,"version":null,"sidebarTitle":"List consignado saldo devedor obrigacoes","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/saldo-devedor","href":"/en/reference/rails/consignado/list-consignado-saldo-devedor-obrigacoes"},{"title":"Get one contract's saldo devedor and its amortization book","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract saldo devedor","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/saldo-devedor","href":"/en/reference/rails/consignado/get-consignado-contract-saldo-devedor"}]},{"group":"Refinancing, renegotiation, and portability","pages":[{"title":"Refinance one or more active contracts into a new one","deprecated":null,"version":null,"sidebarTitle":"Realizar consignado refinanciamento","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/refinanciamento","href":"/en/reference/rails/consignado/realizar-consignado-refinanciamento"},{"title":"Reverse a refinancing within its 7 business day window","deprecated":null,"version":null,"sidebarTitle":"Reverter consignado refinanciamento","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/refinanciamento/reversao","href":"/en/reference/rails/consignado/reverter-consignado-refinanciamento"},{"title":"Renegotiate a contract closed by employment-link termination","deprecated":null,"version":null,"sidebarTitle":"Renegociar consignado contract","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/renegociacao","href":"/en/reference/rails/consignado/renegociar-consignado-contract"},{"title":"Averbate a portability","deprecated":null,"version":null,"sidebarTitle":"Averbar consignado portabilidade","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/portabilidade/{numero_unico}/averbacao","href":"/en/reference/rails/consignado/averbar-consignado-portabilidade"},{"title":"Exclude a contract from this institution because the worker ported it out","deprecated":null,"version":null,"sidebarTitle":"Excluir consignado portabilidade","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao","href":"/en/reference/rails/consignado/excluir-consignado-portabilidade"}]},{"group":"Legacy contracts","pages":[{"title":"Register a pre-existing (legado) loan","deprecated":null,"version":null,"sidebarTitle":"Incluir consignado emprestimo legado","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/legacy-contracts","href":"/en/reference/rails/consignado/incluir-consignado-emprestimo-legado"},{"title":"Renegotiate one or more legado loans into a new contract","deprecated":null,"version":null,"sidebarTitle":"Renegociar consignado emprestimo legado","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/legacy-contracts/renegociacao","href":"/en/reference/rails/consignado/renegociar-consignado-emprestimo-legado"},{"title":"Remove a previously registered legado loan","deprecated":null,"version":null,"sidebarTitle":"Excluir consignado emprestimo legado","openapi":"/en/openapi/v3-current/consignado.yaml put /v1/consignado/legacy-contracts/{numero_contrato}","href":"/en/reference/rails/consignado/excluir-consignado-emprestimo-legado"}]},{"group":"FGTS guarantees","pages":[{"title":"Execute the FGTS guarantee for a contract","deprecated":null,"version":null,"sidebarTitle":"Execute consignado fgts guarantee","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/fgts/garantias/execucao","href":"/en/reference/rails/consignado/execute-consignado-fgts-guarantee"},{"title":"Read the FGTS guarantee execution this gateway holds for a contract","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract fgts guarantee execution","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/fgts-garantia/execucao","href":"/en/reference/rails/consignado/get-consignado-contract-fgts-guarantee-execution"}]},{"group":"Reconciliation and calendar","pages":[{"title":"Read the rail's operational-calendar competência window","deprecated":null,"version":null,"sidebarTitle":"Get consignado calendar","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/calendar","href":"/en/reference/rails/consignado/get-consignado-calendar"},{"title":"Read the payroll escrituração records included in a window","deprecated":null,"version":null,"sidebarTitle":"List consignado escrituracoes","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/reconciliation/escrituracoes","href":"/en/reference/rails/consignado/list-consignado-escrituracoes"},{"title":"Read the CEF D+2 repasse transfers included in a window","deprecated":null,"version":null,"sidebarTitle":"List consignado repasses","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/reconciliation/repasses","href":"/en/reference/rails/consignado/list-consignado-repasses"},{"title":"List the repasse transfers the rail still owes this tenant","deprecated":null,"version":null,"sidebarTitle":"List consignado repasse expectations","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/reconciliation/repasse-expectations","href":"/en/reference/rails/consignado/list-consignado-repasse-expectations"}]},{"group":"Funds and assignments","pages":[{"title":"List the tenant's registered funds","deprecated":null,"version":null,"sidebarTitle":"List consignado fundos","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/fundos","href":"/en/reference/rails/consignado/list-consignado-fundos"},{"title":"Register a new fund","deprecated":null,"version":null,"sidebarTitle":"Create consignado fundo","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/consignado/fundos","href":"/en/reference/rails/consignado/create-consignado-fundo"},{"title":"Deactivate a fund","deprecated":null,"version":null,"sidebarTitle":"Deactivate consignado fundo","openapi":"/en/openapi/v3-current/consignado.yaml delete /v1/consignado/fundos/{id}","href":"/en/reference/rails/consignado/deactivate-consignado-fundo"},{"title":"List the credits ceded to the caller's own fund","deprecated":null,"version":null,"sidebarTitle":"List consignado fundo creditos cedidos","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/fundo/creditos","href":"/en/reference/rails/consignado/list-consignado-fundo-creditos-cedidos"},{"title":"List the credits ceded to one fund the caller administers","deprecated":null,"version":null,"sidebarTitle":"List consignado fundo creditos cedidos as bancarizador","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/fundos/{id}/creditos","href":"/en/reference/rails/consignado/list-consignado-fundo-creditos-cedidos-as-bancarizador"},{"title":"Register a credit's cessão to its attributed fund","deprecated":null,"version":null,"sidebarTitle":"Register consignado cessao","openapi":"/en/openapi/v3-current/consignado.yaml put /v1/consignado/leilao/bid-submissions/cessao","href":"/en/reference/rails/consignado/register-consignado-cessao"}]},{"group":"Capacity and usage","pages":[{"title":"Get this tenant's outbound Dataprev rail throughput","deprecated":null,"version":null,"sidebarTitle":"Get consignado throughput","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/throughput","href":"/en/reference/rails/consignado/get-consignado-throughput"},{"title":"Set this tenant's outbound Dataprev rail throughput","deprecated":null,"version":null,"sidebarTitle":"Put consignado throughput","openapi":"/en/openapi/v3-current/consignado.yaml put /v1/consignado/throughput","href":"/en/reference/rails/consignado/put-consignado-throughput"},{"title":"List this tenant's outbound Dataprev rail throughput transitions","deprecated":null,"version":null,"sidebarTitle":"List consignado throughput history","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/throughput/history","href":"/en/reference/rails/consignado/list-consignado-throughput-history"},{"title":"Get consignado gateway usage for a competência","deprecated":null,"version":null,"sidebarTitle":"Get consignado usage","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/usage","href":"/en/reference/rails/consignado/get-consignado-usage"}]},{"group":"Monitoring","pages":[{"title":"Report which operation families this deployment reaches","deprecated":null,"version":null,"sidebarTitle":"Get consignado capabilities","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/capabilities","href":"/en/reference/rails/consignado/get-consignado-capabilities"},{"title":"Report this process's scheduled Consignado loops","deprecated":null,"version":null,"sidebarTitle":"List consignado scheduled jobs","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/jobs","href":"/en/reference/rails/consignado/list-consignado-scheduled-jobs"},{"title":"List the tenant's rail commands and the operations that leave no record","deprecated":null,"version":null,"sidebarTitle":"List consignado rail commands","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/rail-commands","href":"/en/reference/rails/consignado/list-consignado-rail-commands"}]},{"group":"Event subscriptions","pages":[{"title":"List the tenant's hub subscriptions","deprecated":null,"version":null,"sidebarTitle":"List subscriptions","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/subscriptions","href":"/en/reference/rails/consignado/list-subscriptions"},{"title":"Create a hub subscription","deprecated":null,"version":null,"sidebarTitle":"Create subscription","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/subscriptions","href":"/en/reference/rails/consignado/create-subscription"},{"title":"Get a hub subscription","deprecated":null,"version":null,"sidebarTitle":"Get subscription","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/subscriptions/{id}","href":"/en/reference/rails/consignado/get-subscription"},{"title":"Reveal a subscription's full destination (admin only)","deprecated":null,"version":null,"sidebarTitle":"Reveal subscription endpoint","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/subscriptions/{id}/endpoint","href":"/en/reference/rails/consignado/reveal-subscription-endpoint"},{"title":"Get a subscription's delivery health","deprecated":null,"version":null,"sidebarTitle":"Get subscription health","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/subscriptions/{id}/health","href":"/en/reference/rails/consignado/get-subscription-health"},{"title":"Rotate a subscription signing secret","deprecated":null,"version":null,"sidebarTitle":"Rotate subscription secret","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/subscriptions/{id}/rotate","href":"/en/reference/rails/consignado/rotate-subscription-secret"},{"title":"Send a synchronous test delivery","deprecated":null,"version":null,"sidebarTitle":"Test subscription delivery","openapi":"/en/openapi/v3-current/consignado.yaml post /v1/subscriptions/{id}/test-delivery","href":"/en/reference/rails/consignado/test-subscription-delivery"},{"title":"Revoke a hub subscription","deprecated":null,"version":null,"sidebarTitle":"Revoke subscription","openapi":"/en/openapi/v3-current/consignado.yaml delete /v1/subscriptions/{id}","href":"/en/reference/rails/consignado/revoke-subscription"},{"title":"Census this tenant's outbox event delivery by status","deprecated":null,"version":null,"sidebarTitle":"Get consignado event delivery","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/event-delivery","href":"/en/reference/rails/consignado/get-consignado-event-delivery"},{"title":"List the outbox facts this gateway destroyed","deprecated":null,"version":null,"sidebarTitle":"List consignado invalid events","openapi":"/en/openapi/v3-current/consignado.yaml get /v1/consignado/event-delivery/invalid","href":"/en/reference/rails/consignado/list-consignado-invalid-events"}]},{"group":"Error handling","pages":[{"title":"Consignado error list","href":"/en/reference/rails/consignado/consignado-error-list"}]},{"group":"Events","pages":[{"title":"Consignado events","href":"/en/reference/events/consignado"}]}]}]},{"anchor":"Interfaces","icon":"plug","dropdowns":[{"dropdown":"Pix Lerian","icon":"bolt","description":"Pix application APIs for mock-provider integration and testing","groups":[{"group":"DICT and Pix keys","pages":[{"group":"Pix key claims","pages":[{"title":"List Pix key claims","deprecated":null,"version":null,"sidebarTitle":"List claims","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /claims","href":"/en/reference/interfaces/pix-lerian/dict/list-claims"},{"title":"Open a Pix key claim","deprecated":null,"version":null,"sidebarTitle":"Create claim","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /claims","href":"/en/reference/interfaces/pix-lerian/dict/create-claim"},{"title":"Get a Pix key claim","deprecated":null,"version":null,"sidebarTitle":"Get claim","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /claims/{claim_id}","href":"/en/reference/interfaces/pix-lerian/dict/get-claim"},{"title":"Acknowledge a Pix key claim","deprecated":null,"version":null,"sidebarTitle":"Acknowledge claim","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /claims/{claim_id}/acknowledge","href":"/en/reference/interfaces/pix-lerian/dict/acknowledge-claim"},{"title":"Cancel a Pix key claim","deprecated":null,"version":null,"sidebarTitle":"Cancel claim","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /claims/{claim_id}/cancel","href":"/en/reference/interfaces/pix-lerian/dict/cancel-claim"},{"title":"Complete a Pix key claim","deprecated":null,"version":null,"sidebarTitle":"Complete claim","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /claims/{claim_id}/complete","href":"/en/reference/interfaces/pix-lerian/dict/complete-claim"},{"title":"Confirm a Pix key claim","deprecated":null,"version":null,"sidebarTitle":"Confirm claim","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /claims/{claim_id}/confirm","href":"/en/reference/interfaces/pix-lerian/dict/confirm-claim"}]},{"group":"Fraud markers","pages":[{"title":"List fraud markers","deprecated":null,"version":null,"sidebarTitle":"List fraud markers","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /dict/fraud-markers","href":"/en/reference/interfaces/pix-lerian/dict/list-fraud-markers"},{"title":"Create a fraud marker","deprecated":null,"version":null,"sidebarTitle":"Create fraud marker","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /dict/fraud-markers","href":"/en/reference/interfaces/pix-lerian/dict/create-fraud-marker"},{"title":"Get a fraud marker","deprecated":null,"version":null,"sidebarTitle":"Get fraud marker","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /dict/fraud-markers/{fraud_marker_id}","href":"/en/reference/interfaces/pix-lerian/dict/get-fraud-marker"},{"title":"Cancel a fraud marker","deprecated":null,"version":null,"sidebarTitle":"Cancel fraud marker","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /dict/fraud-markers/{fraud_marker_id}/cancel","href":"/en/reference/interfaces/pix-lerian/dict/cancel-fraud-marker"}]},{"group":"Funds recoveries","pages":[{"title":"List funds recoveries","deprecated":null,"version":null,"sidebarTitle":"List funds recoveries","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /dict/funds-recoveries","href":"/en/reference/interfaces/pix-lerian/dict/list-funds-recoveries"},{"title":"Create a funds recovery","deprecated":null,"version":null,"sidebarTitle":"Create funds recovery","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /dict/funds-recoveries","href":"/en/reference/interfaces/pix-lerian/dict/create-funds-recovery"},{"title":"Get a funds recovery","deprecated":null,"version":null,"sidebarTitle":"Get funds recovery","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /dict/funds-recoveries/{id}","href":"/en/reference/interfaces/pix-lerian/dict/get-funds-recovery"},{"title":"Update a funds recovery","deprecated":null,"version":null,"sidebarTitle":"Patch funds recovery","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml patch /dict/funds-recoveries/{id}","href":"/en/reference/interfaces/pix-lerian/dict/patch-funds-recovery"},{"title":"Cancel a funds recovery","deprecated":null,"version":null,"sidebarTitle":"Cancel funds recovery","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /dict/funds-recoveries/{id}/cancel","href":"/en/reference/interfaces/pix-lerian/dict/cancel-funds-recovery"},{"title":"List infraction reports for a funds recovery","deprecated":null,"version":null,"sidebarTitle":"List funds recovery infraction reports","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /dict/funds-recoveries/{id}/infraction-reports","href":"/en/reference/interfaces/pix-lerian/dict/list-funds-recovery-infraction-reports"},{"title":"Initiate a refund for a funds recovery","deprecated":null,"version":null,"sidebarTitle":"Refund funds recovery","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /dict/funds-recoveries/{id}/refund","href":"/en/reference/interfaces/pix-lerian/dict/refund-funds-recovery"},{"title":"List refunds linked to a funds recovery","deprecated":null,"version":null,"sidebarTitle":"List funds recovery refunds","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /dict/funds-recoveries/{id}/refunds","href":"/en/reference/interfaces/pix-lerian/dict/list-funds-recovery-refunds"},{"title":"Get a funds recovery tracking graph","deprecated":null,"version":null,"sidebarTitle":"Get funds recovery tracking graph","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /dict/funds-recoveries/{id}/tracking-graph","href":"/en/reference/interfaces/pix-lerian/dict/get-funds-recovery-tracking-graph"}]},{"group":"Infraction reports","pages":[{"title":"List infraction reports","deprecated":null,"version":null,"sidebarTitle":"List infraction reports","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /dict/infraction-reports","href":"/en/reference/interfaces/pix-lerian/dict/list-infraction-reports"},{"title":"Get an infraction report","deprecated":null,"version":null,"sidebarTitle":"Get infraction report","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /dict/infraction-reports/{id}","href":"/en/reference/interfaces/pix-lerian/dict/get-infraction-report"},{"title":"Acknowledge an infraction report","deprecated":null,"version":null,"sidebarTitle":"Acknowledge infraction report","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /dict/infraction-reports/{id}/acknowledge","href":"/en/reference/interfaces/pix-lerian/dict/acknowledge-infraction-report"},{"title":"List balance blocks for an infraction report","deprecated":null,"version":null,"sidebarTitle":"List infraction report balance blocks","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /dict/infraction-reports/{id}/balance-blocks","href":"/en/reference/interfaces/pix-lerian/dict/list-infraction-report-balance-blocks"},{"title":"Cancel an infraction report","deprecated":null,"version":null,"sidebarTitle":"Cancel infraction report","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /dict/infraction-reports/{id}/cancel","href":"/en/reference/interfaces/pix-lerian/dict/cancel-infraction-report"},{"title":"Close an infraction report","deprecated":null,"version":null,"sidebarTitle":"Close infraction report","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /dict/infraction-reports/{id}/close","href":"/en/reference/interfaces/pix-lerian/dict/close-infraction-report"}]},{"group":"Refunds","pages":[{"title":"List refunds","deprecated":null,"version":null,"sidebarTitle":"List refunds","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /dict/refunds","href":"/en/reference/interfaces/pix-lerian/dict/list-refunds"},{"title":"Create a refund","deprecated":null,"version":null,"sidebarTitle":"Create refund","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /dict/refunds","href":"/en/reference/interfaces/pix-lerian/dict/create-refund"},{"title":"Get a refund","deprecated":null,"version":null,"sidebarTitle":"Get refund","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /dict/refunds/{id}","href":"/en/reference/interfaces/pix-lerian/dict/get-refund"},{"title":"Close refund blocks after a manual devolution","deprecated":null,"version":null,"sidebarTitle":"Blocks close refund","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /dict/refunds/{id}/blocks/close","href":"/en/reference/interfaces/pix-lerian/dict/blocks-close-refund"},{"title":"Cancel a refund","deprecated":null,"version":null,"sidebarTitle":"Cancel refund","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /dict/refunds/{id}/cancel","href":"/en/reference/interfaces/pix-lerian/dict/cancel-refund"},{"title":"Close a refund with the analysis outcome (Phase 3)","deprecated":null,"version":null,"sidebarTitle":"Close refund","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /dict/refunds/{id}/close","href":"/en/reference/interfaces/pix-lerian/dict/close-refund"},{"title":"Settle a refund with an aggregated block devolution (Phase 1)","deprecated":null,"version":null,"sidebarTitle":"Settle refund","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /dict/refunds/{id}/settle","href":"/en/reference/interfaces/pix-lerian/dict/settle-refund"},{"title":"Confirm the aggregated settlement (liquidation — Phase 2)","deprecated":null,"version":null,"sidebarTitle":"Confirm settle refund","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /dict/refunds/{id}/settle/confirm","href":"/en/reference/interfaces/pix-lerian/dict/confirm-settle-refund"}]},{"group":"Pix key entries","pages":[{"title":"List Pix key entries for an account","deprecated":null,"version":null,"sidebarTitle":"List entries","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /entries","href":"/en/reference/interfaces/pix-lerian/dict/list-entries"},{"title":"Create a Pix key entry","deprecated":null,"version":null,"sidebarTitle":"Create entry","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /entries","href":"/en/reference/interfaces/pix-lerian/dict/create-entry"},{"title":"Get a Pix key entry","deprecated":null,"version":null,"sidebarTitle":"Get entry","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /entries/{entry_id}","href":"/en/reference/interfaces/pix-lerian/dict/get-entry"},{"title":"Update a Pix key entry","deprecated":null,"version":null,"sidebarTitle":"Update entry","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml patch /entries/{entry_id}","href":"/en/reference/interfaces/pix-lerian/dict/update-entry"},{"title":"Delete a Pix key entry","deprecated":null,"version":null,"sidebarTitle":"Delete entry","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml delete /entries/{entry_id}","href":"/en/reference/interfaces/pix-lerian/dict/delete-entry"}]},{"group":"Pix key lookup","pages":[{"title":"Check whether Pix keys exist","deprecated":null,"version":null,"sidebarTitle":"Check keys existence","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml post /keys/check","href":"/en/reference/interfaces/pix-lerian/dict/check-keys-existence"},{"title":"Retrieve a Pix key","deprecated":null,"version":null,"sidebarTitle":"Lookup key","openapi":"/en/openapi/v3-current/pix-lerian-dict.yaml get /keys/{key}","href":"/en/reference/interfaces/pix-lerian/dict/lookup-key"}]}]},{"group":"Collections and BR Codes","pages":[{"group":"BR Codes","pages":[{"title":"Decode a Pix EMV payload","deprecated":null,"version":null,"sidebarTitle":"Decode qrcode","openapi":"/en/openapi/v3-current/pix-lerian-cob.yaml post /brcodes/decode","href":"/en/reference/interfaces/pix-lerian/cob/decode-qrcode"},{"title":"List static BR Codes","deprecated":null,"version":null,"sidebarTitle":"List static brcodes","openapi":"/en/openapi/v3-current/pix-lerian-cob.yaml get /brcodes/static","href":"/en/reference/interfaces/pix-lerian/cob/list-static-brcodes"},{"title":"Create a static BR Code","deprecated":null,"version":null,"sidebarTitle":"Create static brcode","openapi":"/en/openapi/v3-current/pix-lerian-cob.yaml post /brcodes/static","href":"/en/reference/interfaces/pix-lerian/cob/create-static-brcode"},{"title":"Get a static BR Code by ID","deprecated":null,"version":null,"sidebarTitle":"Get static brcode","openapi":"/en/openapi/v3-current/pix-lerian-cob.yaml get /brcodes/static/{id}","href":"/en/reference/interfaces/pix-lerian/cob/get-static-brcode"}]},{"group":"Due-date collections","pages":[{"title":"List due-date collections or retrieve one by txId","deprecated":null,"version":null,"sidebarTitle":"List due date collections","openapi":"/en/openapi/v3-current/pix-lerian-cob.yaml get /collections/duedate","href":"/en/reference/interfaces/pix-lerian/cob/list-due-date-collections"},{"title":"Create a due-date Pix collection (cobv)","deprecated":null,"version":null,"sidebarTitle":"Create due date collection","openapi":"/en/openapi/v3-current/pix-lerian-cob.yaml post /collections/duedate","href":"/en/reference/interfaces/pix-lerian/cob/create-due-date-collection"},{"title":"Poll the provider's current view of a due-date collection","deprecated":null,"version":null,"sidebarTitle":"Get due date provider status","openapi":"/en/openapi/v3-current/pix-lerian-cob.yaml get /collections/duedate/provider-status","href":"/en/reference/interfaces/pix-lerian/cob/get-due-date-provider-status"},{"title":"Get a due-date collection by ID","deprecated":null,"version":null,"sidebarTitle":"Get due date collection","openapi":"/en/openapi/v3-current/pix-lerian-cob.yaml get /collections/duedate/{id}","href":"/en/reference/interfaces/pix-lerian/cob/get-due-date-collection"},{"title":"Revise a due-date collection's value modifiers","deprecated":null,"version":null,"sidebarTitle":"Revise due date collection","openapi":"/en/openapi/v3-current/pix-lerian-cob.yaml patch /collections/duedate/{id}","href":"/en/reference/interfaces/pix-lerian/cob/revise-due-date-collection"},{"title":"Cancel a due-date collection","deprecated":null,"version":null,"sidebarTitle":"Cancel due date collection","openapi":"/en/openapi/v3-current/pix-lerian-cob.yaml delete /collections/duedate/{id}","href":"/en/reference/interfaces/pix-lerian/cob/cancel-due-date-collection"}]},{"group":"Immediate collections","pages":[{"title":"List immediate collections or retrieve one by txId","deprecated":null,"version":null,"sidebarTitle":"List immediate collections","openapi":"/en/openapi/v3-current/pix-lerian-cob.yaml get /collections/immediate","href":"/en/reference/interfaces/pix-lerian/cob/list-immediate-collections"},{"title":"Create an immediate Pix collection (cob)","deprecated":null,"version":null,"sidebarTitle":"Create immediate collection","openapi":"/en/openapi/v3-current/pix-lerian-cob.yaml post /collections/immediate","href":"/en/reference/interfaces/pix-lerian/cob/create-immediate-collection"},{"title":"Get an immediate collection by ID","deprecated":null,"version":null,"sidebarTitle":"Get immediate collection","openapi":"/en/openapi/v3-current/pix-lerian-cob.yaml get /collections/immediate/{id}","href":"/en/reference/interfaces/pix-lerian/cob/get-immediate-collection"},{"title":"Cancel an immediate collection","deprecated":null,"version":null,"sidebarTitle":"Cancel immediate collection","openapi":"/en/openapi/v3-current/pix-lerian-cob.yaml delete /collections/immediate/{id}","href":"/en/reference/interfaces/pix-lerian/cob/cancel-immediate-collection"}]}]},{"group":"Payments and refunds","pages":[{"group":"Pix refunds","pages":[{"title":"List Pix refunds for an account","deprecated":null,"version":null,"sidebarTitle":"List refunds","openapi":"/en/openapi/v3-current/pix-lerian-spi.yaml get /refunds","href":"/en/reference/interfaces/pix-lerian/spi/list-refunds"},{"title":"Get a Pix refund by ID","deprecated":null,"version":null,"sidebarTitle":"Get refund","openapi":"/en/openapi/v3-current/pix-lerian-spi.yaml get /refunds/{id}","href":"/en/reference/interfaces/pix-lerian/spi/get-refund"},{"title":"Create an outbound Pix refund (MED)","deprecated":null,"version":null,"sidebarTitle":"Create refund","openapi":"/en/openapi/v3-current/pix-lerian-spi.yaml post /transfers/{id}/refunds","href":"/en/reference/interfaces/pix-lerian/spi/create-refund"}]},{"group":"Pix transfers","pages":[{"title":"List Pix transfers for an account","deprecated":null,"version":null,"sidebarTitle":"List transfers","openapi":"/en/openapi/v3-current/pix-lerian-spi.yaml get /transfers","href":"/en/reference/interfaces/pix-lerian/spi/list-transfers"},{"title":"Initiate a Pix transfer (step 1)","deprecated":null,"version":null,"sidebarTitle":"Initiate transfer","openapi":"/en/openapi/v3-current/pix-lerian-spi.yaml post /transfers/cashout/initiate","href":"/en/reference/interfaces/pix-lerian/spi/initiate-transfer"},{"title":"Process and confirm a Pix transfer (step 2)","deprecated":null,"version":null,"sidebarTitle":"Process transfer","openapi":"/en/openapi/v3-current/pix-lerian-spi.yaml post /transfers/cashout/process","href":"/en/reference/interfaces/pix-lerian/spi/process-transfer"},{"title":"Get a Pix transfer by ID","deprecated":null,"version":null,"sidebarTitle":"Get transfer","openapi":"/en/openapi/v3-current/pix-lerian-spi.yaml get /transfers/{id}","href":"/en/reference/interfaces/pix-lerian/spi/get-transfer"}]},{"group":"Scheduled payments","pages":[{"title":"Schedules a proposed limit would make unviable","deprecated":null,"version":null,"sidebarTitle":"Get scheduled payment limit impact","openapi":"/en/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payment-limit-impact","href":"/en/reference/interfaces/pix-lerian/spi/get-scheduled-payment-limit-impact"},{"title":"Total scheduled for an account on a date","deprecated":null,"version":null,"sidebarTitle":"Get scheduled payment totals","openapi":"/en/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payment-totals","href":"/en/reference/interfaces/pix-lerian/spi/get-scheduled-payment-totals"},{"title":"List scheduled Pix payments","deprecated":null,"version":null,"sidebarTitle":"List scheduled payments","openapi":"/en/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payments","href":"/en/reference/interfaces/pix-lerian/spi/list-scheduled-payments"},{"title":"Register a scheduled Pix payment","deprecated":null,"version":null,"sidebarTitle":"Create scheduled payment","openapi":"/en/openapi/v3-current/pix-lerian-spi.yaml post /scheduled-payments","href":"/en/reference/interfaces/pix-lerian/spi/create-scheduled-payment"},{"title":"Read one scheduled Pix payment","deprecated":null,"version":null,"sidebarTitle":"Get scheduled payment","openapi":"/en/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payments/{schedule_id}","href":"/en/reference/interfaces/pix-lerian/spi/get-scheduled-payment"},{"title":"Cancel a scheduled Pix payment","deprecated":null,"version":null,"sidebarTitle":"Cancel scheduled payment","openapi":"/en/openapi/v3-current/pix-lerian-spi.yaml post /scheduled-payments/{schedule_id}/cancel","href":"/en/reference/interfaces/pix-lerian/spi/cancel-scheduled-payment"},{"title":"Read a scheduled payment's receipt","deprecated":null,"version":null,"sidebarTitle":"Get scheduled payment receipt","openapi":"/en/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payments/{schedule_id}/receipt","href":"/en/reference/interfaces/pix-lerian/spi/get-scheduled-payment-receipt"}]}]},{"group":"Pix Automático API","pages":[{"title":"List authorization requests pending the payer's decision","deprecated":null,"version":null,"sidebarTitle":"List authorization requests","openapi":"/en/openapi/v3-current/pix-lerian-pixauto.yaml get /payer/authorization-requests","href":"/en/reference/interfaces/pix-lerian/pix-automatico/list-authorization-requests"},{"title":"Load a recurrence from a scanned QR Code","deprecated":null,"version":null,"sidebarTitle":"Create authorization request from qr code","openapi":"/en/openapi/v3-current/pix-lerian-pixauto.yaml post /payer/authorization-requests/from-qr","href":"/en/reference/interfaces/pix-lerian/pix-automatico/create-authorization-request-from-qr-code"},{"title":"Get one authorization request","deprecated":null,"version":null,"sidebarTitle":"Get authorization request","openapi":"/en/openapi/v3-current/pix-lerian-pixauto.yaml get /payer/authorization-requests/{authorization_request_id}","href":"/en/reference/interfaces/pix-lerian/pix-automatico/get-authorization-request"},{"title":"Accept or reject an authorization request","deprecated":null,"version":null,"sidebarTitle":"Decide authorization request","openapi":"/en/openapi/v3-current/pix-lerian-pixauto.yaml post /payer/authorization-requests/{authorization_request_id}/decide","href":"/en/reference/interfaces/pix-lerian/pix-automatico/decide-authorization-request"},{"title":"List the payer's authorizations","deprecated":null,"version":null,"sidebarTitle":"List authorizations","openapi":"/en/openapi/v3-current/pix-lerian-pixauto.yaml get /payer/authorizations","href":"/en/reference/interfaces/pix-lerian/pix-automatico/list-authorizations"},{"title":"Get one authorization","deprecated":null,"version":null,"sidebarTitle":"Get authorization","openapi":"/en/openapi/v3-current/pix-lerian-pixauto.yaml get /payer/authorizations/{authorization_id}","href":"/en/reference/interfaces/pix-lerian/pix-automatico/get-authorization"},{"title":"Update the payer-configurable parameters of an authorization","deprecated":null,"version":null,"sidebarTitle":"Update authorization parameters","openapi":"/en/openapi/v3-current/pix-lerian-pixauto.yaml patch /payer/authorizations/{authorization_id}","href":"/en/reference/interfaces/pix-lerian/pix-automatico/update-authorization-parameters"},{"title":"Cancel an authorization at the payer's request","deprecated":null,"version":null,"sidebarTitle":"Cancel authorization","openapi":"/en/openapi/v3-current/pix-lerian-pixauto.yaml post /payer/authorizations/{authorization_id}/cancel","href":"/en/reference/interfaces/pix-lerian/pix-automatico/cancel-authorization"},{"title":"List the state transitions of an authorization","deprecated":null,"version":null,"sidebarTitle":"List authorization history","openapi":"/en/openapi/v3-current/pix-lerian-pixauto.yaml get /payer/authorizations/{authorization_id}/history","href":"/en/reference/interfaces/pix-lerian/pix-automatico/list-authorization-history"},{"title":"List scheduled debits","deprecated":null,"version":null,"sidebarTitle":"List scheduled payments","openapi":"/en/openapi/v3-current/pix-lerian-pixauto.yaml get /payer/scheduled-payments","href":"/en/reference/interfaces/pix-lerian/pix-automatico/list-scheduled-payments"},{"title":"Cancel a single scheduled debit at the payer's request","deprecated":null,"version":null,"sidebarTitle":"Cancel scheduled payment","openapi":"/en/openapi/v3-current/pix-lerian-pixauto.yaml post /payer/scheduled-payments/{scheduled_payment_id}/cancel","href":"/en/reference/interfaces/pix-lerian/pix-automatico/cancel-scheduled-payment"}]},{"group":"Error handling","pages":[{"title":"Pix Lerian error list","href":"/en/reference/interfaces/pix-lerian/pix-lerian-error-list"}]}]},{"dropdown":"Pix JD","icon":"bolt","description":"Pix operations through the JD direct interface","groups":[{"group":"Direct participant APIs","pages":[{"group":"Entries","pages":[{"title":"Register a transactional account closure","deprecated":null,"version":null,"sidebarTitle":"Register a transactional account closure","openapi":"/en/openapi/v3-current/pix.yaml post /v1/account-closures","href":"/en/reference/interfaces/pix-jd/register-a-transactional-account-closure"},{"title":"List PIX key entries","deprecated":null,"version":null,"sidebarTitle":"List keys","openapi":"/en/openapi/v3-current/pix.yaml get /v1/entries","href":"/en/reference/interfaces/pix-jd/list-keys"},{"title":"Register a PIX key entry","deprecated":null,"version":null,"sidebarTitle":"Create key","openapi":"/en/openapi/v3-current/pix.yaml post /v1/entries","href":"/en/reference/interfaces/pix-jd/create-key"},{"title":"Verify PIX key existence","deprecated":null,"version":null,"sidebarTitle":"Verify pix key existence","openapi":"/en/openapi/v3-current/pix.yaml post /v1/entries/verification","href":"/en/reference/interfaces/pix-jd/verify-pix-key-existence"},{"title":"Delete a PIX key entry","deprecated":null,"version":null,"sidebarTitle":"Delete key","openapi":"/en/openapi/v3-current/pix.yaml delete /v1/entries/{entryId}","href":"/en/reference/interfaces/pix-jd/delete-key"},{"title":"Change a PIX key entry","deprecated":null,"version":null,"sidebarTitle":"Change a pix key entry","openapi":"/en/openapi/v3-current/pix.yaml put /v1/entries/{entryId}","href":"/en/reference/interfaces/pix-jd/change-a-pix-key-entry"},{"title":"Confirm PIX key ownership","deprecated":null,"version":null,"sidebarTitle":"Confirm key","openapi":"/en/openapi/v3-current/pix.yaml post /v1/entries/{entryId}/confirmation","href":"/en/reference/interfaces/pix-jd/confirm-key"},{"title":"Get PIX key entry details","deprecated":null,"version":null,"sidebarTitle":"Retrieve key","openapi":"/en/openapi/v3-current/pix.yaml get /v1/entries/{entryId}/details","href":"/en/reference/interfaces/pix-jd/retrieve-key"},{"title":"Look up a PIX key before paying it","deprecated":null,"version":null,"sidebarTitle":"Look up a pix key before paying it","openapi":"/en/openapi/v3-current/pix.yaml get /v1/entries/{entryId}/lookup","href":"/en/reference/interfaces/pix-jd/look-up-a-pix-key-before-paying-it"},{"title":"Register a holder-ownership removal","deprecated":null,"version":null,"sidebarTitle":"Register a holder ownership removal","openapi":"/en/openapi/v3-current/pix.yaml post /v1/holder-removals","href":"/en/reference/interfaces/pix-jd/register-a-holder-ownership-removal"}]},{"group":"Claims","pages":[{"title":"List PIX key claims","deprecated":null,"version":null,"sidebarTitle":"List claims","openapi":"/en/openapi/v3-current/pix.yaml get /v1/claims","href":"/en/reference/interfaces/pix-jd/list-claims"},{"title":"Open a PIX key claim","deprecated":null,"version":null,"sidebarTitle":"Create claim","openapi":"/en/openapi/v3-current/pix.yaml post /v1/claims","href":"/en/reference/interfaces/pix-jd/create-claim"},{"title":"Cancel a PIX key claim","deprecated":null,"version":null,"sidebarTitle":"Cancel claim","openapi":"/en/openapi/v3-current/pix.yaml delete /v1/claims/{claimId}","href":"/en/reference/interfaces/pix-jd/cancel-claim"},{"title":"Get a PIX key claim","deprecated":null,"version":null,"sidebarTitle":"Retrieve claim","openapi":"/en/openapi/v3-current/pix.yaml get /v1/claims/{claimId}","href":"/en/reference/interfaces/pix-jd/retrieve-claim"},{"title":"Conclude a PIX key claim","deprecated":null,"version":null,"sidebarTitle":"Complete claim","openapi":"/en/openapi/v3-current/pix.yaml post /v1/claims/{claimId}/conclusion","href":"/en/reference/interfaces/pix-jd/complete-claim"},{"title":"Confirm a PIX key claim","deprecated":null,"version":null,"sidebarTitle":"Confirm claim","openapi":"/en/openapi/v3-current/pix.yaml post /v1/claims/{claimId}/confirmation","href":"/en/reference/interfaces/pix-jd/confirm-claim"}]},{"group":"Banks","pages":[{"title":"List PIX participant bank ids","deprecated":null,"version":null,"sidebarTitle":"List pix participant bank ids","openapi":"/en/openapi/v3-current/pix.yaml get /v1/banks","href":"/en/reference/interfaces/pix-jd/list-pix-participant-bank-ids"},{"title":"List SPI participants","deprecated":null,"version":null,"sidebarTitle":"List spi participants","openapi":"/en/openapi/v3-current/pix.yaml get /v1/banks/participants","href":"/en/reference/interfaces/pix-jd/list-spi-participants"}]},{"group":"Transactions","pages":[{"title":"List PIX transactions","deprecated":null,"version":null,"sidebarTitle":"List transactions","openapi":"/en/openapi/v3-current/pix.yaml get /v1/transactions","href":"/en/reference/interfaces/pix-jd/list-transactions"},{"title":"Create a PIX transaction","deprecated":null,"version":null,"sidebarTitle":"Create transaction","openapi":"/en/openapi/v3-current/pix.yaml post /v1/transactions","href":"/en/reference/interfaces/pix-jd/create-transaction"},{"title":"Get a PIX transaction status","deprecated":null,"version":null,"sidebarTitle":"Retrieve transaction status","openapi":"/en/openapi/v3-current/pix.yaml get /v1/transactions/{transactionId}","href":"/en/reference/interfaces/pix-jd/retrieve-transaction-status"}]},{"group":"Limits","pages":[{"title":"List PIX transaction limits","deprecated":null,"version":null,"sidebarTitle":"Retrieve transaction limits","openapi":"/en/openapi/v3-current/pix.yaml get /v1/limits","href":"/en/reference/interfaces/pix-jd/retrieve-transaction-limits"},{"title":"Change a PIX transaction limit","deprecated":null,"version":null,"sidebarTitle":"Update transaction limit","openapi":"/en/openapi/v3-current/pix.yaml patch /v1/limits","href":"/en/reference/interfaces/pix-jd/update-transaction-limit"},{"title":"Get available PIX limits","deprecated":null,"version":null,"sidebarTitle":"Retrieve available limits","openapi":"/en/openapi/v3-current/pix.yaml get /v1/limits/available","href":"/en/reference/interfaces/pix-jd/retrieve-available-limits"}]},{"group":"QR Codes","pages":[{"title":"Decode a scanned PIX QR code","deprecated":null,"version":null,"sidebarTitle":"Decode qr code","openapi":"/en/openapi/v3-current/pix.yaml post /v1/qrcodes/decode","href":"/en/reference/interfaces/pix-jd/decode-qr-code"},{"title":"Decode a PIX QR code via its payload URL","deprecated":null,"version":null,"sidebarTitle":"Decode a pix qr code via its payload url","openapi":"/en/openapi/v3-current/pix.yaml post /v1/qrcodes/decode/url","href":"/en/reference/interfaces/pix-jd/decode-a-pix-qr-code-via-its-payload-url"},{"title":"Create an immediate dynamic PIX QR code","deprecated":null,"version":null,"sidebarTitle":"Create dynamic qr code","openapi":"/en/openapi/v3-current/pix.yaml post /v1/qrcodes/dynamic","href":"/en/reference/interfaces/pix-jd/create-dynamic-qr-code"},{"title":"Update an immediate dynamic PIX QR code","deprecated":null,"version":null,"sidebarTitle":"Update an immediate dynamic pix qr code","openapi":"/en/openapi/v3-current/pix.yaml put /v1/qrcodes/dynamic/{documentId}","href":"/en/reference/interfaces/pix-jd/update-an-immediate-dynamic-pix-qr-code"},{"title":"List the PSP's PIX QR codes","deprecated":null,"version":null,"sidebarTitle":"List the psp s pix qr codes","openapi":"/en/openapi/v3-current/pix.yaml get /v1/qrcodes/list","href":"/en/reference/interfaces/pix-jd/list-the-psp-s-pix-qr-codes"},{"title":"Create a static PIX QR code","deprecated":null,"version":null,"sidebarTitle":"Create static qr code","openapi":"/en/openapi/v3-current/pix.yaml post /v1/qrcodes/static","href":"/en/reference/interfaces/pix-jd/create-static-qr-code"}]},{"group":"Refunds","pages":[{"title":"Create a PIX refund","deprecated":null,"version":null,"sidebarTitle":"Create refund","openapi":"/en/openapi/v3-current/pix.yaml post /v1/refunds","href":"/en/reference/interfaces/pix-jd/create-refund"},{"title":"List PIX refund reasons","deprecated":null,"version":null,"sidebarTitle":"List refund reasons","openapi":"/en/openapi/v3-current/pix.yaml get /v1/refunds/reasons","href":"/en/reference/interfaces/pix-jd/list-refund-reasons"}]},{"group":"PIX Automatico","pages":[{"group":"Authorization requests","pages":[{"title":"List PIX Automatico authorizations","deprecated":null,"version":null,"sidebarTitle":"List pix automatico authorizations","openapi":"/en/openapi/v3-current/pix.yaml get /v1/pix-automatico/authorizations","href":"/en/reference/interfaces/pix-jd/list-pix-automatico-authorizations"},{"title":"Request a PIX Automatico authorization","deprecated":null,"version":null,"sidebarTitle":"Request a pix automatico authorization","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations","href":"/en/reference/interfaces/pix-jd/request-a-pix-automatico-authorization"},{"title":"Register an inbound PIX Automatico cancellation","deprecated":null,"version":null,"sidebarTitle":"Register an inbound pix automatico cancellation","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/inbound/cancellation/register","href":"/en/reference/interfaces/pix-jd/register-an-inbound-pix-automatico-cancellation"},{"title":"Validate an inbound PIX Automatico cancellation","deprecated":null,"version":null,"sidebarTitle":"Validate an inbound pix automatico cancellation","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/inbound/cancellation/validate","href":"/en/reference/interfaces/pix-jd/validate-an-inbound-pix-automatico-cancellation"},{"title":"Register an inbound PIX Automatico solicitation on the PSP Pagador","deprecated":null,"version":null,"sidebarTitle":"Register an inbound pix automatico solicitation on the psp pagador","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/inbound/payer/register","href":"/en/reference/interfaces/pix-jd/register-an-inbound-pix-automatico-solicitation-on-the-psp-pagador"},{"title":"Register an inbound PIX Automatico authorization on the PSP Recebedor","deprecated":null,"version":null,"sidebarTitle":"Register an inbound pix automatico authorization on the psp recebedor","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/inbound/recipient/register","href":"/en/reference/interfaces/pix-jd/register-an-inbound-pix-automatico-authorization-on-the-psp-recebedor"},{"title":"Validate an inbound PIX Automatico authorization","deprecated":null,"version":null,"sidebarTitle":"Validate an inbound pix automatico authorization","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/inbound/validate","href":"/en/reference/interfaces/pix-jd/validate-an-inbound-pix-automatico-authorization"}]},{"group":"Authorization management","pages":[{"title":"Consult a PIX Automatico authorization situation","deprecated":null,"version":null,"sidebarTitle":"Consult a pix automatico authorization situation","openapi":"/en/openapi/v3-current/pix.yaml get /v1/pix-automatico/authorizations/{idRecorrencia}","href":"/en/reference/interfaces/pix-jd/consult-a-pix-automatico-authorization-situation"},{"title":"Cancel a PIX Automatico authorization","deprecated":null,"version":null,"sidebarTitle":"Cancel a pix automatico authorization","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/{idRecorrencia}/cancel","href":"/en/reference/interfaces/pix-jd/cancel-a-pix-automatico-authorization"},{"title":"Consult a PIX Automatico authorization cancellation","deprecated":null,"version":null,"sidebarTitle":"Consult a pix automatico authorization cancellation","openapi":"/en/openapi/v3-current/pix.yaml get /v1/pix-automatico/authorizations/{idRecorrencia}/cancel/{idCancelamento}","href":"/en/reference/interfaces/pix-jd/consult-a-pix-automatico-authorization-cancellation"},{"title":"Confirm a PIX Automatico authorization","deprecated":null,"version":null,"sidebarTitle":"Confirm a pix automatico authorization","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/{idRecorrencia}/confirm","href":"/en/reference/interfaces/pix-jd/confirm-a-pix-automatico-authorization"},{"title":"Update a PIX Automatico authorization max value","deprecated":null,"version":null,"sidebarTitle":"Update a pix automatico authorization max value","openapi":"/en/openapi/v3-current/pix.yaml put /v1/pix-automatico/authorizations/{idRecorrencia}/max-value","href":"/en/reference/interfaces/pix-jd/update-a-pix-automatico-authorization-max-value"},{"title":"Respond to a PIX Automatico authorization","deprecated":null,"version":null,"sidebarTitle":"Respond to a pix automatico authorization","openapi":"/en/openapi/v3-current/pix.yaml put /v1/pix-automatico/authorizations/{idRecorrencia}/respond","href":"/en/reference/interfaces/pix-jd/respond-to-a-pix-automatico-authorization"},{"title":"Register a PIX Automatico authorization validation","deprecated":null,"version":null,"sidebarTitle":"Register a pix automatico authorization validation","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/{idRecorrencia}/validation","href":"/en/reference/interfaces/pix-jd/register-a-pix-automatico-authorization-validation"}]},{"group":"Composite QR codes","pages":[{"title":"Create a CobV (due-date) composite PIX Automatico QR code","deprecated":null,"version":null,"sidebarTitle":"Create a cobv due date composite pix automatico qr code","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/composite/cobv","href":"/en/reference/interfaces/pix-jd/create-a-cobv-due-date-composite-pix-automatico-qr-code"},{"title":"Update a CobV (due-date) composite PIX Automatico QR code","deprecated":null,"version":null,"sidebarTitle":"Update a cobv due date composite pix automatico qr code","openapi":"/en/openapi/v3-current/pix.yaml put /v1/pix-automatico/composite/cobv/{id}","href":"/en/reference/interfaces/pix-jd/update-a-cobv-due-date-composite-pix-automatico-qr-code"},{"title":"Decode a composite PIX Automatico QR code from its URL","deprecated":null,"version":null,"sidebarTitle":"Decode a composite pix automatico qr code from its url","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/composite/decode","href":"/en/reference/interfaces/pix-jd/decode-a-composite-pix-automatico-qr-code-from-its-url"},{"title":"Create an immediate dynamic composite PIX Automatico QR code","deprecated":null,"version":null,"sidebarTitle":"Create an immediate dynamic composite pix automatico qr code","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/composite/dynamic","href":"/en/reference/interfaces/pix-jd/create-an-immediate-dynamic-composite-pix-automatico-qr-code"},{"title":"Update an immediate dynamic composite PIX Automatico QR code","deprecated":null,"version":null,"sidebarTitle":"Update an immediate dynamic composite pix automatico qr code","openapi":"/en/openapi/v3-current/pix.yaml put /v1/pix-automatico/composite/dynamic/{id}","href":"/en/reference/interfaces/pix-jd/update-an-immediate-dynamic-composite-pix-automatico-qr-code"},{"title":"Create a recurrence-only composite PIX Automatico QR code","deprecated":null,"version":null,"sidebarTitle":"Create a recurrence only composite pix automatico qr code","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/composite/recurrence","href":"/en/reference/interfaces/pix-jd/create-a-recurrence-only-composite-pix-automatico-qr-code"},{"title":"Update a recurrence-only composite PIX Automatico QR code","deprecated":null,"version":null,"sidebarTitle":"Update a recurrence only composite pix automatico qr code","openapi":"/en/openapi/v3-current/pix.yaml put /v1/pix-automatico/composite/recurrence/{id}","href":"/en/reference/interfaces/pix-jd/update-a-recurrence-only-composite-pix-automatico-qr-code"},{"title":"Create a static composite PIX Automatico QR code","deprecated":null,"version":null,"sidebarTitle":"Create a static composite pix automatico qr code","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/composite/static","href":"/en/reference/interfaces/pix-jd/create-a-static-composite-pix-automatico-qr-code"}]},{"group":"Authorization events","pages":[{"title":"Receive a PIX Automatico authorization cancellation registration event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico authorization cancellation registration event","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/authorization-cancellation-registered","href":"/en/reference/interfaces/pix-jd/receive-a-pix-automatico-authorization-cancellation-registration-event"},{"title":"Receive a PIX Automatico authorization cancellation status event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico authorization cancellation status event","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/authorization-cancellation-status","href":"/en/reference/interfaces/pix-jd/receive-a-pix-automatico-authorization-cancellation-status-event"},{"title":"Receive a PIX Automatico payer-side authorization registration event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico payer side authorization registration event","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/authorization-payer-registered","href":"/en/reference/interfaces/pix-jd/receive-a-pix-automatico-payer-side-authorization-registration-event"},{"title":"Receive a PIX Automatico recipient-side authorization registration event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico recipient side authorization registration event","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/authorization-recipient-registered","href":"/en/reference/interfaces/pix-jd/receive-a-pix-automatico-recipient-side-authorization-registration-event"},{"title":"Receive a PIX Automatico authorization status event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico authorization status event","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/authorization-status","href":"/en/reference/interfaces/pix-jd/receive-a-pix-automatico-authorization-status-event"}]},{"group":"Schedule events","pages":[{"title":"Receive a PIX Automatico schedule cancellation registration event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico schedule cancellation registration event","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/schedule-cancellation-registered","href":"/en/reference/interfaces/pix-jd/receive-a-pix-automatico-schedule-cancellation-registration-event"},{"title":"Receive a PIX Automatico schedule cancellation status event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico schedule cancellation status event","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/schedule-cancellation-status","href":"/en/reference/interfaces/pix-jd/receive-a-pix-automatico-schedule-cancellation-status-event"},{"title":"Receive a PIX Automatico schedule registration event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico schedule registration event","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/schedule-registered","href":"/en/reference/interfaces/pix-jd/receive-a-pix-automatico-schedule-registration-event"},{"title":"Receive a PIX Automatico schedule status event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico schedule status event","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/schedule-status","href":"/en/reference/interfaces/pix-jd/receive-a-pix-automatico-schedule-status-event"}]},{"group":"Schedules and payment instructions","pages":[{"title":"Request a PIX Automatico schedule send","deprecated":null,"version":null,"sidebarTitle":"Request a pix automatico schedule send","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules","href":"/en/reference/interfaces/pix-jd/request-a-pix-automatico-schedule-send"},{"title":"Register an inbound PIX Automatico schedule cancellation","deprecated":null,"version":null,"sidebarTitle":"Register an inbound pix automatico schedule cancellation","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules/inbound/cancellation/register","href":"/en/reference/interfaces/pix-jd/register-an-inbound-pix-automatico-schedule-cancellation"},{"title":"Validate an inbound PIX Automatico schedule cancellation","deprecated":null,"version":null,"sidebarTitle":"Validate an inbound pix automatico schedule cancellation","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules/inbound/cancellation/validate","href":"/en/reference/interfaces/pix-jd/validate-an-inbound-pix-automatico-schedule-cancellation"},{"title":"Register an inbound PIX Automatico payment instruction","deprecated":null,"version":null,"sidebarTitle":"Register an inbound pix automatico payment instruction","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules/inbound/register","href":"/en/reference/interfaces/pix-jd/register-an-inbound-pix-automatico-payment-instruction"},{"title":"Validate an inbound PIX Automatico payment instruction","deprecated":null,"version":null,"sidebarTitle":"Validate an inbound pix automatico payment instruction","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules/inbound/validate","href":"/en/reference/interfaces/pix-jd/validate-an-inbound-pix-automatico-payment-instruction"},{"title":"List PIX Automatico schedules","deprecated":null,"version":null,"sidebarTitle":"List pix automatico schedules","openapi":"/en/openapi/v3-current/pix.yaml get /v1/pix-automatico/schedules/list","href":"/en/reference/interfaces/pix-jd/list-pix-automatico-schedules"},{"title":"Consult a PIX Automatico schedule situation","deprecated":null,"version":null,"sidebarTitle":"Consult a pix automatico schedule situation","openapi":"/en/openapi/v3-current/pix.yaml get /v1/pix-automatico/schedules/{endToEndId}","href":"/en/reference/interfaces/pix-jd/consult-a-pix-automatico-schedule-situation"},{"title":"Cancel a PIX Automatico schedule","deprecated":null,"version":null,"sidebarTitle":"Cancel a pix automatico schedule","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules/{endToEndId}/cancel","href":"/en/reference/interfaces/pix-jd/cancel-a-pix-automatico-schedule"},{"title":"Consult a PIX Automatico schedule cancellation","deprecated":null,"version":null,"sidebarTitle":"Consult a pix automatico schedule cancellation","openapi":"/en/openapi/v3-current/pix.yaml get /v1/pix-automatico/schedules/{endToEndId}/cancel/{idCancelamento}","href":"/en/reference/interfaces/pix-jd/consult-a-pix-automatico-schedule-cancellation"}]},{"group":"Settlement","pages":[{"title":"Reserve an inbound PIX Automatico debit hold","deprecated":null,"version":null,"sidebarTitle":"Reserve an inbound pix automatico debit hold","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/settlements/inbound/block","href":"/en/reference/interfaces/pix-jd/reserve-an-inbound-pix-automatico-debit-hold"},{"title":"Effect an inbound PIX Automatico settlement debit","deprecated":null,"version":null,"sidebarTitle":"Effect an inbound pix automatico settlement debit","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/settlements/inbound/debit","href":"/en/reference/interfaces/pix-jd/effect-an-inbound-pix-automatico-settlement-debit"},{"title":"Reverse an inbound PIX Automatico settlement debit","deprecated":null,"version":null,"sidebarTitle":"Reverse an inbound pix automatico settlement debit","openapi":"/en/openapi/v3-current/pix.yaml delete /v1/pix-automatico/settlements/inbound/debit/{endToEndId}","href":"/en/reference/interfaces/pix-jd/reverse-an-inbound-pix-automatico-settlement-debit"}]},{"group":"JD Courier","pages":[{"title":"Tell the JD Courier which Pix Automático traffic is this engine's","deprecated":null,"version":null,"sidebarTitle":"Tell the jd courier which pix automatico traffic is this engine s","openapi":"/en/openapi/v3-current/pix.yaml post /v1/pix-automatico/courier-ownership","href":"/en/reference/interfaces/pix-jd/tell-the-jd-courier-which-pix-automatico-traffic-is-this-engine-s"}]}]},{"group":"MED Infractions","pages":[{"title":"List MED infractions","deprecated":null,"version":null,"sidebarTitle":"List med infractions","openapi":"/en/openapi/v3-current/pix.yaml get /v1/med/infractions","href":"/en/reference/interfaces/pix-jd/list-med-infractions"},{"title":"Get a MED infraction","deprecated":null,"version":null,"sidebarTitle":"Get a med infraction","openapi":"/en/openapi/v3-current/pix.yaml get /v1/med/infractions/{idRelatoInfracao}","href":"/en/reference/interfaces/pix-jd/get-a-med-infraction"},{"title":"Analyze a MED infraction","deprecated":null,"version":null,"sidebarTitle":"Analyze a med infraction","openapi":"/en/openapi/v3-current/pix.yaml post /v1/med/infractions/{idRelatoInfracao}/analyze","href":"/en/reference/interfaces/pix-jd/analyze-a-med-infraction"},{"title":"Cancel a MED infraction","deprecated":null,"version":null,"sidebarTitle":"Cancel a med infraction","openapi":"/en/openapi/v3-current/pix.yaml post /v1/med/infractions/{idRelatoInfracao}/cancel","href":"/en/reference/interfaces/pix-jd/cancel-a-med-infraction"},{"title":"Get a MED infraction from the JDPI base","deprecated":null,"version":null,"sidebarTitle":"Get a med infraction from jdpi","openapi":"/en/openapi/v3-current/pix.yaml get /v1/med/infractions/{idRelatoInfracao}/jdpi","href":"/en/reference/interfaces/pix-jd/get-a-med-infraction-from-jdpi"}]},{"group":"MED Refunds","pages":[{"title":"List MED refund requests","deprecated":null,"version":null,"sidebarTitle":"List med refund requests","openapi":"/en/openapi/v3-current/pix.yaml get /v1/med/refunds","href":"/en/reference/interfaces/pix-jd/list-med-refund-requests"},{"title":"Open a MED refund request","deprecated":null,"version":null,"sidebarTitle":"Open a med refund request","openapi":"/en/openapi/v3-current/pix.yaml post /v1/med/refunds","href":"/en/reference/interfaces/pix-jd/open-a-med-refund-request"},{"title":"Get the credit status of a MED refund order","deprecated":null,"version":null,"sidebarTitle":"Get a med refund credit status","openapi":"/en/openapi/v3-current/pix.yaml get /v1/med/refunds/credits/{endToEndIdDevolucao}","href":"/en/reference/interfaces/pix-jd/get-a-med-refund-credit-status"},{"title":"List MED refund requests pending my analysis","deprecated":null,"version":null,"sidebarTitle":"List med refund requests pending my analysis","openapi":"/en/openapi/v3-current/pix.yaml get /v1/med/refunds/pending-analysis","href":"/en/reference/interfaces/pix-jd/list-med-refund-requests-pending-my-analysis"},{"title":"Get a MED refund request","deprecated":null,"version":null,"sidebarTitle":"Get a med refund request","openapi":"/en/openapi/v3-current/pix.yaml get /v1/med/refunds/{idSolDevolucao}","href":"/en/reference/interfaces/pix-jd/get-a-med-refund-request"},{"title":"Analyze a MED refund request","deprecated":null,"version":null,"sidebarTitle":"Analyze a med refund request","openapi":"/en/openapi/v3-current/pix.yaml post /v1/med/refunds/{idSolDevolucao}/analyze","href":"/en/reference/interfaces/pix-jd/analyze-a-med-refund-request"},{"title":"Cancel a MED refund request","deprecated":null,"version":null,"sidebarTitle":"Cancel a med refund request","openapi":"/en/openapi/v3-current/pix.yaml post /v1/med/refunds/{idSolDevolucao}/cancel","href":"/en/reference/interfaces/pix-jd/cancel-a-med-refund-request"},{"title":"Effectuate a MED refund debit (THIRD RAIL — moves money)","deprecated":null,"version":null,"sidebarTitle":"Effectuate a med refund debit","openapi":"/en/openapi/v3-current/pix.yaml post /v1/med/refunds/{idSolDevolucao}/effectuate","href":"/en/reference/interfaces/pix-jd/effectuate-a-med-refund-debit"},{"title":"Get a MED refund request from the JDPI base","deprecated":null,"version":null,"sidebarTitle":"Get a med refund request from jdpi","openapi":"/en/openapi/v3-current/pix.yaml get /v1/med/refunds/{idSolDevolucao}/jdpi","href":"/en/reference/interfaces/pix-jd/get-a-med-refund-request-from-jdpi"}]},{"group":"MED Fraud Markers","pages":[{"title":"List MED fraud markers (local base)","deprecated":null,"version":null,"sidebarTitle":"List med fraud markers local base","openapi":"/en/openapi/v3-current/pix.yaml get /v1/med/fraud-markers","href":"/en/reference/interfaces/pix-jd/list-med-fraud-markers-local-base"},{"title":"Register a MED fraud marker","deprecated":null,"version":null,"sidebarTitle":"Register a med fraud marker","openapi":"/en/openapi/v3-current/pix.yaml post /v1/med/fraud-markers","href":"/en/reference/interfaces/pix-jd/register-a-med-fraud-marker"},{"title":"List MED fraud markers (DICT-direct)","deprecated":null,"version":null,"sidebarTitle":"List med fraud markers dict direct","openapi":"/en/openapi/v3-current/pix.yaml get /v1/med/fraud-markers/dict","href":"/en/reference/interfaces/pix-jd/list-med-fraud-markers-dict-direct"},{"title":"Get a MED fraud marker","deprecated":null,"version":null,"sidebarTitle":"Get a med fraud marker","openapi":"/en/openapi/v3-current/pix.yaml get /v1/med/fraud-markers/{idMarcacaoFraude}","href":"/en/reference/interfaces/pix-jd/get-a-med-fraud-marker"},{"title":"Cancel a MED fraud marker","deprecated":null,"version":null,"sidebarTitle":"Cancel a med fraud marker","openapi":"/en/openapi/v3-current/pix.yaml post /v1/med/fraud-markers/{idMarcacaoFraude}/cancel","href":"/en/reference/interfaces/pix-jd/cancel-a-med-fraud-marker"}]},{"group":"MED Recoveries","pages":[{"title":"Create a MED value recovery","deprecated":null,"version":null,"sidebarTitle":"Create a med value recovery","openapi":"/en/openapi/v3-current/pix.yaml post /v1/med/recoveries","href":"/en/reference/interfaces/pix-jd/create-a-med-value-recovery"},{"title":"List MED recoveries awaiting return","deprecated":null,"version":null,"sidebarTitle":"List med recoveries awaiting return","openapi":"/en/openapi/v3-current/pix.yaml get /v1/med/recoveries/awaiting-return","href":"/en/reference/interfaces/pix-jd/list-med-recoveries-awaiting-return"},{"title":"Get a MED value recovery","deprecated":null,"version":null,"sidebarTitle":"Get a med value recovery","openapi":"/en/openapi/v3-current/pix.yaml get /v1/med/recoveries/{idRecValores}","href":"/en/reference/interfaces/pix-jd/get-a-med-value-recovery"},{"title":"Amend a MED value recovery","deprecated":null,"version":null,"sidebarTitle":"Amend a med value recovery","openapi":"/en/openapi/v3-current/pix.yaml put /v1/med/recoveries/{idRecValores}/amend","href":"/en/reference/interfaces/pix-jd/amend-a-med-value-recovery"},{"title":"Start a MED value recovery return stage","deprecated":null,"version":null,"sidebarTitle":"Start a med value recovery return stage","openapi":"/en/openapi/v3-current/pix.yaml post /v1/med/recoveries/{idRecValores}/return","href":"/en/reference/interfaces/pix-jd/start-a-med-value-recovery-return-stage"}]},{"group":"Webhooks","pages":[{"title":"Process an inbound JDPI cash-in","deprecated":null,"version":null,"sidebarTitle":"Process an inbound upstream cash in","openapi":"/en/openapi/v3-current/pix.yaml post /v1/webhooks/cash-ins","href":"/en/reference/interfaces/pix-jd/process-an-inbound-upstream-cash-in"},{"title":"Process a payee-bank-initiated PIX devolução","deprecated":null,"version":null,"sidebarTitle":"Process a payee bank initiated pix devolu o","openapi":"/en/openapi/v3-current/pix.yaml post /v1/webhooks/refunds","href":"/en/reference/interfaces/pix-jd/process-a-payee-bank-initiated-pix-devolu-o"},{"title":"Validate a receiving account synchronously","deprecated":null,"version":null,"sidebarTitle":"Validate a receiving account synchronously","openapi":"/en/openapi/v3-current/pix.yaml post /v1/webhooks/validates","href":"/en/reference/interfaces/pix-jd/validate-a-receiving-account-synchronously"},{"title":"Receive an asynchronous account validation","deprecated":null,"version":null,"sidebarTitle":"Receive an asynchronous account validation","openapi":"/en/openapi/v3-current/pix.yaml post /v1/webhooks/validates/async","href":"/en/reference/interfaces/pix-jd/receive-an-asynchronous-account-validation"}]},{"group":"Error handling","pages":[{"title":"Pix JD error list","href":"/en/reference/interfaces/pix-jd/pix-jd-error-list"}]},{"group":"Events","pages":[{"title":"Pix Direct via JD events","href":"/en/reference/events/pix-direct-jd"}]}]},{"group":"Indirect participant APIs","pages":[{"title":"Indirect participants","sidebarTitle":"Overview","href":"/en/reference/interfaces/pix-jd/indirect-participants"},{"title":"List indirect participants","deprecated":null,"version":null,"sidebarTitle":"List indirect participants","openapi":"/en/openapi/v3-current/pix.yaml get /v1/indirects","href":"/en/reference/interfaces/pix-jd/list-indirect-participants"},{"title":"Register an indirect participant","deprecated":null,"version":null,"sidebarTitle":"Register an indirect participant","openapi":"/en/openapi/v3-current/pix.yaml post /v1/indirects","href":"/en/reference/interfaces/pix-jd/register-an-indirect-participant"},{"title":"Get an indirect participant","deprecated":null,"version":null,"sidebarTitle":"Get an indirect participant","openapi":"/en/openapi/v3-current/pix.yaml get /v1/indirects/{indirectId}","href":"/en/reference/interfaces/pix-jd/get-an-indirect-participant"},{"title":"Update an indirect participant","deprecated":null,"version":null,"sidebarTitle":"Update an indirect participant","openapi":"/en/openapi/v3-current/pix.yaml patch /v1/indirects/{indirectId}","href":"/en/reference/interfaces/pix-jd/update-an-indirect-participant"},{"title":"Get an indirect participant's JWK Set","deprecated":null,"version":null,"sidebarTitle":"Get an indirect participant jwk set","openapi":"/en/openapi/v3-current/pix.yaml get /v1/indirects/{indirectId}/jwks","href":"/en/reference/interfaces/pix-jd/get-an-indirect-participant-jwk-set"},{"title":"List an indirect participant's transactions","deprecated":null,"version":null,"sidebarTitle":"List indirect participant transactions","openapi":"/en/openapi/v3-current/pix.yaml get /v1/indirects/{indirectId}/transactions","href":"/en/reference/interfaces/pix-jd/list-indirect-participant-transactions"}]}]},{"dropdown":"JD Courier","icon":"route","description":"Engine coexistence on one JD channel","groups":[{"group":"Engines","pages":[{"title":"List the registered engines","deprecated":null,"version":null,"sidebarTitle":"List the registered engines","openapi":"/en/openapi/v3-current/jd-courier.yaml get /v1/engines","href":"/en/reference/interfaces/jd-courier/list-the-registered-engines"},{"title":"Register an engine","deprecated":null,"version":null,"sidebarTitle":"Register an engine","openapi":"/en/openapi/v3-current/jd-courier.yaml post /v1/engines","href":"/en/reference/interfaces/jd-courier/register-an-engine"},{"title":"Enable, disable or rename an engine","deprecated":null,"version":null,"sidebarTitle":"Enable disable or rename an engine","openapi":"/en/openapi/v3-current/jd-courier.yaml patch /v1/engines/{engineId}","href":"/en/reference/interfaces/jd-courier/enable-disable-or-rename-an-engine"},{"title":"Issue the engine's SOAP channel credential","deprecated":null,"version":null,"sidebarTitle":"Issue the engine s soap channel credential","openapi":"/en/openapi/v3-current/jd-courier.yaml post /v1/engines/{engineId}/channel-credential","href":"/en/reference/interfaces/jd-courier/issue-the-engine-s-soap-channel-credential"},{"title":"Revoke one of the engine's SOAP channel credentials","deprecated":null,"version":null,"sidebarTitle":"Revoke one of the engine s soap channel credentials","openapi":"/en/openapi/v3-current/jd-courier.yaml post /v1/engines/{engineId}/channel-credential/{credentialId}/revoke","href":"/en/reference/interfaces/jd-courier/revoke-one-of-the-engine-s-soap-channel-credentials"}]},{"group":"Ownership map","pages":[{"title":"List ownership assignments","deprecated":null,"version":null,"sidebarTitle":"List ownership assignments","openapi":"/en/openapi/v3-current/jd-courier.yaml get /v1/ownership/assignments","href":"/en/reference/interfaces/jd-courier/list-ownership-assignments"},{"title":"Assign a key to an engine","deprecated":null,"version":null,"sidebarTitle":"Assign a key to an engine","openapi":"/en/openapi/v3-current/jd-courier.yaml post /v1/ownership/assignments","href":"/en/reference/interfaces/jd-courier/assign-a-key-to-an-engine"},{"title":"Read one ownership assignment","deprecated":null,"version":null,"sidebarTitle":"Read one ownership assignment","openapi":"/en/openapi/v3-current/jd-courier.yaml get /v1/ownership/assignments/{assignmentId}","href":"/en/reference/interfaces/jd-courier/read-one-ownership-assignment"},{"title":"Unassign a key","deprecated":null,"version":null,"sidebarTitle":"Unassign a key","openapi":"/en/openapi/v3-current/jd-courier.yaml delete /v1/ownership/assignments/{assignmentId}","href":"/en/reference/interfaces/jd-courier/unassign-a-key"},{"title":"Move a key to another engine","deprecated":null,"version":null,"sidebarTitle":"Move a key to another engine","openapi":"/en/openapi/v3-current/jd-courier.yaml post /v1/ownership/assignments/{assignmentId}/move","href":"/en/reference/interfaces/jd-courier/move-a-key-to-another-engine"},{"title":"Ownership history for one key","deprecated":null,"version":null,"sidebarTitle":"Ownership history for one key","openapi":"/en/openapi/v3-current/jd-courier.yaml get /v1/ownership/assignments/{assignmentId}/audit","href":"/en/reference/interfaces/jd-courier/ownership-history-for-one-key"},{"title":"Ownership history for one key, addressed by the key","deprecated":null,"version":null,"sidebarTitle":"Ownership history for one key addressed by the key","openapi":"/en/openapi/v3-current/jd-courier.yaml post /v1/ownership/audit/lookup","href":"/en/reference/interfaces/jd-courier/ownership-history-for-one-key-addressed-by-the-key"}]},{"group":"Engine API","pages":[{"title":"Resolve which engine owns a key","deprecated":null,"version":null,"sidebarTitle":"Resolve which engine owns a key","openapi":"/en/openapi/v3-current/jd-courier.yaml post /v1/ownership/lookup","href":"/en/reference/interfaces/jd-courier/resolve-which-engine-owns-a-key"},{"title":"Claim a Pix Automático recurrence for the calling engine","deprecated":null,"version":null,"sidebarTitle":"Claim a pix automatico recurrence for the calling engine","openapi":"/en/openapi/v3-current/jd-courier.yaml put /v1/ownership/recurrences/{recurrenceId}","href":"/en/reference/interfaces/jd-courier/claim-a-pix-automatico-recurrence-for-the-calling-engine"},{"title":"Declare an earlier leg of a Pix Automático payment the calling engine holds","deprecated":null,"version":null,"sidebarTitle":"Declare an earlier leg of a pix automatico payment the calling engine holds","openapi":"/en/openapi/v3-current/jd-courier.yaml put /v1/ownership/payments/{endToEndId}/legs/{leg}","href":"/en/reference/interfaces/jd-courier/declare-an-earlier-leg-of-a-pix-automatico-payment-the-calling-engine-holds"}]},{"group":"Channels","pages":[{"title":"List the registered rails, their declared properties and their state","deprecated":null,"version":null,"sidebarTitle":"List the registered rails their declared properties and their state","openapi":"/en/openapi/v3-current/jd-courier.yaml get /v1/channels","href":"/en/reference/interfaces/jd-courier/list-the-registered-rails-their-declared-properties-and-their-state"},{"title":"Activate a rail for the caller's tenant","deprecated":null,"version":null,"sidebarTitle":"Activate a rail for the caller s tenant","openapi":"/en/openapi/v3-current/jd-courier.yaml put /v1/channels/{channelId}/activation","href":"/en/reference/interfaces/jd-courier/activate-a-rail-for-the-caller-s-tenant"},{"title":"Suspend a rail for the caller's tenant","deprecated":null,"version":null,"sidebarTitle":"Suspend a rail for the caller s tenant","openapi":"/en/openapi/v3-current/jd-courier.yaml delete /v1/channels/{channelId}/activation","href":"/en/reference/interfaces/jd-courier/suspend-a-rail-for-the-caller-s-tenant"},{"title":"Declare that an engine is in bypass on this rail","deprecated":null,"version":null,"sidebarTitle":"Declare that an engine is in bypass on this rail","openapi":"/en/openapi/v3-current/jd-courier.yaml put /v1/channels/{channelId}/bypass","href":"/en/reference/interfaces/jd-courier/declare-that-an-engine-is-in-bypass-on-this-rail"},{"title":"Declare the end of a bypass on this rail","deprecated":null,"version":null,"sidebarTitle":"Declare the end of a bypass on this rail","openapi":"/en/openapi/v3-current/jd-courier.yaml delete /v1/channels/{channelId}/bypass","href":"/en/reference/interfaces/jd-courier/declare-the-end-of-a-bypass-on-this-rail"},{"title":"List the per-code delivery-mode declarations on a rail","deprecated":null,"version":null,"sidebarTitle":"List the per code delivery mode declarations on a rail","openapi":"/en/openapi/v3-current/jd-courier.yaml get /v1/channels/{channelId}/delivery-modes","href":"/en/reference/interfaces/jd-courier/list-the-per-code-delivery-mode-declarations-on-a-rail"},{"title":"Declare the delivery mode for one message code","deprecated":null,"version":null,"sidebarTitle":"Declare the delivery mode for one message code","openapi":"/en/openapi/v3-current/jd-courier.yaml put /v1/channels/{channelId}/delivery-modes/{messageCode}","href":"/en/reference/interfaces/jd-courier/declare-the-delivery-mode-for-one-message-code"},{"title":"Revoke a code's declaration and restore the single-owner default","deprecated":null,"version":null,"sidebarTitle":"Revoke a code s declaration and restore the single owner default","openapi":"/en/openapi/v3-current/jd-courier.yaml delete /v1/channels/{channelId}/delivery-modes/{messageCode}","href":"/en/reference/interfaces/jd-courier/revoke-a-code-s-declaration-and-restore-the-single-owner-default"},{"title":"Lift a durable channel halt","deprecated":null,"version":null,"sidebarTitle":"Lift a durable channel halt","openapi":"/en/openapi/v3-current/jd-courier.yaml post /v1/channels/{channelId}/lease/resume","href":"/en/reference/interfaces/jd-courier/lift-a-durable-channel-halt"}]},{"group":"Messages","pages":[{"title":"List retained messages","deprecated":null,"version":null,"sidebarTitle":"List retained messages","openapi":"/en/openapi/v3-current/jd-courier.yaml get /v1/retained","href":"/en/reference/interfaces/jd-courier/list-retained-messages"},{"title":"Run a retained message's routing decision again","deprecated":null,"version":null,"sidebarTitle":"Run a retained message s routing decision again","openapi":"/en/openapi/v3-current/jd-courier.yaml post /v1/retained/{messageId}/reevaluate","href":"/en/reference/interfaces/jd-courier/run-a-retained-message-s-routing-decision-again"},{"title":"Reopen the delivery of a message to an engine","deprecated":null,"version":null,"sidebarTitle":"Reopen the delivery of a message to an engine","openapi":"/en/openapi/v3-current/jd-courier.yaml post /v1/messages/{messageId}/redeliver","href":"/en/reference/interfaces/jd-courier/reopen-the-delivery-of-a-message-to-an-engine"}]},{"group":"Send journal","pages":[{"title":"List SPB sends","deprecated":null,"version":null,"sidebarTitle":"List spb sends","openapi":"/en/openapi/v3-current/jd-courier.yaml get /v1/send-journal","href":"/en/reference/interfaces/jd-courier/list-spb-sends"},{"title":"One SPB send and its query history","deprecated":null,"version":null,"sidebarTitle":"One spb send and its query history","openapi":"/en/openapi/v3-current/jd-courier.yaml get /v1/send-journal/{controlId}","href":"/en/reference/interfaces/jd-courier/one-spb-send-and-its-query-history"},{"title":"Close an indeterminate send by hand","deprecated":null,"version":null,"sidebarTitle":"Close an indeterminate send by hand","openapi":"/en/openapi/v3-current/jd-courier.yaml post /v1/send-journal/{controlId}/resolve","href":"/en/reference/interfaces/jd-courier/close-an-indeterminate-send-by-hand"}]},{"group":"Reconciliation","pages":[{"title":"Reconciliation report for a rail","deprecated":null,"version":null,"sidebarTitle":"Reconciliation report for a rail","openapi":"/en/openapi/v3-current/jd-courier.yaml get /v1/channels/{channelId}/reconciliation","href":"/en/reference/interfaces/jd-courier/reconciliation-report-for-a-rail"},{"title":"Trigger a reconciliation cycle for a rail","deprecated":null,"version":null,"sidebarTitle":"Trigger a reconciliation cycle for a rail","openapi":"/en/openapi/v3-current/jd-courier.yaml post /v1/channels/{channelId}/reconciliation/tick","href":"/en/reference/interfaces/jd-courier/trigger-a-reconciliation-cycle-for-a-rail"},{"title":"Close a reconciliation finding","deprecated":null,"version":null,"sidebarTitle":"Close a reconciliation finding","openapi":"/en/openapi/v3-current/jd-courier.yaml post /v1/assurance/findings/{findingId}/close","href":"/en/reference/interfaces/jd-courier/close-a-reconciliation-finding"}]},{"group":"Error handling","pages":[{"title":"JD Courier error list","href":"/en/reference/interfaces/jd-courier/jd-courier-error-list"}]}]},{"dropdown":"Pix BTG","icon":"bolt","description":"Pix operations through the BTG indirect interface","groups":[{"group":"DICT API","pages":[{"title":"Check Pix Keys Existence","deprecated":null,"version":null,"sidebarTitle":"Check keys existence","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/keys/check","href":"/en/reference/interfaces/pix-btg/check-keys-existence"},{"title":"Create a Pix Entry","deprecated":null,"version":null,"sidebarTitle":"Create entry","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/entries","href":"/en/reference/interfaces/pix-btg/create-entry"},{"title":"Delete a Pix Entry","deprecated":null,"version":null,"sidebarTitle":"Delete an entry","openapi":"/en/openapi/v3-current/indirect-pix.yaml delete /v1/dict/entries/{entry_id}","href":"/en/reference/interfaces/pix-btg/delete-an-entry"},{"title":"List All Pix Entries","deprecated":null,"version":null,"sidebarTitle":"List entries","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/entries","href":"/en/reference/interfaces/pix-btg/list-entries"},{"title":"Retrieve a Pix Key","deprecated":null,"version":null,"sidebarTitle":"Retrieve a key","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/keys/{key}","href":"/en/reference/interfaces/pix-btg/retrieve-a-key"},{"title":"Get a Pix Entry","deprecated":null,"version":null,"sidebarTitle":"Retrieve an entry","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/entries/{entry_id}","href":"/en/reference/interfaces/pix-btg/retrieve-an-entry"},{"title":"Update a Pix Entry Data","deprecated":null,"version":null,"sidebarTitle":"Update an entry","openapi":"/en/openapi/v3-current/indirect-pix.yaml patch /v1/dict/entries/{entry_id}","href":"/en/reference/interfaces/pix-btg/update-an-entry"}]},{"group":"Claims API","pages":[{"title":"Acknowledge a Key Claim","deprecated":null,"version":null,"sidebarTitle":"Acknowledge a claim","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/claims/{claim_id}/acknowledge","href":"/en/reference/interfaces/pix-btg/acknowledge-a-claim"},{"title":"Cancel a Key Claim","deprecated":null,"version":null,"sidebarTitle":"Cancel a claim","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/claims/{claim_id}/cancel","href":"/en/reference/interfaces/pix-btg/cancel-a-claim"},{"title":"Complete a Key Claim","deprecated":null,"version":null,"sidebarTitle":"Complete a claim","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/claims/{claim_id}/complete","href":"/en/reference/interfaces/pix-btg/complete-a-claim"},{"title":"Confirm a Key Claim","deprecated":null,"version":null,"sidebarTitle":"Confirm a claim","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/claims/{claim_id}/confirm","href":"/en/reference/interfaces/pix-btg/confirm-a-claim"},{"title":"Create a Key Claim","deprecated":null,"version":null,"sidebarTitle":"Create a claim","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/claims","href":"/en/reference/interfaces/pix-btg/create-a-claim"},{"title":"List Key Claims","deprecated":null,"version":null,"sidebarTitle":"List claims","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/claims","href":"/en/reference/interfaces/pix-btg/list-claims"},{"title":"Get a Key Claim","deprecated":null,"version":null,"sidebarTitle":"Retrieve a claim","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/claims/{claim_id}","href":"/en/reference/interfaces/pix-btg/retrieve-a-claim"}]},{"group":"MED · Infractions","pages":[{"title":"Acknowledge an Infraction Report","deprecated":null,"version":null,"sidebarTitle":"Acknowledge an infraction report","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/infraction-reports/{infraction_id}/acknowledge","href":"/en/reference/interfaces/pix-btg/acknowledge-an-infraction-report"},{"title":"Cancel an Infraction Report","deprecated":null,"version":null,"sidebarTitle":"Cancel an infraction report","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/infraction-reports/{infraction_id}/cancel","href":"/en/reference/interfaces/pix-btg/cancel-an-infraction-report"},{"title":"Close an Infraction Report","deprecated":true,"version":null,"sidebarTitle":"Close an infraction report","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/infraction-reports/{infraction_id}/close","href":"/en/reference/interfaces/pix-btg/close-an-infraction-report"},{"title":"Create an Infraction Report","deprecated":true,"version":null,"sidebarTitle":"Create an infraction report","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/infraction-reports","href":"/en/reference/interfaces/pix-btg/create-an-infraction-report"},{"title":"List Infraction Reports","deprecated":null,"version":null,"sidebarTitle":"List infraction reports","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/infraction-reports","href":"/en/reference/interfaces/pix-btg/list-infraction-reports"},{"title":"Retrieve Infraction Report details","deprecated":null,"version":null,"sidebarTitle":"Retrieve an infraction report","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/infraction-reports/{infraction_id}","href":"/en/reference/interfaces/pix-btg/retrieve-an-infraction-report"}]},{"group":"MED · Fraud markers","pages":[{"title":"Cancel a Fraud Marker","deprecated":null,"version":null,"sidebarTitle":"Cancel a fraud marker","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/fraud-markers/{fraud_marker_id}/cancel","href":"/en/reference/interfaces/pix-btg/cancel-a-fraud-marker"},{"title":"Create a Fraud Marker","deprecated":null,"version":null,"sidebarTitle":"Create a fraud marker","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/fraud-markers","href":"/en/reference/interfaces/pix-btg/create-a-fraud-marker"},{"title":"List Fraud Markers","deprecated":null,"version":null,"sidebarTitle":"List fraud markers","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/fraud-markers","href":"/en/reference/interfaces/pix-btg/list-fraud-markers"}]},{"group":"MED · Refund requests","pages":[{"title":"Cancel a Refund Request","deprecated":null,"version":null,"sidebarTitle":"Cancel a refund request","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/refund-requests/{refund_id}/cancel","href":"/en/reference/interfaces/pix-btg/cancel-a-refund-request"},{"title":"Close a Refund Request","deprecated":null,"version":null,"sidebarTitle":"Close a refund request","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/refund-requests/{refund_id}/close","href":"/en/reference/interfaces/pix-btg/close-a-refund-request"},{"title":"Create a Refund Request","deprecated":null,"version":null,"sidebarTitle":"Create a refund request","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/refund-requests","href":"/en/reference/interfaces/pix-btg/create-a-refund-request"},{"title":"List Refund Requests","deprecated":null,"version":null,"sidebarTitle":"List refund requests","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/refund-requests","href":"/en/reference/interfaces/pix-btg/list-refund-requests"},{"title":"Retrieve a Refund Request","deprecated":null,"version":null,"sidebarTitle":"Retrieve a refund request","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/refund-requests/{refund_id}","href":"/en/reference/interfaces/pix-btg/retrieve-a-refund-request"}]},{"group":"MED · Statistics","pages":[{"title":"Get Key Statistics","deprecated":null,"version":null,"sidebarTitle":"Retrieve key statistics","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/statistics/keys/{key}","href":"/en/reference/interfaces/pix-btg/retrieve-key-statistics"},{"title":"Get Person Statistics","deprecated":null,"version":null,"sidebarTitle":"Retrieve person statistics","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/statistics/persons/{tax_id}","href":"/en/reference/interfaces/pix-btg/retrieve-person-statistics"}]},{"group":"Transactions API","pages":[{"title":"Get a Refund","deprecated":null,"version":null,"sidebarTitle":"Get a refund","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/refunds/{refund_id}","href":"/en/reference/interfaces/pix-btg/get-a-refund"},{"title":"Initiate a Pix Transfer","deprecated":null,"version":null,"sidebarTitle":"Initiate a pix transfer","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/transfers/cashout/initiate","href":"/en/reference/interfaces/pix-btg/initiate-a-pix-transfer"},{"title":"List Pix Transfers","deprecated":null,"version":null,"sidebarTitle":"List pix transfers","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/transfers","href":"/en/reference/interfaces/pix-btg/list-pix-transfers"},{"title":"List Refunds","deprecated":null,"version":null,"sidebarTitle":"List refunds","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/refunds","href":"/en/reference/interfaces/pix-btg/list-refunds"},{"title":"Process a Pix Transfer","deprecated":null,"version":null,"sidebarTitle":"Process a pix transfer","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/transfers/cashout/process","href":"/en/reference/interfaces/pix-btg/process-a-pix-transfer"},{"title":"Refund a Received Pix Transfer","deprecated":null,"version":null,"sidebarTitle":"Refund a received pix transfer","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/transfers/{transfer_id}/refunds","href":"/en/reference/interfaces/pix-btg/refund-a-received-pix-transfer"},{"title":"Get a Pix Transfer","deprecated":null,"version":null,"sidebarTitle":"Retrieve a pix transfer","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/transfers/{transfer_id}","href":"/en/reference/interfaces/pix-btg/retrieve-a-pix-transfer"},{"title":"Unblock a Pix Refund","deprecated":null,"version":null,"sidebarTitle":"Unblock a pix refund","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/refunds/{refund_id}/unblock","href":"/en/reference/interfaces/pix-btg/unblock-a-pix-refund"},{"title":"Unblock a Pix Transfer","deprecated":null,"version":null,"sidebarTitle":"Unblock a pix transfer","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/transfers/{transfer_id}/unblock","href":"/en/reference/interfaces/pix-btg/unblock-a-pix-transfer"}]},{"group":"QR Codes API","pages":[{"title":"Create a Static QR Code","deprecated":null,"version":null,"sidebarTitle":"Create a static qr code","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/brcode/static","href":"/en/reference/interfaces/pix-btg/create-a-static-qr-code"},{"title":"Decode a Pix QR Code","deprecated":null,"version":null,"sidebarTitle":"Decode a pix qr code","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/qrcodes/decode","href":"/en/reference/interfaces/pix-btg/decode-a-pix-qr-code"},{"title":"List Static QR Codes","deprecated":null,"version":null,"sidebarTitle":"List static qr codes","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/brcode/static","href":"/en/reference/interfaces/pix-btg/list-static-qr-codes"},{"title":"Retrieve Static QR Code Details","deprecated":null,"version":null,"sidebarTitle":"Retrieve a static qr code","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/brcode/static/{brcode_id}","href":"/en/reference/interfaces/pix-btg/retrieve-a-static-qr-code"}]},{"group":"Collections API","pages":[{"title":"Create a Dynamic Charge with Due Date","deprecated":null,"version":null,"sidebarTitle":"Create a dynamic charge with due date","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/collections/duedate","href":"/en/reference/interfaces/pix-btg/create-a-dynamic-charge-with-due-date"},{"title":"Create an Immediate Charge","deprecated":null,"version":null,"sidebarTitle":"Create an immediate charge","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/collections/immediate","href":"/en/reference/interfaces/pix-btg/create-an-immediate-charge"},{"title":"Delete an Immediate Charge","deprecated":null,"version":null,"sidebarTitle":"Delete an immediate charge","openapi":"/en/openapi/v3-current/indirect-pix.yaml delete /v1/collections/immediate/{collection_id}","href":"/en/reference/interfaces/pix-btg/delete-an-immediate-charge"},{"title":"List Dynamic Charges with Due Date","deprecated":null,"version":null,"sidebarTitle":"List dynamic charges with due date","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/collections/duedate","href":"/en/reference/interfaces/pix-btg/list-dynamic-charges-with-due-date"},{"title":"List Immediate Charges","deprecated":null,"version":null,"sidebarTitle":"List immediate charges","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/collections/immediate","href":"/en/reference/interfaces/pix-btg/list-immediate-charges"},{"title":"Retrieve Dynamic Charge with Due Date Details","deprecated":null,"version":null,"sidebarTitle":"Retrieve dynamic charge with due date details","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/collections/duedate/{collection_id}","href":"/en/reference/interfaces/pix-btg/retrieve-dynamic-charge-with-due-date-details"},{"title":"Retrieve Immediate Charge Details","deprecated":null,"version":null,"sidebarTitle":"Retrieve immediate charge details","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/collections/immediate/{collection_id}","href":"/en/reference/interfaces/pix-btg/retrieve-immediate-charge-details"},{"title":"Update a Dynamic Charge with Due Date","deprecated":null,"version":null,"sidebarTitle":"Update a dynamic charge with due date","openapi":"/en/openapi/v3-current/indirect-pix.yaml patch /v1/collections/duedate/{collection_id}","href":"/en/reference/interfaces/pix-btg/update-a-dynamic-charge-with-due-date"},{"title":"Update an Immediate Charge","deprecated":null,"version":null,"sidebarTitle":"Update an immediate charge","openapi":"/en/openapi/v3-current/indirect-pix.yaml put /v1/collections/immediate/{collection_id}","href":"/en/reference/interfaces/pix-btg/update-an-immediate-charge"}]},{"group":"Funds Recovery API","pages":[{"title":"Cancel a Funds Recovery Request","deprecated":null,"version":null,"sidebarTitle":"Cancel a funds recovery request","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/funds-recoveries/{funds_recovery_id}/cancel","href":"/en/reference/interfaces/pix-btg/cancel-a-funds-recovery-request"},{"title":"Create a Funds Recovery Request","deprecated":null,"version":null,"sidebarTitle":"Create a funds recovery request","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/funds-recoveries","href":"/en/reference/interfaces/pix-btg/create-a-funds-recovery-request"},{"title":"List Funds Recoveries","deprecated":null,"version":null,"sidebarTitle":"List funds recoveries","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/funds-recoveries","href":"/en/reference/interfaces/pix-btg/list-funds-recoveries"},{"title":"List Infraction Reports","deprecated":null,"version":null,"sidebarTitle":"List funds recovery infraction reports","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/funds-recoveries/{funds_recovery_id}/infraction-reports","href":"/en/reference/interfaces/pix-btg/list-funds-recovery-infraction-reports"},{"title":"List Refunds","deprecated":null,"version":null,"sidebarTitle":"List funds recovery refunds","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/funds-recoveries/{funds_recovery_id}/refunds","href":"/en/reference/interfaces/pix-btg/list-funds-recovery-refunds"},{"title":"Request Refund","deprecated":null,"version":null,"sidebarTitle":"Request funds recovery refund","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/funds-recoveries/{funds_recovery_id}/refund","href":"/en/reference/interfaces/pix-btg/request-funds-recovery-refund"},{"title":"Retrieve Funds Recovery details","deprecated":null,"version":null,"sidebarTitle":"Retrieve funds recovery details","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/funds-recoveries/{funds_recovery_id}","href":"/en/reference/interfaces/pix-btg/retrieve-funds-recovery-details"},{"title":"Retrieve Tracking Graph","deprecated":null,"version":null,"sidebarTitle":"Retrieve funds recovery tracking graph","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/funds-recoveries/{funds_recovery_id}/tracking-graph","href":"/en/reference/interfaces/pix-btg/retrieve-funds-recovery-tracking-graph"},{"title":"Update a Funds Recovery Request","deprecated":null,"version":null,"sidebarTitle":"Update a funds recovery request","openapi":"/en/openapi/v3-current/indirect-pix.yaml patch /v1/dict/funds-recoveries/{funds_recovery_id}","href":"/en/reference/interfaces/pix-btg/update-a-funds-recovery-request"}]},{"group":"Reconciliation API","pages":[{"title":"List All Reconciliation Jobs","deprecated":null,"version":null,"sidebarTitle":"List all reconciliation jobs","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/reconciliation","href":"/en/reference/interfaces/pix-btg/list-all-reconciliation-jobs"},{"title":"List All VSync States","deprecated":null,"version":null,"sidebarTitle":"List all vsync states","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/dict/vsync","href":"/en/reference/interfaces/pix-btg/list-all-vsync-states"},{"title":"Start Full Reconciliation","deprecated":null,"version":null,"sidebarTitle":"Start full reconciliation","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/dict/reconciliation/full","href":"/en/reference/interfaces/pix-btg/start-full-reconciliation"}]},{"group":"Pix Automático API","pages":[{"title":"List Pix Automático Authorization Requests","deprecated":null,"version":null,"sidebarTitle":"List pix automatico authorization requests","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/recurrences/payer/authorization-requests","href":"/en/reference/interfaces/pix-btg/list-pix-automatico-authorization-requests"},{"title":"Get a Pix Automático Authorization Request","deprecated":null,"version":null,"sidebarTitle":"Get a pix automatico authorization request","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/recurrences/payer/authorization-requests/{id}","href":"/en/reference/interfaces/pix-btg/get-a-pix-automatico-authorization-request"},{"title":"Decide on a Pix Automático Authorization Request","deprecated":null,"version":null,"sidebarTitle":"Decide on a pix automatico authorization request","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/recurrences/payer/authorization-requests/{id}/decision","href":"/en/reference/interfaces/pix-btg/decide-on-a-pix-automatico-authorization-request"},{"title":"List Pix Automático Authorizations","deprecated":null,"version":null,"sidebarTitle":"List pix automatico authorizations","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/recurrences/payer/authorizations","href":"/en/reference/interfaces/pix-btg/list-pix-automatico-authorizations"},{"title":"List Pix Automático Charges by Authorization","deprecated":null,"version":null,"sidebarTitle":"List pix automatico charges by authorization","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/recurrences/payer/authorizations/{authorizationId}/charges","href":"/en/reference/interfaces/pix-btg/list-pix-automatico-charges-by-authorization"},{"title":"Get a Pix Automático Authorization","deprecated":null,"version":null,"sidebarTitle":"Get a pix automatico authorization","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/recurrences/payer/authorizations/{id}","href":"/en/reference/interfaces/pix-btg/get-a-pix-automatico-authorization"},{"title":"Cancel a Pix Automático Authorization","deprecated":null,"version":null,"sidebarTitle":"Cancel a pix automatico authorization","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/recurrences/payer/authorizations/{id}/cancel","href":"/en/reference/interfaces/pix-btg/cancel-a-pix-automatico-authorization"},{"title":"Get a Pix Automático Charge","deprecated":null,"version":null,"sidebarTitle":"Get a pix automatico charge","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/recurrences/payer/charges/{id}","href":"/en/reference/interfaces/pix-btg/get-a-pix-automatico-charge"},{"title":"Confirm a scanned Pix Automático recurrence","deprecated":null,"version":null,"sidebarTitle":"Confirm a scanned pix automatico recurrence","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/recurrences/payer/qr/confirm","href":"/en/reference/interfaces/pix-btg/confirm-a-scanned-pix-automatico-recurrence"},{"title":"Pay and confirm a scanned Pix Automático recurrence (J3)","deprecated":null,"version":null,"sidebarTitle":"Pay and confirm a scanned pix automatico recurrence","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/recurrences/payer/qr/pay-and-confirm","href":"/en/reference/interfaces/pix-btg/pay-and-confirm-a-scanned-pix-automatico-recurrence"}]},{"group":"Schedules API","pages":[{"title":"List Pix Schedules","deprecated":null,"version":null,"sidebarTitle":"List pix schedules","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/schedules","href":"/en/reference/interfaces/pix-btg/list-pix-schedules"},{"title":"Create a Pix Schedule","deprecated":null,"version":null,"sidebarTitle":"Create a pix schedule","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/schedules","href":"/en/reference/interfaces/pix-btg/create-a-pix-schedule"},{"title":"Get a Pix Schedule","deprecated":null,"version":null,"sidebarTitle":"Get a pix schedule","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/schedules/{schedule_id}","href":"/en/reference/interfaces/pix-btg/get-a-pix-schedule"},{"title":"Cancel a Pix Schedule","deprecated":null,"version":null,"sidebarTitle":"Cancel a pix schedule","openapi":"/en/openapi/v3-current/indirect-pix.yaml delete /v1/schedules/{schedule_id}","href":"/en/reference/interfaces/pix-btg/cancel-a-pix-schedule"}]},{"group":"Transaction Reports API","pages":[{"title":"List Transaction Reports","deprecated":null,"version":null,"sidebarTitle":"List transaction reports","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/transaction-reports","href":"/en/reference/interfaces/pix-btg/list-transaction-reports"},{"title":"Submit a Transaction Report","deprecated":null,"version":null,"sidebarTitle":"Submit a transaction report","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/transaction-reports/{id}/submit","href":"/en/reference/interfaces/pix-btg/submit-a-transaction-report"}]},{"group":"Transaction times","pages":[{"title":"Trigger the asynchronous TemposTransacoes computation","deprecated":null,"version":null,"sidebarTitle":"Create transaction times job","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/statistics/tempos-transacoes/jobs","href":"/en/reference/interfaces/pix-btg/create-transaction-times-job"},{"title":"List TemposTransacoes report job executions","deprecated":null,"version":null,"sidebarTitle":"List transaction times jobs","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/statistics/tempos-transacoes/jobs","href":"/en/reference/interfaces/pix-btg/list-transaction-times-jobs"},{"title":"Get the TemposTransacoes job of a reference month","deprecated":null,"version":null,"sidebarTitle":"Get transaction times job","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/statistics/tempos-transacoes/jobs/{referenceMonth}","href":"/en/reference/interfaces/pix-btg/get-transaction-times-job"},{"title":"Cancel a stuck or long-running TemposTransacoes job","deprecated":null,"version":null,"sidebarTitle":"Cancel transaction times job","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/statistics/tempos-transacoes/jobs/{referenceMonth}/cancel","href":"/en/reference/interfaces/pix-btg/cancel-transaction-times-job"}]},{"group":"Webhooks API","pages":[{"title":"List inbound webhooks","deprecated":null,"version":null,"sidebarTitle":"List inbound webhooks","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/webhooks/inbound","href":"/en/reference/interfaces/pix-btg/list-inbound-webhooks"},{"title":"Get inbound webhook by id","deprecated":null,"version":null,"sidebarTitle":"Get an inbound webhook","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/webhooks/inbound/{id}","href":"/en/reference/interfaces/pix-btg/get-an-inbound-webhook"},{"title":"Retry inbound webhook","deprecated":null,"version":null,"sidebarTitle":"Retry an inbound webhook","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/webhooks/inbound/{id}/retry","href":"/en/reference/interfaces/pix-btg/retry-an-inbound-webhook"},{"title":"List outbound webhooks","deprecated":null,"version":null,"sidebarTitle":"List outbound webhooks","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/webhooks/outbound","href":"/en/reference/interfaces/pix-btg/list-outbound-webhooks"},{"title":"Get outbound webhook by id","deprecated":null,"version":null,"sidebarTitle":"Get an outbound webhook","openapi":"/en/openapi/v3-current/indirect-pix.yaml get /v1/webhooks/outbound/{id}","href":"/en/reference/interfaces/pix-btg/get-an-outbound-webhook"},{"title":"Retry outbound webhook","deprecated":null,"version":null,"sidebarTitle":"Retry an outbound webhook","openapi":"/en/openapi/v3-current/indirect-pix.yaml post /v1/webhooks/outbound/{id}/retry","href":"/en/reference/interfaces/pix-btg/retry-an-outbound-webhook"}]},{"group":"Error handling","pages":[{"title":"Indirect Pix error list","href":"/en/reference/interfaces/pix-btg/indirect-pix-error-list"}]}]},{"dropdown":"TED JD","icon":"building-columns","description":"TED operations through the JD interface","groups":[{"group":"Transfers API","pages":[{"title":"Initiate a Transfer","deprecated":null,"version":null,"sidebarTitle":"Initiate transfer","openapi":"/en/openapi/v3-current/ted.yaml post /v1/transfers/initiate","href":"/en/reference/interfaces/ted-jd/initiate-transfer"},{"title":"Prepare Transfer Signing Payload","deprecated":null,"version":null,"sidebarTitle":"Prepare transfer signing","openapi":"/en/openapi/v3-current/ted.yaml post /v1/transfers/signing/prepare","href":"/en/reference/interfaces/ted-jd/prepare-transfer-signing"},{"title":"Process a Transfer","deprecated":null,"version":null,"sidebarTitle":"Process transfer","openapi":"/en/openapi/v3-current/ted.yaml post /v1/transfers/process","href":"/en/reference/interfaces/ted-jd/process-transfer"},{"title":"Get a Transfer","deprecated":null,"version":null,"sidebarTitle":"Retrieve transfer","openapi":"/en/openapi/v3-current/ted.yaml get /v1/transfers/{transferId}","href":"/en/reference/interfaces/ted-jd/retrieve-transfer"},{"title":"List Transfers","deprecated":null,"version":null,"sidebarTitle":"List transfers","openapi":"/en/openapi/v3-current/ted.yaml get /v1/transfers","href":"/en/reference/interfaces/ted-jd/list-transfers"},{"title":"Cancel a Transfer","deprecated":null,"version":null,"sidebarTitle":"Cancel transfer","openapi":"/en/openapi/v3-current/ted.yaml post /v1/transfers/{transferId}/cancel","href":"/en/reference/interfaces/ted-jd/cancel-transfer"}]},{"group":"Dashboard \u0026 Reconciliation API","pages":[{"title":"Get dashboard summary","deprecated":null,"version":null,"sidebarTitle":"Get dashboard summary","openapi":"/en/openapi/v3-current/ted.yaml get /v1/transfers/dashboard/summary","href":"/en/reference/interfaces/ted-jd/get-dashboard-summary"},{"title":"List pending reconciliation transfers","deprecated":null,"version":null,"sidebarTitle":"List pending reconciliation","openapi":"/en/openapi/v3-current/ted.yaml get /v1/transfers/reconciliation/pending","href":"/en/reference/interfaces/ted-jd/list-pending-reconciliation"},{"title":"List unresolved TED IN reconciliation gaps","deprecated":null,"version":null,"sidebarTitle":"List ted in reconciliation gaps","openapi":"/en/openapi/v3-current/ted.yaml get /v1/transfers/ted-in/reconciliation-gaps","href":"/en/reference/interfaces/ted-jd/list-ted-in-reconciliation-gaps"},{"title":"Trigger reconciliation sweep","deprecated":null,"version":null,"sidebarTitle":"Trigger reconciliation sweep","openapi":"/en/openapi/v3-current/ted.yaml post /v1/transfers/reconciliation/tick","href":"/en/reference/interfaces/ted-jd/trigger-reconciliation-sweep"},{"title":"Retry Transfer Reconciliation","deprecated":null,"version":null,"sidebarTitle":"Retry transfer reconciliation","openapi":"/en/openapi/v3-current/ted.yaml post /v1/transfers/{transferId}/reconciliation/retry","href":"/en/reference/interfaces/ted-jd/retry-transfer-reconciliation"},{"title":"Resolve Transfer Reconciliation","deprecated":null,"version":null,"sidebarTitle":"Resolve transfer reconciliation","openapi":"/en/openapi/v3-current/ted.yaml post /v1/transfers/{transferId}/reconciliation/resolve","href":"/en/reference/interfaces/ted-jd/resolve-transfer-reconciliation"},{"title":"Repair Transfer Ledger Scope","deprecated":null,"version":null,"sidebarTitle":"Repair transfer ledger scope","openapi":"/en/openapi/v3-current/ted.yaml post /v1/transfers/{transferId}/scope/repair","href":"/en/reference/interfaces/ted-jd/repair-transfer-ledger-scope"},{"title":"Check Ledger Routing Readiness","deprecated":null,"version":null,"sidebarTitle":"Check ledger routing readiness","openapi":"/en/openapi/v3-current/ted.yaml get /v1/transfers/routing/preflight","href":"/en/reference/interfaces/ted-jd/check-ledger-routing-readiness"}]},{"group":"TED In Operations API","pages":[{"title":"Trigger TED IN Poller","deprecated":null,"version":null,"sidebarTitle":"Trigger ted in poll","openapi":"/en/openapi/v3-current/ted.yaml post /v1/transfers/ted-in/poll","href":"/en/reference/interfaces/ted-jd/trigger-ted-in-poll"},{"title":"Replay TED IN Backlog","deprecated":null,"version":null,"sidebarTitle":"Replay ted in poll","openapi":"/en/openapi/v3-current/ted.yaml post /v1/transfers/ted-in/replay","href":"/en/reference/interfaces/ted-jd/replay-ted-in-poll"},{"title":"Resume TED IN Poller","deprecated":null,"version":null,"sidebarTitle":"Resume ted in poller","openapi":"/en/openapi/v3-current/ted.yaml post /v1/transfers/ted-in/resume","href":"/en/reference/interfaces/ted-jd/resume-ted-in-poller"},{"title":"Get TED IN Poller Status","deprecated":null,"version":null,"sidebarTitle":"Get ted in poller status","openapi":"/en/openapi/v3-current/ted.yaml get /v1/transfers/ted-in/poller","href":"/en/reference/interfaces/ted-jd/get-ted-in-poller-status"},{"title":"List Retained TED IN Messages","deprecated":null,"version":null,"sidebarTitle":"List retained ted in messages","openapi":"/en/openapi/v3-current/ted.yaml get /v1/transfers/ted-in/retained","href":"/en/reference/interfaces/ted-jd/list-retained-ted-in-messages"},{"title":"List Undeliverable TED IN Credits","deprecated":null,"version":null,"sidebarTitle":"List undeliverable ted in credits","openapi":"/en/openapi/v3-current/ted.yaml get /v1/transfers/ted-in/undeliverables","href":"/en/reference/interfaces/ted-jd/list-undeliverable-ted-in-credits"},{"title":"Close Unsettled TED IN Credit","deprecated":null,"version":null,"sidebarTitle":"Close unsettled ted in credit","openapi":"/en/openapi/v3-current/ted.yaml post /v1/transfers/ted-in/unsettled/{messageId}/close","href":"/en/reference/interfaces/ted-jd/close-unsettled-ted-in-credit"}]},{"group":"Webhooks API","pages":[{"title":"Create a Webhook Registration","deprecated":null,"version":null,"sidebarTitle":"Create webhook","openapi":"/en/openapi/v3-current/ted.yaml post /v1/webhooks","href":"/en/reference/interfaces/ted-jd/create-webhook"},{"title":"List Webhook Registrations","deprecated":null,"version":null,"sidebarTitle":"List webhooks","openapi":"/en/openapi/v3-current/ted.yaml get /v1/webhooks","href":"/en/reference/interfaces/ted-jd/list-webhooks"},{"title":"Get a Webhook Registration","deprecated":null,"version":null,"sidebarTitle":"Get webhook","openapi":"/en/openapi/v3-current/ted.yaml get /v1/webhooks/{webhookId}","href":"/en/reference/interfaces/ted-jd/get-webhook"},{"title":"Patch a Webhook Registration","deprecated":null,"version":null,"sidebarTitle":"Update webhook","openapi":"/en/openapi/v3-current/ted.yaml patch /v1/webhooks/{webhookId}","href":"/en/reference/interfaces/ted-jd/update-webhook"},{"title":"Delete a Webhook Registration","deprecated":null,"version":null,"sidebarTitle":"Delete webhook","openapi":"/en/openapi/v3-current/ted.yaml delete /v1/webhooks/{webhookId}","href":"/en/reference/interfaces/ted-jd/delete-webhook"},{"title":"Rotate a Webhook Signing Secret","deprecated":null,"version":null,"sidebarTitle":"Rotate webhook signing secret","openapi":"/en/openapi/v3-current/ted.yaml post /v1/webhooks/{webhookId}/signing-secret/rotate","href":"/en/reference/interfaces/ted-jd/rotate-webhook-signing-secret"},{"title":"List Webhook Event Types","deprecated":null,"version":null,"sidebarTitle":"List webhook event types","openapi":"/en/openapi/v3-current/ted.yaml get /v1/webhooks/event-types","href":"/en/reference/interfaces/ted-jd/list-webhook-event-types"}]},{"group":"Webhook DLQ API","pages":[{"title":"List DLQ Messages","deprecated":null,"version":null,"sidebarTitle":"List webhook dlq messages","openapi":"/en/openapi/v3-current/ted.yaml get /v1/webhooks/dlq","href":"/en/reference/interfaces/ted-jd/list-webhook-dlq-messages"},{"title":"Retry DLQ Message","deprecated":null,"version":null,"sidebarTitle":"Retry webhook dlq message","openapi":"/en/openapi/v3-current/ted.yaml post /v1/webhooks/dlq/{messageId}/retry","href":"/en/reference/interfaces/ted-jd/retry-webhook-dlq-message"}]},{"group":"Error handling","pages":[{"title":"Bank Transfer error list","href":"/en/reference/interfaces/ted-jd/ted-error-list"}]}]},{"dropdown":"Payments BTG","icon":"barcode","description":"Boleto payments through the BTG interface","groups":[{"group":"Boletos API","pages":[{"title":"Issue a single boleto","deprecated":null,"version":null,"sidebarTitle":"Issue boleto","openapi":"/en/openapi/v3-current/payments.yaml post /v1/boletos","href":"/en/reference/interfaces/payments-btg/issue-boleto"},{"title":"Issue installment boletos","deprecated":null,"version":null,"sidebarTitle":"Issue installment boletos","openapi":"/en/openapi/v3-current/payments.yaml post /v1/boletos/installments","href":"/en/reference/interfaces/payments-btg/issue-installment-boletos"},{"title":"List boletos","deprecated":null,"version":null,"sidebarTitle":"List boletos","openapi":"/en/openapi/v3-current/payments.yaml get /v1/boletos","href":"/en/reference/interfaces/payments-btg/list-boletos"},{"title":"Get boleto by ID","deprecated":null,"version":null,"sidebarTitle":"Get boleto","openapi":"/en/openapi/v3-current/payments.yaml get /v1/boletos/{id}","href":"/en/reference/interfaces/payments-btg/get-boleto"},{"title":"Get installment series","deprecated":null,"version":null,"sidebarTitle":"Get installment series","openapi":"/en/openapi/v3-current/payments.yaml get /v1/boletos/installments/{series_id}","href":"/en/reference/interfaces/payments-btg/get-installment-series"},{"title":"Download boleto PDF","deprecated":null,"version":null,"sidebarTitle":"Download boleto pdf","openapi":"/en/openapi/v3-current/payments.yaml get /v1/boletos/{id}/pdf","href":"/en/reference/interfaces/payments-btg/download-boleto-pdf"},{"title":"Cancel an issued boleto","deprecated":null,"version":null,"sidebarTitle":"Cancel boleto","openapi":"/en/openapi/v3-current/payments.yaml post /v1/boletos/{id}/cancel","href":"/en/reference/interfaces/payments-btg/cancel-boleto"}]},{"group":"Payments API","pages":[{"title":"Initiate a payment","deprecated":null,"version":null,"sidebarTitle":"Initiate payment","openapi":"/en/openapi/v3-current/payments.yaml post /v1/payments","href":"/en/reference/interfaces/payments-btg/initiate-payment"},{"title":"Initiate a DARF payment","deprecated":null,"version":null,"sidebarTitle":"Initiate darf payment","openapi":"/en/openapi/v3-current/payments.yaml post /v1/payments/darf","href":"/en/reference/interfaces/payments-btg/initiate-darf-payment"},{"title":"Consult a bill by digitable line","deprecated":null,"version":null,"sidebarTitle":"Consult a bill by digitable line","openapi":"/en/openapi/v3-current/payments.yaml post /v1/payments/consult","href":"/en/reference/interfaces/payments-btg/consult-a-bill-by-digitable-line"},{"title":"List payments","deprecated":null,"version":null,"sidebarTitle":"List payments","openapi":"/en/openapi/v3-current/payments.yaml get /v1/payments","href":"/en/reference/interfaces/payments-btg/list-payments"},{"title":"Get payment by ID","deprecated":null,"version":null,"sidebarTitle":"Get payment","openapi":"/en/openapi/v3-current/payments.yaml get /v1/payments/{id}","href":"/en/reference/interfaces/payments-btg/get-payment"},{"title":"Cancel a payment","deprecated":null,"version":null,"sidebarTitle":"Cancel payment","openapi":"/en/openapi/v3-current/payments.yaml post /v1/payments/{id}/cancel","href":"/en/reference/interfaces/payments-btg/cancel-payment"}]},{"group":"Dashboards API","pages":[{"title":"Get boleto dashboard","deprecated":null,"version":null,"sidebarTitle":"Get boleto dashboard","openapi":"/en/openapi/v3-current/payments.yaml get /v1/dashboards/boletos","href":"/en/reference/interfaces/payments-btg/get-boleto-dashboard"},{"title":"Get payment dashboard","deprecated":null,"version":null,"sidebarTitle":"Get payment dashboard","openapi":"/en/openapi/v3-current/payments.yaml get /v1/dashboards/payments","href":"/en/reference/interfaces/payments-btg/get-payment-dashboard"}]},{"group":"Admin API","pages":[{"title":"Connect provider with the tenant's client credentials","deprecated":null,"version":null,"sidebarTitle":"Connect provider","openapi":"/en/openapi/v3-current/payments.yaml post /v1/admin/providers/connect","href":"/en/reference/interfaces/payments-btg/connect-provider"},{"title":"Re-register the tenant's existing webhook subscription at a provider","deprecated":null,"version":null,"sidebarTitle":"Resubscribe provider webhook","openapi":"/en/openapi/v3-current/payments.yaml post /v1/admin/providers/webhooks/{provider_type}/resubscribe","href":"/en/reference/interfaces/payments-btg/resubscribe-provider-webhook"},{"title":"Get webhook configuration","deprecated":null,"version":null,"sidebarTitle":"Get webhook configuration","openapi":"/en/openapi/v3-current/payments.yaml get /v1/admin/webhooks","href":"/en/reference/interfaces/payments-btg/get-webhook-configuration"},{"title":"Configure outbound webhook","deprecated":null,"version":null,"sidebarTitle":"Configure webhook","openapi":"/en/openapi/v3-current/payments.yaml post /v1/admin/webhooks","href":"/en/reference/interfaces/payments-btg/configure-webhook"},{"title":"Preflight the accounting routes of a ledger","deprecated":null,"version":null,"sidebarTitle":"Preflight accounting routes","openapi":"/en/openapi/v3-current/payments.yaml get /v1/admin/accounting-routes/preflight","href":"/en/reference/interfaces/payments-btg/preflight-accounting-routes"},{"title":"Re-present a quarantined provider webhook","deprecated":null,"version":null,"sidebarTitle":"Represent quarantined webhook","openapi":"/en/openapi/v3-current/payments.yaml post /v1/admin/quarantine/webhooks/{id}/represent","href":"/en/reference/interfaces/payments-btg/represent-quarantined-webhook"}]},{"group":"Webhooks API","pages":[{"title":"Receive a provider webhook","deprecated":null,"version":null,"sidebarTitle":"Receive provider webhook","openapi":"/en/openapi/v3-current/payments.yaml post /v1/webhooks/btg","href":"/en/reference/interfaces/payments-btg/receive-provider-webhook"},{"title":"Receive a provider webhook on a tenant connection","deprecated":null,"version":null,"sidebarTitle":"Receive provider webhook by connection","openapi":"/en/openapi/v3-current/payments.yaml post /v1/webhooks/btg/{connection_token}","href":"/en/reference/interfaces/payments-btg/receive-provider-webhook-by-connection"}]},{"group":"Error handling","pages":[{"title":"Payments error list","href":"/en/reference/interfaces/payments-btg/payments-error-list"}]}]}]},{"anchor":"Platform","icon":"layer-group","dropdowns":[{"dropdown":"Access Manager","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/access-manager-yellow.png","description":"Authentication, authorization, and identity","groups":[{"group":"Overview","pages":[{"title":"Access Manager API overview","href":"/en/reference/platform/access-manager/am-api-introduction"}]},{"group":"Authentication","pages":[{"title":"Auth APIs","sidebarTitle":"Overview","href":"/en/reference/platform/access-manager/am-auth-apis"},{"title":"Request an access token","deprecated":null,"version":null,"sidebarTitle":"Request access token","openapi":"/en/openapi/v3-current/AM-auth.yaml post /v1/login/oauth/access_token","href":"/en/reference/platform/access-manager/request-access-token"},{"title":"Exchange a refresh token for an access token","deprecated":null,"version":null,"sidebarTitle":"Refresh token","openapi":"/en/openapi/v3-current/AM-auth.yaml post /v1/login/oauth/refresh_token","href":"/en/reference/platform/access-manager/refresh-token"},{"title":"Log out","deprecated":null,"version":null,"sidebarTitle":"End user session","openapi":"/en/openapi/v3-current/AM-auth.yaml post /v1/logout","href":"/en/reference/platform/access-manager/end-user-session"}]},{"group":"Single sign-on","pages":[{"title":"Discover how an email signs in","deprecated":null,"version":null,"sidebarTitle":"Discover how an email signs in","openapi":"/en/openapi/v3-current/AM-auth.yaml post /v1/sso/discover","href":"/en/reference/platform/access-manager/discover-how-an-email-signs-in"},{"title":"Start an SSO login","deprecated":null,"version":null,"sidebarTitle":"Start an sso login","openapi":"/en/openapi/v3-current/AM-auth.yaml get /v1/sso/start","href":"/en/reference/platform/access-manager/start-an-sso-login"}]},{"group":"Authorization","pages":[{"title":"Enforce a user permission","deprecated":null,"version":null,"sidebarTitle":"Validate user permission","openapi":"/en/openapi/v3-current/AM-auth.yaml post /v1/authorize","href":"/en/reference/platform/access-manager/validate-user-permission"}]},{"group":"User information","pages":[{"title":"Get OIDC user info","deprecated":null,"version":null,"sidebarTitle":"Retrieve user information","openapi":"/en/openapi/v3-current/AM-auth.yaml get /v1/userinfo","href":"/en/reference/platform/access-manager/retrieve-user-information"},{"title":"List the caller's permissions","deprecated":null,"version":null,"sidebarTitle":"Retrieve user permissions","openapi":"/en/openapi/v3-current/AM-auth.yaml get /v1/permissions","href":"/en/reference/platform/access-manager/retrieve-user-permissions"}]},{"group":"Login MFA","pages":[{"title":"Initiate an MFA challenge","deprecated":null,"version":null,"sidebarTitle":"Initiate mfa challenge","openapi":"/en/openapi/v3-current/AM-auth.yaml post /v1/login/mfa/challenge","href":"/en/reference/platform/access-manager/initiate-mfa-challenge"},{"title":"Verify an MFA challenge","deprecated":null,"version":null,"sidebarTitle":"Verify mfa login","openapi":"/en/openapi/v3-current/AM-auth.yaml post /v1/login/mfa/verify","href":"/en/reference/platform/access-manager/verify-mfa-login"}]},{"group":"Identity overview","pages":[{"title":"Identity APIs","sidebarTitle":"Overview","href":"/en/reference/platform/access-manager/am-identity-apis"}]},{"group":"Groups","pages":[{"title":"List Groups","deprecated":null,"version":null,"sidebarTitle":"List groups","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/groups","href":"/en/reference/platform/access-manager/list-groups"},{"title":"Create a Group","deprecated":null,"version":null,"sidebarTitle":"Create a group","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/groups","href":"/en/reference/platform/access-manager/create-a-group"},{"title":"Retrieve Group details","deprecated":null,"version":null,"sidebarTitle":"Retrieve group details","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/groups/{id}","href":"/en/reference/platform/access-manager/retrieve-group-details"},{"title":"Update a Group","deprecated":null,"version":null,"sidebarTitle":"Update a group","openapi":"/en/openapi/v3-current/AM-identity.yaml patch /v1/groups/{id}","href":"/en/reference/platform/access-manager/update-a-group"},{"title":"Delete a Group","deprecated":null,"version":null,"sidebarTitle":"Delete a group","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/groups/{id}","href":"/en/reference/platform/access-manager/delete-a-group"},{"title":"Add Members to a Group","deprecated":null,"version":null,"sidebarTitle":"Assigns users to a group","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/groups/{id}/users","href":"/en/reference/platform/access-manager/assigns-users-to-a-group"},{"title":"Remove Members from a Group in Batch","deprecated":null,"version":null,"sidebarTitle":"Removes multiple users from a group batch","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/groups/{id}/users/remove","href":"/en/reference/platform/access-manager/removes-multiple-users-from-a-group-batch"},{"title":"Remove one Member from a Group","deprecated":null,"version":null,"sidebarTitle":"Removes a single user from a group","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/groups/{id}/users/{userId}","href":"/en/reference/platform/access-manager/removes-a-single-user-from-a-group"}]},{"group":"Applications","pages":[{"title":"Create an Application","deprecated":null,"version":null,"sidebarTitle":"Create an application","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/applications","href":"/en/reference/platform/access-manager/create-an-application"},{"title":"List Applications","deprecated":null,"version":null,"sidebarTitle":"List applications","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/applications","href":"/en/reference/platform/access-manager/list-applications"},{"title":"List Available Applications","deprecated":null,"version":null,"sidebarTitle":"List available applications","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/applications/available","href":"/en/reference/platform/access-manager/list-available-applications"},{"title":"Retrieve Application details","deprecated":null,"version":null,"sidebarTitle":"Retrieve application details","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/applications/{id}","href":"/en/reference/platform/access-manager/retrieve-application-details"},{"title":"Delete an Application","deprecated":null,"version":null,"sidebarTitle":"Delete application","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/applications/{id}","href":"/en/reference/platform/access-manager/delete-application"}]},{"group":"Partners","pages":[{"title":"List partners","deprecated":null,"version":null,"sidebarTitle":"List partners","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/partners","href":"/en/reference/platform/access-manager/list-partners"},{"title":"Create a partner","deprecated":null,"version":null,"sidebarTitle":"Create a partner","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/partners","href":"/en/reference/platform/access-manager/create-a-partner"},{"title":"Retrieve a partner","deprecated":null,"version":null,"sidebarTitle":"Retrieve a partner","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/partners/{id}","href":"/en/reference/platform/access-manager/retrieve-a-partner"},{"title":"Update a partner","deprecated":null,"version":null,"sidebarTitle":"Update a partner","openapi":"/en/openapi/v3-current/AM-identity.yaml patch /v1/partners/{id}","href":"/en/reference/platform/access-manager/update-a-partner"},{"title":"Delete a partner","deprecated":null,"version":null,"sidebarTitle":"Delete a partner","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/partners/{id}","href":"/en/reference/platform/access-manager/delete-a-partner"},{"title":"Retrieve the partner ceiling of a product","deprecated":null,"version":null,"sidebarTitle":"Retrieve the partner ceiling of a product","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/partners/ceiling","href":"/en/reference/platform/access-manager/retrieve-the-partner-ceiling-of-a-product"},{"title":"List scope catalogs","deprecated":null,"version":null,"sidebarTitle":"List scope catalogs","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/scope-catalog","href":"/en/reference/platform/access-manager/list-scope-catalogs"},{"title":"Retrieve a product's scope catalog","deprecated":null,"version":null,"sidebarTitle":"Retrieve a product s scope catalog","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/scope-catalog/{product}","href":"/en/reference/platform/access-manager/retrieve-a-product-s-scope-catalog"}]},{"group":"Users","pages":[{"title":"Create a user","deprecated":null,"version":null,"sidebarTitle":"Create user","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/users","href":"/en/reference/platform/access-manager/create-user"},{"title":"List Users","deprecated":null,"version":null,"sidebarTitle":"List users","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/users","href":"/en/reference/platform/access-manager/list-users"},{"title":"Retrieve User details","deprecated":null,"version":null,"sidebarTitle":"Retrieve user details","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/users/{id}","href":"/en/reference/platform/access-manager/retrieve-user-details"},{"title":"Update a user","deprecated":null,"version":null,"sidebarTitle":"Update user","openapi":"/en/openapi/v3-current/AM-identity.yaml patch /v1/users/{id}","href":"/en/reference/platform/access-manager/update-user"},{"title":"Delete a user","deprecated":null,"version":null,"sidebarTitle":"Delete user","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/users/{id}","href":"/en/reference/platform/access-manager/delete-user"},{"title":"List own tenants","deprecated":null,"version":null,"sidebarTitle":"List own tenants","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/users/{id}/tenants","href":"/en/reference/platform/access-manager/list-own-tenants"},{"title":"Set own default tenant","deprecated":null,"version":null,"sidebarTitle":"Set own default tenant","openapi":"/en/openapi/v3-current/AM-identity.yaml put /v1/users/{id}/tenants/default","href":"/en/reference/platform/access-manager/set-own-default-tenant"},{"title":"Retrieve own user profile","deprecated":null,"version":null,"sidebarTitle":"Retrieve the caller s own profile","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/users/{id}/profile","href":"/en/reference/platform/access-manager/retrieve-the-caller-s-own-profile"},{"title":"Get user effective permissions","deprecated":null,"version":null,"sidebarTitle":"Get effective permissions","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/users/{id}/effective-permissions","href":"/en/reference/platform/access-manager/get-effective-permissions"},{"title":"Set own user phone number","deprecated":null,"version":null,"sidebarTitle":"Set the caller s phone number","openapi":"/en/openapi/v3-current/AM-identity.yaml patch /v1/users/{id}/phone","href":"/en/reference/platform/access-manager/set-the-caller-s-phone-number"},{"title":"Remove user phone number","deprecated":null,"version":null,"sidebarTitle":"Remove an user s phone number","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/users/{id}/phone","href":"/en/reference/platform/access-manager/remove-an-user-s-phone-number"},{"title":"Reset a user password","deprecated":null,"version":null,"sidebarTitle":"Reset user password","openapi":"/en/openapi/v3-current/AM-identity.yaml patch /v1/users/{id}/reset-password","href":"/en/reference/platform/access-manager/reset-user-password"},{"title":"Update a user password","deprecated":null,"version":null,"sidebarTitle":"Update user password","openapi":"/en/openapi/v3-current/AM-identity.yaml patch /v1/users/{id}/update-password","href":"/en/reference/platform/access-manager/update-user-password"},{"title":"Request a password reset code","deprecated":null,"version":null,"sidebarTitle":"Request a password reset code","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/users/forgot-password/send-code","href":"/en/reference/platform/access-manager/request-a-password-reset-code"},{"title":"Reset a password with a verification code","deprecated":null,"version":null,"sidebarTitle":"Reset a password with a verification code","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/users/forgot-password/reset","href":"/en/reference/platform/access-manager/reset-a-password-with-a-verification-code"},{"title":"List the Direct Permissions of a User","deprecated":null,"version":null,"sidebarTitle":"Returns the permissions assigned to a user","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/users/{id}/permissions","href":"/en/reference/platform/access-manager/returns-the-permissions-assigned-to-a-user"},{"title":"Add Permissions to a User","deprecated":null,"version":null,"sidebarTitle":"Assigns permissions to a user","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/permissions","href":"/en/reference/platform/access-manager/assigns-permissions-to-a-user"},{"title":"Remove Permissions from a User in Batch","deprecated":null,"version":null,"sidebarTitle":"Removes multiple permissions from a user batch","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/permissions/remove","href":"/en/reference/platform/access-manager/removes-multiple-permissions-from-a-user-batch"},{"title":"Remove one Permission from a User","deprecated":null,"version":null,"sidebarTitle":"Removes a single permission from a user","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/users/{id}/permissions/{permId}","href":"/en/reference/platform/access-manager/removes-a-single-permission-from-a-user"}]},{"group":"Account MFA","pages":[{"title":"Initiate MFA Setup","deprecated":null,"version":null,"sidebarTitle":"Initiate mfa setup","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/mfa/setup","href":"/en/reference/platform/access-manager/initiate-mfa-setup"},{"title":"Verify MFA Setup","deprecated":null,"version":null,"sidebarTitle":"Verify mfa passcode","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/mfa/verify","href":"/en/reference/platform/access-manager/verify-mfa-passcode"},{"title":"Enable MFA","deprecated":null,"version":null,"sidebarTitle":"Enable mfa","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/mfa/enable","href":"/en/reference/platform/access-manager/enable-mfa"},{"title":"Get MFA Status","deprecated":null,"version":null,"sidebarTitle":"Get mfa status","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/users/{id}/mfa","href":"/en/reference/platform/access-manager/get-mfa-status"},{"title":"Request an MFA disable confirmation code","deprecated":null,"version":null,"sidebarTitle":"Request an mfa disable confirmation code","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/mfa/disable/challenge","href":"/en/reference/platform/access-manager/request-an-mfa-disable-confirmation-code"},{"title":"Disable MFA","deprecated":null,"version":null,"sidebarTitle":"Disable mfa","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/users/{id}/mfa","href":"/en/reference/platform/access-manager/disable-mfa"},{"title":"Set Preferred MFA Method","deprecated":null,"version":null,"sidebarTitle":"Set preferred mfa method","openapi":"/en/openapi/v3-current/AM-identity.yaml patch /v1/users/{id}/mfa/preferred","href":"/en/reference/platform/access-manager/set-preferred-mfa-method"},{"title":"Disable a single MFA channel","deprecated":null,"version":null,"sidebarTitle":"Disable a single mfa channel","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/users/{id}/mfa/{mfaType}","href":"/en/reference/platform/access-manager/disable-a-single-mfa-channel"},{"title":"Regenerate MFA Recovery Codes","deprecated":null,"version":null,"sidebarTitle":"Regenerate mfa recovery codes","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/mfa/recovery-codes","href":"/en/reference/platform/access-manager/regenerate-mfa-recovery-codes"},{"title":"Admin Enable MFA","deprecated":null,"version":null,"sidebarTitle":"Admin enable mfa","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/mfa/admin/enable","href":"/en/reference/platform/access-manager/admin-enable-mfa"},{"title":"Admin Disable MFA","deprecated":null,"version":null,"sidebarTitle":"Admin disable mfa","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/users/{id}/mfa/admin/{mfaType}","href":"/en/reference/platform/access-manager/admin-disable-mfa"}]},{"group":"Identity providers","pages":[{"title":"List Providers","deprecated":null,"version":null,"sidebarTitle":"List providers","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/providers","href":"/en/reference/platform/access-manager/list-providers"},{"title":"Create a Provider","deprecated":null,"version":null,"sidebarTitle":"Create a provider","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/providers","href":"/en/reference/platform/access-manager/create-a-provider"},{"title":"Retrieve Provider details","deprecated":null,"version":null,"sidebarTitle":"Retrieve a provider","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/providers/{id}","href":"/en/reference/platform/access-manager/retrieve-a-provider"},{"title":"Update a Provider","deprecated":null,"version":null,"sidebarTitle":"Update a provider","openapi":"/en/openapi/v3-current/AM-identity.yaml patch /v1/providers/{id}","href":"/en/reference/platform/access-manager/update-a-provider"},{"title":"Delete a Provider","deprecated":null,"version":null,"sidebarTitle":"Delete a provider","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/providers/{id}","href":"/en/reference/platform/access-manager/delete-a-provider"},{"title":"Test send through a Provider","deprecated":null,"version":null,"sidebarTitle":"Test send through a provider","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/providers/{id}/test-send","href":"/en/reference/platform/access-manager/test-send-through-a-provider"}]},{"group":"Application providers","pages":[{"title":"List Application Providers","deprecated":null,"version":null,"sidebarTitle":"List application providers","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/applications/{id}/providers","href":"/en/reference/platform/access-manager/list-application-providers"},{"title":"Link Provider to Application","deprecated":null,"version":null,"sidebarTitle":"Link provider to application","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/applications/{id}/providers","href":"/en/reference/platform/access-manager/link-provider-to-application"},{"title":"Update Provider Link","deprecated":null,"version":null,"sidebarTitle":"Update application provider link","openapi":"/en/openapi/v3-current/AM-identity.yaml patch /v1/applications/{id}/providers/{providerId}","href":"/en/reference/platform/access-manager/update-application-provider-link"},{"title":"Unlink Provider from Application","deprecated":null,"version":null,"sidebarTitle":"Unlink provider from application","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/applications/{id}/providers/{providerId}","href":"/en/reference/platform/access-manager/unlink-provider-from-application"},{"title":"Set Provider as Default","deprecated":null,"version":null,"sidebarTitle":"Set default application provider","openapi":"/en/openapi/v3-current/AM-identity.yaml patch /v1/applications/{id}/providers/{providerId}/default","href":"/en/reference/platform/access-manager/set-default-application-provider"}]},{"group":"Permissions","pages":[{"title":"List Permissions","deprecated":null,"version":null,"sidebarTitle":"List permissions","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/permissions","href":"/en/reference/platform/access-manager/list-permissions"},{"title":"Retrieve Permission details","deprecated":null,"version":null,"sidebarTitle":"Retrieve permission details","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/permissions/{id}","href":"/en/reference/platform/access-manager/retrieve-permission-details"}]},{"group":"Roles","pages":[{"title":"List Roles","deprecated":null,"version":null,"sidebarTitle":"List roles","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/roles","href":"/en/reference/platform/access-manager/list-roles"},{"title":"Create a Role","deprecated":null,"version":null,"sidebarTitle":"Create a role","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/roles","href":"/en/reference/platform/access-manager/create-a-role"},{"title":"Retrieve Role details","deprecated":null,"version":null,"sidebarTitle":"Retrieve role details","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/roles/{id}","href":"/en/reference/platform/access-manager/retrieve-role-details"},{"title":"Update a Role","deprecated":null,"version":null,"sidebarTitle":"Update a role","openapi":"/en/openapi/v3-current/AM-identity.yaml patch /v1/roles/{id}","href":"/en/reference/platform/access-manager/update-a-role"},{"title":"Delete a Role","deprecated":null,"version":null,"sidebarTitle":"Delete a role","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/roles/{id}","href":"/en/reference/platform/access-manager/delete-a-role"},{"title":"Grant a Role to Groups","deprecated":null,"version":null,"sidebarTitle":"Assigns groups to a role","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/roles/{id}/groups","href":"/en/reference/platform/access-manager/assigns-groups-to-a-role"},{"title":"Revoke a Role from Groups in Batch","deprecated":null,"version":null,"sidebarTitle":"Removes multiple groups from a role batch","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/roles/{id}/groups/remove","href":"/en/reference/platform/access-manager/removes-multiple-groups-from-a-role-batch"},{"title":"Revoke a Role from one Group","deprecated":null,"version":null,"sidebarTitle":"Removes a single group from a role","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/roles/{id}/groups/{groupId}","href":"/en/reference/platform/access-manager/removes-a-single-group-from-a-role"},{"title":"List the Permissions of a Role","deprecated":null,"version":null,"sidebarTitle":"Returns the permissions assigned to a role","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/roles/{id}/permissions","href":"/en/reference/platform/access-manager/returns-the-permissions-assigned-to-a-role"},{"title":"Add Permissions to a Role","deprecated":null,"version":null,"sidebarTitle":"Assigns permissions to a role","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/roles/{id}/permissions","href":"/en/reference/platform/access-manager/assigns-permissions-to-a-role"},{"title":"Remove Permissions from a Role in Batch","deprecated":null,"version":null,"sidebarTitle":"Removes multiple permissions from a role batch","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/roles/{id}/permissions/remove","href":"/en/reference/platform/access-manager/removes-multiple-permissions-from-a-role-batch"},{"title":"Remove one Permission from a Role","deprecated":null,"version":null,"sidebarTitle":"Removes a single permission from a role","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/roles/{id}/permissions/{permId}","href":"/en/reference/platform/access-manager/removes-a-single-permission-from-a-role"},{"title":"Grant a Role to Users","deprecated":null,"version":null,"sidebarTitle":"Assigns users to a role","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/roles/{id}/users","href":"/en/reference/platform/access-manager/assigns-users-to-a-role"},{"title":"Revoke a Role from Users in Batch","deprecated":null,"version":null,"sidebarTitle":"Removes multiple users from a role batch","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/roles/{id}/users/remove","href":"/en/reference/platform/access-manager/removes-multiple-users-from-a-role-batch"},{"title":"Revoke a Role from one User","deprecated":null,"version":null,"sidebarTitle":"Removes a single user from a role","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/roles/{id}/users/{userId}","href":"/en/reference/platform/access-manager/removes-a-single-user-from-a-role"}]},{"group":"Security policies","pages":[{"title":"Get Organization IP Allowlist","deprecated":null,"version":null,"sidebarTitle":"Get organization ip allowlist","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/security/ip-allowlist","href":"/en/reference/platform/access-manager/get-organization-ip-allowlist"},{"title":"Set Organization IP Allowlist","deprecated":null,"version":null,"sidebarTitle":"Set organization ip allowlist","openapi":"/en/openapi/v3-current/AM-identity.yaml put /v1/security/ip-allowlist","href":"/en/reference/platform/access-manager/set-organization-ip-allowlist"},{"title":"Update SSO login policy","deprecated":null,"version":null,"sidebarTitle":"Update sso login policy","openapi":"/en/openapi/v3-current/AM-identity.yaml patch /v1/sso/policy","href":"/en/reference/platform/access-manager/update-sso-login-policy"},{"title":"Get SSO provider configuration","deprecated":null,"version":null,"sidebarTitle":"Get sso provider configuration","openapi":"/en/openapi/v3-current/AM-identity.yaml get /v1/sso/provider","href":"/en/reference/platform/access-manager/get-sso-provider-configuration"},{"title":"Upsert SSO provider configuration","deprecated":null,"version":null,"sidebarTitle":"Upsert sso provider configuration","openapi":"/en/openapi/v3-current/AM-identity.yaml put /v1/sso/provider","href":"/en/reference/platform/access-manager/upsert-sso-provider-configuration"},{"title":"Delete SSO provider configuration","deprecated":null,"version":null,"sidebarTitle":"Delete sso provider configuration","openapi":"/en/openapi/v3-current/AM-identity.yaml delete /v1/sso/provider","href":"/en/reference/platform/access-manager/delete-sso-provider-configuration"},{"title":"Preflight an SSO provider configuration","deprecated":null,"version":null,"sidebarTitle":"Preflight an sso provider configuration","openapi":"/en/openapi/v3-current/AM-identity.yaml post /v1/sso/provider/preflight","href":"/en/reference/platform/access-manager/preflight-an-sso-provider-configuration"}]},{"group":"Plugin declarations","pages":[{"title":"Upsert a plugin declaration","deprecated":null,"version":null,"sidebarTitle":"Upsert a plugin declaration","openapi":"/en/openapi/v3-current/AM-identity.yaml put /v1/declarations/{slug}","href":"/en/reference/platform/access-manager/upsert-a-plugin-declaration"}]},{"group":"Error handling","pages":[{"title":"Access Manager error list","href":"/en/reference/platform/access-manager/access-manager-error-list"}]}]},{"dropdown":"Streaming Hub","icon":"tower-broadcast","description":"Event subscriptions and delivery","groups":[{"group":"Catalog","pages":[{"title":"List the event catalog","deprecated":null,"version":null,"sidebarTitle":"Get event catalog","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /v1/catalog","href":"/en/reference/platform/streaming-hub/get-event-catalog"}]},{"group":"Subscriptions","pages":[{"title":"Create a subscription","deprecated":null,"version":null,"sidebarTitle":"Create subscription","openapi":"/en/openapi/v3-current/streaming-hub.yaml post /v1/subscriptions","href":"/en/reference/platform/streaming-hub/create-subscription"},{"title":"List subscriptions","deprecated":null,"version":null,"sidebarTitle":"List subscriptions","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /v1/subscriptions","href":"/en/reference/platform/streaming-hub/list-subscriptions"},{"title":"Get a subscription","deprecated":null,"version":null,"sidebarTitle":"Get subscription","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /v1/subscriptions/{id}","href":"/en/reference/platform/streaming-hub/get-subscription"},{"title":"Read a subscription's full destination","deprecated":null,"version":null,"sidebarTitle":"Get subscription endpoint","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /v1/subscriptions/{id}/endpoint","href":"/en/reference/platform/streaming-hub/get-subscription-endpoint"},{"title":"Get subscription delivery health","deprecated":null,"version":null,"sidebarTitle":"Get subscription health","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /v1/subscriptions/{id}/health","href":"/en/reference/platform/streaming-hub/get-subscription-health"},{"title":"Re-pin a subscription's schema major","deprecated":null,"version":null,"sidebarTitle":"Update subscription schema pin","openapi":"/en/openapi/v3-current/streaming-hub.yaml patch /v1/subscriptions/{id}","href":"/en/reference/platform/streaming-hub/update-subscription-schema-pin"},{"title":"Delete a subscription","deprecated":null,"version":null,"sidebarTitle":"Delete subscription","openapi":"/en/openapi/v3-current/streaming-hub.yaml delete /v1/subscriptions/{id}","href":"/en/reference/platform/streaming-hub/delete-subscription"},{"title":"Ping a webhook subscription","deprecated":null,"version":null,"sidebarTitle":"Ping subscription","openapi":"/en/openapi/v3-current/streaming-hub.yaml post /v1/subscriptions/{id}/ping","href":"/en/reference/platform/streaming-hub/ping-subscription"},{"title":"Re-verify and re-enable a subscription","deprecated":null,"version":null,"sidebarTitle":"Verify subscription","openapi":"/en/openapi/v3-current/streaming-hub.yaml post /v1/subscriptions/{id}/verify","href":"/en/reference/platform/streaming-hub/verify-subscription"},{"title":"Set or rotate a queue credential","deprecated":null,"version":null,"sidebarTitle":"Set subscription credential","openapi":"/en/openapi/v3-current/streaming-hub.yaml put /v1/subscriptions/{id}/credential","href":"/en/reference/platform/streaming-hub/set-subscription-credential"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"sidebarTitle":"Rotate subscription secret","openapi":"/en/openapi/v3-current/streaming-hub.yaml post /v1/subscriptions/{id}/secret/rotate","href":"/en/reference/platform/streaming-hub/rotate-subscription-secret"},{"title":"Get AWS delegated-grant setup artifacts","deprecated":null,"version":null,"sidebarTitle":"Get subscription setup artifacts","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /v1/subscriptions/{id}/setup-artifacts","href":"/en/reference/platform/streaming-hub/get-subscription-setup-artifacts"},{"title":"Register an AWS delegated grant","deprecated":null,"version":null,"sidebarTitle":"Set subscription delegated grant","openapi":"/en/openapi/v3-current/streaming-hub.yaml put /v1/subscriptions/{id}/delegated-grant","href":"/en/reference/platform/streaming-hub/set-subscription-delegated-grant"}]},{"group":"Event Delivery","pages":[{"title":"Pull entitled events","deprecated":null,"version":null,"sidebarTitle":"Pull events","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /v1/events","href":"/en/reference/platform/streaming-hub/pull-events"}]},{"group":"Dashboard","pages":[{"title":"Get the operational dashboard snapshot","deprecated":null,"version":null,"sidebarTitle":"Get dashboard","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /v1/dashboard","href":"/en/reference/platform/streaming-hub/get-dashboard"},{"title":"List the subscriptions needing attention","deprecated":null,"version":null,"sidebarTitle":"List subscriptions needing attention","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /v1/dashboard/subscriptions","href":"/en/reference/platform/streaming-hub/list-subscriptions-needing-attention"}]},{"group":"Admin","pages":[{"title":"List dead-letter observations","deprecated":null,"version":null,"sidebarTitle":"List dlq observations","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /admin/dlq","href":"/en/reference/platform/streaming-hub/list-dlq-observations"}]},{"group":"Operational","pages":[{"title":"Liveness probe","deprecated":null,"version":null,"sidebarTitle":"Liveness probe","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /healthz","href":"/en/reference/platform/streaming-hub/liveness-probe"},{"title":"Readiness probe","deprecated":null,"version":null,"sidebarTitle":"Readiness probe","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /readyz","href":"/en/reference/platform/streaming-hub/readiness-probe"},{"title":"Build identity","deprecated":null,"version":null,"sidebarTitle":"Get version","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /version","href":"/en/reference/platform/streaming-hub/get-version"},{"title":"Runtime snapshot","deprecated":null,"version":null,"sidebarTitle":"Get runtime","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /runtime","href":"/en/reference/platform/streaming-hub/get-runtime"},{"title":"Prometheus metrics","deprecated":null,"version":null,"sidebarTitle":"Get metrics","openapi":"/en/openapi/v3-current/streaming-hub.yaml get /metrics","href":"/en/reference/platform/streaming-hub/get-metrics"}]},{"group":"Error handling","pages":[{"title":"Streaming Hub error list","href":"/en/reference/platform/streaming-hub/streaming-hub-error-list"}]}]},{"dropdown":"System Facts","icon":"clipboard-list","description":"Record and correlate business facts across services","groups":[{"group":"Overview","pages":[{"title":"System Facts API overview","href":"/en/reference/platform/system-facts/api-overview"}]},{"group":"Reference Types","pages":[{"title":"List reference types","deprecated":null,"version":null,"sidebarTitle":"List reference types","openapi":"/en/openapi/v3-current/system-facts.yaml get /v1/reference-types","href":"/en/reference/platform/system-facts/list-reference-types"},{"title":"Read a reference type","deprecated":null,"version":null,"sidebarTitle":"Read a reference type","openapi":"/en/openapi/v3-current/system-facts.yaml get /v1/reference-types/{type}","href":"/en/reference/platform/system-facts/read-a-reference-type"},{"title":"Register a reference type","deprecated":null,"version":null,"sidebarTitle":"Register a reference type","openapi":"/en/openapi/v3-current/system-facts.yaml put /v1/reference-types/{type}","href":"/en/reference/platform/system-facts/register-a-reference-type"}]},{"group":"Contracts","pages":[{"title":"List contract versions","deprecated":null,"version":null,"sidebarTitle":"List contract versions","openapi":"/en/openapi/v3-current/system-facts.yaml get /v1/contracts","href":"/en/reference/platform/system-facts/list-contract-versions"},{"title":"List the versions of a fact type","deprecated":null,"version":null,"sidebarTitle":"List the versions of a fact type","openapi":"/en/openapi/v3-current/system-facts.yaml get /v1/contracts/{producer}/{namespace}/{type}","href":"/en/reference/platform/system-facts/list-the-versions-of-a-fact-type"},{"title":"Read a contract version","deprecated":null,"version":null,"sidebarTitle":"Read a contract version","openapi":"/en/openapi/v3-current/system-facts.yaml get /v1/contracts/{producer}/{namespace}/{type}/{schemaVersion}","href":"/en/reference/platform/system-facts/read-a-contract-version"},{"title":"Register a contract version","deprecated":null,"version":null,"sidebarTitle":"Register a contract version","openapi":"/en/openapi/v3-current/system-facts.yaml put /v1/contracts/{producer}/{namespace}/{type}/{schemaVersion}","href":"/en/reference/platform/system-facts/register-a-contract-version"},{"title":"Deprecate a contract version","deprecated":null,"version":null,"sidebarTitle":"Deprecate a contract version","openapi":"/en/openapi/v3-current/system-facts.yaml post /v1/contracts/{producer}/{namespace}/{type}/{schemaVersion}/deprecate","href":"/en/reference/platform/system-facts/deprecate-a-contract-version"}]},{"group":"Facts","pages":[{"title":"Send a fact","deprecated":null,"version":null,"sidebarTitle":"Send a fact","openapi":"/en/openapi/v3-current/system-facts.yaml post /v1/facts","href":"/en/reference/platform/system-facts/send-a-fact"}]},{"group":"Flows","pages":[{"title":"List facts by a searchable reference","deprecated":null,"version":null,"sidebarTitle":"List facts by a searchable reference","openapi":"/en/openapi/v3-current/system-facts.yaml get /v1/flows","href":"/en/reference/platform/system-facts/list-facts-by-a-searchable-reference"},{"title":"Find the flow of a reference","deprecated":null,"version":null,"sidebarTitle":"Find the flow of a reference","openapi":"/en/openapi/v3-current/system-facts.yaml get /v1/flows/by-reference","href":"/en/reference/platform/system-facts/find-the-flow-of-a-reference"},{"title":"Read a flow","deprecated":null,"version":null,"sidebarTitle":"Read a flow","openapi":"/en/openapi/v3-current/system-facts.yaml get /v1/flows/{flowAggregationId}","href":"/en/reference/platform/system-facts/read-a-flow"}]},{"group":"Error handling","pages":[{"title":"System Facts API error list","href":"/en/reference/platform/system-facts/system-facts-error-list"}]}]},{"dropdown":"Systemplane","icon":"sliders","description":"Runtime configuration entries and catalog","groups":[{"group":"Overview","pages":[{"title":"Systemplane admin API","href":"/en/reference/platform/systemplane/overview"}]},{"group":"Entries","pages":[{"title":"List entries in a namespace","deprecated":null,"version":null,"sidebarTitle":"List entries","openapi":"/en/openapi/v3-current/systemplane.yaml get /system/{namespace}","href":"/en/reference/platform/systemplane/list-entries"},{"title":"Get one entry","deprecated":null,"version":null,"sidebarTitle":"Get entry","openapi":"/en/openapi/v3-current/systemplane.yaml get /system/{namespace}/{key}","href":"/en/reference/platform/systemplane/get-entry"},{"title":"Write one entry","deprecated":null,"version":null,"sidebarTitle":"Put entry","openapi":"/en/openapi/v3-current/systemplane.yaml put /system/{namespace}/{key}","href":"/en/reference/platform/systemplane/put-entry"},{"title":"Delete one entry","deprecated":null,"version":null,"sidebarTitle":"Delete entry","openapi":"/en/openapi/v3-current/systemplane.yaml delete /system/{namespace}/{key}","href":"/en/reference/platform/systemplane/delete-entry"}]},{"group":"Catalog","pages":[{"title":"List the key catalog","deprecated":null,"version":null,"sidebarTitle":"Catalog list","openapi":"/en/openapi/v3-current/systemplane.yaml get /system/-/catalog","href":"/en/reference/platform/systemplane/catalog-list"},{"title":"Get one key's write contract","deprecated":null,"version":null,"sidebarTitle":"Catalog detail","openapi":"/en/openapi/v3-current/systemplane.yaml get /system/-/catalog/{namespace}/{key}","href":"/en/reference/platform/systemplane/catalog-detail"}]},{"group":"Error handling","pages":[{"title":"Systemplane error list","href":"/en/reference/platform/systemplane/systemplane-error-list"}]}]},{"dropdown":"Narya","icon":"server","description":"Run coding agents behind one HTTP API","groups":[{"group":"Overview","pages":[{"title":"Narya host API overview","href":"/en/reference/platform/narya/host-api-overview"}]},{"group":"Host","pages":[{"title":"Describe the host process","deprecated":null,"version":null,"sidebarTitle":"Describe the host process","openapi":"/en/openapi/v3-current/narya.yaml get /v1/host","href":"/en/reference/platform/narya/describe-the-host-process"},{"title":"Run the read-only health walk","deprecated":null,"version":null,"sidebarTitle":"Run the read only health walk","openapi":"/en/openapi/v3-current/narya.yaml get /v1/doctor","href":"/en/reference/platform/narya/run-the-read-only-health-walk"},{"title":"Report every declared external tool server's health and cost","deprecated":null,"version":null,"sidebarTitle":"Report every declared external tool server s health and cost","openapi":"/en/openapi/v3-current/narya.yaml get /v1/tool-servers","href":"/en/reference/platform/narya/report-every-declared-external-tool-server-s-health-and-cost"}]},{"group":"Sessions","pages":[{"title":"List sessions","deprecated":null,"version":null,"sidebarTitle":"List sessions","openapi":"/en/openapi/v3-current/narya.yaml get /v1/sessions","href":"/en/reference/platform/narya/list-sessions"},{"title":"Create a session","deprecated":null,"version":null,"sidebarTitle":"Create a session","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions","href":"/en/reference/platform/narya/create-a-session"},{"title":"Get a session","deprecated":null,"version":null,"sidebarTitle":"Get a session","openapi":"/en/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}","href":"/en/reference/platform/narya/get-a-session"},{"title":"Archive a session","deprecated":null,"version":null,"sidebarTitle":"Archive a session","openapi":"/en/openapi/v3-current/narya.yaml delete /v1/sessions/{sessionId}","href":"/en/reference/platform/narya/archive-a-session"},{"title":"Switch the session's model","deprecated":null,"version":null,"sidebarTitle":"Switch the session s model","openapi":"/en/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/model","href":"/en/reference/platform/narya/switch-the-session-s-model"},{"title":"Rename the session","deprecated":null,"version":null,"sidebarTitle":"Rename the session","openapi":"/en/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/title","href":"/en/reference/platform/narya/rename-the-session"},{"title":"Record whether anybody is watching this session","deprecated":null,"version":null,"sidebarTitle":"Record whether anybody is watching this session","openapi":"/en/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/posture","href":"/en/reference/platform/narya/record-whether-anybody-is-watching-this-session"},{"title":"Hold this session back from the organisation, or hand it back","deprecated":null,"version":null,"sidebarTitle":"Hold this session back from the organisation or hand it back","openapi":"/en/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/visibility","href":"/en/reference/platform/narya/hold-this-session-back-from-the-organisation-or-hand-it-back"},{"title":"Put this session into a named response style","deprecated":null,"version":null,"sidebarTitle":"Put this session into a named response style","openapi":"/en/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/style","href":"/en/reference/platform/narya/put-this-session-into-a-named-response-style"},{"title":"Move a session to another directory","deprecated":null,"version":null,"sidebarTitle":"Move a session to another directory","openapi":"/en/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/repository","href":"/en/reference/platform/narya/move-a-session-to-another-directory"},{"title":"Record that a reader has looked at this session","deprecated":null,"version":null,"sidebarTitle":"Record that a reader has looked at this session","openapi":"/en/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/viewed","href":"/en/reference/platform/narya/record-that-a-reader-has-looked-at-this-session"},{"title":"Say whether this session pays to stay warm, and how much","deprecated":null,"version":null,"sidebarTitle":"Say whether this session pays to stay warm and how much","openapi":"/en/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/warming","href":"/en/reference/platform/narya/say-whether-this-session-pays-to-stay-warm-and-how-much"},{"title":"Branch a session at an earlier entry","deprecated":null,"version":null,"sidebarTitle":"Branch a session at an earlier entry","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/branch","href":"/en/reference/platform/narya/branch-a-session-at-an-earlier-entry"},{"title":"Go back to an earlier point, on a new branch","deprecated":null,"version":null,"sidebarTitle":"Go back to an earlier point on a new branch","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/rewind","href":"/en/reference/platform/narya/go-back-to-an-earlier-point-on-a-new-branch"},{"title":"Read a session's transcript","deprecated":null,"version":null,"sidebarTitle":"Read a session s transcript","openapi":"/en/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/entries","href":"/en/reference/platform/narya/read-a-session-s-transcript"},{"title":"Read one file a transcript row carried","deprecated":null,"version":null,"sidebarTitle":"Read one file a transcript row carried","openapi":"/en/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/media/{mediaKey}","href":"/en/reference/platform/narya/read-one-file-a-transcript-row-carried"},{"title":"Summarise this conversation, on demand","deprecated":null,"version":null,"sidebarTitle":"Summarise this conversation on demand","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/summary","href":"/en/reference/platform/narya/summarise-this-conversation-on-demand"},{"title":"Label one entry of a transcript","deprecated":null,"version":null,"sidebarTitle":"Label one entry of a transcript","openapi":"/en/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/entries/{entryId}/label","href":"/en/reference/platform/narya/label-one-entry-of-a-transcript"},{"title":"Read the branched family a session belongs to","deprecated":null,"version":null,"sidebarTitle":"Read the branched family a session belongs to","openapi":"/en/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/tree","href":"/en/reference/platform/narya/read-the-branched-family-a-session-belongs-to"},{"title":"Read what one conversation cost, broken down by model","deprecated":null,"version":null,"sidebarTitle":"Read what one conversation cost broken down by model","openapi":"/en/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/usage","href":"/en/reference/platform/narya/read-what-one-conversation-cost-broken-down-by-model"},{"title":"Read what a session changed on disk","deprecated":null,"version":null,"sidebarTitle":"Read what a session changed on disk","openapi":"/en/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/changes","href":"/en/reference/platform/narya/read-what-a-session-changed-on-disk"},{"title":"Drop a message still waiting behind a running turn","deprecated":null,"version":null,"sidebarTitle":"Drop a message still waiting behind a running turn","openapi":"/en/openapi/v3-current/narya.yaml delete /v1/sessions/{sessionId}/inputs/{entryId}","href":"/en/reference/platform/narya/drop-a-message-still-waiting-behind-a-running-turn"},{"title":"Get the repository's saved composer draft","deprecated":null,"version":null,"sidebarTitle":"Get the repository s saved composer draft","openapi":"/en/openapi/v3-current/narya.yaml get /v1/drafts","href":"/en/reference/platform/narya/get-the-repository-s-saved-composer-draft"},{"title":"Save the repository's composer draft","deprecated":null,"version":null,"sidebarTitle":"Save the repository s composer draft","openapi":"/en/openapi/v3-current/narya.yaml put /v1/drafts","href":"/en/reference/platform/narya/save-the-repository-s-composer-draft"},{"title":"Read whether a repository's instruction files may be loaded","deprecated":null,"version":null,"sidebarTitle":"Read whether a repository s instruction files may be loaded","openapi":"/en/openapi/v3-current/narya.yaml get /v1/repository-trust","href":"/en/reference/platform/narya/read-whether-a-repository-s-instruction-files-may-be-loaded"},{"title":"Record a repository's instruction-file answer","deprecated":null,"version":null,"sidebarTitle":"Record a repository s instruction file answer","openapi":"/en/openapi/v3-current/narya.yaml put /v1/repository-trust","href":"/en/reference/platform/narya/record-a-repository-s-instruction-file-answer"}]},{"group":"Messages","pages":[{"title":"Submit a user message","deprecated":null,"version":null,"sidebarTitle":"Submit a user message","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/messages","href":"/en/reference/platform/narya/submit-a-user-message"},{"title":"Interrupt the session's main lane","deprecated":null,"version":null,"sidebarTitle":"Interrupt the session s main lane","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/interrupt","href":"/en/reference/platform/narya/interrupt-the-session-s-main-lane"},{"title":"Send a message to a session's inbox","deprecated":null,"version":null,"sidebarTitle":"Send a message to a session s inbox","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/inbox","href":"/en/reference/platform/narya/send-a-message-to-a-session-s-inbox"},{"title":"Get an inter-session ask","deprecated":null,"version":null,"sidebarTitle":"Get an inter session ask","openapi":"/en/openapi/v3-current/narya.yaml get /v1/asks/{askId}","href":"/en/reference/platform/narya/get-an-inter-session-ask"}]},{"group":"Events","pages":[{"title":"Stream events (SSE)","deprecated":null,"version":null,"sidebarTitle":"Stream events sse","openapi":"/en/openapi/v3-current/narya.yaml get /v1/events","href":"/en/reference/platform/narya/stream-events-sse"}]},{"group":"Lanes","pages":[{"title":"List a session's lanes","deprecated":null,"version":null,"sidebarTitle":"List a session s lanes","openapi":"/en/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/lanes","href":"/en/reference/platform/narya/list-a-session-s-lanes"},{"title":"Open a lane","deprecated":null,"version":null,"sidebarTitle":"Open a lane","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/lanes","href":"/en/reference/platform/narya/open-a-lane"},{"title":"Close a lane","deprecated":null,"version":null,"sidebarTitle":"Close a lane","openapi":"/en/openapi/v3-current/narya.yaml delete /v1/sessions/{sessionId}/lanes/{laneId}","href":"/en/reference/platform/narya/close-a-lane"},{"title":"Submit a message to a lane","deprecated":null,"version":null,"sidebarTitle":"Submit a message to a lane","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/lanes/{laneId}/messages","href":"/en/reference/platform/narya/submit-a-message-to-a-lane"},{"title":"Interrupt a lane","deprecated":null,"version":null,"sidebarTitle":"Interrupt a lane","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/lanes/{laneId}/interrupt","href":"/en/reference/platform/narya/interrupt-a-lane"},{"title":"Stop waiting on a delegated lane","deprecated":null,"version":null,"sidebarTitle":"Stop waiting on a delegated lane","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/lanes/{laneId}/promote","href":"/en/reference/platform/narya/stop-waiting-on-a-delegated-lane"},{"title":"Summarise this lane's conversation now","deprecated":null,"version":null,"sidebarTitle":"Summarise this lane s conversation now","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/lanes/{laneId}/compact","href":"/en/reference/platform/narya/summarise-this-lane-s-conversation-now"},{"title":"Set aside this lane's old tool output","deprecated":null,"version":null,"sidebarTitle":"Set aside this lane s old tool output","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/lanes/{laneId}/prune","href":"/en/reference/platform/narya/set-aside-this-lane-s-old-tool-output"}]},{"group":"Monitors","pages":[{"title":"List the session's running monitors","deprecated":null,"version":null,"sidebarTitle":"List the session s running monitors","openapi":"/en/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/monitors","href":"/en/reference/platform/narya/list-the-session-s-running-monitors"},{"title":"Start a monitor","deprecated":null,"version":null,"sidebarTitle":"Start a monitor","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/monitors","href":"/en/reference/platform/narya/start-a-monitor"},{"title":"Stop a monitor","deprecated":null,"version":null,"sidebarTitle":"Stop a monitor","openapi":"/en/openapi/v3-current/narya.yaml delete /v1/sessions/{sessionId}/monitors/{name}","href":"/en/reference/platform/narya/stop-a-monitor"}]},{"group":"Agents","pages":[{"title":"List agent recipes","deprecated":null,"version":null,"sidebarTitle":"List agent recipes","openapi":"/en/openapi/v3-current/narya.yaml get /v1/agents","href":"/en/reference/platform/narya/list-agent-recipes"},{"title":"Get an agent recipe","deprecated":null,"version":null,"sidebarTitle":"Get an agent recipe","openapi":"/en/openapi/v3-current/narya.yaml get /v1/agents/{name}","href":"/en/reference/platform/narya/get-an-agent-recipe"}]},{"group":"Skills and commands","pages":[{"title":"List installed skills","deprecated":null,"version":null,"sidebarTitle":"List installed skills","openapi":"/en/openapi/v3-current/narya.yaml get /v1/skills","href":"/en/reference/platform/narya/list-installed-skills"},{"title":"Expand one skill into text","deprecated":null,"version":null,"sidebarTitle":"Expand one skill into text","openapi":"/en/openapi/v3-current/narya.yaml post /v1/skills/{name}/expansion","href":"/en/reference/platform/narya/expand-one-skill-into-text"},{"title":"List slash commands","deprecated":null,"version":null,"sidebarTitle":"List slash commands","openapi":"/en/openapi/v3-current/narya.yaml get /v1/commands","href":"/en/reference/platform/narya/list-slash-commands"},{"title":"Expand one command file into text","deprecated":null,"version":null,"sidebarTitle":"Expand one command file into text","openapi":"/en/openapi/v3-current/narya.yaml post /v1/commands/{name}/expansion","href":"/en/reference/platform/narya/expand-one-command-file-into-text"}]},{"group":"Permissions","pages":[{"title":"List permission asks","deprecated":null,"version":null,"sidebarTitle":"List permission asks","openapi":"/en/openapi/v3-current/narya.yaml get /v1/permissions","href":"/en/reference/platform/narya/list-permission-asks"},{"title":"Decide a permission ask","deprecated":null,"version":null,"sidebarTitle":"Decide a permission ask","openapi":"/en/openapi/v3-current/narya.yaml post /v1/permissions/{permissionId}/decision","href":"/en/reference/platform/narya/decide-a-permission-ask"},{"title":"List the decision audit","deprecated":null,"version":null,"sidebarTitle":"List the decision audit","openapi":"/en/openapi/v3-current/narya.yaml get /v1/permissions/decisions","href":"/en/reference/platform/narya/list-the-decision-audit"},{"title":"List the questions waiting on a person","deprecated":null,"version":null,"sidebarTitle":"List the questions waiting on a person","openapi":"/en/openapi/v3-current/narya.yaml get /v1/questions","href":"/en/reference/platform/narya/list-the-questions-waiting-on-a-person"},{"title":"Answer a question the agent asked","deprecated":null,"version":null,"sidebarTitle":"Answer a question the agent asked","openapi":"/en/openapi/v3-current/narya.yaml post /v1/questions/{questionId}/answer","href":"/en/reference/platform/narya/answer-a-question-the-agent-asked"}]},{"group":"Peers","pages":[{"title":"List addressable peer sessions","deprecated":null,"version":null,"sidebarTitle":"List addressable peer sessions","openapi":"/en/openapi/v3-current/narya.yaml get /v1/peers","href":"/en/reference/platform/narya/list-addressable-peer-sessions"}]},{"group":"Packages","pages":[{"title":"List installed packages","deprecated":null,"version":null,"sidebarTitle":"List installed packages","openapi":"/en/openapi/v3-current/narya.yaml get /v1/packages","href":"/en/reference/platform/narya/list-installed-packages"},{"title":"Install a package","deprecated":null,"version":null,"sidebarTitle":"Install a package","openapi":"/en/openapi/v3-current/narya.yaml post /v1/packages","href":"/en/reference/platform/narya/install-a-package"},{"title":"Say what a source is, and whether installing it needs trust","deprecated":null,"version":null,"sidebarTitle":"Say what a source is and whether installing it needs trust","openapi":"/en/openapi/v3-current/narya.yaml get /v1/packages/classification","href":"/en/reference/platform/narya/say-what-a-source-is-and-whether-installing-it-needs-trust"},{"title":"Get a package job","deprecated":null,"version":null,"sidebarTitle":"Get a package job","openapi":"/en/openapi/v3-current/narya.yaml get /v1/packages/jobs/{jobId}","href":"/en/reference/platform/narya/get-a-package-job"},{"title":"Remove a package","deprecated":null,"version":null,"sidebarTitle":"Remove a package","openapi":"/en/openapi/v3-current/narya.yaml delete /v1/packages/{name}","href":"/en/reference/platform/narya/remove-a-package"},{"title":"Disable a package","deprecated":null,"version":null,"sidebarTitle":"Disable a package","openapi":"/en/openapi/v3-current/narya.yaml post /v1/packages/{name}/disable","href":"/en/reference/platform/narya/disable-a-package"},{"title":"Enable a package","deprecated":null,"version":null,"sidebarTitle":"Enable a package","openapi":"/en/openapi/v3-current/narya.yaml post /v1/packages/{name}/enable","href":"/en/reference/platform/narya/enable-a-package"}]},{"group":"Extensions","pages":[{"title":"List this home's registered extensions","deprecated":null,"version":null,"sidebarTitle":"List this home s registered extensions","openapi":"/en/openapi/v3-current/narya.yaml get /v1/extensions","href":"/en/reference/platform/narya/list-this-home-s-registered-extensions"},{"title":"Register an extension","deprecated":null,"version":null,"sidebarTitle":"Register an extension","openapi":"/en/openapi/v3-current/narya.yaml post /v1/extensions","href":"/en/reference/platform/narya/register-an-extension"},{"title":"Read one registered extension","deprecated":null,"version":null,"sidebarTitle":"Read one registered extension","openapi":"/en/openapi/v3-current/narya.yaml get /v1/extensions/{publisher}/{name}","href":"/en/reference/platform/narya/read-one-registered-extension"},{"title":"Re-point, re-order, re-grant or disable a registered extension","deprecated":null,"version":null,"sidebarTitle":"Re point re order re grant or disable a registered extension","openapi":"/en/openapi/v3-current/narya.yaml patch /v1/extensions/{publisher}/{name}","href":"/en/reference/platform/narya/re-point-re-order-re-grant-or-disable-a-registered-extension"},{"title":"Revoke a registered extension","deprecated":null,"version":null,"sidebarTitle":"Revoke a registered extension","openapi":"/en/openapi/v3-current/narya.yaml delete /v1/extensions/{publisher}/{name}","href":"/en/reference/platform/narya/revoke-a-registered-extension"},{"title":"Rotate a registered extension's secret","deprecated":null,"version":null,"sidebarTitle":"Rotate a registered extension s secret","openapi":"/en/openapi/v3-current/narya.yaml post /v1/extensions/{publisher}/{name}/secret","href":"/en/reference/platform/narya/rotate-a-registered-extension-s-secret"},{"title":"Invoke an operation a registered extension exposes","deprecated":null,"version":null,"sidebarTitle":"Invoke an operation a registered extension exposes","openapi":"/en/openapi/v3-current/narya.yaml post /v1/extensions/{name}/invoke","href":"/en/reference/platform/narya/invoke-an-operation-a-registered-extension-exposes"}]},{"group":"Workflows","pages":[{"title":"List workflow runs","deprecated":null,"version":null,"sidebarTitle":"List workflow runs","openapi":"/en/openapi/v3-current/narya.yaml get /v1/workflows/runs","href":"/en/reference/platform/narya/list-workflow-runs"},{"title":"Start a workflow run","deprecated":null,"version":null,"sidebarTitle":"Start a workflow run","openapi":"/en/openapi/v3-current/narya.yaml post /v1/workflows/runs","href":"/en/reference/platform/narya/start-a-workflow-run"},{"title":"Get a workflow run","deprecated":null,"version":null,"sidebarTitle":"Get a workflow run","openapi":"/en/openapi/v3-current/narya.yaml get /v1/workflows/runs/{runId}","href":"/en/reference/platform/narya/get-a-workflow-run"},{"title":"Stop a workflow run","deprecated":null,"version":null,"sidebarTitle":"Stop a workflow run","openapi":"/en/openapi/v3-current/narya.yaml post /v1/workflows/runs/{runId}/stop","href":"/en/reference/platform/narya/stop-a-workflow-run"},{"title":"Resume a workflow run","deprecated":null,"version":null,"sidebarTitle":"Resume a workflow run","openapi":"/en/openapi/v3-current/narya.yaml post /v1/workflows/runs/{runId}/resume","href":"/en/reference/platform/narya/resume-a-workflow-run"}]},{"group":"Schedules","pages":[{"title":"List the schedules this host's clock owes","deprecated":null,"version":null,"sidebarTitle":"List the schedules this host s clock owes","openapi":"/en/openapi/v3-current/narya.yaml get /v1/schedules","href":"/en/reference/platform/narya/list-the-schedules-this-host-s-clock-owes"},{"title":"Ask the host's clock to start work nobody will be present for","deprecated":null,"version":null,"sidebarTitle":"Ask the host s clock to start work nobody will be present for","openapi":"/en/openapi/v3-current/narya.yaml post /v1/schedules","href":"/en/reference/platform/narya/ask-the-host-s-clock-to-start-work-nobody-will-be-present-for"},{"title":"Get a schedule","deprecated":null,"version":null,"sidebarTitle":"Get a schedule","openapi":"/en/openapi/v3-current/narya.yaml get /v1/schedules/{scheduleId}","href":"/en/reference/platform/narya/get-a-schedule"},{"title":"Cancel a schedule","deprecated":null,"version":null,"sidebarTitle":"Cancel a schedule","openapi":"/en/openapi/v3-current/narya.yaml delete /v1/schedules/{scheduleId}","href":"/en/reference/platform/narya/cancel-a-schedule"},{"title":"Say what one fire of this schedule may spend","deprecated":null,"version":null,"sidebarTitle":"Say what one fire of this schedule may spend","openapi":"/en/openapi/v3-current/narya.yaml put /v1/schedules/{scheduleId}/budget","href":"/en/reference/platform/narya/say-what-one-fire-of-this-schedule-may-spend"}]},{"group":"Providers","pages":[{"title":"List model providers","deprecated":null,"version":null,"sidebarTitle":"List model providers","openapi":"/en/openapi/v3-current/narya.yaml get /v1/providers","href":"/en/reference/platform/narya/list-model-providers"},{"title":"Start provider sign-in","deprecated":null,"version":null,"sidebarTitle":"Start provider sign in","openapi":"/en/openapi/v3-current/narya.yaml post /v1/providers/{name}/auth","href":"/en/reference/platform/narya/start-provider-sign-in"},{"title":"Read the provider's sign-in in flight","deprecated":null,"version":null,"sidebarTitle":"Read the provider s sign in in flight","openapi":"/en/openapi/v3-current/narya.yaml get /v1/providers/{name}/auth","href":"/en/reference/platform/narya/read-the-provider-s-sign-in-in-flight"},{"title":"Sign out of a provider","deprecated":null,"version":null,"sidebarTitle":"Sign out of a provider","openapi":"/en/openapi/v3-current/narya.yaml delete /v1/providers/{name}/auth","href":"/en/reference/platform/narya/sign-out-of-a-provider"},{"title":"List models across providers","deprecated":null,"version":null,"sidebarTitle":"List models across providers","openapi":"/en/openapi/v3-current/narya.yaml get /v1/models","href":"/en/reference/platform/narya/list-models-across-providers"},{"title":"List recently chosen models","deprecated":null,"version":null,"sidebarTitle":"List recently chosen models","openapi":"/en/openapi/v3-current/narya.yaml get /v1/models/recent","href":"/en/reference/platform/narya/list-recently-chosen-models"}]},{"group":"Records","pages":[{"title":"Search the sessions you can read","deprecated":null,"version":null,"sidebarTitle":"Search all past sessions","openapi":"/en/openapi/v3-current/narya.yaml get /v1/records/search","href":"/en/reference/platform/narya/search-all-past-sessions"},{"title":"List sessions that touched a file","deprecated":null,"version":null,"sidebarTitle":"List sessions that touched a file","openapi":"/en/openapi/v3-current/narya.yaml get /v1/records/files","href":"/en/reference/platform/narya/list-sessions-that-touched-a-file"},{"title":"Report consumption over a period","deprecated":null,"version":null,"sidebarTitle":"Report consumption over a period","openapi":"/en/openapi/v3-current/narya.yaml get /v1/records/usage","href":"/en/reference/platform/narya/report-consumption-over-a-period"},{"title":"Import a transcript from another harness","deprecated":null,"version":null,"sidebarTitle":"Import a transcript from another harness","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/import","href":"/en/reference/platform/narya/import-a-transcript-from-another-harness"},{"title":"Export a session transcript","deprecated":null,"version":null,"sidebarTitle":"Export a session transcript","openapi":"/en/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/export","href":"/en/reference/platform/narya/export-a-session-transcript"}]},{"group":"Environments","pages":[{"title":"List the environments this host holds","deprecated":null,"version":null,"sidebarTitle":"List the environments this host holds","openapi":"/en/openapi/v3-current/narya.yaml get /v1/environments","href":"/en/reference/platform/narya/list-the-environments-this-host-holds"},{"title":"Create an environment","deprecated":null,"version":null,"sidebarTitle":"Create an environment","openapi":"/en/openapi/v3-current/narya.yaml post /v1/environments","href":"/en/reference/platform/narya/create-an-environment"},{"title":"Get an environment","deprecated":null,"version":null,"sidebarTitle":"Get an environment","openapi":"/en/openapi/v3-current/narya.yaml get /v1/environments/{environmentId}","href":"/en/reference/platform/narya/get-an-environment"},{"title":"Destroy an environment","deprecated":null,"version":null,"sidebarTitle":"Destroy an environment","openapi":"/en/openapi/v3-current/narya.yaml delete /v1/environments/{environmentId}","href":"/en/reference/platform/narya/destroy-an-environment"},{"title":"List the repositories this organisation selected on GitHub","deprecated":null,"version":null,"sidebarTitle":"List the repositories this organisation selected on github","openapi":"/en/openapi/v3-current/narya.yaml get /v1/github/repositories","href":"/en/reference/platform/narya/list-the-repositories-this-organisation-selected-on-github"}]},{"group":"Sharing","pages":[{"title":"Publish this session to the organisation's home","deprecated":null,"version":null,"sidebarTitle":"Publish this session to the organisation s home","openapi":"/en/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/share","href":"/en/reference/platform/narya/publish-this-session-to-the-organisation-s-home"},{"title":"The live shares of this session, and who each one is for","deprecated":null,"version":null,"sidebarTitle":"The live shares of this session and who each one is for","openapi":"/en/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/share","href":"/en/reference/platform/narya/the-live-shares-of-this-session-and-who-each-one-is-for"},{"title":"Revoke every share of this session, deleting what was copied","deprecated":null,"version":null,"sidebarTitle":"Revoke every share of this session deleting what was copied","openapi":"/en/openapi/v3-current/narya.yaml delete /v1/sessions/{sessionId}/share","href":"/en/reference/platform/narya/revoke-every-share-of-this-session-deleting-what-was-copied"},{"title":"What publishing this session would send, and what it would hold back","deprecated":null,"version":null,"sidebarTitle":"What publishing this session would send and what it would hold back","openapi":"/en/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/share/preview","href":"/en/reference/platform/narya/what-publishing-this-session-would-send-and-what-it-would-hold-back"},{"title":"Who has opened this shared session, and when","deprecated":null,"version":null,"sidebarTitle":"Who has opened this shared session and when","openapi":"/en/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/share/disclosures","href":"/en/reference/platform/narya/who-has-opened-this-shared-session-and-when"},{"title":"List the shared sessions this home holds","deprecated":null,"version":null,"sidebarTitle":"List the shared sessions this home holds","openapi":"/en/openapi/v3-current/narya.yaml get /v1/shares","href":"/en/reference/platform/narya/list-the-shared-sessions-this-home-holds"},{"title":"Read one shared session's record","deprecated":null,"version":null,"sidebarTitle":"Read one shared session s record","openapi":"/en/openapi/v3-current/narya.yaml get /v1/shares/{shareId}","href":"/en/reference/platform/narya/read-one-shared-session-s-record"},{"title":"Delete everything this home holds for one share","deprecated":null,"version":null,"sidebarTitle":"Delete everything this home holds for one share","openapi":"/en/openapi/v3-current/narya.yaml delete /v1/shares/{shareId}","href":"/en/reference/platform/narya/delete-everything-this-home-holds-for-one-share"},{"title":"Read a shared session's copied entries","deprecated":null,"version":null,"sidebarTitle":"Read a shared session s copied entries","openapi":"/en/openapi/v3-current/narya.yaml get /v1/shares/{shareId}/entries","href":"/en/reference/platform/narya/read-a-shared-session-s-copied-entries"},{"title":"Take a batch of a shared session's entries","deprecated":null,"version":null,"sidebarTitle":"Take a batch of a shared session s entries","openapi":"/en/openapi/v3-current/narya.yaml post /v1/shares/{shareId}/entries","href":"/en/reference/platform/narya/take-a-batch-of-a-shared-session-s-entries"},{"title":"Settle who a published share is for","deprecated":null,"version":null,"sidebarTitle":"Settle who a published share is for","openapi":"/en/openapi/v3-current/narya.yaml put /v1/shares/{shareId}/recipients","href":"/en/reference/platform/narya/settle-who-a-published-share-is-for"},{"title":"Take who the copy of a share is for","deprecated":null,"version":null,"sidebarTitle":"Take who the copy of a share is for","openapi":"/en/openapi/v3-current/narya.yaml put /v1/shares/{shareId}/audience","href":"/en/reference/platform/narya/take-who-the-copy-of-a-share-is-for"},{"title":"Who has opened this shared copy, and when","deprecated":null,"version":null,"sidebarTitle":"Who has opened this shared copy and when","openapi":"/en/openapi/v3-current/narya.yaml get /v1/shares/{shareId}/disclosures","href":"/en/reference/platform/narya/who-has-opened-this-shared-copy-and-when"}]},{"group":"Refinements","pages":[{"title":"Read the exact system prompt this session's next turn will send","deprecated":null,"version":null,"sidebarTitle":"Read the exact system prompt this session s next turn will send","openapi":"/en/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/prompt","href":"/en/reference/platform/narya/read-the-exact-system-prompt-this-session-s-next-turn-will-send"},{"title":"List what narya has been taught","deprecated":null,"version":null,"sidebarTitle":"List what narya has been taught","openapi":"/en/openapi/v3-current/narya.yaml get /v1/refinements","href":"/en/reference/platform/narya/list-what-narya-has-been-taught"},{"title":"Teach narya something, and ask a person to allow it","deprecated":null,"version":null,"sidebarTitle":"Teach narya something and ask a person to allow it","openapi":"/en/openapi/v3-current/narya.yaml post /v1/refinements","href":"/en/reference/platform/narya/teach-narya-something-and-ask-a-person-to-allow-it"},{"title":"Read one refinement whole","deprecated":null,"version":null,"sidebarTitle":"Read one refinement whole","openapi":"/en/openapi/v3-current/narya.yaml get /v1/refinements/{refinementId}","href":"/en/reference/platform/narya/read-one-refinement-whole"},{"title":"Undo what narya learned","deprecated":null,"version":null,"sidebarTitle":"Undo what narya learned","openapi":"/en/openapi/v3-current/narya.yaml post /v1/refinements/{refinementId}/rollback","href":"/en/reference/platform/narya/undo-what-narya-learned"},{"title":"Ask to widen what a fact applies to","deprecated":null,"version":null,"sidebarTitle":"Ask to widen what a fact applies to","openapi":"/en/openapi/v3-current/narya.yaml post /v1/refinements/{refinementId}/promote","href":"/en/reference/platform/narya/ask-to-widen-what-a-fact-applies-to"},{"title":"Narrow a fact to one checkout","deprecated":null,"version":null,"sidebarTitle":"Narrow a fact to one checkout","openapi":"/en/openapi/v3-current/narya.yaml post /v1/refinements/{refinementId}/demote","href":"/en/reference/platform/narya/narrow-a-fact-to-one-checkout"},{"title":"List the rounds waiting on a person","deprecated":null,"version":null,"sidebarTitle":"List the rounds waiting on a person","openapi":"/en/openapi/v3-current/narya.yaml get /v1/refinements/rounds","href":"/en/reference/platform/narya/list-the-rounds-waiting-on-a-person"},{"title":"Read one round whole, to answer it","deprecated":null,"version":null,"sidebarTitle":"Read one round whole to answer it","openapi":"/en/openapi/v3-current/narya.yaml get /v1/refinements/rounds/{roundId}","href":"/en/reference/platform/narya/read-one-round-whole-to-answer-it"},{"title":"Answer one round of proposed refinements","deprecated":null,"version":null,"sidebarTitle":"Answer one round of proposed refinements","openapi":"/en/openapi/v3-current/narya.yaml post /v1/refinements/rounds/{roundId}/answer","href":"/en/reference/platform/narya/answer-one-round-of-proposed-refinements"}]},{"group":"Platform","pages":[{"title":"List the calls Lerian's platform made to this home","deprecated":null,"version":null,"sidebarTitle":"Every time lerian s platform reached this home","openapi":"/en/openapi/v3-current/narya.yaml get /v1/platform/accesses","href":"/en/reference/platform/narya/every-time-lerian-s-platform-reached-this-home"}]},{"group":"Error handling","pages":[{"title":"Narya host API error list","href":"/en/reference/platform/narya/host-api-error-list"}]}]}]}]},{"tab":"News","icon":"bullhorn","pages":[{"title":"News","href":"/en/news/news"}]}]},{"language":"pt-BR","footer":{"socials":{"discord":"https://discord.gg/DnhqKwkGv3","github":"https://github.com/LerianStudio","linkedin":"https://www.linkedin.com/company/lerianstudio","instagram":"https://www.instagram.com/lerian.studio"},"links":[{"header":"Produtos","items":[{"label":"Midaz","href":"/pt/products/midaz/what-is-midaz"},{"label":"Tracer","href":"/pt/products/tracer/what-is-tracer"},{"label":"Matcher","href":"/pt/products/matcher/what-is-matcher"},{"label":"Flowker","href":"/pt/products/flowker/what-is-flowker"},{"label":"Lender","href":"/pt/products/lender/what-is-lender"},{"label":"Reporter","href":"/pt/products/reporter/what-is-reporter"}]},{"header":"Pagamentos","items":[{"label":"Trilhos Brasil","href":"/pt/rails/what-are-brazil-rails"},{"label":"Interfaces","href":"/pt/interfaces/introduction"},{"label":"Pix","href":"/pt/interfaces/pix/pix-overview"},{"label":"TED","href":"/pt/interfaces/ted/ted-overview"}]},{"header":"Desenvolvedores","items":[{"label":"Referência da API","href":"/pt/reference/introduction"},{"label":"Streaming de eventos","href":"/pt/reference/events/overview"},{"label":"Novidades","href":"/pt/news/news"}]},{"header":"Empresa","items":[{"label":"Blog","href":"https://blog.lerian.studio/"},{"label":"Contato","href":"https://lerian.studio/contact"},{"label":"GitHub","href":"https://github.com/LerianStudio"}]}]},"navbar":{"links":[{"icon":"newspaper","href":"https://blog.lerian.studio/","label":"Blog"}],"primary":{"type":"button","label":"Fale conosco","href":"https://lerian.studio/contact"}},"pages":[{"title":"pt-BR","href":"/pt/reference/products/midaz/v2/create-holder"}]},{"language":"es","footer":{"socials":{"discord":"https://discord.gg/DnhqKwkGv3","github":"https://github.com/LerianStudio","linkedin":"https://www.linkedin.com/company/lerianstudio","instagram":"https://www.instagram.com/lerian.studio"},"links":[{"header":"Productos","items":[{"label":"Midaz","href":"/es/products/midaz/what-is-midaz"},{"label":"Tracer","href":"/es/products/tracer/what-is-tracer"},{"label":"Matcher","href":"/es/products/matcher/what-is-matcher"},{"label":"Flowker","href":"/es/products/flowker/what-is-flowker"},{"label":"Lender","href":"/es/products/lender/what-is-lender"},{"label":"Reporter","href":"/es/products/reporter/what-is-reporter"}]},{"header":"Pagos","items":[{"label":"Rieles Brasil","href":"/es/rails/what-are-brazil-rails"},{"label":"Interfaces","href":"/es/interfaces/introduction"},{"label":"Pix","href":"/es/interfaces/pix/pix-overview"},{"label":"TED","href":"/es/interfaces/ted/ted-overview"}]},{"header":"Desarrolladores","items":[{"label":"Referencia de API","href":"/es/reference/introduction"},{"label":"Streaming de eventos","href":"/es/reference/events/overview"},{"label":"Novedades","href":"/es/news/news"}]},{"header":"Empresa","items":[{"label":"Blog","href":"https://blog.lerian.studio/"},{"label":"Contacto","href":"https://lerian.studio/contact"},{"label":"GitHub","href":"https://github.com/LerianStudio"}]}]},"navbar":{"links":[{"icon":"newspaper","href":"https://blog.lerian.studio/","label":"Blog"}],"primary":{"type":"button","label":"Contáctanos","href":"https://lerian.studio/contact"}},"pages":[{"title":"es","href":"/es/reference/products/midaz/v2/create-holder"}]}]},"title":"Create a Holder - Lerian","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}