Griffin API keys API

openapi: 3.2.0
info:
  title: Griffin API keys 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: API keys
  description: 'The `api-key-secret` field is only shown once when you create an API key.

    We cannot recover the value, so you should store it securely.


    Pass an `Authorization` header with `GriffinAPIKey api-key-secret` to authenticate.


    Each API key is only valid for one [organization](#tag/Organizations).

    If you are a [member](#tag/Memberships) of multiple organizations, you will need to create a new API key for each one.

    There is currently no limit on the number of API keys you can create.'
paths:
  /v0/api-keys/{api-key-id}:
    get:
      tags:
      - API keys
      description: Returns the API key without `api-key-secret`.
      parameters:
      - required: true
        name: api-key-id
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  api-key-url:
                    type: string
                    x-allOf:
                    - type: string
                    - {}
                    - type: object
                      properties:
                        api-key-id:
                          type: string
                          format: ''
                          title: api-key-id
                          required: true
                          name: api-key-id
                      required:
                      - api-key-id
                    x-anyOf:
                    - type: string
                      x-allOf:
                      - type: string
                      - {}
                      - type: object
                        properties:
                          api-key-id:
                            type: string
                            format: ''
                            title: api-key-id
                            required: true
                            name: api-key-id
                        required:
                        - api-key-id
                    - type: string
                      x-allOf:
                      - type: string
                      - {}
                      - type: object
                        properties:
                          api-key-id:
                            type: string
                            format: ''
                            title: api-key-id
                            required: true
                            name: api-key-id
                        required:
                        - api-key-id
                    title: api-key-url
                    description: The resource path for the API key
                    example: /v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA
                  api-key-name:
                    title: api-key-name
                    pattern: ^[a-zA-z0-9-_]+
                    description: The immutable display name for the API key
                    maxLength: 64
                    example: buildserver
                    minLength: 1
                  api-key-live?:
                    type: boolean
                  organization-url:
                    type: string
                    title: organization-url
                    example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
                    description: Link to the [organization](#tag/Organizations).
                  user-url:
                    type: string
                    title: user-url
                    example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
                    description: Link to the user.
                  created-at:
                    title: created-at
                    format: date-time
                    type: string
                    description: ISO 8601 formatted date-time.
                required:
                - api-key-url
                - api-key-name
                - api-key-live?
                - organization-url
                - user-url
                - created-at
                title: api-key
        '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: ''
      summary: Get API key
    delete:
      tags:
      - API keys
      description: Deletes the API Key. This operation cannot be undone.
      parameters:
      - required: true
        name: api-key-id
        in: path
        schema:
          type: string
      responses:
        '204':
          description: ''
        '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: ''
        '422':
          description: ''
      summary: Delete API key
  /v0/organizations/{organization-id}/api-keys:
    get:
      tags:
      - API keys
      description: List all active API keys in your organization.
      parameters:
      - in: query
        name: sort
        description: ''
        required: false
        schema:
          type: string
          enum:
          - -created-at
          - created-at
      - 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: organization-id
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  api-keys:
                    type: array
                    items:
                      type: object
                      properties:
                        api-key-url:
                          type: string
                          x-allOf:
                          - type: string
                          - {}
                          - type: object
                            properties:
                              api-key-id:
                                type: string
                                format: ''
                                title: api-key-id
                                required: true
                                name: api-key-id
                            required:
                            - api-key-id
                          x-anyOf:
                          - type: string
                            x-allOf:
                            - type: string
                            - {}
                            - type: object
                              properties:
                                api-key-id:
                                  type: string
                                  format: ''
                                  title: api-key-id
                                  required: true
                                  name: api-key-id
                              required:
                              - api-key-id
                          - type: string
                            x-allOf:
                            - type: string
                            - {}
                            - type: object
                              properties:
                                api-key-id:
                                  type: string
                                  format: ''
                                  title: api-key-id
                                  required: true
                                  name: api-key-id
                              required:
                              - api-key-id
                          title: api-key-url
                          description: The resource path for the API key
                          example: /v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA
                        api-key-name:
                          title: api-key-name
                          pattern: ^[a-zA-z0-9-_]+
                          description: The immutable display name for the API key
                          maxLength: 64
                          example: buildserver
                          minLength: 1
                        api-key-live?:
                          type: boolean
                        organization-url:
                          type: string
                          title: organization-url
                          example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
                          description: Link to the [organization](#tag/Organizations).
                        user-url:
                          type: string
                          title: user-url
                          example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
                          description: Link to the user.
                        created-at:
                          title: created-at
                          format: date-time
                          type: string
                          description: ISO 8601 formatted date-time.
                      required:
                      - api-key-url
                      - api-key-name
                      - api-key-live?
                      - organization-url
                      - user-url
                      - created-at
                      title: api-key
                  links:
                    type: object
                    properties:
                      prev:
                        type:
                        - string
                        - 'null'
                      next:
                        type:
                        - string
                        - 'null'
                    required:
                    - prev
                    - next
                    title: links
                  included:
                    title: ''
                    description: Present only when the request uses the `include` parameter.
                required:
                - api-keys
                - links
                title: organization-api-keys-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
      summary: List API keys
    post:
      tags:
      - API keys
      description: Create a new API key. This is the only time `api-key-secret` is shown.
      parameters:
      - required: true
        name: organization-id
        in: path
        schema:
          type: string
      responses:
        '201':
          headers:
            Location:
              description: The URL of the created API key
              schema:
                type: string
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  api-key-url:
                    type: string
                    x-allOf:
                    - type: string
                    - {}
                    - type: object
                      properties:
                        api-key-id:
                          type: string
                          format: ''
                          title: api-key-id
                          required: true
                          name: api-key-id
                      required:
                      - api-key-id
                    x-anyOf:
                    - type: string
                      x-allOf:
                      - type: string
                      - {}
                      - type: object
                        properties:
                          api-key-id:
                            type: string
                            format: ''
                            title: api-key-id
                            required: true
                            name: api-key-id
                        required:
                        - api-key-id
                    - type: string
                      x-allOf:
                      - type: string
                      - {}
                      - type: object
                        properties:
                          api-key-id:
                            type: string
                            format: ''
                            title: api-key-id
                            required: true
                            name: api-key-id
                        required:
                        - api-key-id
                    title: api-key-url
                    description: The resource path for the API key
                    example: /v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA
                  api-key-name:
                    title: api-key-name
                    pattern: ^[a-zA-z0-9-_]+
                    description: The immutable display name for the API key
                    maxLength: 64
                    example: buildserver
                    minLength: 1
                  api-key-live?:
                    type: boolean
                  organization-url:
                    type: string
                    title: organization-url
                    example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
                    description: Link to the [organization](#tag/Organizations).
                  user-url:
                    type: string
                    title: user-url
                    example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
                    description: Link to the user.
                  created-at:
                    title: created-at
                    format: date-time
                    type: string
                    description: ISO 8601 formatted date-time.
                  api-key-secret:
                    type: string
                    title: api-key-secret
                    description: The API secret
                    example: g-test-buildserver-RrUZ5fUG4pSKwYVVG1C3Ft1xrMRxy1T7KUIyTva5bTk
                required:
                - api-key-live?
                - api-key-name
                - api-key-secret
                - api-key-url
                - created-at
                - organization-url
                - user-url
        '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: ''
        '409':
          description: ''
      summary: Create API Key
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                api-key-name:
                  title: api-key-name
                  description: The name of the API Key. Cannot contain whitespace.
                  minLength: 1
              required:
              - api-key-name
              title: request-create-api-key
        required: true
  /v0/users/{user-id}/api-keys:
    get:
      tags:
      - API keys
      description: List all your active API keys.
      parameters:
      - in: query
        name: sort
        description: ''
        required: false
        schema:
          type: string
          enum:
          - -created-at
          - created-at
      - 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: user-id
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  api-keys:
                    type: array
                    items:
                      type: object
                      properties:
                        api-key-url:
                          type: string
                          x-allOf:
                          - type: string
                          - {}
                          - type: object
                            properties:
                              api-key-id:
                                type: string
                                format: ''
                                title: api-key-id
                                required: true
                                name: api-key-id
                            required:
                            - api-key-id
                          x-anyOf:
                          - type: string
                            x-allOf:
                            - type: string
                            - {}
                            - type: object
                              properties:
                                api-key-id:
                                  type: string
                                  format: ''
                                  title: api-key-id
                                  required: true
                                  name: api-key-id
                              required:
                              - api-key-id
                          - type: string
                            x-allOf:
                            - type: string
                            - {}
                            - type: object
                              properties:
                                api-key-id:
                                  type: string
                                  format: ''
                                  title: api-key-id
                                  required: true
                                  name: api-key-id
                              required:
                              - api-key-id
                          title: api-key-url
                          description: The resource path for the API key
                          example: /v0/api-keys/ak.ICAgICAgYXBpLWtleS1pZA
                        api-key-name:
                          title: api-key-name
                          pattern: ^[a-zA-z0-9-_]+
                          description: The immutable display name for the API key
                          maxLength: 64
                          example: buildserver
                          minLength: 1
                        api-key-live?:
                          type: boolean
                        organization-url:
                          type: string
                          title: organization-url
                          example: /v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA
                          description: Link to the [organization](#tag/Organizations).
                        user-url:
                          type: string
                          title: user-url
                          example: /v0/users/ur.ICAgICAgICAgdXNlci1pZA
                          description: Link to the user.
                        created-at:
                          title: created-at
                          format: date-time
                          type: string
                          description: ISO 8601 formatted date-time.
                      required:
                      - api-key-url
                      - api-key-name
                      - api-key-live?
                      - organization-url
                      - user-url
                      - created-at
                      title: api-key
                  links:
                    type: object
                    properties:
                      prev:
                        type:
                        - string
                        - 'null'
                      next:
                        type:
                        - string
                        - 'null'
                    required:
                    - prev
                    - next
                    title: links
                required:
                - api-keys
                - links
                title: api-keys-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
      summary: List API keys
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