post
https://{host}/v2/requests
The PII deletion request API allows you to raise a PII deletion request.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
Prerequisites
- Make sure that PII deletion configuration is enabled. Refer Enable PII deletion documentation for more information.
- Make sure that you have appropriate access control configured. For more information, see access group documentation.
Example request
curl --location 'https://eu.api.capillarytech.com/v2/requests' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'X-CAP-API-OAUTH-TOKEN: RUGojdJXl0hvvoSazhdwcv1YmLq_WV18e2Uiv49ZXkFjs2pvTDiHYrp2dv78-1rD-6q63HwwdPhhRnc4QQmgB-CG2bWTA0rQjZkZRRNViZOuRHhQArBgm4Ilx5_Un2H1YCNUDIMI9_VigV0GMJ8p1lmKp1nTD6vuO544OTphAnUVQjyVfxJyJmi9Dt14XykbRUT8BRIYOTjF4KHo8ziG_MBa-RHGmevFPQmi8NAr-LkriAjzC2wJ-BnBFSLNc-_p33knlasPA3TsbGndn0oig' \
--data '
{
"type": "CUSTOMER",
"baseType": "DELETE",
"comments": "APP DELETION",
"customerIdentificationInfo": {
"source": "INSTORE",
"identifierType": "mobile",
"identifierValue": "919986000581"
}
}
'Body parameters
| Parameter | Type | Description |
|---|---|---|
| type | string | Type of the data. At present, only CUSTOMER is supported. |
| baseType | string | Type of the operation. In this context, DELETE is the operation type. |
| comments | string | Comments or description. The maximum number of supported characters is 255. |
| source | string | Source of customer data |
| identifierType | string | Type of identifier |
| identifierValue | string | Value of the identifier |
Response
| Parameter | Description |
|---|---|
| createdId | The request-id created. |
| warnings | Warnings, if any. |