{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-@l10n/en-US/apis/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["cards","card"]},"type":"markdown"},"seo":{"title":"API Reference","description":"Documentação oficial da API da plataforma de crédito embarcado Dinie. Integre produtos de crédito diretamente na sua aplicação.","siteUrl":"https://docs.dinie.com","lang":"pt-BR","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-reference","__idx":0},"children":["API Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Complete reference for the Dinie REST API v3. Resource-oriented, with predictable URLs, JSON, and standard HTTP codes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-urls","__idx":1},"children":["Base URLs"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"URL"},"children":["URL"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sandbox"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://sandbox.api.dinie.com.br/v3"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Production"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.dinie.com.br/v3"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All examples in this documentation use the sandbox URL. Replace it when going to production. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/en-us/guides/going-to-production"},"children":["Going to Production"]}," guide for the full checklist."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"concepts","__idx":2},"children":["Concepts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Understand the technical fundamentals before integrating:"]},{"$$mdtype":"Tag","name":"Cards","attributes":{"columns":3,"cardMinWidth":240},"children":[{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Authentication","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/en-us/apis/concepts/authentication"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["OAuth 2.0 client credentials, access tokens, and credential rotation."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Errors","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/en-us/apis/concepts/errors"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Standard error structure, HTTP codes, error types, and resolution."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Webhooks","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/en-us/apis/concepts/webhooks"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Signature verification, retries, available events, and Standard Webhooks."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Idempotency","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/en-us/apis/concepts/idempotency"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["How to use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Idempotency-Key"]}," to ensure safe retry operations."]}]},{"$$mdtype":"Tag","name":"Card","attributes":{"title":"Pagination","imagePosition":"start","iconPosition":"auto","layout":"vertical","align":"start","variant":"filled","to":"/en-us/apis/concepts/pagination"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cursor-based pagination, listing parameters, and result navigation."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":3},"children":["Resources"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"customers","__idx":4},"children":["Customers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Register and manage customers (borrowing companies)."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/customers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Register customer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/customers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List customers"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/customers/:id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve customer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/customers/:id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update customer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/customers/:id/kyc-attachments"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Upload KYC attachment"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/customers/:id/biometrics"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Biometrics session"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"credit-offers","__idx":5},"children":["Credit Offers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Query credit offers automatically generated by Dinie's analysis."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/customers/:id/credit-offers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List customer offers"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/credit-offers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List all offers"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/credit-offers/:id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve offer"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"loans","__idx":6},"children":["Loans"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Simulate, create, and query loans from credit offers."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/credit-offers/:id/simulations"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create simulation"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/loans"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create loan"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/loans/:id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve loan"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/loans/:id/transactions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List transactions"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"webhooks","__idx":7},"children":["Webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configure endpoints to receive real-time event notifications."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/webhooks/endpoints"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create endpoint"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/webhooks/endpoints"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List endpoints"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/webhooks/endpoints/:id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve endpoint"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/webhooks/endpoints/:id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update endpoint"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/webhooks/endpoints/:id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete endpoint"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/webhooks/endpoints/:id/secret/rotate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rotate secret"]}]}]}]}]}]},"headings":[{"value":"API Reference","id":"api-reference","depth":1},{"value":"Base URLs","id":"base-urls","depth":2},{"value":"Concepts","id":"concepts","depth":2},{"value":"Resources","id":"resources","depth":2},{"value":"Customers","id":"customers","depth":3},{"value":"Credit Offers","id":"credit-offers","depth":3},{"value":"Loans","id":"loans","depth":3},{"value":"Webhooks","id":"webhooks","depth":3}],"frontmatter":{"seo":{"title":"API Reference"}},"lastModified":"2026-03-15T13:30:00.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/en-us/apis/introduction","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}