API Reference

This documentation provides comprehensive details for integrating with our public API. It is designed for staffing, HR tech, and recruitment companies, as well as internal teams and authorized partners, to seamlessly integrate resume and talent intelligence capabilities into their applications.

With the FlashApply API, you can parse resumes at scale, tailor them to jobs, verify details, match candidates, redact Personal Identifiable Information (PII), run AI-powered searches, and more.

Getting Started

To begin, sign up for an account. Once your account is approved (typically instantly, but within 24 hours at most), you can start making API calls.

1. Authentication: Obtain an API key from the dashboard
2. Base URL: All API requests should be made to https://api.flashapply.ai
3. Mock Environment: All mock API requests should be made to https://api.flashapply.ai/mock and use the API key mock-api-key
4. Request Format: All request bodies and responses are in JSON format unless otherwise specified
5. Error Handling: Familiarize yourself with our standard error responses to handle issues gracefully

Key Sections

• API Collections: Explore detailed documentation for each API endpoint, grouped by feature area.
• Schema Reference: Understand the structure of data entities used across the API. Most resources support partial updates, reducing the number of API calls and endpoints you need to integrate with.
• Rate Limiting & Authentication: Learn about our security measures and usage policies.
• Best Practices: Get tips for efficient and reliable API integration.
• Changelog: Stay updated with the latest API changes and deprecations.

We are committed to providing a robust and reliable API. If you have encounter issues or have any questions, please contact our support team.