All API requests require authentication using API keys
Base URL:
https://api.hippo-pii.comInclude your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEYSecurity Note
Keep your API keys secure and never expose them in client-side code. Use environment variables in production.
Available endpoints for PII detection and processing
/v1/detectDetect PII entities in text
/v1/tokenizeReplace PII with secure tokens
/v1/detokenizeReverse tokenization to original text
/v1/analyze/fileProcess uploaded files for PII
/v1/entitiesList supported PII entity types
/v1/usageGet API usage statistics
Example requests for PII detection
curl -X POST https://api.hippo-pii.com/v1/detect \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"text": "My name is John Doe and my email is john@example.com",
"entities": ["PERSON", "EMAIL"],
"mode": "detect"
}'PII entity types that can be detected and tokenized
PERSONPerson names
Example:
John DoeEMAILEmail addresses
Example:
john@example.comPHONEPhone numbers
Example:
+1-555-123-4567SSNSocial Security Numbers
Example:
123-45-6789CREDIT_CARDCredit card numbers
Example:
4111-1111-1111-1111IP_ADDRESSIP addresses
Example:
192.168.1.1ADDRESSPhysical addresses
Example:
123 Main St, CityISRAELI_IDIsraeli ID numbers
Example:
123456789BANK_ACCOUNTBank account numbers
Example:
1234567890PASSPORTPassport numbers
Example:
A12345678Understanding API error responses and status codes
Invalid request parameters or malformed JSON
Invalid or missing API key
Too many requests - check your rate limits
Internal server error - contact support if persistent
{
"success": false,
"error": {
"code": "INVALID_API_KEY",
"message": "The provided API key is invalid",
"details": "Please check your API key and try again"
},
"request_id": "req_123456789"
}API usage limits and best practices
Rate Limit Headers
Check the X-RateLimit-Remaining and X-RateLimit-Reset headers in API responses to monitor your usage.