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

# Cancel verification

> Cancel an individual verification that has not yet reached a terminal successful or failed outcome.



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/verifications/{id}/cancel
openapi: 3.0.0
info:
  title: Helium Id Public API v1
  version: 1.0.0
  description: API reference for Helium ID public verification endpoints.
servers:
  - url: https://server.heliumid.io/api
security:
  - ApiKeyAuth: []
paths:
  /v1/verifications/{id}/cancel:
    patch:
      summary: Cancel verification
      description: >-
        Cancel an individual verification that has not yet reached a terminal
        successful or failed outcome.
      parameters:
        - $ref: '#/components/parameters/VerificationId'
      responses:
        '200':
          description: Verification cancelled successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessEnvelopeSingleVerification'
              example:
                status: true
                message: Verification cancelled successfully
                data:
                  id: 69d830f88c8373aa37c95974
                  status: cancelled
                  statusCode: 5000
                  reason: ''
                  vendorData: user_12345
                  userMeta:
                    applicationId: app_67890
                  verificationMethod: auto
                  createdAt: '2026-04-09T23:06:32.943Z'
                  updatedAt: '2026-04-10T00:01:12.818Z'
                code: 200
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    VerificationId:
      name: id
      in: path
      required: true
      description: The verification identifier returned when the session was created.
      schema:
        type: string
      example: 69d830f88c8373aa37c95974
  schemas:
    SuccessEnvelopeSingleVerification:
      type: object
      properties:
        status:
          type: boolean
          example: true
        message:
          type: string
          example: Fetched Single verifications
        data:
          $ref: '#/components/schemas/VerificationRecord'
        code:
          type: integer
          example: 200
    VerificationRecord:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
          enum:
            - not started
            - started
            - abandoned
            - completed
            - successful
            - failed
            - cancelled
        statusCode:
          type: integer
        reason:
          type: string
        vendorData:
          type: string
        userMeta:
          type: object
          additionalProperties: true
        userEmail:
          type: string
        verificationMethod:
          type: string
          enum:
            - auto
            - manual
        selfie:
          $ref: '#/components/schemas/VerificationSelfie'
        doc:
          $ref: '#/components/schemas/VerificationDocument'
        docInfo:
          $ref: '#/components/schemas/VerificationDocInfo'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
        error:
          type: object
          nullable: true
          additionalProperties: true
        data:
          nullable: true
        code:
          type: integer
    VerificationSelfie:
      type: object
      properties:
        key:
          type: string
        url:
          type: string
          format: uri
    VerificationDocument:
      type: object
      properties:
        type:
          type: string
        name:
          type: string
        issuingState:
          type: string
        key:
          $ref: '#/components/schemas/VerificationDocumentKeys'
        url:
          $ref: '#/components/schemas/VerificationDocumentUrls'
    VerificationDocInfo:
      type: object
      properties:
        docType:
          type: string
        docNumber:
          type: string
        issueDate:
          type: string
        expiryDate:
          type: string
        issuingState:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        middleName:
          type: string
        dob:
          type: string
        sex:
          type: string
    VerificationDocumentKeys:
      type: object
      properties:
        front:
          type: string
        back:
          type: string
    VerificationDocumentUrls:
      type: object
      properties:
        front:
          type: string
          format: uri
        back:
          type: string
          format: uri
  responses:
    BadRequest:
      description: The request payload, identifier, or state transition is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: false
            message: Verification not found or has been deleted
            code: 400
    Unauthorized:
      description: The request could not be authenticated with the supplied API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            status: false
            message: Unauthorized
            code: 401
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your Helium ID API key.

````