Request a personal export, profile deletion or account deletion

Privacy · requestPersonalDataOperation

Separate asynchronous operations. Deletions require an AMR authentication timestamp within five minutes, not a refreshed token iat. Account deletion additionally requires ownership, exact account name and confirmation. Active identical requests are reused. Processor follow-up is reported separately from local completion.

POST/privacy/requests

Base URL: https://api.businessmode.io/v1

Authentication

Human bearer token

The requirement above comes from this operation's OpenAPI security declaration. See Authentication.

Parameters

No path, query, or header parameters are defined.

Request body

Required

application/json

oneOf · PrivacyRequestInput

oneOf · 3 alternatives

Alternative 1
object
  • No additional properties
FieldTypeRequiredDescription / constraints
kindstringYesConstant: export
Alternative 2
object
  • No additional properties
FieldTypeRequiredDescription / constraints
confirmbooleanYesConstant: true
kindstringYesConstant: delete_profile
Alternative 3
object
  • No additional properties
FieldTypeRequiredDescription / constraints
accountIdstringYesFormat: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
accountNamestringYesMinimum length: 1 · Maximum length: 200
confirmbooleanYesConstant: true
kindstringYesConstant: delete_account

Responses

For status codes, request IDs, and safe retry decisions, see Errors & recovery. Known-code descriptions below are operation-specific, not a complete global error enum.

202 Asynchronous request accepted; inspect its status for completion.

Content type: application/json

object · PrivacyRequest
  • No additional properties
FieldTypeRequiredDescription / constraints
artifactExpiresAtanyOfYes
View nested schema
anyOf

anyOf · 2 alternatives

Alternative 1
string
  • Format: date-time
  • Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Alternative 2
null
completedAtanyOfYes
View nested schema
anyOf

anyOf · 2 alternatives

Alternative 1
string
  • Format: date-time
  • Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Alternative 2
null
downloadAvailablebooleanYes
failureCodestring | nullYes
idstringYesFormat: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
kindstringYesValues: export, delete_profile, delete_account
processorFollowUpbooleanYes
requestedAtstringYesFormat: date-time · Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
statusstringYesValues: queued, processing, available, needs_attention, completed, expired

400 Invalid request.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

401 Authentication failed.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

403 The authenticated human is not permitted to perform this operation.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

409 The request conflicts with current resource state.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

429 Too many requests. Honor Retry-After before retrying with the same logical Idempotency-Key, where required. Known error codes: rate_limit_exceeded.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

500 An unexpected server error occurred.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

← All API operations