Whether you’re building new API documentation or updating existing documentation, your goal is to provide clear, concise information to help developers understand and use the services you offer. To achieve that, you need to know who you’re writing for and understand your audience’s level of technical knowledge. This article covers best practices for API documentation and helps you get started creating documentation that meets your users’ needs.

IPQualityScore API documentation overview has pioneered fraud detection & security since 2011. We offer a suite of user, order & transaction risk analysis APIs designed to Proactively Prevent Fraud(tm) with industry leading accuracy to identify fraudulent users, suspicious payments, and abusive behavior online.

Our Device Fingerprinting API profiles devices in real time to determine a unique device ID and risk profile based on device settings, identifiers, and other attributes that indicate potential malicious activity (such as emulators, location spoofing, non-human bot behavior). Our Phone Reputation API scores phones to detect invalid, disposable, or throwaway phone numbers that are more likely to generate chargeback fraud disputes. And our Physical Address Verification API makes it easy to verify and validate user data by scoring the quality of a physical address in real-time.

IPQualityScore API Documentation Overview: A Complete Developer Guide

The Transaction Risk API is designed to score e-commerce transactions in real-time based on a wide range of considered inputs that are known to be associated with fraudsters and high-risk activity (such as multiple account creation, overlapping addresses, and payment gateway errors). In addition, we can leverage additional user & order data (like billing information, phone number, and order details) to improve the accuracy of the risk score.