Endpoint and Authentication:
Endpoint: https://trial.protecto.ai/api/vault/metadata/data
For authentication, include the following token in the request headers:
Headers: {“Authorization”: “Bearer <AUTH_TOKEN>”}
Query params: { “pageName”: “token”/”auto-detect”/ “format” }
Example response
1.If pageName is a token:
{
"editable": [
{
"type": "custom",
"column": [
"noOfBytes",
"minimumNoOfBytes",
"maximumNoOfBytes",
"tokenCharacters",
"caseSensitive"
]
},
{
"type": "default",
"column": [
"noOfBytes",
"minimumNoOfBytes",
"maximumNoOfBytes",
"tokenCharacters",
"caseSensitive"
]
}
],
"values": [
{
"tokenName": "Default",
"noOfBytes": "random",
"minimumNoOfBytes": 13,
"maximumNoOfBytes": 20,
"tokenCharacters": "alpha-numeric",
"caseSensitive": false,
"type": "default"
},
{
"tokenName": "TextToken",
"noOfBytes": "same as input",
"minimumNoOfBytes": 23,
"maximumNoOfBytes": 99999,
"tokenCharacters": "alpha-numeric",
"caseSensitive": false,
"type": "default"
},
{
"tokenName": "NumericToken",
"noOfBytes": "same as input",
"minimumNoOfBytes": 10,
"maximumNoOfBytes": 10,
"tokenCharacters": "alpha-numeric",
"caseSensitive": false,
"type": "default"
},
{
"tokenName": "SpecialToken",
"noOfBytes": "same as input",
"minimumNoOfBytes": 10,
"maximumNoOfBytes": 20,
"tokenCharacters": "numeric",
"caseSensitive": false,
"type": "default"
},
{
"tokenName": "AlphaNumericToken",
"noOfBytes": "same as input",
"minimumNoOfBytes": 1,
"maximumNoOfBytes": 20000,
"tokenCharacters": "alpha-numeric",
"caseSensitive": true,
"type": "custom"
},
{
"tokenName": "NewToken",
"noOfBytes": "random",
"minimumNoOfBytes": 14,
"maximumNoOfBytes": 221,
"tokenCharacters": "alpha-numeric",
"caseSensitive": false,
"type": "custom"
}
]
}
2. If pageName is auto-detect:
{
"editable": [
{
"type": "custom",
"column": ["tokenName", "prefix", "suffix"]
},
{
"type": "default",
"column": ["tokenName", "prefix", "suffix"]
}
],
"values": [
{
"tagName": "Person",
"tokenName": "Default",
"prefix": "<PER>",
"suffix": "</PER>",
"example": "mfP1icZ0PN-HwGjwR",
"type": "default"
},
{
"tagName": "Phone",
"tokenName": "NumericToken",
"prefix": "<PHN>",
"suffix": "</PHN>",
"example": "KrVOH-R22lH-TQM6L",
"type": "default"
},
{
"tagName": "Email",
"tokenName": "TextToken",
"prefix": "<EMAIL>",
"suffix": "</EMAIL>",
"example": "kUc2iuc@0VxLPAG1Dvm",
"type": "default"
},
{
"tagName": "Credit Card",
"tokenName": "SpecialToken",
"prefix": "<CRD>",
"suffix": "</CRD>",
"example": "4D67A-FZLFh-3OBk0-3cNo0",
"type": "custom"
},
{
"tagName": "Ip Address",
"tokenName": "NewToken",
"prefix": "<IPA>",
"suffix": "</IPA>",
"example": "n02G5.D3RH1.R22lH.cVTPM",
"type": "custom"
},
{
"tagName": "US SSN",
"tokenName": "AlphaNumericToken",
"prefix": "<SSN>",
"suffix": "</SSN>",
"example": "CWa96-0LNQd-umB6i",
"type": "custom"
}
]
}
3.if pageName is format:
{
"values": [
{
"formatName": "Person",
"example": ["Ella-Rose Amelia Brown, Jr"],
"mask": ["uGqK-2RC7 dO2Fo gIJ1j, NuASiExQmY"]
},
{
"formatName": "Email",
"example": ["johndoe@example.com"],
"mask": ["kUc2iuc@0VxLPAG1Dvm"]
},
{
"formatName": "Phone Number",
"example": ["+1 (555) 123-4567 ext. 123"],
"mask": ["+ovuVn (KrVOH) R22lH-TQM6L ext. R22lH"]
},
{
"formatName": "CreditCard",
"example": ["5000-2368-7954-3214, 5000 2368 7954 3214"],
"mask": ["4D67A-FZLFh-3OBk0-3cNo0, 4D67A FZLFh 3OBk0 3cNo0"]
},
{
"formatName": "IP Address",
"example": ["192.168.123.132"],
"mask": ["n02G5.D3RH1.R22lH.cVTPM"]
},
{
"formatName": "US SSN",
"example": ["856-45-6789", "856 45 6789"],
"mask": ["CWa96-0LNQd-umB6i", "CWa96 0LNQd umB6i"]
}
]
}
