{"items":[{"type":"link","fsPath":"@l10n/en-US/apis/introduction.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/en-us/apis/introduction","routeSlug":"/en-us/apis/introduction"},{"type":"separator","label":"Concepts"},{"type":"link","fsPath":"@l10n/en-US/apis/concepts/authentication.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/en-us/apis/concepts/authentication","routeSlug":"/en-us/apis/concepts/authentication"},{"type":"link","fsPath":"@l10n/en-US/apis/concepts/errors.md","metadata":{"type":"markdown"},"label":"Errors","link":"/en-us/apis/concepts/errors","routeSlug":"/en-us/apis/concepts/errors"},{"type":"link","fsPath":"@l10n/en-US/apis/concepts/webhooks.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/en-us/apis/concepts/webhooks","routeSlug":"/en-us/apis/concepts/webhooks"},{"type":"link","fsPath":"@l10n/en-US/apis/concepts/idempotency.md","metadata":{"type":"markdown"},"label":"Idempotency","link":"/en-us/apis/concepts/idempotency","routeSlug":"/en-us/apis/concepts/idempotency"},{"type":"link","fsPath":"@l10n/en-US/apis/concepts/pagination.md","metadata":{"type":"markdown"},"label":"Pagination","link":"/en-us/apis/concepts/pagination","routeSlug":"/en-us/apis/concepts/pagination"},{"type":"link","fsPath":"@l10n/en-US/apis/concepts/conventions.md","metadata":{"type":"markdown"},"label":"Conventions","link":"/en-us/apis/concepts/conventions","routeSlug":"/en-us/apis/concepts/conventions"},{"type":"separator","label":"Endpoints"},{"type":"link","label":"Dinie API","link":"/en-us/apis/openapi","routeSlug":"/en-us/apis/openapi"},{"type":"group","label":"Authentication","link":"/en-us/apis/openapi/authentication","routeSlug":"/en-us/apis/openapi/authentication","items":[{"label":"Get an access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/authentication/createtoken","routeSlug":"/en-us/apis/openapi/authentication/createtoken","metadata":{"seo":{"title":"Get an access token","description":"POST /auth/token"}},"httpPath":"/auth/token"},{"label":"Create an API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/authentication/createcredential","routeSlug":"/en-us/apis/openapi/authentication/createcredential","metadata":{"seo":{"title":"Create an API key","description":"POST /auth/credentials"}},"httpPath":"/auth/credentials"},{"label":"List API keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/authentication/listcredentials","routeSlug":"/en-us/apis/openapi/authentication/listcredentials","metadata":{"seo":{"title":"List API keys","description":"GET /auth/credentials"}},"httpPath":"/auth/credentials"},{"label":"Revoke an API key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/authentication/revokecredential","routeSlug":"/en-us/apis/openapi/authentication/revokecredential","metadata":{"seo":{"title":"Revoke an API key","description":"DELETE /auth/credentials/{client_id}"}},"httpPath":"/auth/credentials/{client_id}"}]},{"type":"group","label":"Customers","link":"/en-us/apis/openapi/customers","routeSlug":"/en-us/apis/openapi/customers","items":[{"label":"Register a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/customers/createcustomer","routeSlug":"/en-us/apis/openapi/customers/createcustomer","metadata":{"seo":{"title":"Register a customer","description":"POST /customers"}},"httpPath":"/customers"},{"label":"List customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/customers/listcustomers","routeSlug":"/en-us/apis/openapi/customers/listcustomers","metadata":{"seo":{"title":"List customers","description":"GET /customers"}},"httpPath":"/customers"},{"label":"Get a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/customers/getcustomer","routeSlug":"/en-us/apis/openapi/customers/getcustomer","metadata":{"seo":{"title":"Get a customer","description":"GET /customers/{customer_id}"}},"httpPath":"/customers/{customer_id}"},{"label":"Update customer data","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/customers/updatecustomer","routeSlug":"/en-us/apis/openapi/customers/updatecustomer","metadata":{"seo":{"title":"Update customer data","description":"PATCH /customers/{customer_id}"}},"httpPath":"/customers/{customer_id}"},{"label":"Upload a KYC attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/customers/uploadkycattachment","routeSlug":"/en-us/apis/openapi/customers/uploadkycattachment","metadata":{"seo":{"title":"Upload a KYC attachment","description":"POST /customers/{customer_id}/kyc-attachments"}},"httpPath":"/customers/{customer_id}/kyc-attachments"},{"label":"Get customer bank account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/customers/getcustomerbankaccount","routeSlug":"/en-us/apis/openapi/customers/getcustomerbankaccount","metadata":{"seo":{"title":"Get customer bank account","description":"GET /customers/{customer_id}/bank-account"}},"httpPath":"/customers/{customer_id}/bank-account"},{"label":"Create or update customer bank account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/customers/upsertcustomerbankaccount","routeSlug":"/en-us/apis/openapi/customers/upsertcustomerbankaccount","metadata":{"seo":{"title":"Create or update customer bank account","description":"POST /customers/{customer_id}/bank-account"}},"httpPath":"/customers/{customer_id}/bank-account"},{"label":"List banks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/customers/listbanks","routeSlug":"/en-us/apis/openapi/customers/listbanks","metadata":{"seo":{"title":"List banks","description":"GET /banks"}},"httpPath":"/banks"},{"label":"Start biometrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/customers/createbiometricssession","routeSlug":"/en-us/apis/openapi/customers/createbiometricssession","metadata":{"seo":{"title":"Start biometrics","description":"POST /customers/{customer_id}/biometrics"}},"httpPath":"/customers/{customer_id}/biometrics"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Customer created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/customers/oncustomercreated","routeSlug":"/en-us/apis/openapi/customers/oncustomercreated","metadata":{"seo":{"title":"Customer created","description":"Fires when the customer reaches pending_kyc status after async enrichment completes.Includes the full enriched data (trading_name, KYC requirements).This is the moment to start collecting KYC documents from the customer."}},"httpPath":"customer.created"},{"label":"Customer under review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/customers/oncustomerunderreview","routeSlug":"/en-us/apis/openapi/customers/oncustomerunderreview","metadata":{"seo":{"title":"Customer under review","description":"Fires when all required KYC documents have been submitted and the credit reviewis started by Dinie. Includes the customer ID and under_review status.Use it to update the status in your system and inform the customer that the review is in progress."}},"httpPath":"customer.under_review"},{"label":"Customer KYC updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/customers/oncustomerkycupdated","routeSlug":"/en-us/apis/openapi/customers/oncustomerkycupdated","metadata":{"seo":{"title":"Customer KYC updated","description":"Fires when any KYC requirement changes status (approved, rejected, orpending correction). Includes the full kyc array with the updated status ofeach item. Use it to identify rejected documents and request resubmission from the customervia PATCH /customers/{id} or POST /customers/{id}/kyc-attachments."}},"httpPath":"customer.kyc_updated"},{"label":"Customer active","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/customers/oncustomeractive","routeSlug":"/en-us/apis/openapi/customers/oncustomeractive","metadata":{"seo":{"title":"Customer active","description":"Fires when the customer is fully verified (KYC approved) — registration is complete.Note: active means KYC complete, NOT credit eligible. Eligibility is determinedby CreditOffer availability. Includes the customer ID and active status. QueryGET /customers/{id}/credit-offers to check for available pre-approved offers."}},"httpPath":"customer.active"},{"label":"Customer denied","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/customers/oncustomerdenied","routeSlug":"/en-us/apis/openapi/customers/oncustomerdenied","metadata":{"seo":{"title":"Customer denied","description":"Fires when the customer is permanently blocked (fraud, closed company atReceita Federal, or other terminal condition). This is a terminal state —the customer cannot proceed. Includes the customer ID and denied status."}},"httpPath":"customer.denied"}]},{"type":"group","label":"Credit Offers","link":"/en-us/apis/openapi/credit-offers","routeSlug":"/en-us/apis/openapi/credit-offers","items":[{"label":"List customer credit offers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/credit-offers/listcustomercreditoffers","routeSlug":"/en-us/apis/openapi/credit-offers/listcustomercreditoffers","metadata":{"seo":{"title":"List customer credit offers","description":"GET /customers/{customer_id}/credit-offers"}},"httpPath":"/customers/{customer_id}/credit-offers"},{"label":"List credit offers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/credit-offers/listcreditoffers","routeSlug":"/en-us/apis/openapi/credit-offers/listcreditoffers","metadata":{"seo":{"title":"List credit offers","description":"GET /credit-offers"}},"httpPath":"/credit-offers"},{"label":"Get a credit offer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/credit-offers/getcreditoffer","routeSlug":"/en-us/apis/openapi/credit-offers/getcreditoffer","metadata":{"seo":{"title":"Get a credit offer","description":"GET /credit-offers/{credit_offer_id}"}},"httpPath":"/credit-offers/{credit_offer_id}"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Credit offer available","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/credit-offers/oncreditofferavailable","routeSlug":"/en-us/apis/openapi/credit-offers/oncreditofferavailable","metadata":{"seo":{"title":"Credit offer available","description":"Fires when Dinie generates a new pre-approved credit offer for the customer.Includes approved amount, interest rate, installments, and offer expiration date.Use it to notify the customer about credit availability and start the simulation flowvia POST /credit-offers/{id}/simulations."}},"httpPath":"credit_offer.available"},{"label":"Credit offer expired","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/credit-offers/oncreditofferexpired","routeSlug":"/en-us/apis/openapi/credit-offers/oncreditofferexpired","metadata":{"seo":{"title":"Credit offer expired","description":"Fires when a credit offer expires after exceeding its expiration date(valid_until). Includes the full offer data with expired status.Use it to remove the offer from the customer interface. New offers may be generatedin the future via credit_offer.available."}},"httpPath":"credit_offer.expired"}]},{"type":"group","label":"Loans","link":"/en-us/apis/openapi/loans","routeSlug":"/en-us/apis/openapi/loans","items":[{"label":"Simulate a loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/loans/createsimulation","routeSlug":"/en-us/apis/openapi/loans/createsimulation","metadata":{"seo":{"title":"Simulate a loan","description":"POST /credit-offers/{credit_offer_id}/simulations"}},"httpPath":"/credit-offers/{credit_offer_id}/simulations"},{"label":"Create a loan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/loans/createloan","routeSlug":"/en-us/apis/openapi/loans/createloan","metadata":{"seo":{"title":"Create a loan","description":"POST /loans"}},"httpPath":"/loans"},{"label":"Get a loan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/loans/getloan","routeSlug":"/en-us/apis/openapi/loans/getloan","metadata":{"seo":{"title":"Get a loan","description":"GET /loans/{loan_id}"}},"httpPath":"/loans/{loan_id}"},{"label":"List transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/loans/listtransactions","routeSlug":"/en-us/apis/openapi/loans/listtransactions","metadata":{"seo":{"title":"List transactions","description":"GET /loans/{loan_id}/transactions"}},"httpPath":"/loans/{loan_id}/transactions"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Loan created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/loans/onloancreated","routeSlug":"/en-us/apis/openapi/loans/onloancreated","metadata":{"seo":{"title":"Loan created","description":"Fires when the loan is created via POST /loans from an accepted offer.CCB contract is generated synchronously. Includes the loan, offer, and customer IDs,requested amount, number of installments, and signing_url for contract signing.The loan starts with awaiting_signatures status. Present the signing link to the customer."}},"httpPath":"loan.created"},{"label":"Signature received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/loans/onloansignaturereceived","routeSlug":"/en-us/apis/openapi/loans/onloansignaturereceived","metadata":{"seo":{"title":"Signature received","description":"Fires each time an individual signer completes their signature on the CCB contract.Includes signer identity (name, CPF), signature timestamp, and progress count(signatures_received / signatures_required). Use it to track signing progressand notify the customer about remaining signatures."}},"httpPath":"loan.signature_received"},{"label":"Loan processing","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/loans/onloanprocessing","routeSlug":"/en-us/apis/openapi/loans/onloanprocessing","metadata":{"seo":{"title":"Loan processing","description":"Fires when all required signatures are collected and disbursement is in progress.The loan transitions to processing status. Use it to inform the customer thatthe funds are being transferred."}},"httpPath":"loan.processing"},{"label":"Loan active","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/loans/onloanactive","routeSlug":"/en-us/apis/openapi/loans/onloanactive","metadata":{"seo":{"title":"Loan active","description":"Fires when the disbursement is confirmed and the loan enters the repayment phase.Includes the requested amount (requested_amount) and the principal amount received (principal_amount).Use it to confirm to the customer that the funds have been credited and present the installment schedule."}},"httpPath":"loan.active"},{"label":"Loan payment received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/loans/onloanpaymentreceived","routeSlug":"/en-us/apis/openapi/loans/onloanpaymentreceived","metadata":{"seo":{"title":"Loan payment received","description":"Fires when an installment payment is recorded for the loan. Includes the amount paid, payment date, and corresponding installment number. Use it to update the outstanding balance in your system and notify the customer about the payment confirmation."}},"httpPath":"loan.payment_received"},{"label":"Loan finished","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/loans/onloanfinished","routeSlug":"/en-us/apis/openapi/loans/onloanfinished","metadata":{"seo":{"title":"Loan finished","description":"Fires when all loan installments are paid off and the contract is closed.Includes the loan ID and finished status. Use it to mark the loan ascompleted in your system and check if new credit offers are available."}},"httpPath":"loan.finished"},{"label":"Loan cancelled","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/loans/onloancancelled","routeSlug":"/en-us/apis/openapi/loans/onloancancelled","metadata":{"seo":{"title":"Loan cancelled","description":"Fires when the loan is cancelled before disbursement is completed. Includes the loan IDand cancelled status. Use it to update the status in your system andinform the customer. The original credit offer may still be available for a new request."}},"httpPath":"loan.cancelled"},{"label":"Loan error","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en-us/apis/openapi/loans/onloanerror","routeSlug":"/en-us/apis/openapi/loans/onloanerror","metadata":{"seo":{"title":"Loan error","description":"Fires when an unrecoverable error occurs in the loan, such as a disbursement failureor contract generation error. Includes the error code and message in the error field.Use it to alert your team, log the issue, and inform the customer about the situation."}},"httpPath":"loan.error"}]},{"type":"group","label":"Webhooks","link":"/en-us/apis/openapi/webhooks","routeSlug":"/en-us/apis/openapi/webhooks","items":[{"label":"Create a webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/webhooks/createwebhookendpoint","routeSlug":"/en-us/apis/openapi/webhooks/createwebhookendpoint","metadata":{"seo":{"title":"Create a webhook","description":"POST /webhooks/endpoints"}},"httpPath":"/webhooks/endpoints"},{"label":"List webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/webhooks/listwebhookendpoints","routeSlug":"/en-us/apis/openapi/webhooks/listwebhookendpoints","metadata":{"seo":{"title":"List webhooks","description":"GET /webhooks/endpoints"}},"httpPath":"/webhooks/endpoints"},{"label":"Get a webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/webhooks/getwebhookendpoint","routeSlug":"/en-us/apis/openapi/webhooks/getwebhookendpoint","metadata":{"seo":{"title":"Get a webhook","description":"GET /webhooks/endpoints/{webhook_endpoint_id}"}},"httpPath":"/webhooks/endpoints/{webhook_endpoint_id}"},{"label":"Update a webhook","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/webhooks/updatewebhookendpoint","routeSlug":"/en-us/apis/openapi/webhooks/updatewebhookendpoint","metadata":{"seo":{"title":"Update a webhook","description":"PATCH /webhooks/endpoints/{webhook_endpoint_id}"}},"httpPath":"/webhooks/endpoints/{webhook_endpoint_id}"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/webhooks/deletewebhookendpoint","routeSlug":"/en-us/apis/openapi/webhooks/deletewebhookendpoint","metadata":{"seo":{"title":"Delete a webhook","description":"DELETE /webhooks/endpoints/{webhook_endpoint_id}"}},"httpPath":"/webhooks/endpoints/{webhook_endpoint_id}"},{"label":"Rotate the secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/webhooks/rotatewebhooksecret","routeSlug":"/en-us/apis/openapi/webhooks/rotatewebhooksecret","metadata":{"seo":{"title":"Rotate the secret","description":"POST /webhooks/endpoints/{webhook_endpoint_id}/rotate-secret"}},"httpPath":"/webhooks/endpoints/{webhook_endpoint_id}/rotate-secret"},{"label":"List webhook deliveries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/webhooks/listwebhookdeliveries","routeSlug":"/en-us/apis/openapi/webhooks/listwebhookdeliveries","metadata":{"seo":{"title":"List webhook deliveries","description":"GET /webhooks/endpoints/{endpoint_id}/deliveries"}},"httpPath":"/webhooks/endpoints/{endpoint_id}/deliveries"},{"label":"Retry a webhook delivery","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en-us/apis/openapi/webhooks/retrywebhookdelivery","routeSlug":"/en-us/apis/openapi/webhooks/retrywebhookdelivery","metadata":{"seo":{"title":"Retry a webhook delivery","description":"POST /webhooks/endpoints/{endpoint_id}/deliveries/{id}/retry"}},"httpPath":"/webhooks/endpoints/{endpoint_id}/deliveries/{id}/retry"}]}]}