> ## Documentation Index
> Fetch the complete documentation index at: https://widgetic.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check that a partner's own database still works

> Runs the same check as `setPartnerDataDatabase` against the database already saved: a schema is made in it, a
table created, a row written and read back, and the schema removed again. Use it after changing the role's
password or the project's settings in Neon, or when saving is failing with 503 `PARTNER_DATABASE_UNAVAILABLE`.

The result is recorded either way. A pass refreshes `verifiedAt` and clears `lastVerificationError`; a failure
answers 422 `PARTNER_DATABASE_UNVERIFIED` and is recorded in `lastVerificationError` and
`lastVerificationFailedAt`, so the database shows what went wrong the next time it is read. A failed check does
not remove the database. `details.reason` is one of the reasons `setPartnerDataDatabase` lists, or
`STORED_STRING_UNREADABLE` when the connection string Widgetic stored can no longer be read: set the database
again, with its connection string.

This needs an API key with full access. The caller must be the person who administers the partner, or a
Widgetic administrator.




## OpenAPI

````yaml /openapi/widgetic-api-public.json post /partners/{partnerId}/data-database/verify
openapi: 3.0.0
info:
  title: Widgetic API Gateway
  version: 1.0.0
  description: API documentation for the Widgetic API Gateway
  license:
    name: Widgetic Integration License
    url: https://docs.widgetic.com/resources/license
servers:
  - url: https://api.widgetic.com/v1
    description: Production server
    variables:
      env:
        default: production
        description: Environment
      apiUrl:
        default: https://api.widgetic.com
        description: API URL
      apiVersion:
        default: /v1
        description: API Version path prefix
security: []
tags: []
paths:
  /partners/{partnerId}/data-database/verify:
    post:
      tags:
        - Partners
      summary: Check that a partner's own database still works
      description: >
        Runs the same check as `setPartnerDataDatabase` against the database
        already saved: a schema is made in it, a

        table created, a row written and read back, and the schema removed
        again. Use it after changing the role's

        password or the project's settings in Neon, or when saving is failing
        with 503 `PARTNER_DATABASE_UNAVAILABLE`.


        The result is recorded either way. A pass refreshes `verifiedAt` and
        clears `lastVerificationError`; a failure

        answers 422 `PARTNER_DATABASE_UNVERIFIED` and is recorded in
        `lastVerificationError` and

        `lastVerificationFailedAt`, so the database shows what went wrong the
        next time it is read. A failed check does

        not remove the database. `details.reason` is one of the reasons
        `setPartnerDataDatabase` lists, or

        `STORED_STRING_UNREADABLE` when the connection string Widgetic stored
        can no longer be read: set the database

        again, with its connection string.


        This needs an API key with full access. The caller must be the person
        who administers the partner, or a

        Widgetic administrator.
      operationId: verifyPartnerDataDatabase
      parameters:
        - in: path
          name: partnerId
          required: true
          schema:
            type: string
            format: uuid
          description: The partner whose database to check
      responses:
        '200':
          description: The database passed the check
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerDataDatabaseResponse'
        '401':
          description: The API key is missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            The caller does not administer this partner, or the API key has not
            full access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The partner has no database of its own
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: The database did not pass the check (PARTNER_DATABASE_UNVERIFIED)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: >-
            Too many checks in a short time. Try again after the Retry-After
            seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: >-
            A partner's own database is not available on this server
            (PARTNER_DATABASE_UNAVAILABLE)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
      x-code-samples:
        - lang: TypeScript
          label: TypeScript SDK
          source: >
            import { Configuration, PartnersApi } from '@widgetic/api-sdk-ts';


            const partnersApi = new PartnersApi(new Configuration({ apiKey:
            'YOUR_API_KEY' }));


            const { data: database } = await
            partnersApi.verifyPartnerDataDatabase({ partnerId });

            console.log(database.verifiedAt);
