- About the IPQS APIs
- Proxy & VPN Detection API
- Email Verification API
- Phone Number Validation API
- Malicious URL Scanner API
- Device Fingerprint API
- Mobile Device Fingerprinting SDK
- Fraud Flows
- Gaming Fraud Detection SDK
- Dark Web Leak API
- Malware File Scanner API
- Request List API
- Fraud Reporting API
- Account Management APIs
- Bulk Validation CSV
- Allowlist Blocklist APIs
- Plugins Platforms Integrations
- IP Reputation Database
- IP Address Abuse Feed
- Email Verification Database
-
Custom Integrations
- Getting Started
- Authentication
- Refresh Secret
- IP & Proxy Checks
- Email Verification Checks
- Phone Number Validity Checks
- Device Tracker
- List Device Trackers
- Device Tracker Statistics
- Login Tokens
- Overview Statistics
- Recent Proxy Statistics
- Recent Email Statistics
- Fraud Reporting
- Retrieve Requests by ID
- Device Fraud Risk Reasons API Documentation
- Transaction Risk Reasons API Documentation
- Country List API Documentation
- Release Notes
Response Parameters
Rate this article:
Select all that apply:
Email:
Response Field Definitions
The response parameters for most Flow Steps will be identical to those of its corresponding API:
The ID Verification Flow Step is unique to Fraud Flows and therefore has its own separate response parameters.
Response parameters - ID Verification
| Key | Description | Type |
|---|---|---|
| success | Whether the ID Verification succeeded. | Boolean |
| id_type | The type of ID the end user submitted. | String |
| id_number | The ID number of the submitted ID. | String |
| issue_date | The issue date found on the ID. | Datetime |
| expiration_date | The expiration date found on the ID. | Datetime |
| given_name | The given name found on the ID. | String |
| surname | The surname found on the ID. | String |
| birth_date | The birth date found on the ID. | Datetime |
| sex | The sex found on the ID. | String |
| height | The height found on the ID. | String |
| address1 | The first line of an address found on the ID. | String |
| address2 | The second line of an address found on the ID. | String |
| city | The city found on the ID. | String |
| state | The state/province found on the ID. | String |
| postal_code | The postal code found on the ID. | String |
| country | The country found on the ID. | String |
| valid_id | Whether the ID appears to be a valid ID. | Boolean |
| valid_selfie | Whether the selfie appears to be valid (photo of a person) | Boolean |
| match_confidence | A number 0-100 representing how confident the selfie matches the ID. | Integer |