Getting Started

1

Obtain API key

Contact support to get your development API key and access credentials.
2

Choose specific endpoints

Once familiar with the API, use line-of-business specific endpoints for optimal performance.

Lines of Business

Choose a specific line of business endpoint for faster processing and template-specific optimizations:

Authentication

All API requests require authentication using an API key passed in the x-api-key header.
curl -X POST 'https://api.ferofill.com/api/v1/submission/extract' \
  -H 'x-api-key: YOUR_API_KEY' \
  -F 'files=@document1.pdf' \
  -F 'files=@document2.jpg'
Never expose your API key in client-side code or commit it to version control. Store it securely in environment variables.

Rate Limits

Rate limits vary by environment and API key type:
EnvironmentLimit
Development/POC5 requests/hour
ProductionCustom limits
Contact support to upgrade your rate limits or obtain a production API key.