iGrant.io API

openapi: 3.1.0
info:
  title: iGrant.io API
  version: '2026-10-15'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-15: 10 operation(s) read from 10 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; iGrant.io has published no machine-readable contract
    that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 10
    pages-with-code: 0
    pages-read: 10
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-15'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.igrant.io/docs/openid4vc-api/config-ping-webhook
  - https://docs.igrant.io/docs/openid4vc-api/config-read-webhook
  - https://docs.igrant.io/docs/openid4vc-api/config-list-webhooks
  - https://docs.igrant.io/docs/openid4vc-api/config-create-webhook
  - https://docs.igrant.io/docs/openid4vc-api/config-delete-webhook
  - https://docs.igrant.io/docs/openid4vc-api/config-update-webhook
  - https://docs.igrant.io/docs/openid4vc-api/config-read-webhook-event-types
  - https://docs.igrant.io/docs/openid4vc-api/get-webhook-payload-content-types
  - https://docs.igrant.io/docs/openid4vc-api/config-read-recent-webhook-delivery
  - https://docs.igrant.io/docs/openid4vc-api/config-list-all-recent-webhook-deliveries
paths:
  /v2/config/webhook:
    post:
      operationId: post_v2_config_webhook
      tags:
      - Config
      summary: Create webhook
      x-source: https://docs.igrant.io/docs/openid4vc-api/config-create-webhook
      parameters:
      - name: X-SandboxOrgId
        in: header
        required: false
        schema:
          type: string
        description: Optional. Unique identifier of the sandbox organisation to use for this request.
      - name: X-SubwalletId
        in: header
        required: false
        schema:
          type: string
        description: Deprecated name of the sandbox org header; X-SandboxOrgId wins if both are sent.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV2ConfigWebhookRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV2ConfigWebhookResponse'
      x-evidence:
        kind: documentation
  /v2/config/webhook/{webhookid}:
    delete:
      operationId: delete_v2_config_webhook_webhookid
      tags:
      - Config
      summary: Delete webhook
      description: This endpoint deletes a webhook. The server disables the webhook and marks it as deleted. After the delete, the webhook sends
        no more events, and the other webhook endpoints do not find it.
      x-source: https://docs.igrant.io/docs/openid4vc-api/config-delete-webhook
      parameters:
      - name: webhookid
        in: path
        required: true
        schema:
          type: string
      - name: X-SandboxOrgId
        in: header
        required: false
        schema:
          type: string
        description: Optional. Unique identifier of the sandbox organisation to use for this request.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteV2ConfigWebhookWebhookidResponse'
      x-evidence:
        kind: documentation
    get:
      operationId: get_v2_config_webhook_webhookid
      tags:
      - Config
      summary: Read webhook
      x-source: https://docs.igrant.io/docs/openid4vc-api/config-read-webhook
      parameters:
      - name: webhookid
        in: path
        required: true
        schema:
          type: string
      - name: X-SandboxOrgId
        in: header
        required: false
        schema:
          type: string
        description: Optional. Unique identifier of the sandbox organisation to use for this request.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2ConfigWebhookWebhookidResponse'
      x-evidence:
        kind: documentation
    put:
      operationId: put_v2_config_webhook_webhookid
      tags:
      - Config
      summary: Update webhook
      x-source: https://docs.igrant.io/docs/openid4vc-api/config-update-webhook
      parameters:
      - name: webhookid
        in: path
        required: true
        schema:
          type: string
      - name: X-SandboxOrgId
        in: header
        required: false
        schema:
          type: string
        description: Optional. Unique identifier of the sandbox organisation to use for this request.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutV2ConfigWebhookWebhookidRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutV2ConfigWebhookWebhookidResponse'
      x-evidence:
        kind: documentation
  /v2/config/webhook/{webhookid}/ping:
    post:
      operationId: post_v2_config_webhook_webhookid_ping
      tags:
      - Config
      summary: Ping webhook
      x-source: https://docs.igrant.io/docs/openid4vc-api/config-ping-webhook
      parameters:
      - name: webhookid
        in: path
        required: true
        schema:
          type: string
      - name: X-SandboxOrgId
        in: header
        required: false
        schema:
          type: string
        description: Optional. Unique identifier of the sandbox organisation to use for this request.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV2ConfigWebhookWebhookidPingResponse'
      x-evidence:
        kind: documentation
  /v2/config/webhooks:
    get:
      operationId: get_v2_config_webhooks
      tags:
      - Config
      summary: List all webhooks
      x-source: https://docs.igrant.io/docs/openid4vc-api/config-list-webhooks
      parameters:
      - name: offset
        in: query
        required: true
        schema:
          type: integer
        description: Number of records to skip for pagination. A negative or unreadable value falls back to 0.
      - name: limit
        in: query
        required: true
        schema:
          type: integer
        description: Maximum number of records to return per page.
      - name: X-SandboxOrgId
        in: header
        required: true
        schema:
          type: string
        description: Unique identifier of the sandbox organisation to use for this request.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2ConfigWebhooksResponse'
      x-evidence:
        kind: documentation
  /v2/config/webhooks/{webhookid}/deliveries:
    get:
      operationId: get_v2_config_webhooks_webhookid_deliveries
      tags:
      - Config
      summary: List all webhook deliveries
      x-source: https://docs.igrant.io/docs/openid4vc-api/config-list-all-recent-webhook-deliveries
      parameters:
      - name: webhookid
        in: path
        required: true
        schema:
          type: string
      - name: offset
        in: query
        required: true
        schema:
          type: integer
        description: Number of records to skip for pagination. A negative or unreadable value falls back to 0.
      - name: limit
        in: query
        required: true
        schema:
          type: integer
        description: Maximum number of records to return per page.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2ConfigWebhooksWebhookidDeliveriesResponse'
      x-evidence:
        kind: documentation
  /v2/config/webhooks/{webhookid}/delivery/{deliveryid}:
    get:
      operationId: get_v2_config_webhooks_webhookid_delivery_deliveryid
      tags:
      - Config
      summary: Read webhook delivery
      x-source: https://docs.igrant.io/docs/openid4vc-api/config-read-recent-webhook-delivery
      parameters:
      - name: webhookid
        in: path
        required: true
        schema:
          type: string
      - name: deliveryid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2ConfigWebhooksWebhookidDeliveryDeliveryidResponse'
      x-evidence:
        kind: documentation
  /v2/config/webhooks/event-types:
    get:
      operationId: get_v2_config_webhooks_event_types
      tags:
      - Config
      summary: This endpoint lists all the webhook event types that you can subscribe to.
      x-source: https://docs.igrant.io/docs/openid4vc-api/config-read-webhook-event-types
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2ConfigWebhooksEventTypesResponse'
      x-evidence:
        kind: documentation
  /v2/config/webhooks/payload/content-types:
    get:
      operationId: get_v2_config_webhooks_payload_content_types
      tags:
      - Config
      summary: List all webhook content types
      x-source: https://docs.igrant.io/docs/openid4vc-api/get-webhook-payload-content-types
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2ConfigWebhooksPayloadContentTypesResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostV2ConfigWebhookRequest:
      type: object
      properties:
        payloadUrl:
          type: string
          description: The HTTPS or HTTP URL that receives the webhook payload. Must start with http:// or https:// and be unique for the organisation.
        contentType:
          type: string
          description: 'Possible values: application/json, application/x-www-form-urlencoded.'
        subscribedEvents:
          type: object
          description: The event types that the webhook receives, in three groups. At least one event type must be present in at least one group.
        consentManagementWebhook:
          type: array
          description: Consent management event types.
        digitalWalletWebhook:
          type: array
          description: Digital wallet (OpenID4VC) event types.
        dataMarketplaceWebhook:
          type: array
          description: Data marketplace event types.
        disabled:
          type: boolean
          description: When true, the webhook does not receive event deliveries. Default false.
        secretKey:
          type: string
          description: Secret key used to compute the X-IGrant-Signature header for each delivery.
        skipSslVerification:
          type: boolean
          description: When true, the server does not verify the TLS certificate of the payload URL. Default false.
      required:
      - payloadUrl
      - contentType
      - subscribedEvents
      - secretKey
    PostV2ConfigWebhookResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the webhook.
        orgId:
          type: string
          description: Unique identifier of the organisation that owns the webhook.
        sandboxOrgId:
          type: string
          description: Identifier of the sandbox organisation, if applicable.
        payloadUrl:
          type: string
          description: URL that receives the webhook payload.
        contentType:
          type: string
          description: Content type of the webhook payload.
        subscribedEvents:
          type: object
          description: Event types the webhook receives.
        disabled:
          type: boolean
          description: When true, the webhook receives no event delivery.
        secretKey:
          type: string
          description: Secret key used by the service to calculate the X-IGrant-Signature header.
        skipSslVerification:
          type: boolean
          description: When true, TLS certificate verification is skipped.
        timestamp:
          type: string
          description: UTC time when the service created the webhook.
    DeleteV2ConfigWebhookWebhookidResponse:
      type: object
      properties:
        '200':
          type: string
          description: OK – The response contains the webhook in its final state.
        '401':
          type: string
          description: Unauthorized.
        '404':
          type: string
          description: Resource not found – The organisation has no webhook with the given ID, or the webhook is deleted.
        '500':
          type: string
          description: Internal server error.
    GetV2ConfigWebhookWebhookidResponse:
      type: object
      properties:
        '200':
          type: string
          description: OK – webhook object returned.
        '401':
          type: string
          description: Unauthorized – error object returned.
        '404':
          type: string
          description: Resource not found – error object returned.
        '500':
          type: string
          description: Internal server error – error object returned.
    PutV2ConfigWebhookWebhookidRequest:
      type: object
      properties:
        payloadUrl:
          type: string
          description: The HTTPS or HTTP URL that receives the webhook payload. Must start with http:// or https:// and be unique for the organisation.
        contentType:
          type: string
          description: 'Possible values: application/json, application/x-www-form-urlencoded.'
        subscribedEvents:
          type: object
          description: The event types that the webhook receives, in 3 groups.
        disabled:
          type: boolean
          description: When true, the webhook does not receive event deliveries. Default false.
        secretKey:
          type: string
          description: Secret key used to compute the X-IGrant-Signature HMAC-SHA256 header for each delivery.
        skipSslVerification:
          type: boolean
          description: When true, the server does not verify the TLS certificate of the payload URL. Default false.
      required:
      - payloadUrl
      - contentType
      - subscribedEvents
      - secretKey
    PutV2ConfigWebhookWebhookidResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the webhook.
        orgId:
          type: string
          description: Unique identifier of the organisation that owns the webhook.
        sandboxOrgId:
          type: string
          description: Identifier of the sandbox organisation (if applicable).
        payloadUrl:
          type: string
          description: URL that receives the webhook payload.
        contentType:
          type: string
          description: Content type of the webhook payload.
        subscribedEvents:
          type: object
          description: Event types the webhook receives.
        disabled:
          type: boolean
          description: When true, the webhook receives no event delivery.
        secretKey:
          type: string
          description: Secret key used by the service to calculate the X-IGrant-Signature header.
        skipSslVerification:
          type: boolean
          description: When true, the service does not verify the TLS certificate of the payload URL.
        timestamp:
          type: string
          description: UTC time when the service created the webhook.
    PostV2ConfigWebhookWebhookidPingResponse:
      type: object
      properties:
        responseStatusCode:
          type: integer
          description: HTTP status code that the payload URL sent. The value is 0 when the service could not reach the payload URL.
        responseStatusStr:
          type: string
          description: HTTP status text that the payload URL sent. The value is an empty string when the service could not reach the payload URL.
        executionStartTimestamp:
          type: string
          description: UTC time when the ping started.
        executionEndTimestamp:
          type: string
          description: UTC time when the ping ended.
        status:
          type: string
          description: 'Possible values: [ completed , failed ] Result of the ping.'
        statusDescription:
          type: string
          description: Reason for a failure. The value is an empty string when status is completed.
    GetV2ConfigWebhooksResponse:
      type: object
      properties:
        pagination:
          type: object
          description: Pagination information.
        webhooks:
          type: array
          description: The webhooks on the requested page.
    GetV2ConfigWebhooksWebhookidDeliveriesResponse:
      type: object
      properties:
        pagination:
          type: object
          description: Pagination object
        pagination.currentPage:
          type: integer
          description: Current page number
        pagination.totalItems:
          type: integer
          description: Total number of items available
        pagination.totalPages:
          type: integer
          description: Total number of pages based on limit
        pagination.limit:
          type: integer
          description: Number of items per page
        pagination.hasPrevious:
          type: boolean
          description: Indicates if there's a previous page
        pagination.hasNext:
          type: boolean
          description: Indicates if there's a next page
        webhookDeliveries:
          type: array
          description: Array of WebhookDelivery objects
        webhookDeliveries[].id:
          type: string
          description: Unique identifier of the delivery.
        webhookDeliveries[].webhookId:
          type: string
          description: Unique identifier of the webhook that made the delivery.
        webhookDeliveries[].responseStatusCode:
          type: integer
          description: HTTP status code that the payload URL sent. 0 when unreachable.
        webhookDeliveries[].responseStatusStr:
          type: string
          description: HTTP status text that the payload URL sent. Empty when unreachable.
        webhookDeliveries[].timestamp:
          type: string
          description: UTC time when the delivery started.
        webhookDeliveries[].status:
          type: string
          description: 'Possible values: completed, failed.'
        webhookDeliveries[].statusDescription:
          type: string
          description: Reason for a failure. Empty when succeeded.
    GetV2ConfigWebhooksWebhookidDeliveryDeliveryidResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the delivery. This is the deliveryID field of the delivered payload.
        webhookId:
          type: string
          description: Unique identifier of the webhook that made the delivery.
        responseStatusCode:
          type: integer
          description: HTTP status code that the payload URL sent. The value is 0 when the service could not reach the payload URL.
        responseStatusStr:
          type: string
          description: HTTP status text that the payload URL sent. The value is an empty string when the service could not reach the payload URL.
        timestamp:
          type: string
          description: UTC time when the delivery started.
        status:
          type: string
          description: 'Possible values: [ completed , failed ] Result of the delivery.'
        statusDescription:
          type: string
          description: Reason for a failure. The value is an empty string when the delivery succeeded.
    GetV2ConfigWebhooksEventTypesResponse:
      type: object
      properties:
        consentManagementWebhookEventTypes:
          type: array
          description: The event types for consent management. These events occur when an individual gives or refuses consent, or asks to delete,
            download or update their data.
        dataMarketplaceWebhookEventTypes:
          type: array
          description: The event types for the data marketplace. These events occur when the server creates a data disclosure agreement record.
        digitalWalletWebhookEventTypes:
          type: array
          description: The event types for the digital wallet. These events occur during a connection, a credential issuance or a credential verification.
    GetV2ConfigWebhooksPayloadContentTypesResponse:
      type: object
      properties:
        ContentTypes:
          type: string
          description: The payload content types that a webhook can use.
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: Authorization
      x-source: https://docs.igrant.io/docs/developer-apis/get-started/
tags:
- name: Config
security:
- ApiKey: []