{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API Documentation","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-documentation","__idx":0},"children":["API Documentation"]},{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/color.a7565a83be942a3582a9837b774cc47c79a4fe69fbf5120dce8ac9f4949fe157.c5aff763.svg","width":"40%","height":"40%"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-quick-start-guide","__idx":1},"children":["🚀 Quick Start Guide"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authentication"]},": All API requests require authentication using API bearer token"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sandbox Base URL"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.sandbox.congruitcredit.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Production Base URL"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.congruitcredit.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Rate Limits"]},": 10 requests per second per IP address"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response Format"]},": All responses are in JSON format"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authentication","__idx":2},"children":["Authentication"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Include the OAuth token in the Authorization header\ncurl -H \"Authorization: Bearer BEARER_TOKEN\" \\\n     https://api.congruitcredit.com/v1/[endpoint]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"api-bearer-tokens","__idx":3},"children":["API Bearer Tokens"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each API call requires a short-lived bearer token in the authentication header. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/authentication"},"children":["Authentication Guide"]}," for full details."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-available-apis","__idx":4},"children":["📚 Available APIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In this documentation, we refer to two classes of API calls:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["authentication"]}," calls which are always live and never mocked or tested"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["workhorse"]}," calls which return products and their attributes - these can be mocked or tested"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"_","__idx":5},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/exchange/swagger/"},"children":["Exchange API"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Our Exchange APIs for the give-portion of our give-to-get programs. Use this endpoint to furnish consumer banking and loan details via api. We also support furnishing by csv files. Use the Evaluation endpoint to request credit and fraud reports for a consumer including the Exchange reports."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["ACH transaction contributions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["tradeline contributions"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"_-1","__idx":6},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/evaluation/swagger/"},"children":["Evaluation API"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Our evaluation API for credit and fraud assessment:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Credit evaluation products, including Exchange products"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Fraud detection and analysis products"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"_-2","__idx":7},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/tokens/swagger/"},"children":["Authentication API"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Specialized API for authentication:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Bearer token generation and validation"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-documentation-structure","__idx":8},"children":["📖 Documentation Structure"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Getting Started"]},": Basic setup"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authentication"]},": Authentication using OAuth 2.0"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Reference"]},": Complete endpoint documentation using OpenAPI"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-development-tools","__idx":9},"children":["🔧 Development Tools"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"interactive-api-explorer","__idx":10},"children":["Interactive API Explorer"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Try our APIs directly in your browser using the interactive documentation. Each endpoint includes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Parameter validation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Request schemas"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Response schema documentation"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-support","__idx":11},"children":["📞 Support"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getting-help","__idx":12},"children":["Getting Help"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Documentation"]},": This site contains comprehensive guides"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Status"]},": Check ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://status.congruitcredit.com"},"children":["status.congruitcredit.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Technical Support"]},": ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"mailto:support@congruitcredit.com"},"children":["support@congruitcredit.com"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"rate-limits","__idx":13},"children":["Rate Limits"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Rate limits are evaluated over a rolling 5-minute window. This supports burst capacity that might exceed the average rate limit. For example, you have a burst in organic traffic that exceeds 10 requests per second but the burst only lasts for a minute before going back to a low baseline. The rate limit would be evaluated over a 5 minute period and you would not be throttled."]},{"$$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":"Requests/second"},"children":["Requests/second"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["10"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"-security","__idx":14},"children":["🔒 Security"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"best-practices","__idx":15},"children":["Best Practices"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Never expose API credentials or tokens"]}," in client-side code"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use HTTPS"]}," for all API requests"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Monitor usage"]}," for unusual activity"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"permitted-ips","__idx":16},"children":["Permitted IPs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For enhanced security, you must add your specific IP addresses to our allowlist. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/authentication"},"children":["Authentication Guide"]}," for details."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ready to get started?"]}," Choose ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/getting-started"},"children":["getting started"]}," from the navigation menu above to begin exploring our documentation."]}]},"headings":[{"value":"API Documentation","id":"api-documentation","depth":1},{"value":"🚀 Quick Start Guide","id":"-quick-start-guide","depth":2},{"value":"Authentication","id":"authentication","depth":3},{"value":"API Bearer Tokens","id":"api-bearer-tokens","depth":3},{"value":"📚 Available APIs","id":"-available-apis","depth":2},{"value":"","id":"_","depth":3},{"value":"","id":"_-1","depth":3},{"value":"","id":"_-2","depth":3},{"value":"📖 Documentation Structure","id":"-documentation-structure","depth":2},{"value":"🔧 Development Tools","id":"-development-tools","depth":2},{"value":"Interactive API Explorer","id":"interactive-api-explorer","depth":3},{"value":"📞 Support","id":"-support","depth":2},{"value":"Getting Help","id":"getting-help","depth":3},{"value":"Rate Limits","id":"rate-limits","depth":3},{"value":"🔒 Security","id":"-security","depth":2},{"value":"Best Practices","id":"best-practices","depth":3},{"value":"Permitted IPs","id":"permitted-ips","depth":3}],"frontmatter":{"seo":{"title":"API Documentation"}},"lastModified":"2026-06-24T18:21:33.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}