Information
This portal is currently in BETA. Minor variations may exist, and supplementary product documentation is being added. Upcoming updates include:
- Country-specific company report schemas and data structures
- UBO information per country
- KYC documentation
WELCOME TO THE CREDITSAFE CONNECT API DOCUMENTATION
This portal will provide information on how to use the Connect API to its most efficient capacity.
This documentation contains the following sections and what you can find within them:
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 feed back 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
Resource Links
- Front End UI for testing API
- Help Articles Database
- Data Dictionaries
- Data Availability Per Country
- Feature Availability
- Connect Report Templates