Griffin Legal person history API

openapi: 3.2.0
info:
  title: Griffin API keys Legal person history API
  version: '1.0'
  description: "## Introduction\n\nThe Griffin API is based on [REST](https://en.wikipedia.org/wiki/Representational_state_transfer).\nIt has resource-oriented URLs, accepts [JSON](https://www.json.org/json-en.html)-encoded request bodies, returns [JSON](https://www.json.org/json-en.html)-encoded responses, and uses standard HTTP response verbs and response codes.\n\nOur API deviates from strict RESTful principles if it makes sense to do so, such as when we enforce tighter access controls around certain operations.\nFor example, when closing a bank account: rather than send a PATCH request to the [bank account](#tag/Bank-accounts) resource to update it's status to `\"closed\"`, we provide a dedicated account closure resource.\n\nAnyone can [create an account](https://app.griffin.com/register) with Griffin and try out our API in [sandbox mode](/docs/guides/sandbox-vs-live-mode).\n\nNew to Griffin? Check out our [getting started guide](/docs/guides/get-started-with-the-api).\n\n## Navigation\n\nOur API is designed to be navigated programmatically. When you request any resource, you will find the URLs for related resources in the response body.\n\nThe API is structured as a tree with your [organization](#tag/Organizations) at the top. Everything that you own will be a sub-resource of your organization.\n\nTo bootstrap the navigation process, request the [index](#tag/Navigation/paths/~1v0~1index/get) endpoint: the response will contain your `organization-url`.\n\nFor a walkthrough, see our [getting started guide](/docs/guides/get-started-with-the-api).\n\n## Pagination\n\nOur list APIs support pagination (e.g. [list bank accounts](#tag/Bank-accounts/paths/~1v0~1organizations~1%7Borganization-id%7D~1bank~1accounts/get) and [list payments](#tag/Payments/paths/~1v0~1bank~1accounts~1%7Bbank-account-id%7D~1payments/get)).\nBy default, a list API returns up to 25 results. If there are more results available, the response payload will include links to the previous/next pages.\n\n### Change page size\n\nYou can request a different number of results (between 1 and 200, inclusive) by using the `page[size]` query parameter:\n\n```\nGET /v0/organizations/:id/bank/accounts?page[size]=100\n```\n\n### Navigating between pages\n\nList responses will include a `links` object with `prev` and `next` attributes, as shown below.\nPerform a GET request to the value of the attribute to fetch the previous/next page of results.\n\n```\n{\n  \"accounts\": [\n    // ...\n  ],\n  \"links\": {\n    \"prev\": \"/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts?page[before]=djE6WxSPxfYUTnCU9XtWzj9gGA\",\n    \"next\": \"/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA/bank/accounts?page[after]=djE6aw79PXZySUOL16LD8HRJ3A\"\n  }\n}\n\n```\nIf there is no previous or next page available, the value of the attribute will be  null.\n\nAny other query parameters included in the initial request will also be included in the response payload's links.\nIf you want to change parameters (see [filtering and sorting](#section/Filtering-and-sorting)), request the first page and follow the links from there.\n\n## Filtering and sorting\n\n### Sort results\n\nBy default, resources will be listed in descending order, usually based on the `created-at` attribute.\nYou can change the sorting behaviour of a list of results by using the `sort` query parameter.\n\nFor example, to list bank accounts in ascending order (oldest first):\n\n```\nGET /v0/organizations/:id/bank/accounts?sort=created-at\n```\n\nTo _explicitly_ sort in descending order (newest first), prefix the sort attribute with `-`:\n\n```\nGET /v0/organizations/:id/bank/accounts?sort=-created-at\n```\n\n### Filter results\n\nSome list APIs allow you to filter the results.\nFilters are expressed as nested data structures encoded into query parameters.\nFor example, you can list bank accounts that are in either the `opening` or `open` state with:\n\n```\nGET /v0/organizations/:id/bank/accounts?filter[account-status][in][]=opening&filter[account-status][in][]=open\n```\n\nSimilarly, you can list legal persons with a specific `application-status`:\n\n```\nGET /v0/organizations/:id/legal-persons?filter[application-status][eq]=accepted\n```\n\n### Include resources\n\nSome list APIs allow you to include associated resources in the response, reducing the number of requests needed to fetch related data.\nFor instance, when listing bank accounts, you can include each bank account's beneficiary legal person by using the `include` query parameter:\n\n```\nGET /v0/organizations/:id/bank/accounts?include=beneficiary\n```\n\nThe response returns the usual list of bank accounts, but it will also have an `included` object with a `legal-persons` attribute:\n\n```\n{\n  \"accounts\": [\n    // ...\n  ],\n  \"links\": {\n    // ...\n  }\n  \"included\": {\n    \"legal-persons\": [\n      // ...\n    ]\n  }\n}\n```\n\nCheck the documentation for each list API to see all options for sorting and filtering\n\n## Request limits\n\nEach organization is allowed up to 50 concurrent (in-flight) API requests. Exceeding this threshold results in a 429 - Too Many Requests response. Upon receiving a 429 response, you should implement a backoff strategy, pausing to allow your outstanding requests to complete before attempting new requests. To manage your request rate effectively and avoid surpassing this limit, consider using a controlled approach such as a finite pool of threads or workers.\n\n## Versioning\n\nThe Griffin API is versioned via a prefix in the URL.\nThe current version is v0.\nAn example endpoint is: https://api.griffin.com/v0/index.\n\nWe will not break your integration with a particular version for as long as we support that version.\nIf we release a new version, you will have 12 months to upgrade to it."
