Skip to main content
The credential comparison report is a PDF that compares the leaked credentials found across a set of domains over a chosen period — useful for measuring exposure across your brands, subsidiaries, or a domain and its country variants side by side. (In the dashboard this is the Credential Reports product.)

​
Generate

generate_credential_comparison_report takes the domains to compare and a period:
domains is the set to compare; it must contain at least one domain — an empty list is rejected with 400 {"domains": ["Empty domains list is not allowed."]} (blank or duplicate entries are dropped too). started_at / ended_at bound the period (dd-mm-yyyy). It returns { message, report_id } — take it to track the report and download the PDF.

​
Schedule it monthly

Rather than running this by hand each month, schedule it. create_report_schedule generates a credential comparison report for the same domains every month:
domains is required and must be non-empty — an empty list is rejected with 400 {"domains": ["Empty domains list is not allowed."]}. is_active defaults to true; end_date (dd-mm-yyyy, optional) stops the schedule after that date. It returns { message, schedule_id }.
  • List your schedules with list_report_schedules — each carries id, domains, is_active, create_date, update_date, and end_date.
  • Pause or edit one with update_report_schedule. Every PATCH must include domains; end_date and is_active are optional. There’s no separate delete — to stop a schedule, send its domains with is_active: false. A bare PATCH {"is_active": false} returns 400 {"domains": ["This field is required."]}.
  • See what it’s produced with list_scheduled_reports — the reports that schedule has generated, each downloadable by its report_id like any other.