Skip to main content

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โ€‹

NameTypeRequiredDescription
textStringโœ…Text to anonymize
langStringโœ…Language code (e.g., en, de, etc.)
webhook_urlStringโœ…HTTPS endpoint to receive the result
choicesArrayโœ…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"
}