Skip to content

Add hidden KYB Agent API docs#9

Merged
robbalian merged 1 commit intomainfrom
robbalian/kyb-agent-docs
Feb 23, 2026
Merged

Add hidden KYB Agent API docs#9
robbalian merged 1 commit intomainfrom
robbalian/kyb-agent-docs

Conversation

@robbalian
Copy link
Copy Markdown
Contributor

Summary

  • Adds a single hidden docs page for the KYB Agent API at /guides/kyb-quickstart
  • Covers both endpoints: POST /kyb/report/start and GET /kyb/report/{report_id}
  • Points to api.reprompt.io with Bearer auth
  • Includes example responses for all states (processing, completed, error)
  • Hidden from navigation — accessible only via direct link
  • Adds openapi-kyb.json spec for reference

Test plan

  • Verify page loads at /guides/kyb-quickstart
  • Confirm page does not appear in version dropdown or sidebar nav
  • Review example responses for accuracy

🤖 Generated with Claude Code

Single hidden page at /guides/kyb-quickstart with full API reference
for the KYB Agent service (POST start report, GET poll report).
Points to api.reprompt.io with Bearer auth. Not visible in nav.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@claude
Copy link
Copy Markdown

claude bot commented Feb 23, 2026

Claude finished @robbalian's task —— View job


Review Results

Code Examples Testing

  • POST /kyb/report/start: ⏭️ Skip (no API key)
  • GET /kyb/report/{report_id}: ⏭️ Skip (no API key)
  • Placeholder format: ✅ Uses correct YOUR_API_KEY format

Documentation Quality Assessment

✅ HIGH QUALITY - NO AI SLOP DETECTED

  • Concise & Technical: Direct, no fluff or obvious explanations
  • Well-structured: Clear sections, proper tables, logical flow
  • Specific examples: Uses real business (Stripe Inc) with actual address
  • Proper hidden attribute: hidden: true correctly set
  • Good response examples: Shows all states (processing/completed/error) with realistic data

OpenAPI Spec Review

✅ ALIGNED WITH DOCUMENTATION

  • Schemas match documented parameters exactly
  • Required fields align: business_name, business_address
  • Optional fields match: person_submitting, tax_identification_number
  • Response structure matches examples
  • Base URL consistent: https://api.reprompt.io

Minor Notes

  • Documentation uses api.reprompt.io while OpenAPI uses api.reprompt.io (consistent)
  • All endpoint paths, parameter names, and response fields align properly
  • No breaking changes or inconsistencies found

Assessment: DEFINITELY_FINE

High-quality technical documentation with accurate examples. No AI slop, proper formatting, and OpenAPI alignment.

@robbalian robbalian merged commit 48f55ac into main Feb 23, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant