Skip to content
Last updated

WELCOME TO THE CREDITSAFE CONNECT API DOCUMENTATION

Information

Detailed documentation for each product in the API is currently being delivered to the platform. Please check the change log regularly for the latest updates and additions.

Coming soon:

  • Expanded documentation for KYC Protect, including:
    • Detailed process flows
    • Integration guides

This portal will provide information on how to use the Connect API to its most efficient capacity.

This documentation contains the following corresponding sections of the sidebar navigation.

These are not clickable links on this page but can be accessed through the sidebar. The resources include:

Information

This will include information on the following:

  • Structure of the Documentation Portal and how to Navigate it
  • Rate Limiting
  • Versioning Strategy
  • Feedback - The new portal allows you to leave feedback on any specific page, and also to highlight any suspected code queries

Quick Start Guide

  • This will provide basic information on how to access any of the collections in either YAML or JSON to start making calls to the API
  • Authenticating with the API

API Catalog

  • This provides two methods of acquiring the API Specifications
    • The full Connect API and all of its associated products
    • Individual modualised products of the API for a more directed API Specification
  • Front End UI for testing API
  • Help Articles Database
  • Data Dictionaries
  • Data Availability Per Country
  • Feature Availability
  • Connect Report Templates

Need Help? Try the New AI Assistance Tool!

You can now get instant help with general questions or guidance on using the portal by clicking the search option in the top right corner and selecting Search with AI. The AI tool uses all available documentation resources to assist you as much as possible.

 
Next page