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

# Cancel In-person Verification

> Cancel an in-person verification and return the reader terminal to idle. A verification that has already finished is returned unchanged, with its `result` if it completed or failed.



## OpenAPI

````yaml terminal-api POST /terminal/proximity-verifications/{verificationId}/cancel
openapi: 3.0.0
info:
  description: Authsignal's Terminal API.
  version: 1.0.0
  title: Terminal API
  termsOfService: https://www.authsignal.com/legal/terms-of-service
  contact:
    email: hello@authsignal.com
servers:
  - url: https://api.authsignal.com/v1
  - url: https://au.api.authsignal.com/v1
  - url: https://eu.api.authsignal.com/v1
  - url: https://ca.api.authsignal.com/v1
  - url: https://uk.api.authsignal.com/v1
security:
  - terminalAuth: []
tags:
  - name: payment-session
    description: ''
    externalDocs:
      description: Find out more
      url: https://docs.authsignal.com
  - name: in-person-verification
    description: ''
    externalDocs:
      description: Find out more
      url: https://docs.authsignal.com
externalDocs:
  description: Find out more about Authsignal
  url: https://docs.authsignal.com
paths:
  /terminal/proximity-verifications/{verificationId}/cancel:
    post:
      tags:
        - in-person-verification
      summary: Cancel an in-person verification
      description: >-
        Cancel an in-person verification and return the reader terminal to idle.
        A verification that has already finished is returned unchanged, with its
        `result` if it completed or failed.
      operationId: cancelProximityVerification
      parameters:
        - $ref: '#/components/parameters/verificationId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InPersonVerification'
        '401':
          description: The controller token is missing, invalid or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The verification doesn't exist or was created by another controller.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            `verification_in_progress` if Authsignal is checking the customer's
            response. Keep polling until it finishes.
            `verification_state_changed` if the status changed during the
            request. Get the verification again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - controllerAuth: []
components:
  parameters:
    verificationId:
      name: verificationId
      in: path
      description: The ID of the in-person verification.
      required: true
      schema:
        type: string
  schemas:
    InPersonVerification:
      type: object
      properties:
        verificationId:
          type: string
          description: The ID of the in-person verification.
        terminalId:
          type: string
          description: The ID of the reader terminal the verification was sent to.
        optionId:
          type: string
          nullable: true
          description: >-
            The request option the customer chose on the reader. `null` until
            they choose.
        optionName:
          type: string
          nullable: true
          description: >-
            The display name of the chosen request option. `null` until the
            customer chooses.
        reference:
          type: string
          description: A reference identifier originating from the point of sale system.
        status:
          type: string
          enum:
            - PENDING
            - IN_PROGRESS
            - VERIFYING
            - COMPLETED
            - FAILED
            - CANCELLED
            - EXPIRED
          description: >-
            `PENDING` until the reader picks up the verification, `IN_PROGRESS`
            while the customer chooses an option and presents their credential,
            and `VERIFYING` while Authsignal checks the response. `COMPLETED`,
            `FAILED`, `CANCELLED` and `EXPIRED` are final.
        createdAt:
          type: string
          format: date-time
        expiresAt:
          type: string
          format: date-time
          description: When the customer must have presented their credential by.
        resultExpiresAt:
          type: string
          format: date-time
          description: When the verification and its result stop being available.
        result:
          type: object
          description: Present once the status is `COMPLETED` or `FAILED`.
          properties:
            state:
              type: string
              enum:
                - RESPONSE_RECEIVED
                - RESPONSE_FAILED
            actionState:
              type: string
              description: >-
                The state of the action after your rules have run, for example
                `CHALLENGE_SUCCEEDED` or `REVIEW_REQUIRED`.
            error:
              type: string
            errorDescription:
              type: string
            claims:
              type: object
              additionalProperties: true
              description: >-
                The verified claims from the presented credential, keyed by
                claim name. Empty unless `state` is `RESPONSE_RECEIVED`.
            credentials:
              type: array
              items:
                $ref: '#/components/schemas/DigitalCredential'
              description: >-
                The credentials the customer presented, with each credential's
                claims grouped by namespace.
      required:
        - verificationId
        - terminalId
        - optionId
        - optionName
        - status
        - createdAt
        - expiresAt
        - resultExpiresAt
      example:
        verificationId: 41feec4e-5a9e-46bd-9068-72261a57fc5d
        terminalId: 8c2d0e1b-5f4a-4c3e-9b8a-7d6c5b4a3f2e
        optionId: age
        optionName: Over 18
        reference: sale-1042
        status: COMPLETED
        createdAt: '2026-10-15T01:02:03.000Z'
        expiresAt: '2026-10-15T01:07:03.000Z'
        resultExpiresAt: '2026-10-15T01:12:03.000Z'
        result:
          state: RESPONSE_RECEIVED
          actionState: CHALLENGE_SUCCEEDED
          claims:
            age_over_18: true
            portrait: >-
              data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/...
          credentials:
            - format: mso_mdoc
              docType: org.iso.18013.5.1.mDL
              claims:
                org.iso.18013.5.1:
                  age_over_18: true
                  portrait: >-
                    data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/...
              issuer:
                trusted: true
                country: NZ
              claimsVerified: true
              deviceAuthVerified: true
    Error:
      type: object
      properties:
        error:
          type: string
        errorCode:
          type: string
        errorDescription:
          type: string
      example:
        error: terminal_busy
        errorCode: terminal_busy
        errorDescription: ''
    DigitalCredential:
      type: object
      properties:
        format:
          type: string
          description: The credential format, for example `mso_mdoc`.
        docType:
          type: string
          description: The document type of the credential.
        claims:
          type: object
          additionalProperties:
            type: object
            additionalProperties: true
          description: >-
            The disclosed claims, grouped by namespace. Binary claims are
            base64-encoded, and images such as `portrait` are returned as data
            URLs.
        issuer:
          type: object
          description: Details of the credential issuer.
          properties:
            trusted:
              type: boolean
              description: Whether the issuer is in one of your trusted issuer lists.
            authority:
              type: string
            country:
              type: string
            stateOrProvince:
              type: string
            organization:
              type: string
        claimsVerified:
          type: boolean
          description: Whether the disclosed claims match the issuer's signed digests.
        deviceAuthVerified:
          type: boolean
          description: Whether the holder's device proved possession of the credential.
        revocationStatus:
          type: string
          enum:
            - NOT_REVOKED
            - REVOKED
            - UNKNOWN
        validity:
          type: object
          properties:
            signed:
              type: string
              format: date-time
            validFrom:
              type: string
              format: date-time
            validUntil:
              type: string
              format: date-time
  securitySchemes:
    terminalAuth:
      type: apiKey
      in: header
      name: x-authsignal-terminal
      description: >-
        Use your terminal ID obtained from the on-boarded device. This unique
        identifier is required to authenticate requests to the payment session
        APIs from your point of sale terminal.
    controllerAuth:
      type: http
      scheme: bearer
      description: >-
        Use the controller token issued for your point of sale device. Contact
        Authsignal to issue a controller token.

````

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