Basic Information

Base URL

https://www.iqautoscan3.com

QA URL

https://qa_www.iqautoscan3.com

Authentication

All API requests require authentication using an API key. Include your credentials in the request headers or as specified in your integration agreement.

Error Handling

All endpoints return standard HTTP status codes and error responses in the following format:

{
  "error": {
    "code": "INVALID_SEARCH_LEVEL",
    "message": "SearchLevel must be 1, 2, or 3",
    "details": "Provided value: 5"
  },
  "status": 400
}

Common Error Codes:

Best Practices

1. Use Batch Processing

For large datasets, use the batch scanning workflow rather than multiple single-name scans. This improves performance and reduces API calls.

2. Implement Polling with Backoff

When monitoring progress, use exponential backoff.

3. Filter Early

Use V2 composite requests with PEP and watchlist filters to reduce false positives and improve result relevance.

4. Encrypt in Production

Always use secure/encrypted endpoints (/Secure/) for production data to ensure compliance with data protection regulations.

5. Clean Up Completed Scans

Clear completed search data regularly using the Clear Search Data endpoint to maintain system performance.

6. Handle Pagination

Process results in pages (recommended: 100-500 records per page) to avoid memory issues with large result sets.

8. Configure Appropriate Similarity Thresholds

Determine the comfortability your institution has with threshold results.

9. Handle Rate Limits Gracefully

Implement retry logic with exponential backoff when receiving 429 responses.

10. Monitor API Health

Use the health check endpoint to verify API availability before batch operations.

Appendix

Search Level Reference

Entity Type Reference

Search Type Reference

Document Version: 1.0
Last Updated: April 28, 2026
API Version: v1
Base URL: https://www.iqautoscan3.com