PII detection & De-identification service API
Note: These APIs are available for private deployment. Not Generally Available. Email our team for getting access to these APIs: info@mayadataprivacy.eu
๐ Submit an Anonymization (De-identification) Jobโ
๐ Endpointโ
POST /mdp/ai-safe/job/anonymize
๐ Authenticationโ
- Type: API Key
- Key Name:
Authorization
- Location: Header
- Description: JWT token for authorization
Description:โ
Submits a new anonymization job. The text is processed asynchronously. Once completed, the result will be posted to the given webhook URL.
๐ฅ Requestโ
- Content-Type:
application/json
Parametersโ
Name | Type | Required | Description |
---|---|---|---|
text | String | โ | Text to anonymize |
lang | String | โ | Language code (e.g., en , de , etc.) |
webhook_url | String | โ | HTTPS endpoint to receive the result |
choices | Array | โ | Array of info types to anonymize: "Names" , "Emails" , "Phone" |
๐งช Example Requestโ
{
"lang": "eng",
"text": "Hello this is a test prompt by John. My email Id is John@mail.com and my number is +5424351451",
"choices": ["Names", "Emails", "Phone"],
"webhook_url": "https://yourdomain.com/webhook-endpoint"
}
๐ค Responseโ
{
"success": true,
"message": "Anonymization Job Accepted",
"response_code": 200
}
Once processing completes, the service sends a POST request to the provided webhook URL.
๐ฌ Webhook Payloadโ
โ Successโ
{
"job_id": "8d93cfc6-4023-478d-bd3b-6b693d6cf3ca",
"status": "completed",
"anonymized_text": "Hello this is a test prompt by Miller. My email Id is Maria.Miller.1@dummy.com and my number is +918506513874"
}
โ Failureโ
{
"job_id": "8d93cfc6-4023-478d-bd3b-6b693d6cf3ca",
"status": "failed",
"error": "some error occured"
}