{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-connect-apis-catalog/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Connect to the Docs","llmstxt":{"hide":true}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"connect-to-the-docs","__idx":0},"children":["Connect to the Docs"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Connect to the Docs lets you link the Creditsafe Connect API documentation directly to your development environment, such as VS Code or Cursor. Once connected, AI coding assistants like GitHub Copilot and Cursor can read our API documentation, specifications and workflows, so you get context-aware help with API integration, workflow design and code generation without leaving your IDE."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is a developer tool for accessing documentation only. It is separate from any Creditsafe product or service."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"important-documentation-access-only","__idx":2},"children":["Important: Documentation Access Only"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Connect to the Docs provides access to API documentation, specifications, and integration guidance only."]}," It does not provide access to Creditsafe services or API credentials."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To execute any code generated with the help of the connected docs or to make calls to Creditsafe Connect APIs, you must:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["✅ Have a valid Creditsafe account"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["✅ Possess valid API credentials (username and password)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["✅ Have appropriate product subscriptions and permissions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["✅ Have sufficient credits for the operations you intend to perform"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Connecting the docs helps you ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["learn how"]}," to integrate with Creditsafe APIs and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["generate integration code"]},", but you are responsible for obtaining and managing your own credentials and API access."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"benefits-of-connecting-to-the-docs","__idx":3},"children":["Benefits of Connecting to the Docs"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"intelligent-api-discovery","__idx":4},"children":["Intelligent API Discovery"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Semantic search"]}," across all Creditsafe Connect APIs"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Instant endpoint lookup"]}," with detailed parameter information"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OpenAPI specification access"]}," for any product or endpoint"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"accelerated-development","__idx":5},"children":["Accelerated Development"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Generate integration code"]}," for your preferred language"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create test scripts"]}," with real API examples"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Build workflow automation"]}," using Arazzo specifications"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"context-aware-assistance","__idx":6},"children":["Context-Aware Assistance"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Error troubleshooting"]}," with API-specific guidance"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authentication help"]}," with token management examples"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Best practices"]}," for API integration patterns"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"documentation-integration","__idx":7},"children":["Documentation Integration"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Always up-to-date"]}," API specifications"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Direct access"]}," to security schemes and data models"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Comprehensive endpoint documentation"]}," including request/response examples"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"setup","__idx":8},"children":["Setup"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The docs connect to your IDE through a standard connection URL: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://doc.creditsafe.com/mcp"]},". Your IDE labels this option as an \"MCP server\", so you will see that term in the menus below. No authentication is required."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"vs-code","__idx":9},"children":["VS Code"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the command palette (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ctrl + Shift + P"]}," on Windows/Linux or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cmd + Shift + P"]}," on macOS)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["MCP: Add Server"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Choose ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP"]}," as the server type"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter the URL: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://doc.creditsafe.com/mcp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Provide a name for the connection (e.g., \"Creditsafe Connect API Docs\")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Complete the setup"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"manual-configuration-vs-code","__idx":10},"children":["Manual Configuration (VS Code)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you prefer to configure manually, add the following to your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".vscode/mcp.json"]}," file:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"servers\": {\n    \"Creditsafe Connect API Docs\": {\n      \"url\": \"https://doc.creditsafe.com/mcp\",\n      \"type\": \"http\"\n    }\n  },\n  \"inputs\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"cursor","__idx":11},"children":["Cursor"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the command palette (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ctrl + Shift + P"]}," on Windows/Linux or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cmd + Shift + P"]}," on macOS)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Open MCP settings"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add custom MCP"]}," to edit your configuration"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add the connection configuration (see below)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"manual-configuration-cursor","__idx":12},"children":["Manual Configuration (Cursor)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add the following to your settings file:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"mcpServers\": {\n    \"Creditsafe Connect API Docs\": {\n      \"url\": \"https://doc.creditsafe.com/mcp\"\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"verification","__idx":13},"children":["Verification"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After installation, verify the connection is working:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open your AI assistant (GitHub Copilot Chat, Cursor Chat, etc.)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ask: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["\"List available Creditsafe APIs\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You should see a response listing products like KYC Protect, Bank Validation, Company Reports, etc."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the connection is successful, you're ready to start using the docs in your IDE!"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-usage","__idx":14},"children":["Example Usage"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-1-api-discovery","__idx":15},"children":["Example 1: API Discovery"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Prompt:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Can you show me the available endpoints for the KYC Protect API?\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What the AI will do:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Look up the KYC Protect endpoints in the connected docs"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Display all available operations with descriptions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Show HTTP methods and paths"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-2-generate-integration-code","__idx":16},"children":["Example 2: Generate Integration Code"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Prompt:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Can you help create a test script for integrating KYC Protect basic workflow in Python?\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What the AI will do:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Fetch the KYC Protect OpenAPI specification"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Review the authentication requirements"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Access the Arazzo workflow definition"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Generate a complete Python script with:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Authentication handling"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Profile creation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["AML search execution"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Search linking"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Error handling"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Example request/response handling"]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Expected Output:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"import requests\nimport json\n\nclass KYCProtectClient:\n    def __init__(self, username, password, base_url=\"https://connect.creditsafe.com/v1\"):\n        self.base_url = base_url\n        self.token = None\n        self.authenticate(username, password)\n    \n    def authenticate(self, username, password):\n        \"\"\"Authenticate and obtain JWT token\"\"\"\n        url = f\"{self.base_url}/authenticate\"\n        payload = {\n            \"username\": username,\n            \"password\": password\n        }\n        response = requests.post(url, json=payload)\n        response.raise_for_status()\n        self.token = response.json()[\"token\"]\n        return self.token\n    \n    def create_profile(self, profile_data):\n        \"\"\"Create a KYC profile\"\"\"\n        url = f\"{self.base_url}/compliance/kyc-protect/profiles\"\n        headers = {\n            \"Authorization\": f\"Bearer {self.token}\",\n            \"Content-Type\": \"application/json\"\n        }\n        response = requests.post(url, headers=headers, json=profile_data)\n        response.raise_for_status()\n        return response.json()\n    \n    def run_aml_search(self, search_criteria):\n        \"\"\"Run AML screening search\"\"\"\n        url = f\"{self.base_url}/compliance/kyc-protect/searches/aml\"\n        headers = {\n            \"Authorization\": f\"Bearer {self.token}\",\n            \"Content-Type\": \"application/json\"\n        }\n        response = requests.post(url, headers=headers, json=search_criteria)\n        response.raise_for_status()\n        return response.json()\n    \n    def link_search_to_profile(self, profile_id, search_id):\n        \"\"\"Link search to profile\"\"\"\n        url = f\"{self.base_url}/compliance/kyc-protect/profiles/{profile_id}/searches\"\n        headers = {\n            \"Authorization\": f\"Bearer {self.token}\",\n            \"Content-Type\": \"application/json\"\n        }\n        payload = {\"searchId\": search_id}\n        response = requests.post(url, headers=headers, json=payload)\n        response.raise_for_status()\n        return response.json()\n\n# Example usage\nif __name__ == \"__main__\":\n    # Initialize client\n    client = KYCProtectClient(\n        username=\"your-username\",\n        password=\"your-password\"\n    )\n    \n    # Create business profile\n    profile = client.create_profile({\n        \"profileType\": \"business\",\n        \"name\": \"Example Corp Ltd\",\n        \"registrationNumber\": \"12345678\"\n    })\n    print(f\"Profile created: {profile['id']}\")\n    \n    # Run AML search\n    search = client.run_aml_search({\n        \"name\": \"Example Corp Ltd\",\n        \"country\": \"GB\"\n    })\n    print(f\"Search completed: {search['searchId']}\")\n    \n    # Link search to profile\n    link = client.link_search_to_profile(profile['id'], search['searchId'])\n    print(f\"Search linked successfully\")\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-3-understand-authentication","__idx":17},"children":["Example 3: Understand Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Prompt:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"How do I authenticate with the Creditsafe Connect API?\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What the AI will do:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retrieve authentication documentation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Explain the JWT token flow"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Provide code examples for obtaining and using tokens"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Show token refresh patterns"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-4-explore-api-workflows","__idx":18},"children":["Example 4: Explore API Workflows"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Prompt:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Show me the complete workflow for the Prospects API\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What the AI will do:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Access the Prospects Arazzo workflow specification"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Display the step-by-step process"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Show input/output dependencies"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Explain success and error handling criteria"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-5-debug-api-errors","__idx":19},"children":["Example 5: Debug API Errors"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Prompt:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"I'm getting a 403 error when creating a prospect order. What does this mean?\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What the AI will do:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Search the Prospects API documentation for 403 errors"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Explain common causes (insufficient credits, permissions)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Suggest troubleshooting steps"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Provide example error response format"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-6-generate-request-examples","__idx":20},"children":["Example 6: Generate Request Examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Prompt:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Can you show me an example request body for creating a Bank Validation order?\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["What the AI will do:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Fetch the Bank Validation OpenAPI schema"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Generate a valid example request body"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Include all required fields"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add optional fields with descriptions"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-your-assistant-can-access","__idx":21},"children":["What Your Assistant Can Access"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When connected, your AI assistant can use the following documentation capabilities:"]},{"$$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":"Capability"},"children":["Capability"]},{"$$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":"strong","attributes":{},"children":["list-apis"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List all available Creditsafe Connect APIs with their descriptions and versions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["get-endpoints"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get all endpoints for a specific API, including HTTP methods and paths"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["get-endpoint-info"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get detailed information about a specific endpoint including parameters, request/response schemas, security requirements, and examples"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["get-full-api-description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get complete OpenAPI specification for an API, including all schemas, components, and data models"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["get-security-schemes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get authentication and security details for API access"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["search"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Semantic search across documentation to find relevant content for specific queries"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"workflow-intelligence","__idx":22},"children":["Workflow Intelligence"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A key advantage of connecting to the docs is access to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Arazzo workflow specifications"]}," that show how endpoints connect together in real-world integration patterns. Unlike basic API documentation that shows individual endpoints in isolation, your assistant can understand:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Step-by-step integration flows"]}," - How to chain multiple API calls together (e.g., authenticate → create profile → run search → link search → enable monitoring)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Data dependencies"]}," - Which outputs from one endpoint are needed as inputs for the next step"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Success and failure criteria"]}," - When to proceed to the next step and how to handle errors at each stage"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conditional logic"]}," - Which steps are optional or country-dependent"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Complete end-to-end workflows"]}," - From authentication through to final data export or monitoring setup"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This workflow intelligence enables the AI to generate production-ready integration code that properly sequences API calls, passes data between steps, and implements comprehensive error handling - not just isolated endpoint examples."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example workflows available:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["KYC Protect: Basic Integration, Full Integration, Monitoring Setup"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Prospects: Complete Order Workflow, List Orders Workflow"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Bank Validation: Standard Validation Flow"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Company Reports: Search and Retrieve Workflow"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"best-practices","__idx":23},"children":["Best Practices"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"1-be-specific-in-your-prompts","__idx":24},"children":["1. Be Specific in Your Prompts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Instead of asking \"How do I use the API?\", ask:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["\"How do I create a KYC profile for a business entity?\""]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["\"What are the required fields for a Prospects order?\""]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["\"Show me how to authenticate and retrieve a company report\""]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"2-reference-specific-products","__idx":25},"children":["2. Reference Specific Products"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When asking questions, mention the product name:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["\"KYC Protect\""]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["\"Bank Validation\""]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["\"Prospects\""]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["\"Company Reports\""]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"3-request-complete-examples","__idx":26},"children":["3. Request Complete Examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ask for end-to-end examples:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["\"Generate a complete workflow for...\""]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["\"Create a test script that handles errors...\""]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["\"Show me the full integration process for...\""]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"4-leverage-workflow-documentation","__idx":27},"children":["4. Leverage Workflow Documentation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For complex integrations, reference the workflows:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["\"Follow the Prospects complete order workflow\""]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["\"Use the KYC Protect basic integration workflow\""]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["\"Implement the Bank Validation standard workflow\""]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"troubleshooting","__idx":28},"children":["Troubleshooting"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"connection-issues","__idx":29},"children":["Connection Issues"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you cannot connect to the MCP server:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify the URL:"]}," Ensure you're using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://doc.creditsafe.com/mcp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Check network access:"]}," Confirm your network allows HTTPS connections"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Restart your IDE:"]}," Close and reopen VS Code or Cursor"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Check your AI assistant extension:"]}," Ensure it is installed, enabled and up to date"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"no-response-from-ai","__idx":30},"children":["No Response from AI"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your AI assistant doesn't respond to API queries:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify connection:"]}," Ask \"List available Creditsafe APIs\""]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Check your IDE settings:"]}," Confirm the connection is enabled in your configuration"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Restart the AI assistant:"]}," Close and reopen the chat window"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"outdated-information","__idx":31},"children":["Outdated Information"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The connection provides real-time access to documentation. If information seems outdated:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Check the API version:"]}," Ensure you're asking about the correct version"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Refresh the connection:"]}," Restart your IDE to reload the docs"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Contact support:"]}," Report issues via ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"mailto:apisupport@creditsafe.com"},"children":["Connect API Support"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"additional-resources","__idx":32},"children":["Additional Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://doc.creditsafe.com"},"children":["Connect API Documentation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connect-apis-catalog/information/authentication"},"children":["Authentication Guide"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connect-apis-catalog/information/versioningandchanges"},"children":["API Versioning"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connect-apis-catalog/information/errorcodes"},"children":["Error Codes Reference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connect-apis-catalog/information/ratelimiting"},"children":["Rate Limiting"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"support","__idx":33},"children":["Support"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For questions or issues with connecting to the docs:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Documentation:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://doc.creditsafe.com"},"children":["https://doc.creditsafe.com"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Feedback:"]}," Use our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/connect-apis-catalog/information/feedback"},"children":["feedback form"]}]}]}]},"headings":[{"value":"Connect to the Docs","id":"connect-to-the-docs","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Important: Documentation Access Only","id":"important-documentation-access-only","depth":2},{"value":"Benefits of Connecting to the Docs","id":"benefits-of-connecting-to-the-docs","depth":2},{"value":"Intelligent API Discovery","id":"intelligent-api-discovery","depth":3},{"value":"Accelerated Development","id":"accelerated-development","depth":3},{"value":"Context-Aware Assistance","id":"context-aware-assistance","depth":3},{"value":"Documentation Integration","id":"documentation-integration","depth":3},{"value":"Setup","id":"setup","depth":2},{"value":"VS Code","id":"vs-code","depth":3},{"value":"Manual Configuration (VS Code)","id":"manual-configuration-vs-code","depth":4},{"value":"Cursor","id":"cursor","depth":3},{"value":"Manual Configuration (Cursor)","id":"manual-configuration-cursor","depth":4},{"value":"Verification","id":"verification","depth":2},{"value":"Example Usage","id":"example-usage","depth":2},{"value":"Example 1: API Discovery","id":"example-1-api-discovery","depth":3},{"value":"Example 2: Generate Integration Code","id":"example-2-generate-integration-code","depth":3},{"value":"Example 3: Understand Authentication","id":"example-3-understand-authentication","depth":3},{"value":"Example 4: Explore API Workflows","id":"example-4-explore-api-workflows","depth":3},{"value":"Example 5: Debug API Errors","id":"example-5-debug-api-errors","depth":3},{"value":"Example 6: Generate Request Examples","id":"example-6-generate-request-examples","depth":3},{"value":"What Your Assistant Can Access","id":"what-your-assistant-can-access","depth":2},{"value":"Workflow Intelligence","id":"workflow-intelligence","depth":3},{"value":"Best Practices","id":"best-practices","depth":2},{"value":"1. Be Specific in Your Prompts","id":"1-be-specific-in-your-prompts","depth":3},{"value":"2. Reference Specific Products","id":"2-reference-specific-products","depth":3},{"value":"3. Request Complete Examples","id":"3-request-complete-examples","depth":3},{"value":"4. Leverage Workflow Documentation","id":"4-leverage-workflow-documentation","depth":3},{"value":"Troubleshooting","id":"troubleshooting","depth":2},{"value":"Connection Issues","id":"connection-issues","depth":3},{"value":"No Response from AI","id":"no-response-from-ai","depth":3},{"value":"Outdated Information","id":"outdated-information","depth":3},{"value":"Additional Resources","id":"additional-resources","depth":2},{"value":"Support","id":"support","depth":2}],"frontmatter":{"seo":{"title":"Connect to the Docs"}},"lastModified":"2026-09-23T10:17:49.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/connect-apis-catalog/information/connecttodocs","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}