Ometria GDPR anonymisation requests API

openapi: 3.2.0
info:
  version: 1.1.0
  title: Ometria data GDPR anonymisation requests API
  description: 'Welcome to the Ometria API reference.


    The Ometria API is organized around the REST methodology, and it uses resource-oriented URLs, and common HTTP response codes to indicate API errors. All requests are authenticated using an API key which can be obtained from your account settings.


    ### HTTPS


    All requests to the Ometria API MUST be carried out via HTTPS. API servers do not listen on unsecured HTTP ports to avoid the possibility of insecure information exchange.


    ### Message encoding


    The V2 Ometria API uses JSON encoding for all data exchanges and assumes UTF-8 character encoding throughout.


    ### Rate limits


    The Ometria API has a default rate limit of 4 requests per second per Ometria account. The /push/ endpoint allows 8 requests per second per Ometria account. If you expect to exceed this limit, please contact us.


    In the case of your application being rate limited, the HTTP code 429 (too many requests) will be returned. In this case your application should reduce the number of requests it is trying to send.'
  contact:
    name: Ometria
    email: support@ometria.com
    url: https://ometria.com
servers:
- url: https://api.ometria.com/v2
security:
- apikey: []
tags:
- name: GDPR anonymisation requests
paths:
  /data-deletion-requests:
    get:
      tags:
      - GDPR anonymisation requests
      summary: List GDPR related data anonymisation requests
      description: Returns previously filed GDPR related data anonymisation requests and their status.
      responses:
        '200':
          description: An array of data anonymisation objects.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataDeletionGetResponse'
        '403':
          description: API key is not authorised to access this resource.
      operationId: getDataDeletionRequests
      x-operation-id-source: derived
    post:
      tags:
      - GDPR anonymisation requests
      summary: Create new GDPR data anonymisation request
      description: Create new or update an existing order
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataDeletionSubmission'
            examples:
              named_identifier_field:
                summary: Using a top-level identifier field
                value:
                  email_address: someone@domain.com
                  comment: Some comment
                  action: anonymise
              identity_resolution_identifier:
                summary: Using an identifier from identity resolution config
                value:
                  identifier:
                    type: loyalty_id
                    value: LOY-7898734
                  comment: Some comment
                  action: anonymise
        description: 'Provide exactly one identifier: `email_address`, `phone_number`, `customer_id`, or an `identifier` object referencing any identifier defined in your identity resolution configuration (e.g. `loyalty_id`).'
        required: true
      responses:
        '200':
          description: GDPR data anonymisation request object successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataDeletionPostResponse'
        '403':
          description: API key is not authorised to access this resource
      operationId: postDataDeletionRequests
      x-operation-id-source: derived
  /data-deletion-requests/{id}:
    get:
      tags:
      - GDPR anonymisation requests
      summary: Get details of specific GDPR related data anonymisation request
      description: Returns details and status of GDPR related data anonymisation request by its ID.
      parameters:
      - name: id
        in: path
        description: The request ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A data anonymisation object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataDeletionGetResponse'
        '403':
          description: API key is not authorised to access this resource.
        '404':
          description: Data anonymisation request with specified ID was not found
      operationId: getDataDeletionRequestsById
      x-operation-id-source: derived
components:
  schemas:
    DataDeletionSubmission:
      type: object
      description: 'GDPR related data anonymisation request submission. Exactly one identifier must be provided to identify the individual: `email_address`, `customer_id`, `phone_number`, or an `identifier` object referencing any identifier defined in your account''s identity resolution configuration (e.g. `loyalty_id`).'
      properties:
        email_address:
          type: string
          description: Email address of individual to be anonymised
        customer_id:
          type: string
          description: Customer ID of individual to be anonymised
        phone_number:
          type: string
          description: Phone number of individual to be anonymised, in E.164/International format (e.g. starting "+447...")
        identifier:
          type: object
          description: An identifier as defined in your account's identity resolution configuration, used to identify the individual to be anonymised. Accepts any configured identifier type, including standard ones such as `email`, as well as custom ones such as `loyalty_id`. Provide this instead of `email_address`, `customer_id` or `phone_number`.
          required:
          - type
          - value
          properties:
            type:
              type: string
              description: The identifier type, as defined in your identity resolution configuration. E.g. `loyalty_id` or `email`.
              example: loyalty_id
            value:
              type: string
              description: The identifier value of the individual to be anonymised.
              example: LOY-7898734
        comment:
          type: string
          description: Optional user supplied comment text
        action:
          type: string
          description: The action to take on this individual's data. The only supported value currently is "anonymise"
          enum:
          - anonymise
      example:
        email_address: someone@domain.com
        comment: Some comment
        action: anonymise
    DataDeletionGetResponse:
      type: object
      description: Describes a GDPR-related data anonymisation request
      properties:
        id:
          type: string
          description: The request ID
        comment:
          type: string
          description: Optional user supplied comment text.
        timestamp_created:
          type: string
          description: Date and time of request being filed. Following ISO 8601 dateTime format with timezone offset _YYYY-MM-DDThh:mm:ss+Z_.
          format: date-time
        timestamp_completed:
          type: string
          description: Date and time of request being processed. Following ISO 8601 dateTime format with timezone offset _YYYY-MM-DDThh:mm:ss+Z_.
          format: date-time
        action:
          type: string
          description: The action to take on this individual's data. Currently he only supported value is "anonymise"
          enum:
          - anonymise
        summary:
          type: string
          description: A textual summary of the records found and modified after processing.
        source:
          type: object
          description: A summary of where the request originated, e.g. from with the application or via API.
        identities:
          type: array
          description: A list of hashed identifiers that represent the identities of individuals processed in this request.
          items:
            type: string
      example:
        id: a8c53a39-e0fc-462c-b5fa-907fe70a4174
        summary: 1 contact record anonymised, 15 events anonymise
        timestamp_created: '2017-02-02 10:18:12.833949+00'
        timestamp_completed: '2017-02-04 10:18:12.833949+00'
        action: anonymise
        comment: Some comment
        identities:
        - hashed_identifier: 3af31748a10ef8bd28ce7620c25fe18d@anonymous.ometria
        source:
          api_request_id: a8c53a39-e0fc-462c-b5fa-907fe70a4174
          origin: api
          user:
            email: user@user.com
            name: A user
    DataDeletionPostResponse:
      type: object
      description: Response to a GDPR-related data anonymisation request submission
      properties:
        id:
          type: string
          description: The request ID
      example:
        id: a8c53a39-e0fc-462c-b5fa-907fe70a4174
  securitySchemes:
    apikey:
      type: apiKey
      name: X-Ometria-Auth
      in: header
      description: Ometria API key which can be obtained from your Ometria account administrator
    apiKeyReadTranslations:
      type: apiKey
      name: X-Ometria-Auth
      in: header
      description: 'Ometria API key which can be obtained from your Ometria account administrator. **Note**: The API key must have the scope `read:translations`.'
    apiKeyWriteTranslations:
      type: apiKey
      name: X-Ometria-Auth
      in: header
      description: 'Ometria API key which can be obtained from your Ometria account administrator. **Note**: The API key must have the scope `write:translations`.'
x-explorer-enabled: false
x-readme:
  proxy-enabled: true
  samples-enabled: true