Supported Formats

Complete list of format names for structure-preserving masking — use these exact strings in the format field of masking requests.

Formats are used to preserve the structure of the original value while masking the actual data, or to override auto-detection when the entity type is known.

Using formats

Provide the format field in your masking request to specify which format to apply:

{
  "mask": [
    {
      "value": "(408) 426-9989",
      "format": "Phone Number",
      "token_name": "Numeric Token"
    }
  ]
}

Format names are case- and spelling-sensitive. Use the exact strings listed below. Invalid format names return errors such as format name not defined.

Complete format list

Format Name	Allowed Delimiters	Example	Masked
`Person Name`	`" "` `,` `.` `-` `'`	John D. Smith	wewe m. Sdfd
`Email Address`	`" "` `@`	test.user@example.com	tqwq.ere@eer.vdf
`Phone Number`	`" "` `.` `-` `(` `)` `+` `x` `extension` `ext` `,`	+1 (234) 567-8900	-9588
`Address`	`" "` `,` `.` `-` `/` `(` `)` `#`	123, Main St. Apt#4	*, M* S. A*#4
`Organization`	`" "` `,` `.` `-`	Protect_Inc.	wew_ewe
`URL`	`/` `:` `//` `?` `&` `#` `,` `=` `+` `.`	https://example.com/path?id=1	https://MMDSD/ddw?we=\*
`IP Address`	`" "` `.`	192.168.1.1	345.232.3.1
`Mac Address`	`-` `:`	00:1A:2B:3C:4D:5E	43:56:67
`Fax Number`	`-` `(` `)` `.` `" "` `+` `/` `,`	+1 (555) 123-4567	+4 (334) 534-6789
`Social Identification Numbers`	`-` `" "`	123-45-6789	434-45-6789
`Passport Number`	`" "` `-` `,` `:` `;` `.`	M123-4567	f233-rwt
`Driving License Number`	`" "` `-`	TN 45 20230012345	RE 43 34343
`Licence Number`	`-` `/` `.` `_`	DL-0420110149646	34-43434343
`Nationality`	(none)	Indian	uhrwt
`Vehicle Identification Number`	`-` `:`	1H_GCM82633A123456	45_dadae
`Registration Number`	`" "` `-` `,` `:`	MH-12-AB-1234	32-WE-56-1234
`Username`	`" "` `,` `.` `-` `_` `@` `'`	john_doe@example.com	jfd@emp.dwe
`Credit Card`	(none)	4111111111111111	435452345
`Credit Card Expiration Date`	`/` `-` `,` `:` `" "`	27-Dec	83-hbr
`CVV`	(none)	123	***
`Bank Account Number`	`-` `" "` `/` `.`	123456/89012	32323/9012
`Routing Number`	`" "` `-`	1100_00	425_00
`Swift`	`" "` (none)	HD,FCINBB	****INBB
`TAN`	`" "` `-` (none)	ABC-D12345E	343-ERE
`Policy No`	`" "` `-` `,` `:`	POL-123-456	ret-656-456
`Pan`	(none)	ABCDE1234F	ere1234F
`Insurance Number`	`" "` `-` `,` `:`	123-45-6789	3456-54-6789
`Pin`	(none)	7865	yhtj
`Medical Record Number`	`" "` `-`	MRN-123456	TYE-ER456
`Date`	`/` `-` `,` `:` `" "`	6/24/2021	6/24/2021

When to use formats

Situation	Use format?
Auto-detection is sufficient	Not required
Downstream system requires specific structure	Yes
Detection is ambiguous (value could be multiple types)	Yes
You want to override what auto-detection would pick	Yes

When both format and auto-detection are possible, format always wins.

Was this page helpful?

Last updated 3 weeks ago

Built with Documentation.AI