servers:
- url: https://api.griffin.com/
security:
- api-key-auth: []
tags:
- name: Legal person history
paths:
  /v0/legal-persons/{legal-person-id}/history:
    get:
      tags:
      - Legal person history
      description: Lists history of events for the given legal person.
      parameters:
      - x-allOf:
        - type: integer
          format: int64
        - minimum: 1
          maximum: 201
        name: page[size]
        required: false
        description: ''
        in: query
        schema:
          type: integer
          format: int64
          maximum: 200
          minimum: 1
      - in: query
        name: page[after]
        description: A base64 encoded opaque string returned in paginated responses.
        required: false
        schema:
          type: string
          format: byte
      - in: query
        name: page[before]
        description: A base64 encoded opaque string returned in paginated responses.
        required: false
        schema:
          type: string
          format: byte
      - required: true
        name: legal-person-id
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  legal-person-history:
                    type: array
                    items:
                      type: object
                      properties: {}
                      required:
                      - legal-person-history-event-type
                      title: history event
                      x-anyOf:
                      - type: object
                        properties:
                          legal-person-history-event-type:
                            enum:
                            - risk-rating-registered
                            type: string
                          timestamp:
                            format: date-time
                            type: string
                            description: Date time of this event.
                            title: timestamp
                          risk-rating:
                            title: risk-rating
                            type: string
                            enum:
                            - high-risk
                            - prohibited-risk
                            - medium-risk
                            - low-risk
                          notes:
                            type: string
                            minLength: 1
                            title: notes
                            description: Rationale for overriding the risk rating.
                          manually-created-by:
                            type: object
                            properties: {}
                            required:
                            - manually-created-by-type
                            title: manually-created-by
                            description: User that triggered this event.
                            x-anyOf:
                            - type: object
                              properties:
                                manually-created-by-type:
                                  enum:
                                  - ops-user
                                  type: string
                              required:
                              - manually-created-by-type
                              - manually-created-by-type
                              title: ops-user
                          previous-risk-rating:
                            title: previous-risk-rating
                            type: string
                            enum:
                            - high-risk
                            - prohibited-risk
                            - medium-risk
                            - low-risk
                        required:
                        - legal-person-history-event-type
                        - timestamp
                        - risk-rating
                        - legal-person-history-event-type
                        title: risk-rating-registered
                      - type: object
                        properties:
                          decision-outcome:
                            title: decision-outcome
                            type: string
                            enum:
                            - accepted
                            - declined
                          decision-notes:
                            type: string
                            title: decision-notes
                            description: Free-text field to explain the reasons behind the decision.
                          verification-url:
                            type: string
                            title: verification-url
                            example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
                            description: A link to the [verification](#tag/Verifications).
                          legal-person-history-event-type:
                            title: legal-person-history-event-type
                            type: string
                            enum:
                            - risk-rating-registered
                            - decision-created
                            - verification-created
                          timestamp:
                            format: date-time
                            type: string
                            description: Date time of this event.
                            title: timestamp
                          decision-maker:
                            title: decision-maker
                            enum:
                            - system
                            - ops-user
                            - user
                            type: string
                            description: Indicates if the decision was automated or made by a human.
                          decision-user-url:
                            type: string
                            example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
                            description: Link to the [user](#tag/Users) that made the decision (if applicable).
                            title: decision-user-url
                          decision-ops-user:
                            title: decision-ops-user
                            enum:
                            - griffin-ops-user
                            type: string
                            description: Indicates that an Ops user has created the decision.
                          decision-user-username:
                            type: string
                            example: user@example.com
                            description: Username of the [user](#tag/Users) that made the decision (if applicable).
                            title: decision-user-username
                        required:
                        - legal-person-history-event-type
                        - timestamp
                        - verification-url
                        - decision-outcome
                        - decision-maker
                        - decision-notes
                        - legal-person-history-event-type
                        title: decision-created
                      - type: object
                        properties:
                          legal-person-history-event-type:
                            enum:
                            - verification-created
                            type: string
                          timestamp:
                            format: date-time
                            type: string
                            description: Date time of this event.
                            title: timestamp
                          verification-url:
                            type: string
                            title: verification-url
                            example: /v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA
                            description: A link to the [verification](#tag/Verifications).
                          workflow-url:
                            type: string
                            title: workflow-url
                            example: /v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA
                            description: A link to the [workflow](/docs/terms/workflow).
                        required:
                        - legal-person-history-event-type
                        - timestamp
                        - verification-url
                        - workflow-url
                        - legal-person-history-event-type
                        title: verification-created
                  links:
                    type: object
                    properties:
                      prev:
                        type:
                        - string
                        - 'null'
                      next:
                        type:
                        - string
                        - 'null'
                    required:
                    - prev
                    - next
                    title: links
                  meta:
                    type: object
                    properties:
                      page:
                        type: object
                        properties:
                          total:
                            type: integer
                            format: int64
                            minimum: 0
                            title: total
                            description: Total number of items. Present when the total number of items in the full result set is less than 10,000.
                          estimated-total:
                            type: object
                            properties:
                              at-least:
                                enum:
                                - 10000
                                type: integer
                                title: at-least
                                description: Present when the total number of items in the full result set exceeds 10,000. This indicates that the actual number of items is at least 10,000, but the exact total is not provided due to performance considerations.
                            title: estimated-total
                        title: page
                    title: meta
                required:
                - legal-person-history
                - links
                title: legal-person-history-response
        '400':
          description: ''
        '401':
          description: Requires an API key to continue
          headers:
            www-authenticate:
              description: Returns `GriffinSession` if no valid authentication is found.
              schema:
                type: string
        '404':
          description: ''
components:
  securitySchemes:
    api-key-auth:
      type: apiKey
      in: header
      name: Authorization
      description: 'API token authentication.

        It should follow the format: `GriffinAPIKey g-test-MyKey-XXXXXXX`'
x-tagGroups:
- name: Getting started
  tags:
  - API keys
  - Connectivity
  - Navigation
  - Events
  - Webhooks
  - Message Signatures
- name: Customer verifications
  tags:
  - Legal persons
  - Legal person history
  - Claims
  - Workflows
  - Verifications
  - Decisions
  - Companies House
  - Reliance onboarding
- name: Banking
  tags:
  - Bank accounts
  - Bank account events
  - Bank account restrictions
  - Bank account holds
  - Pooled account membership
  - Payments
  - Transactions
  - Payees
  - Confirmation of payee
  - Open banking
- name: Team management
  tags:
  - Organizations
  - Users
  - Roles
  - Memberships
  - Invitations
x-id:
- default