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

# QES Onboarding Configure Webhook Service

> QES Onboarding Configure Webhook Service API Documentation

For a usage description of the QES Onboarding Configure Webhook Service, please refer to the [QES Onboarding](/essentials/qesOnboarding) page.

## Endpoint

**POST** `/onboarding/configureWebhook`

## Swagger

<a href="/public/downloads/swagger/qes/QESOnboarding.postman_collection.json" download="QESOnboarding.postman_collection.json">
  <button>⬇️ Download OpenAPI YAML</button>
</a>


## OpenAPI

````yaml POST /onboarding/configureWebhook
openapi: 3.1.0
info:
  title: Umbrella API
  version: 1.0.0
  description: >-
    API documentation for Umbrella services including KYB, KYC, AML, payments,
    phone intelligence, onboarding, and address verification.
servers:
  - url: https://api-umbrella.io/api/services
    description: Production
  - url: https://sandbox-umbrella-api.azurewebsites.net/api/services
    description: Sandbox
security:
  - bearerAuth: []
paths:
  /onboarding/configureWebhook:
    post:
      summary: Configure Webhook
      description: >-
        Registers a webhook URL to receive onboarding status updates such as
        completed verification, signing, or failures.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigureWebhookRequest'
            examples:
              default:
                value:
                  webhookUrl: https://api.idcanopy.com/webhooks/onboarding
                  metadata:
                    authHeader:
                      Authorization: Bearer EXAMPLE_TOKEN_1234567890abcdef
                      Api-Key: fQVZSAp18GqvbwId8LotQl
      responses:
        '200':
          description: Webhook successfully configured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigureWebhookResponse'
              examples:
                default:
                  value:
                    status: true
                    data:
                      id: 74884fe3-c9e1-4462-b60f-c461e422000c
                      url: https://api.idcanopy.com/webhooks/onboarding
                      createdAt: '2025-05-08T16:39:28.339Z'
        '400':
          description: Invalid request payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: Unauthorized request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '409':
          description: Webhook configuration already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
components:
  schemas:
    ConfigureWebhookRequest:
      type: object
      required:
        - webhookUrl
      properties:
        webhookUrl:
          type: string
          format: uri
          description: URL to receive status pings.
          example: https://api.idcanopy.com/webhooks/onboarding
    ConfigureWebhookResponse:
      type: object
      required:
        - status
        - data
      properties:
        status:
          type: boolean
          description: Indicates if webhook was saved.
        data:
          type: object
          required:
            - id
            - url
            - createdAt
          properties:
            id:
              type: string
              description: Internal webhook ID.
              example: 74884fe3-c9e1-4462-b60f-c461e422000c
            url:
              type: string
              format: uri
              description: Registered webhook URL.
              example: https://api.idcanopy.com/webhooks/onboarding
            createdAt:
              type: string
              format: date-time
              description: Timestamp of creation.
              example: '2025-05-08T16:39:28.339Z'
    Error400:
      required:
        - message
      type: object
      properties:
        message:
          type: string
          example: Invalid request payload
    Error401:
      required:
        - message
      type: object
      properties:
        message:
          type: string
          example: Unauthorized request
    Error409:
      type: object
      properties:
        error:
          type: string
          example: Webhook configuration already exists
        message:
          type: string
          example: Webhook configuration already exists for this product and customer.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token obtained from POST /auth. Valid for 60 minutes.

````