components:
  schemas:
    PartnerDataDatabaseResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          description: Always `true` on a success.
          example: true
        data:
          $ref: '#/components/schemas/PartnerDataDatabase'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
    ErrorResponse:
      type: object
      required:
        - success
        - message
        - error
      additionalProperties: true
      properties:
        success:
          type: boolean
          description: Always `false` on a failure.
          example: false
        message:
          type: string
          description: The same text as `error.message`, for a caller that reads one line.
        error:
          $ref: '#/components/schemas/ErrorDetail'
    PartnerDataDatabase:
      type: object
      description: >-
        The Neon database your compositions keep what visitors leave in them
        (votes, ratings, answers, form submissions). The connection string and
        its password are never part of this: they are given once, when the
        database is set.
      required:
        - partnerId
        - host
        - databaseName
        - roleName
        - verifiedAt
        - lastVerificationError
        - lastVerificationFailedAt
        - updatedAt
      properties:
        partnerId:
          type: string
          format: uuid
        host:
          type: string
          description: >-
            The Neon host of the database, as it appears in its connection
            string (`ep-....neon.tech`).
          example: ep-cool-name-123456.eu-central-1.aws.neon.tech
        databaseName:
          type: string
          description: The name of the database in your Neon project.
          example: neondb
        roleName:
          type: string
          description: The role Widgetic connects as.
          example: widgetic_data
        verifiedAt:
          type: string
          format: date-time
          description: When the database last passed the check.
        lastVerificationError:
          type: string
          nullable: true
          description: >-
            Why the latest re-check failed, in a sentence you can act on. Null
            when the last check passed.
        lastVerificationFailedAt:
          type: string
          format: date-time
          nullable: true
          description: When the latest re-check failed. Null when the last check passed.
        updatedAt:
          type: string
          format: date-time
      example:
        partnerId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        host: ep-cool-name-123456.eu-central-1.aws.neon.tech
        databaseName: neondb
        roleName: widgetic_data
        verifiedAt: '2026-01-15T09:30:00.000Z'
        lastVerificationError: Example lastVerificationError
        lastVerificationFailedAt: '2026-01-15T09:30:00.000Z'
        updatedAt: '2026-01-15T09:30:00.000Z'
    ResponseMeta:
      type: object
      description: >-
        Extra information about the answer: where a page sits in a list, the
        cursor of the next page, or warnings about a call that succeeded with a
        caveat.
      additionalProperties: true
      properties:
        page:
          type: integer
          description: The page that was read, counting from 1.
          example: 1
        size:
          type: integer
          description: How many items one page holds.
          example: 20
        total:
          type: integer
          description: How many items the whole list has.
          example: 135
        limit:
          type: integer
          description: The same as `size`.
          example: 20
        offset:
          type: integer
          description: How many items come before this page.
          example: 0
        hasNextPage:
          type: boolean
          example: true
        hasPreviousPage:
          type: boolean
          example: false
        nextCursor:
          type: string
          nullable: true
          description: >-
            Pass this as `cursor` to read the next page of a list that is read
            by cursor. `null` on the last page.
        warnings:
          type: array
          items:
            type: string
          description: >-
            Things the call did not do, though it succeeded (for example a table
            that could not be created just now).
    ErrorDetail:
      type: object
      required:
        - code
        - message
        - timestamp
      properties:
        code:
          type: string
          description: Machine-readable error code.
          example: RESOURCE_NOT_FOUND
        message:
          type: string
          description: Human-readable explanation.
          example: Composition not found
        param:
          type: string
          description: The field that caused the error, when one did.
          example: name
        docUrl:
          type: string
          description: Where this error is explained.
        suggestedAction:
          type: string
          description: What to do about it.
        retryAfter:
          type: integer
          description: >-
            Seconds to wait before trying again (rate limits). The same number
            is in the `Retry-After` header.
          example: 60
        details:
          type: object
          additionalProperties: true
          description: >-
            More about the error: the fields that failed, a limit that was
            reached.
        correlationId:
          type: string
          description: Quote this when you ask support about the call.
          example: req_123e4567-e89b-12d3-a456-426614174000
        timestamp:
          type: string
          format: date-time
          example: '2026-10-15T10:00:00.000Z'
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.