16:["$","$L25",null,{"lang":"en","namespaces":{"common":{"submit":"Submit","sendMessage":"SEND MESSAGE","example":"Example","parameters":"Parameters","responses":"Responses","allDocs":"All Docs","back":"Back","latest":"latest","goTo":"Go to {{placeholder}}","header":{"logo":{"alt":"Circle Docs"},"links":{"apiPlayground":"API Reference","faucet":"Faucet","releaseNotes":"Release Notes","feedback":"Give Feedback","help":"Help","console":"Get API keys","apisAndSdks":"APIs & SDKs","sdk":"SDKs","sampleProjects":"Sample Projects","sdkExplorer":"SDK Explorer","home":"Home"}},"homePage":{"header":{"title":"Circle Docs","description":"Explore our guides and examples to build on the Circle platform."},"getStarted":{"header":"How would you like to get started?","topCards":[{"href":"/interactive-quickstarts","title":"Interactive Quickstarts","description":"Experience our guided tutorials before diving into the code.","cta":"Try it out"},{"href":"/sdks","title":"SDKs","description":"Explore our server-side and client-side SDKs to start building fast.","cta":"View now"},{"href":"/sample-projects","title":"Sample Apps","description":"Explore our range of open-source sample projects for inspiration.","cta":"View demos"},{"href":"/api-reference/w3s/common/ping","title":"API Reference","description":"See code snippets for Circle's APIs in Node.js, Python, and more.","cta":"View reference"}],"bottomCards":[{"href":"https://faucet.circle.com","title":"Testnet Faucet","description":"Get free testnet USDC & EURC.","cta":"Get testnet USDC"},{"href":"/stablecoins/usdc-on-test-networks","title":"Token Addresses","description":"Verify the token addresses for USDC and EURC on supported blockchains.","cta":"View now"}]},"productsAndFeatures":{"header":"Circle Platform","sections":[{"header":"Stablecoins","intro":"Regulated digital currencies issued on blockchains supported by global banks.","cardsTop":[{"href":"/stablecoins/what-is-usdc","title":"USDC"},{"href":"/stablecoins/eurc-on-test-networks","title":"EURC"},{"href":"https://www.circle.com/en/bridged-usdc","title":"Bridged USDC Standard"}]},{"header":"Developer Services","intro":"Enterprise-grade smart contracts, APIs, and SDKs to power apps with stablecoins.","cardsTop":[{"href":"/w3s/programmable-wallets","title":"Wallets"},{"href":"/w3s/smart-contract-platform","title":"Contracts"},{"href":"/stablecoins/cctp-getting-started","title":"CCTP"},{"href":"/stablecoins/paymaster-overview","title":"Paymaster"}]},{"header":"Liquidity Services","intro":"Institutional minting, redemption, and FX services for stablecoins.","cardsTop":[{"href":"/circle-mint/introducing-circle-mint","title":"Mint"}]}]},"startBuildingBanner":{"title":"Start building for free today","description":"Design scalable and elegant on-chain experiences in hours vs. weeks.","path":"https://console.circle.com/signin","cta":"Sign up"},"releaseNotes":{"header":"Release notes","intro":"Intro text"},"buildWithConfidence":{"eyebrow":"Resources","header":"Build with confidence","cards":[{"href":"https://usdc-finder.circle.com","title":"Find USDC on/off-ramps","description":"Use our interactive tool to find the best provider for your needs.","icon":"SearchOutline"},{"href":"https://www.circle.com/blog/tag/developer","title":"Blog","description":"Explore use cases, recent updates, and success stories","icon":"DocumentTextOutline"},{"href":"https://discord.com/invite/buildoncircle","title":"Join Discord","description":"Connect with like-minded builders","icon":"ChatOutline"},{"href":"https://www.circle.com/en/usdc-grant-program","title":"Developer Grants","description":"Grants for developers leveraging USDC to create practical solutions","icon":"CoinOutline"},{"href":"https://www.circle.com/en/credits-program","title":"Circle Credits","description":"Lower the cost of building on-chain apps so you can focus on innovation and quickly get to market","icon":"MultiTokenOutline"},{"href":"https://www.circle.com/en/circle-research","title":"Circle Research","description":"Open-source contributions to the public good to accelerate crypto innovation","icon":"BeakerOutline"}]},"joinCommunity":{"eyebrow":"Community","header":"Join our thriving community","testimonials":{"title":"Testimonials","description":"Hear from developers building with Circle's platform","cta":"Explore","href":"https://www.circle.com/en/developer/testimonials"},"followUs":{"title":"Follow us","discord":{"label":"Discord","href":"https://discord.com/invite/buildoncircle"},"youtube":{"label":"Youtube","href":"https://www.youtube.com/c/Circlecryptofinance"},"twitter":{"label":"Twitter","href":"https://x.com/buildoncircle"}}}},"footer":{"copyright":"© 2023-{{ currentDate }} Circle Technology Services, LLC. All rights reserved.","links":{"developerTerms":"Developer Terms","serviceTerms":"Service Terms","privacyPolicy":"Privacy Policy","acceptableUse":"Acceptable Use","cookiePolicy":"Cookie Policy","privacyPolicyChoice":"Your Privacy Choices"}},"errorPage":{"title":"Oops","description1":"Sorry, something went wrong.","description2":"Our team is looking into it.","buttonLabel":"Try again","backgroundImageAlt":"Background image"},"sdkSampleCard":{"product":"Product","languages":"Languages","platforms":"Platforms","features":"Features","ios":"iOS","android":"Android","react":"React","web":"Web"},"forms":{"validation":{"apiKey":"Please provide a valid API Key.","required":"This field is required.","optionality":"This field is required.","email":"Please enter a valid email address.","minLength":"Minimum {{ min }} characters.","minValue":"Minimum value: {{ min }}.","maxLength":"Maximum {{ max }} characters.","maxValue":"Maximum value: {{ max }}.","length":"Must be {{ length }} characters.","uuid":"Please enter a valid UUID.","walletId":"Please enter a valid Wallet ID.","testnetApiKey":"Please provide a valid Testnet API Key.","entitySecret":"Entity secret must be 64 lowercase alphanumeric characters.","blockchainAddress":"Please enter a valid blockchain address.","number":"Please enter a valid number.","integer":"Please enter a valid integer.","positive":"Please enter a positive number.","anyOf":"Must be of type: {{ types }}.","any":"Please enter a valid type.","blockchain":{"ALGO":"Please enter a valid wallet address for Algorand","APTOS":"Please enter a valid wallet address for Aptos","ARB":"Please enter a valid wallet address for Arbitrum","AVAX":"Please enter a valid wallet address for Avalanche","BTC":"Please enter a valid wallet address for Bitcoin","BASE":"Please enter a valid wallet address for Base","CELO":"Please enter a valid wallet address for Celo","ETH":"Please enter a valid wallet address for Ethereum","EVMOS":"Please enter a valid wallet address for Evmos","HBAR":"Please enter a valid wallet address for Hedera","MANA":"Please enter a valid wallet address for Mana","MATIC":"Please enter a valid wallet address for Polygon","NEAR":"Please enter a valid wallet address for NEAR","NOBLE":"Please enter a valid wallet address for Noble","OP":"Please enter a valid wallet address for OP","POLY":"Please enter a valid wallet address for Polygon","SOL":"Please enter a valid wallet address for Solana","PAH":"Please enter a valid wallet address for Polkadot Asset Hub","SUI":"Please enter a valid wallet address for Sui","TRX":"Please enter a valid wallet address for Tron","UNI":"Please enter a valid wallet address for Unichain","XLM":"Please enter a valid wallet address for Stellar","XRP":"Please enter a valid wallet address for XRP Ledger","ZKS":"Please enter a valid wallet address for zkSync","default":"Please enter a valid wallet address"}},"usdcAccessForm":{"firstName":"First name","lastName":"Last name","businessName":"Business name","businessEmail":"Business email","countriesOfOperation":"Countries of operation","countriesOfOperationItems":["Afghanistan","Åland Islands","Albania","Algeria","American Samoa","Andorra","Angola","Anguilla","Antarctica","Antigua and Barbuda","Argentina","Armenia","Aruba","Australia","Austria","Azerbaijan","Bahamas","Bahrain","Bangladesh","Barbados","Belarus","Belgium","Belize","Benin","Bermuda","Bhutan","Bolivia","Bosnia and Herzegovina","Botswana","Bouvet Island","Brazil","British Indian Ocean Territory","Brunei Darussalam","Bulgaria","Burkina Faso","Burundi","Cambodia","Cameroon","Canada","Cape Verde","Cayman Islands","Central African Republic","Chad","Chile","China","Christmas Island","Cocos (Keeling) Islands","Colombia","Comoros","Congo","Congo, The Democratic Republic of The","Cook Islands","Costa Rica","Cote D'ivoire","Croatia","Cuba","Cyprus","Czech Republic","Denmark","Djibouti","Dominica","Dominican Republic","Ecuador","Egypt","El Salvador","Equatorial Guinea","Eritrea","Estonia","Ethiopia","Falkland Islands (Malvinas)","Faroe Islands","Fiji","Finland","France","French Guiana","French Polynesia","French Southern Territories","Gabon","Gambia","Georgia","Germany","Ghana","Gibraltar","Greece","Greenland","Grenada","Guadeloupe","Guam","Guatemala","Guernsey","Guinea","Guinea-bissau","Guyana","Haiti","Heard Island and Mcdonald Islands","Holy See (Vatican City State)","Honduras","Hong Kong","Hungary","Iceland","India","Indonesia","Iran, Islamic Republic of","Iraq","Ireland","Isle of Man","Israel","Italy","Jamaica","Japan","Jersey","Jordan","Kazakhstan","Kenya","Kiribati","Korea, Democratic People's Republic of","Korea, Republic of","Kuwait","Kyrgyzstan","Lao People's Democratic Republic","Latvia","Lebanon","Lesotho","Liberia","Libyan Arab Jamahiriya","Liechtenstein","Lithuania","Luxembourg","Macao","Macedonia, The Former Yugoslav Republic of","Madagascar","Malawi","Malaysia","Maldives","Mali","Malta","Marshall Islands","Martinique","Mauritania","Mauritius","Mayotte","Mexico","Micronesia, Federated States of","Moldova, Republic of","Monaco","Mongolia","Montenegro","Montserrat","Morocco","Mozambique","Myanmar","Namibia","Nauru","Nepal","Netherlands","Netherlands Antilles","New Caledonia","New Zealand","Nicaragua","Niger","Nigeria","Niue","Norfolk Island","Northern Mariana Islands","Norway","Oman","Pakistan","Palau","Palestinian Territory, Occupied","Panama","Papua New Guinea","Paraguay","Peru","Philippines","Pitcairn","Poland","Portugal","Puerto Rico","Qatar","Reunion","Romania","Russian Federation","Rwanda","Saint Helena","Saint Kitts and Nevis","Saint Lucia","Saint Pierre and Miquelon","Saint Vincent and The Grenadines","Samoa","San Marino","Sao Tome and Principe","Saudi Arabia","Senegal","Serbia","Seychelles","Sierra Leone","Singapore","Slovakia","Slovenia","Solomon Islands","Somalia","South Africa","South Georgia and The South Sandwich Islands","Spain","Sri Lanka","Sudan","Suriname","Svalbard and Jan Mayen","Swaziland","Sweden","Switzerland","Syrian Arab Republic","Taiwan","Tajikistan","Tanzania, United Republic of","Thailand","Timor-leste","Togo","Tokelau","Tonga","Trinidad and Tobago","Tunisia","Turkey","Turkmenistan","Turks and Caicos Islands","Tuvalu","Uganda","Ukraine","United Arab Emirates","United Kingdom","United States","United States Minor Outlying Islands","Uruguay","Uzbekistan","Vanuatu","Venezuela","Viet Nam","Virgin Islands, British","Virgin Islands, U.S.","Wallis and Futuna","Western Sahara","Yemen","Zambia","Zimbabwe"],"importanceForUsers":"Why is it important to provide access to USDC for your users? Select all that apply.","importanceForUsersItems":["On / off ramp from fiat","On / off ramp from other crypto assets","Top-up use cases","Enable cross border transfers","Enable remittance use cases","USDC will be used in the background, as a USD equivalent to move funds","Other"],"endCustomer":"Who is your end customer?","endCustomerItems":["Retail consumers","Businesses"],"stoppingYouToday":"What is stopping you from providing USDC to your users today? Select all that apply.","stoppingYouTodayItems":["Lack of on and off ramps in the geos we operate","We want to stay out of the fund flow (no licenses)","We don't have the right KYC/KYB processes set up","The costs / rates to on and off ramp USDC are too expensive for users","Integration issues with on and off ramp providers","Other"],"userBaseSize":"What is the size of your user base?","userBaseSizeItems":["0-25 end customers","26-100","101-500","501-1000","1000+"],"expectedMonthlyVolume":"What is the expected monthly volume of USDC transactions from each of your end users?","expectedMonthlyVolumeItems":["0-100 USDC","101-250","251-500","501-1000","1000+"],"formFactor":"What form factor do you need to enable access to USDC to your end customers?","formFactorItems":["SDKs","APIs","Embeddable Widget"],"questions":"What questions do you have about USDC Access?","placeholders":{"selectAll":"Select all that apply ...","selectOption":"Select an option ..."},"userAgreement":{"text":"I agree to the <0>User Agreement, <1>Privacy Policy, <2>Acceptable Use Policy, <3>Cookie Policy, <4>E-Sign Consent, and <5>Risk Factors.","links":{"userAgreement":"https://www.circle.com/en/legal/user-agreement","privacyPolicy":"https://www.circle.com/en/legal/privacy-policy","acceptableUsePolicy":"https://www.circle.com/en/legal/acceptable-use-policy","cookiePolicy":"https://www.circle.com/en/legal/cookie-policy","esignConsent":"https://www.circle.com/en/legal/esign-consent","usdcRiskFactors":"https://www.circle.com/en/legal/usdc-risk-factors"}},"disclaimer":"The platform and related software for the USDC partner network is offered by Circle Technology Services, LLC ('CTS'), an affiliate of Circle Internet Financial, LLC ('Circle LLC'). CTS is not a regulated financial services company and neither CTS nor Circle LLC are providing financial, investment, tax, legal, regulatory, accounting, business, or other advice in relation to your use of the USDC partner network.","submissionRecorded":"Thank you! Your submission has been recorded."},"multiSelect":{"clearButtonLabel":"Clear","noResultsMessage":"No entry matches the query","noItemsMessage":"No entries found"}},"modals":{"sendFeedback":{"title":"Give Feedback","error":{"title":"Something went wrong","description":"We were unable to submit your feedback. Please try again at a later time."},"labels":{"email":"Email address","completed":"I completed the Interactive Tutorial","feedback":"Your feedback"},"success":"Thank you for your feedback","score":{"label":"How helpful did you find the Interactive Tutorial?","helpful":"Helpful","notHelpful":"Not helpful"},"discord":{"title":"Join our Discord community","action":"Join Discord","link":"https://discord.com/invite/buildoncircle"},"reachOut":{"title":"Reach out directly","email":"customer-support@circle.com"},"featureRequest":{"title":"Have a feature or docs request?","action":"Submit a proposal"}},"submitFeatureRequest":{"title":"Make a request","description":"Thank you for taking the time to fill out this survey. We look forward to seeing what you build 🚀","button":{"back":"Back","next":"Next","submit":"Submit"},"questions":{"requestType":"What best describes your request?","products":"Which product is your feature request for? Select all that apply.","description":"Describe your feature request with as much detail as possible.","email":"What is your email address? We require your email address to verify your feature request.","consent":"Would you consent to being contacted regarding your feature request if we have any questions?"},"requestTypes":{"0":{"icon":"🏗️","description":"Feature Request: a new capability or improvement to the product"},"1":{"icon":"📖","description":"Content Request: creation, update, or optimization of informational or educational content related to the product"},"2":{"icon":"🌐","description":"Community Request: ideas on how we can improve our community, for example additional workshops or events"}},"products":{"wallets":"Programmable Wallets","scp":"Smart Contract Platform","gas":"Gas station","cctp":"CCTP","usdc":"USDC","eurc":"EURC"},"yes":"Yes","no":"No"},"success":{"title":"Thank you!","discord":{"title":"Join our Discord community","action":"Join Discord","link":"https://discord.com/invite/buildoncircle"},"featureRequest":{"title":"Have a feature or docs request?","action":"Submit a proposal"},"response":"Responses will be sent to your email at"}},"notFound":{"title":"ERC-404: Non-fungible page","subtitle":"Looks like this is a one-of-a-kind disappearance!","searchResultTitle":"Did you mean?"},"social":{"twitter":{"alt":"X/Twitter","src":"https://x.com/BuildOnCircle"},"instagram":{"alt":"Instagram","src":"https://www.instagram.com/teamcircle/?hl=en"},"linkedin":{"alt":"Linkedin","src":"https://www.linkedin.com/company/circle-internet-financial/"},"discord":{"alt":"Discord","src":"https://discord.com/invite/buildoncircle"},"moneyMovement":{"alt":"Money Movement","src":"https://www.circle.com/en/the-money-movement"},"youtube":{"alt":"YouTube","src":"https://www.youtube.com/c/Circlecryptofinance"}},"links":{"legal":{"privacyPolicy":"https://www.circle.com/en/legal/privacy-policy","licenses":"https://www.circle.com/en/legal/licenses","developerTerms":"https://console.circle.com/legal/developer-terms"}}},"algolia":{"modals":{"search":{"title":"Documentation","noResults":"No results for"}},"components":{"search":{"placeholder":"Search"}}},"quickstart":{"tutorials":{"ucw":{"tag":"Circle Wallets","title":"User-Controlled Wallets","description":"Learn how to set up non-custodial wallets for your end-users and initiate a transfer for them.","link":"/quickstarts/user-controlled-wallets","migratedLink":"/interactive-quickstarts/user-controlled-wallets","webSDK":{"title":"Try it out:","appIdHint":"See how to get this","submit":"Execute","successMessage":"Your challenge was successful"}},"dcw":{"tag":"Circle Wallets","title":"Developer-Controlled Wallets","description":"Will show you how to set up custodial wallets by establishing your entity secret and how to initiate a transaction.","link":"/quickstarts/dev-controlled-wallets","migratedLink":"/interactive-quickstarts/dev-controlled-wallets"},"cctp":{"tag":"Circle Wallets","title":"Using CCTP with Circle Wallets","description":"Walkthrough of using the Cross-Chain Transfer Protocol (CCTP) with Circle Wallets, which allows you to bridge USDC across Blockchains.","link":"/quickstarts/cctp","migratedLink":"/interactive-quickstarts/cctp"}}},"content":{"Challenge":"Challenges in User-Controlled Wallets serve as checkpoints where users are required to enter their PIN code to authorize sensitive actions like transactions and smart contract executions. When users are first created, the initial challenge prompts them to set their PIN code and Recovery Method, enabling them to recover access if needed.","App ID":"AKA Application ID is a unique identifier assigned to your application. It serves as a key that allows you to configure and manage various settings specific to your User-Controlled Wallet integration. The App ID is essential for identifying your application and enabling communication with the Circle Platform APIs.","Faucet":"A blockchain faucet is a website or online platform that provides small amounts of cryptocurrency for free or in exchange for simple tasks. These faucets are primarily used on testnets, which simulate the live environment without real tokens or money. Blockchain faucets are used to test and develop applications, ensuring a safe and controlled environment for experimentation without the need for actual funds.","Gas fees":"Gas fees represent the cost of executing transactions on the blockchain network. These fees vary based on factors such as network congestion and transaction complexity.","Ciphertext":"refers to the encrypted form of plain text that is transformed using cryptographic algorithms. It is the result of applying encryption techniques to the original message, making it unreadable to anyone without the decryption key or appropriate knowledge. Ciphertext acts as a security measure, ensuring the confidentiality and integrity of sensitive information during communication or storage. Reverse operations, such as decryption, are required to convert ciphertext back into the original readable plaintext.","RSA encryption":"is a widely used asymmetric encryption algorithm. RSA encryption involves two keys, a public key and a private key. The public key is used for encryption, while the private key is used for decryption. The keys are mathematically related, but it is computationally infeasible to determine the private key from the public key. RSA encryption is widely used for secure communication, digital signatures, and key exchange protocols. Its security relies on the difficulty of factoring large numbers into prime factors, making it resistant to attacks from classical and quantum computers when sufficiently large keys are used.","Entity Secret":"The Entity Secret is a 32-byte private key designed to secure your Developer-Controlled wallets. It acts as your secret password, your personalized cryptographic stamp, known only to you. Our platform does not store the Entity Secret. This ensures that only you have the ability to invoke private keys, maintaining complete control. It is therefore your responsibility to safeguard this secret.","Hierarchical Deterministic (HD) wallet":"A Hierarchical Deterministic (HD) wallet is a type of cryptocurrency wallet that generates a hierarchical tree-like structure of addresses derived from a single root seed. This seed is typically represented as a mnemonic phrase or a random number. HD wallets are designed to simplify the management of multiple addresses and improve privacy. With an HD wallet, a unique key pair is derived for each address, but all keys are mathematically linked to the original root seed. This hierarchical structure enables the wallet to generate an unlimited number of addresses without needing separate backups for each one. Additionally, it ensures that public keys can be derived without revealing the private keys, enhancing security. HD wallets offer benefits such as ease of use, efficient key management, and simplified backup and recovery processes. By organizing addresses hierarchically, users can generate new addresses deterministically while maintaining a comprehensive overview of their wallet's entire address space.","Gas Station policy":"A Gas Station Policy refers to the configuration set on a blockchain network to utilize Circle's managed Paymaster, known as Gas Station. It allows you to define what transactions you are willing to sponsor on behalf of your users. When a transaction meets the specified configuration, Circle's Paymaster covers the associated gas fees. Note a policy is required to enable the Gas Station functionality on the Mainnet.","Testnet":"A blockchain Testnet is a separate and independent network designed for testing and development purposes. It allows blockchain developers and users to experiment, validate, and refine their applications, smart contracts, and functionalities without using real or valuable assets on the main blockchain network.","Entity Secret Ciphertext":"The Entity Secret Ciphertext is an RSA encryption value generated from your Entity Secret and Circle's public key. This asymmetrically encrypted value is sent in API requests like wallet creation or transaction initiation to ensure secure critical actions. This process enables safe usage of the Entity Secret to ensure it cannot be easily accessed or misused.","Smart Contract":"A smart contract is a contract on the blockchain facilitated, verified, or enforced automatically via a computer protocol, with no third-party approval or interaction required.","API":"An application programming interface (API) is a way for two or more computer programs to communicate with each other. It is a type of software interface, offering a service to other pieces of software. A document or standard that describes how to build or use such a connection or interface is called an API specification. A computer system that meets this standard is said to implement or expose an API. The term API may refer either to the specification or to the implementation.","supported chains":"Algorand, Avalanche, Ethereum, Flow, Hedera, Solana, Stellar, and TRON.","Events":"Events are a logging mechanism used in smart contracts to emit information outside of the contract's storage variables. They are emitted, for example, when a token is transferred, allowing smart contracts to inform off-chain applications or users about state changes.","soft finality":"The point at which a transaction is considered sufficiently secure for attestation, even though it has not yet reached hard finality. This allows for faster message processing while balancing the risk of chain reorganizations.","hard finality":"The point at which a transaction is fully finalized on-chain and can no longer be reversed or reorganized. This ensures the highest level of security and certainty before attestation. Hard Finality requires the transaction to reach full consensus on the source blockchain, typically resulting in longer processing times.","Fast Transfer Allowance":"A reserve buffer in CCTP V2 that mitigates reorg risks by ensuring Fast Transfers remain fully backed. It provides financial coverage in case of chain reorgs and subsequent mints, maintaining transaction integrity across supported blockchains."},"documentation":{"feedback":{"helperText":"Did this page help you?","yes":"Yes","no":"No","form":{"title":"Feedback (optional)","placeholder":{"negative":"How can we improve our documentation? Note that we can't directly respond to this feedback; if you need help, submit a Support ticket.","positive":"We're glad it was helpful. Please provide any additional comments you may have. Note that we can't directly respond to this feedback; if you need help, submit a Support ticket."},"close":"Close","submit":"Submit feedback","toastMessage":"Thank you for your feedback!"}}},"playground":{"apiKey":{"add":"Add API Key","label":"API Key","description":"Authenticate with your API key to send a real request"},"operationTemplate":{"error":{"title":"We are having trouble loading the code sample","subtitle":"Please try a different target client or change the input parameters."}},"product":"Product","play":"Play","parameter":{"required":"Required","allowedValues":"Allowed values","showProperties":"Show {{count}} properties","titles":{"header":"Header parameters","path":"Path parameters","query":"Query parameters","cookies":"Cookie parameters","requestBody":"Body parameters","required":"*=required"},"responseTitle":"Response","noneNeeded":"None needed","range":"{{min}} to {{max}}","default":"Default is {{value}}"},"snippet":{"target":{"c":"C","clojure":"Clojure","csharp":"C#","go":"Go","http":"HTTP","java":"Java","javascript":"JavaScript","json":"JSON","kotlin":"Kotlin","node":"Node","objc":"Objective-C","ocaml":"OCaml","php":"PHP","powershell":"Powershell","python":"Python","r":"R","ruby":"Ruby","shell":"Shell","swift":"Swift"},"client":{"c":{"libcurl":"Libcurl"},"clojure":{"clj_http":"clj-http"},"csharp":{"httpclient":"HttpClient","restsharp":"RestSharp"},"go":{"native":"NewRequest"},"http":{"http1":{"1":"HTTP/1.1"}},"java":{"asynchttp":"AsyncHttp","nethttp":"java.net.http","okhttp":"OkHttp","unirest":"Unirest"},"javascript":{"axios":"Axios","fetch":"fetch","jquery":"jQuery","xhr":"XMLHttpRequest"},"json":{"native":"Native JSON"},"kotlin":{"okhttp":"okhttp"},"node":{"axios":"Axios","fetch":"Fetch","native":"HTTP","request":"Request","unirest":"Unirest"},"objc":{"nsurlsession":"NSURLSession"},"ocaml":{"cohttp":"CoHTTP"},"php":{"curl":"cURL","guzzle":"Guzzle","http1":"HTTP v1","http2":"HTTP v2"},"powershell":{"restmethod":"Invoke-RestMethod","webrequest":"Invoke-WebRequest"},"python":{"requests":"Requests"},"r":{"httr":"httr"},"ruby":{"native":"net::http"},"shell":{"curl":"cURL","httpie":"HTTPie","wget":"Wget"},"swift":{"urlsession":"URLSession"}}},"response":{"bodyTitle":"Response Body","headersTitle":"Headers","title":"Response","subtitle":"Choose an example"},"form":{"input":{"string":"string","number":"number","integer":"integer","boolean":"boolean","object":"object","unknown":"unknown","date-time":"date-time","uuid":"uuid","uuid7":"uuid7","url":"url","byte":"byte","oneOf":"oneOf","anyOf":"anyOf","allOf":"allOf","array":"array","arrays":{"oneOf":"array of ({{ types }})","items":"array of {{ type}}s","arrayOf":"array of ","add":"Add {{ type }}"},"record":"Record"},"generate":"Generate","configure":"Configure","clear":"Clear form","oneOf":"One of","anyOf":"Any of","enableField":"Enable {{ name }}","disableField":"Disable {{ name }}"},"playground":{"sidebar":{"search":"Search endpoints"},"placeholder":{"title":"Welcome to the Circle API Reference!","subtitle":"Overview of Circle's RESTful APIs and endpoints. Our API References include a Playground as a safe interactive space to test out API requests in various languages and check their responses in real time. Log in to your Circle Developer Console account and add your API key to start managing your Circle Developer resources in testnet.","backgroundImageAlt":"Background"},"request":"Request","response":"Response","sendRequest":"Send request","resendRequest":"Resend request","configurationModal":{"title":"Configure API Credentials","subtitle":"Set up automatic Entity Secret CipherText generation","body":["This configuration allows you to set up your API Key and Entity Secret for use in the API Playground.","The Entity Secret Cipher Text is an encrypted version of your Entity Secret, used to securely transmit the secret in API requests. A new cipher text must be generated for each API call to maintain security."],"banner":"The Entity Secret is a 32-byte key used to enhance security in Developer-Controlled Wallets. It's required for critical operations such as wallet creation and transaction initiation.","labels":{"configure":"Save configuration","apiKey":"API Key","entitySecret":"Entity Secret"}}},"request":{"title":"Request","description":"Choose a language"}},"faucet":{"chains":{"ALGO":"Algorand Testnet","APTOS":"Aptos Testnet","ARB":"Arbitrum Sepolia","AVAX":"Avalanche Fuji","BASE":"Base Sepolia","CELO":"Celo Alfajores","ETH":"Ethereum Sepolia","HBAR":"Hedera Testnet","NEAR":"Near Testnet","NOBLE":"Noble Testnet","OP":"OP Sepolia","PAH":"Polkadot Westend","POLY":"Polygon PoS Amoy","SOL":"Solana Devnet","SUI":"Sui Testnet","UNI":"Unichain Sepolia","XLM":"Stellar Testnet","XRP":"XRP Ledger Testnet","ZKS":"ZKsync Sepolia"},"requestTokenForm":{"header":"Testnet Faucet","intro":"Send testnet USDC and EURC to your wallet to experiment with fund flows in your app or smart contract for free.","labels":{"network":"Network","destinationAddress":"Send to","destinationAddressPlaceholder":"Wallet address"},"limit":"Limit: One request per pairing of stablecoin and test network hourly","submit":"Send {{ amount }} {{ currency }}","maintenanceMode":{"title":"Maintenance Mode","description":"The faucet is currently undergoing maintenance and will be enabled again shortly."}},"description":{"headline":"Testnet Faucet","items":[{"description":"Send testnet USDC and EURC to your wallet to experiment with funds flows in your app or smart contract.","title":"Free testnet tokens for your app"},{"description":"Select your desired stablecoin and test network and receive funds in seconds. No sign-up required.","title":"Fast, easy, and permissionless"},{"description":"Access testnet funds on every EVM and non-EVM test network that supports USDC and EURC.","title":"Over a dozen blockchains supported"}]},"faq":{"header":"Frequently Asked Questions","items":[{"title":"What is a testnet?","description":"A testnet is an instance of a blockchain used specifically for testing. In contrast to a mainnet blockchain, which represents a production environment, testnets allow developers to test their apps and smart contracts without risking assets with real-world value. Testnet tokens are assets that can be freely obtained from testnet faucets to experiment with funds flows on testnets."},{"title":"How can I get native tokens on testnet like ETH and MATIC?","description":"Developers can use Circle's Faucet in the Developer Console to obtain testnet ETH and MATIC. Testnet tokens generated from the Developer Console will be sent to wallet addresses created with Programmable Wallets. Get started for free.","href":"https://console.circle.com"},{"title":"What's the difference between this Faucet and the Faucet in the Developer Console?","description":"This Faucet is public and permissionless for anyone to use. There's no account required, and it can provide free access to testnet USDC and EURC on all supported blockchains.

The Faucet in the Developer Console provides free access to both native tokens on testnet like ETH and MATIC and stablecoin tokens on testnet like USDC and EURC. It can only fund wallet addresses created with Programmable Wallets. Get started for free.","href":"https://console.circle.com"},{"title":"Which testnets does this Faucet support?","description":"This Faucet provides access to testnet tokens on every blockchain that supports USDC and EURC. See our docs for USDC testnet addresses and EURC testnet addresses.","href":"https://developers.circle.com/stablecoins/docs/usdc-on-test-networks","href2":"https://developers.circle.com/stablecoins/docs/eurc-on-test-networks"},{"title":"How much USDC can I get from this Faucet?","description":"Developers can request 10 USDC on testnet per hour, per address, and per blockchain. If you need more, you can submit a request on Circle's Discord.","href":"https://discord.com/invite/buildoncircle"},{"title":"Why am I seeing an error message of “Limit Exceeded”?","description":"This means that you have exceeded a limit and you will need to wait to try again. Developers can request 10 USDC on testnet per hour, per address, and per blockchain. If you need more, you can submit a request on Circle's Discord.","href":"https://discord.com/invite/buildoncircle"},{"title":"How can I get testnet USDC if the testnet I need it on isn't listed in the network dropdown?","description":"If the chain you're trying to access testnet USDC on isn't listed, you can use Circle's CCTP V2 to move USDC from Ethereum Sepolia to your target chain (as long as the target is supported by CCTP). Follow the CCTP Quickstart Guide in the Developer Docs and make sure to select CCTP V2 for testnet transfers across chains.","href":"https://developers.circle.com/stablecoins/transfer-usdc-on-testnet-from-ethereum-to-avalanche"}]},"requestSuccessful":{"headline":"Tokens sent","description":"{{ amount }} testnet {{ currency }} is on its way to your wallet and should appear shortly.","getMore":"Get more tokens"},"requestLimited":{"headline":"Limit exceeded","description":{"one":"Sorry, you've hit the limit. We'll have more test tokens available in {{ count }} hour.","other":"Sorry, you've hit the limit. We'll have more test tokens available in {{ count }} hours."},"goBack":"Go Back"},"requestFailed":{"headline":"Something went wrong","description":"Try again, and if the problem persists, please contact support.","retry":"Retry"},"header":{"links":{"docs":"Explore Docs"}}},"liquidity-wizard":{"startOver":"Start Over","learnMore":"Learn more","applyHere":"Apply here","footer":{"paragraph_1":"Digital assets are subject to a number of risks, including price volatility. Transacting in digital assets could result in significant losses and may not be suitable for some consumers. Digital asset markets and exchanges are not regulated with the same controls or customer protections available with other forms of financial products and are subject to an evolving regulatory environment. Digital assets do not typically have legal tender status and are not covered by deposit protection insurance. The past performance of a digital asset is not a guide to future performance, nor is it a reliable indicator of future results or performance. Additional disclosures can be found on the <0>Legal and Privacy page.","paragraph_2":"Circle Internet Financial, LLC (NMLS ID# 1201441). Circle Internet Financial, LLC is licensed as a Money Transmitter by the New York State Department of Financial Institutions and to engage in Virtual Currency Business Activity by the New York State Department of Financial Services. Texas customers click <0>here for information about filing complaints. Maryland customers click <0>here for information about filing complaints.","paragraph_3":"Circle Technology Services, LLC (“CTS”) is a software provider and does not provide regulated financial or advisory services. You are solely responsible for services you provide to users, including obtaining any necessary licenses or approvals and otherwise complying with applicable laws. For additional details, please click <0>here<0> to see the Circle Developer terms of service."},"infoSection":{"title":"Already know what you need?","description":"Check out popular on/off-ramp solutions"},"form":{"next":"Next","back":"Back","continue":"Continue","getResults":"Get Results","submit":"Submit","questionCount":"Question {{count}} of {{total}}","completed":{"title":"You’ve completed the USDC Finder experience!","subtitle":"We’d love to follow up on your journey. Please leave your email below:"},"submitted":{"title":"Thank you!","subtitle":"We will be in touch"}},"email":{"heading":"What is your email?","description":"We may reach out with further questions about your needs","placeholder":"johndoe@circle.com","label":"Email","disclaimer":"By submitting this form, you agree to receive a user experience survey from Circle. For more information on our privacy practices, please review our <0>Privacy Policy."},"error":{"title":"Something went wrong","description":"Try again, and if the problem persists, please contact support"},"goToPartnerDirectory":"Go to our Partners Directory","background":{"Coin_1":{"src":"/images/Coin_1.svg","alt":"background image 1"},"Coin_2":{"src":"/images/Coin_2.svg","alt":"background image 2"},"Coin_3":{"src":"/images/Coin_3.svg","alt":"background image 3"}},"questions":[{"id":"useCase","title":"Why do you need USDC on/off-ramps?","description":"Select your primary use case to help us propose a solution.","type":"radio","maxSteps":4,"options":[{"id":"forCustomers","iconName":"UserGroupOutline","title":"Business use: USDC is needed by my customers","description":"Example: My customers need to swap their local fiat currency for USDC to access payment or trading services from my business."},{"id":"forBusiness","iconName":"OfficeBuildingSolid","title":"Business use: USDC is needed for my business operations","description":"Example: My business uses USDC for direct payouts to suppliers or employees."},{"id":"forPersonal","iconName":"UserSolid","title":"Personal use: I want USDC for my individual needs","description":"Example: I need to swap my local fiat currency for USDC to access payment or trading services from an external provider."}],"hideButtons":true,"next":{"forCustomers":"solutionType","forBusiness":"whatQuarterlyGTVShort","forPersonal":"https://www.usdc.com/"}},{"id":"solutionType","title":"What are your requirements?","description":"Select the option that best matches your requirements.","type":"radio","maxSteps":4,"options":[{"id":"forUsers","title":"My business only needs access to USDC","description":"For businesses that have money transmission licenses and regulatory compliance tooling."},{"id":"forKYC","title":"My business needs access to USDC and compliance tooling","description":"For businesses that have money transmission licenses, but need tooling to comply with Know Your Customer (KYC) and Anti-Money Laundering (AML) regulations."},{"id":"forE2E","title":"My business needs an end-to-end solution","description":"For businesses that do not have money transmission licenses and need a solution that handles payments acceptance and compliance obligations out-of-the-box."}],"next":{"forUsers":"whatQuarterlyGTV","forKYC":"result:crypto-service-providers","forE2E":"whatMonthlyGTV"}},{"id":"whatMonthlyGTV","title":"What on/off-ramp volume do you expect?","description":"Select your projected quarterly volume for on/off-ramp transactions (i.e. converting between local fiat currency and USDC).","type":"radio","maxSteps":4,"options":[{"id":"monthlyUpTo150k","title":"Less than $150,000 / quarter"},{"id":"monthlyUpTo500k","title":"$$150,000 to $500,000 / quarter"},{"id":"monthlyUpTo750k","title":"$$500,000 to $750,000 / quarter"},{"id":"monthlyUpTo1m","title":"$$750,000 to $1 million / quarter"},{"id":"monthlyOver1m","title":"More than $1 million / quarter"}],"next":{"monthlyUpTo150k":"result:on-off-ramps","monthlyUpTo500k":"result:on-off-ramps","monthlyUpTo750k":"coinTypeNeeded","monthlyUpTo1m":"coinTypeNeeded","monthlyOver1m":"coinTypeNeeded"}},{"id":"whatQuarterlyGTV","title":"What on/off-ramp volume do you expect?","description":"Select your projected quarterly volume for on/off-ramp transactions (i.e. converting between local fiat currency and USDC).","type":"radio","maxSteps":4,"options":[{"id":"quarterlyUpTo150k","title":"Less than $150,000 / quarter"},{"id":"quarterlyUpTo500k","title":"$$150,000 to $500,000 / quarter"},{"id":"quarterlyUpTo750k","title":"$$500,000 to $750,000 / quarter"},{"id":"quarterlyUpTo1m","title":"$$750,000 to $1 million / quarter"},{"id":"quarterlyOver1m","title":"More than $1 million / quarter"}],"next":{"quarterlyUpTo150k":"result:otc","quarterlyUpTo500k":"result:otc","quarterlyUpTo750k":"result:otc","quarterlyUpTo1m":"result:otc","quarterlyOver1m":"customerLicence"}},{"id":"whatQuarterlyGTVShort","title":"What on/off-ramp volume do you expect?","description":"Select your projected quarterly volume for on/off-ramp transactions (i.e. converting between local fiat currency and USDC).","type":"radio","maxSteps":4,"options":[{"id":"quarterlyUpTo150k","title":"Less than $150,000 / quarter"},{"id":"quarterlyUpTo500k","title":"$$150,000 to $500,000 / quarter"},{"id":"quarterlyUpTo750k","title":"$$500,000 to $750,000 / quarter"},{"id":"quarterlyUpTo1m","title":"$$750,000 to $1 million / quarter"},{"id":"quarterlyOver1m","title":"More than $1 million / quarter"}],"next":{"quarterlyUpTo150k":"result:crypto-service-providers","quarterlyUpTo500k":"result:crypto-service-providers","quarterlyUpTo750k":"result:crypto-service-providers","quarterlyUpTo1m":"result:crypto-service-providers","quarterlyOver1m":"result:circle-mint"}},{"id":"customerLicence","title":"Do you have a money transmission license for your jurisdiction?","description":"A money transmission license is a regulatory requirement for businesses to transfer monetary value in a given jurisdiction.","type":"radio","maxSteps":4,"options":[{"id":"hasLicence","title":"Yes, I have a license"},{"id":"noLicence","title":"No, I do not have a license"}],"next":{"hasLicence":"result:circle-mint","noLicence":"result:crypto-service-providers"}},{"id":"coinTypeNeeded","title":"Do you need access to USDC or EURC?","description":"Select the stablecoin you need. If you need both, select one first, and you can retake this tool afterwards.","type":"radio","maxSteps":4,"options":[{"id":"needUSDC","title":"USDC"},{"id":"needEURC","title":"EURC"}],"next":{"needUSDC":"result:usdc-access","needEURC":"result:on-off-ramps"}}],"results":{"title":"Here’s the best option for your needs","circleMint":{"header":"Circle Mint","chip":"Circle Product","intro":"Circle Mint is the fastest and most cost effective way for distributors to on/off-ramp any amount of USDC directly from Circle, 24/7/365.","list":["Access USDC in over 185 countries","Connect using a web UI or integrate with APIs","Secure fund management and seamless distribution"],"href":"https://circle.com/mint-contact"},"cryptoServiceProviders":{"header":"Crypto Service Providers","description":"Crypto Service Providers offer low cost access to USDC along with compliance tooling for KYC & AML obligations.","list":["Users can convert between local fiat currency and USDC","Built-in tools to help satisfy regulatory requirements","Can offer out-of-the-box solution for easy integration"],"href":"https://partners.circle.com/?f_USDCOnOffRampType=crypto-service-provider"},"otc":{"header":"OTC Desks","intro":"OTC (Over-the-Counter) Desks make it easy to buy and sell large amounts of USDC.","list":["Wholesale pricing for large transactions","Convert large volumes with fast execution","Deep market knowledge and insights"],"href":"https://partners.circle.com/?f_USDCOnOffRampType=liquidity-provider,crypto-service-provider"},"usdcAccess":{"title":"USDC Access","description":"A widget for embedding USDC on/off-ramps in your app, connecting your users to a global network of low cost providers.","list":["Enable your users to convert between local fiat currency and USDC without being in the funds flow","Out-of-the-box solution for easy integration"],"href":"https://developers.circle.com/w3s/usdc-access-about-guide"},"onOffRamps":{"header":"On/Off-Ramp Providers","description":"On/Off-Ramp Providers offer solutions for USDC on/off-ramps for your users. These providers can handle payment acceptance and compliance obligations for KYC & AML.","list":["Enable your users to convert between local fiat currency and USDC without being in the funds flow","Flexible solutions and straightforward integration"],"href":"https://partners.circle.com/?f_USDCOnOffRampType=ramp-provider","shortcutTitle":"USDC on/off-ramp providers"}}}},"config":{"locales":["en"],"defaultLocale":"en","localeDetection":true,"pages":{},"locale":"en","loaderName":"server /page","pathname":"/(docs)/"},"children":"$L26"}]