Skip to main content

Uniphore Customer Portal

Status check API

This API returns the status of the delete request for a given request-id.

Request
curl -H "Authorization: Bearer 911999706310ffbcb32981863e23ce72d5e60d7b" -XGET "https://api.us.cloud.uniphore.com/api/v2/data/delete-status/{request-id}"
Header Parameter

Header Parameter

Description

Authorization

The authorization used in this API is Bearer <Token>. The access token should be sent with all client requests. The access token helps the server to validate the request source.

Path Parameter

Path Parameter Name

Description

request-id

ID of the delete request for which status need to be checked.

Example Response
{
  "data": {
    "requestId": "12121212",
    "startTime": 121212121,
    "status": "in-progress | completed",
    "userId": 1
  }
}
Response Parameters

Response Parameters

Description

requestId

ID of the delete request for which the status need to be checked. The request-id in the request and requestId in the response are the same.

startTime

The time when the delete request was placed.

status

The status of the give delete request. The status can be

  • in-progress

  • completed

  • error

userId

ID of the user for whom the PII delete request was placed.

Response and Error Codes

Response and Error Codes

Description

200

The request is processed, and the status is returned.

401

Authentication failed

404

Invalid customer-id

500

Server error