openapi: 3.2.0
info:
  title: Persona Accounts Events API
  description: The Persona API is a configurable identity platform for KYC, KYB, AML, and fraud prevention.
  termsOfService: https://withpersona.com/legal/terms-of-service
  contact:
    name: Persona Support
    url: https://help.withpersona.com
    email: support@withpersona.com
  version: '2023-01-05'
servers:
- url: https://api.withpersona.com/api/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Events
  description: Immutable record of everything that happens in an account.
paths:
  /events:
    get:
      operationId: listAllEvents
      tags:
      - Events
      summary: List all Events
      description: Returns the queryable record of everything that has happened in your account.
      parameters:
      - $ref: '#/components/parameters/PageAfter'
      - $ref: '#/components/parameters/PageSize'
      responses:
        '200':
          description: A list of Events.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericList'
  /events/{event-id}:
    parameters:
    - name: event-id
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: retrieveEvent
      tags:
      - Events
      summary: Retrieve an Event
      responses:
        '200':
          description: The requested Event.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResource'
components:
  schemas:
    GenericList:
      type: object
      description: A JSON:API document wrapping a collection of resources.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceObject'
        links:
          type: object
          properties:
            prev:
              type:
              - string
              - 'null'
            next:
              type:
              - string
              - 'null'
    ResourceObject:
      type: object
      description: A JSON:API resource object.
      properties:
        type:
          type: string
        id:
          type: string
        attributes:
          type: object
          additionalProperties: true
        relationships:
          type: object
          additionalProperties: true
    GenericResource:
      type: object
      description: A JSON:API document wrapping a single resource.
      properties:
        data:
          $ref: '#/components/schemas/ResourceObject'
        included:
          type: array
          items:
            $ref: '#/components/schemas/ResourceObject'
        meta:
          type: object
          additionalProperties: true
  parameters:
    PageSize:
      name: page[size]
      in: query
      required: false
      description: Number of results per page (max 100).
      schema:
        type: integer
        default: 10
        maximum: 100
    PageAfter:
      name: page[after]
      in: query
      required: false
      description: Cursor for the object after which to start the page.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Persona API key passed as a Bearer token in the Authorization header.