Get account deletion status

GET

https://api.sureshake.com/v2/users/account-deletion/status

Header parameters

authorization
string
required
pattern: ^DeletionReceipt [a-f0-9]{64}$

Returns

200

Default Response

JSON

data
object
required
- requestId
  string
  required
  format: uuid
- status
  queued
  or
  running
  or
  completed
  or
  completed_with_errors
  or
  failed
  or
  overdue
  required
- requestedAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
- targetDate
  string
  required
  format: date-time
- accessSuspended
  true
  required
- support
  object
  required
  status
  not_required
  or
  pending
  or
  resolved
  or
  not_assessed
  required
  ticketId
  string
  or null
  required
  format: uuid
- nextRetryAt
  string
  or null
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

429

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Get account deletion status

curl --request GET \
  --url https://api.sureshake.com/v2/users/account-deletion/status \
  --header 'authorization: string'

const url = 'https://api.sureshake.com/v2/users/account-deletion/status';
const options = {method: 'GET', headers: {authorization: 'string'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "data": {
    "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
    "status": "queued",
    "requestedAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "targetDate": "2019-08-24T14:15:22Z",
    "accessSuspended": true,
    "support": {
      "status": "not_required",
      "ticketId": "e3e3e8ea-b02a-4536-85a2-a9c90f4ee74f"
    },
    "nextRetryAt": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}