Griffin Claims API

openapi: 3.2.0
info:
  title: Griffin API keys Claims 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: Claims
  description: A [claim](/docs/terms/claim) is an unverified data point or series of data points attached to a [legal person](#tag/Legal-persons). Claims are verified by running a [verification](#tag/Verifications) against the legal person.
paths:
  /v0/claims/{claim-id}:
    delete:
      tags:
      - Claims
      description: Deletes an existing claim about a Legal Person.
      parameters:
      - required: true
        name: claim-id
        in: path
        schema:
          type: string
      responses:
        '204':
          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: ''
  /v0/legal-persons/{legal-person-id}/claims:
    get:
      tags:
      - Claims
      description: Yields a list of all current claims about this Legal Person.
      parameters:
      - in: query
        name: filter[verification-status][eq]
        description: The verification-status of a claim changes from `"unverified"` to `"verified"` when it has successfully been used in a verification as part of an accepted application. Claims of errored or declined applications are `"unverified"`.
        required: false
        schema:
          type: string
          enum:
          - unverified
          - verified
      - 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: legal-person-id
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  claims:
                    type: array
                    items:
                      type: object
                      properties: {}
                      required:
                      - claim-type
                      title: claim
                      x-anyOf:
                      - type: object
                        properties:
                          aeoi-entity-classification:
                            title: aeoi-entity-classification
                            enum:
                            - passive-nfe
                            - active-nfe
                            - financial-institution
                            type: string
                            description: "AEOI/CRS entity classification. Submit `financial-institution`\n         if the entity is a financial institution (e.g. a bank, investment fund, or insurance company).\n         Submit `active-nfe` if more than 50% of the entity's gross income is active\n         (e.g. trading, manufacturing, or providing services) and more than 50% of its assets are used\n         to generate that active income. Submit `passive-nfe` if the entity's income is predominantly passive\n         (e.g dividends, interest, rent, royalties, or capital gains) or if it is dormant."
                          claim-type:
                            enum:
                            - aeoi-entity-classification
                            type: string
                          created-at:
                            title: created-at
                            format: date-time
                            type: string
                            description: ISO 8601 formatted date-time.
                          claim-url:
                            type: string
                            x-allOf:
                            - type: string
                            - {}
                            - type: object
                              properties:
                                claim-id:
                                  type: string
                                  format: ''
                                  title: claim-id
                                  required: true
                                  name: claim-id
                              required:
                              - claim-id
                            x-anyOf:
                            - type: string
                              x-allOf:
                              - type: string
                              - {}
                              - type: object
                                properties:
                                  claim-id:
                                    type: string
                                    format: ''
                                    title: claim-id
                                    required: true
                                    name: claim-id
                                required:
                                - claim-id
                            - type: string
                              x-allOf:
                              - type: string
                              - {}
                              - type: object
                                properties:
                                  claim-id:
                                    type: string
                                    format: ''
                                    title: claim-id
                                    required: true
                                    name: claim-id
                                required:
                                - claim-id
                            title: claim-url
                            example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA
                            description: Link to the [claim](#tag/Claims).
                        required:
                        - aeoi-entity-classification
                        - claim-type
                        title: aeoi-entity-classification
                      - type: object
                        properties:
                          telephone-number:
                            title: telephone-number
                            pattern: (\+[1-9])?\d{1,14}
                            example: '+442012345678'
                          claim-type:
                            enum:
                            - alternative-number
                            type: string
                          created-at:
                            title: created-at
                            format: date-time
                            type: string
                            description: ISO 8601 formatted date-time.
                          claim-url:
                            type: string
                            x-allOf:
                            - type: string
                            - {}
                            - type: object
                              properties:
                                claim-id:
                                  type: string
                                  format: ''
                                  title: claim-id
                                  required: true
                                  name: claim-id
                              required:
                              - claim-id
                            x-anyOf:
                            - type: string
                              x-allOf:
                              - type: string
                              - {}
                              - type: object
                                properties:
                                  claim-id:
                                    type: string
                                    format: ''
                                    title: claim-id
                                    required: true
                                    name: claim-id
                                required:
                                - claim-id
                            - type: string
                              x-allOf:
                              - type: string
                              - {}
                              - type: object
                                properties:
                                  claim-id:
                                    type: string
                                    format: ''
                                    title: claim-id
                                    required: true
                                    name: claim-id
                                required:
                                - claim-id
                            title: claim-url
                            example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA
                            description: Link to the [claim](#tag/Claims).
                        required:
                        - telephone-number
                        - claim-type
                        title: alternative-number
                      - type: object
                        properties:
                          annual-turnover:
                            title: annual-turnover
                            required:
                            - currency
                            - value
                            properties:
                              currency:
                                enum:
                                - GBP
                                type: string
                                title: currency code
                                example: GBP
                                default: GBP
                              value:
                                type: string
                                title: value
                                description: The unsigned value as a decimal-formatted string
                                example: '1000.00'
                                default: '1.00'
                            type: object
                            additionalProperties: false
                          claim-type:
                            enum:
                            - annual-turnover
                            type: string
                          created-at:
                            title: created-at
                            format: date-time
                            type: string
                            description: ISO 8601 formatted date-time.
                          claim-url:
                            type: string
                            x-allOf:
                            - type: string
                            - {}
                            - type: object
                              properties:
                                claim-id:
                                  type: string
                                  format: ''
                                  title: claim-id
                                  required: true
                                  name: claim-id
                              required:
                              - claim-id
                            x-anyOf:
                            - type: string
                              x-allOf:
                              - type: string
                              - {}
                              - type: object
                                properties:
                                  claim-id:
                                    type: string
                                    format: ''
                                    title: claim-id
                                    required: true
                                    name: claim-id
                                required:
                                - claim-id
                            - type: string
                              x-allOf:
                              - type: string
                              - {}
                              - type: object
                                properties:
                                  claim-id:
                                    type: string
                                    format: ''
                                    title: claim-id
                                    required: true
                                    name: claim-id
                                required:
                                - claim-id
                            title: claim-url
                            example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA
                            description: Link to the [claim](#tag/Claims).
                        required:
                        - annual-turnover
                        - claim-type
                        title: annual-turnover
                      - type: object
                        properties:
                          balance-sheet-size:
                            title: balance-sheet-size
                            required:
                            - currency
                            - value
                            properties:
                              currency:
                                enum:
                                - GBP
                                type: string
                                title: currency code
                                example: GBP
                                default: GBP
                              value:
                                type: string
                                title: value
                                description: The unsigned value as a decimal-formatted string
                                example: '1000.00'
                                default: '1.00'
                            type: object
                            additionalProperties: false
                          claim-type:
                            enum:
                            - balance-sheet-size
                            type: string
                          created-at:
                            title: created-at
                            format: date-time
                            type: string
                            description: ISO 8601 formatted date-time.
                          claim-url:
                            type: string
                            x-allOf:
                            - type: string
                            - {}
                            - type: object
                              properties:
                                claim-id:
                                  type: string
                                  format: ''
                                  title: claim-id
                                  required: true
                                  name: claim-id
                              required:
                              - claim-id
                            x-anyOf:
                            - type: string
                              x-allOf:
                              - type: string
                              - {}
                              - type: object
                                properties:
                                  claim-id:
                                    type: string
                                    format: ''
                                    title: claim-id
                                    required: true
                                    name: claim-id
                                required:
                                - claim-id
                            - type: string
                              x-allOf:
                              - type: string
                              - {}
                              - type: object
                                properties:
                                  claim-id:
                                    type: string
                                    format: ''
                                    title: claim-id
                                    required: true
                                    name: claim-id
                                required:
                                - claim-id
                            title: claim-url
                            example: /v0/claims/cl.ICAgICAgICBjbGFpbS1pZA
                            description: Link to the [claim](#tag/Claims).
                        required:
                        - balance-sheet-size
                        - claim-type
                        title: balance-sheet-size
                      - type: object
                        properties:
                          business-address:
                            type: object
                            properties: {}
                            required:
                            - country-code
                            title: business-address
                            x-anyOf:
                            - type: object
                              properties:
                                street-name:
                                  title: street-name
                                  minLength: 1
                                  maxLength: 50
                                city:
                                  title: city
                                  minLength: 1
                                  maxLength: 50
                                postal-code:
                                  title: postal-code
                                  type: string
                                  maxLength: 10
                                  example: NW16XE
                                  minLength: 1
                                country-code:
                                  enum:
                                  - IM
                                  type: string
                              required:
                              - street-name
                              - city
                              - postal-code
                              - country-code
                              - country-code
                              title: IM
                              x-anyOf:
                              - type: object
                                properties:
                                  building-name:
                                    title: building-name
                                    maxLength: 50
                                  building-number:
                                    title: building-number
                                    maxLength: 50
                                required:
                                - building-name
                                - building-number
                                title: both building-name and building-number
                              - type: object
                                properties:
                                  building-name:
                                    title: building-name
                                    maxLength: 50
                                required:
                                - building-name
                                title: only building-name
                              - type: object
                                properties:
                                  building-number:
                                    title: building-number
                                    maxLength: 50
                                required:
                                - building-number
                                title: only building-number
                            - type: object
                              properties:
                                street-name:
                                  title: street-name
                                  minLength: 1
                                  maxLength: 50
                                city:
                                  title: city
                                  minLength: 1
                                  maxLength: 50
                                postal-code:
                                  title: postal-code
                                  type: string
                                  maxLength: 10
                                  example: NW16XE
                                  minLength: 1
                                country-code:
                                  enum:
                                  - GB
                                  type: string
                              required:
                              - street-name
                              - city
                              - postal-code
                              - country-code
                              - country-code
                              title: GB
                              x-anyOf:
                              - type: object
                                properties:
                                  building-name:
                                    title: building-name
                                    maxLength: 50
                                  building-number:
                                    title: building-number
                                    maxLength: 50
                                required:
                                - building-name
                                - building-number
                                title: both building-name and building-number
                              - type: object
                                properties:
                                  building-name:
                                    title: building-name
                                    maxLength: 50
                                required:
                                - building-name
                                title: only building-name
                              - type: object
                                properties:
                                  building-number:
                                    title: building-number
                                    maxLength: 50
                                required:
                                - building-number
                                title: only building-number
                            - type: object
                              properties:
                                street-name:
                                  title: street-name
                                  minLength: 1
                                  maxLength: 50
                                city:
                                  title: city
                                  minLength: 1
                                  maxLength: 50
                                postal-code:
                                  title: postal-code
                                  type: string
                                  maxLength: 10
                                  example: NW16XE
                                  minLength: 1
                                country-code:
                                  enum:
                                  - GG
                                  type: string
                              required:
                              - street-name
                              - city
                              - postal-code
                              - country-code
                              - country-code
                              title: GG
                              x-anyOf:
                              - type: object
                                properties:
                                  building-name:
                                    title: building-name
                                    maxLength: 50
                                  building-number:
                                    title: building-number
                                    maxLength: 50
                                required:
                                - building-name
                                - building-number
                                title: both building-name and building-number
                              - type: object
                                properties:
                                  building-name:
                                    title: building-name
                                    maxLength: 50
                                required:
                                - building-name
                                title: only building-name
                              - type: object
                                properties:
                                  building-number:
                                    title: building-number
                                    maxLength: 50
                                required:
                                - building-number
                                title: only building-number
                            - type: object
                              properties:
                                street-name:
                                  title: street-name
                                  minLength: 1
                                  maxLength: 50
                                city:
                                  title: city
                                  minLength: 1
                                  maxLength: 50
                                postal-code:
                                  title: postal-code
                                  type: string
                                  maxLength: 10
                                  example: NW16XE
                                  minLength: 1
                                country-code:
                                  enum:
                                  - JE
                                  type: string
                              required:
                              - street-name
                              - city
                              - postal-code
                              - country-code
                              - country-code
                              title: JE
                              x-

# --- truncated at 32 KB (935 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/griffin/refs/heads/main/openapi/griffin-claims-api-openapi.yml