Skip to main content
GET
/
v1
/
text
/
mask
Mask Text
curl --request GET \
  --url https://api.example.com/v1/text/mask \
  --header 'X-API-Key: <api-key>'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
text
string
required

Text to mask

​
start
integer
default:0

Characters to keep at start

Required range: x >= 0
​
end
integer
default:0

Characters to keep at end

Required range: x >= 0
​
mask_char
string
default:*

Masking character

Response

Successful Response