Microsoft Azure AI Foundry Verify API

openapi: 3.2.0
info:
  title: Azure AI Face Verify API
  version: v1.2
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- KeyAuth: []
- AADToken:
  - https://cognitiveservices.azure.com/.default
tags:
- name: Verify
paths:
  /verify:
    post:
      operationId: FaceRecognitionOperations_VerifyFaceToFace
      summary: Verify whether two faces belong to a same person
      description: '> [!NOTE]

        >

        > *

        > * Higher face image quality means better identification precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.

        > * For the scenarios that are sensitive to accuracy please make your own judgment.

        > * The ''recognitionModel'' associated with the both faces should be the same.'
      responses:
        '200':
          description: A successful call returns the verification result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationResult'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaceErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                faceId1:
                  $ref: '#/components/schemas/Azure.Core.uuid'
                  description: The faceId of one face, come from "Detect".
                faceId2:
                  $ref: '#/components/schemas/Azure.Core.uuid'
                  description: The faceId of another face, come from "Detect".
              required:
              - faceId1
              - faceId2
        required: true
      tags:
      - Verify
components:
  schemas:
    Azure.Core.uuid:
      type: string
      format: uuid
      description: Universally Unique Identifier
    FaceErrorResponse:
      type: object
      description: A response containing error details.
      properties:
        error:
          $ref: '#/components/schemas/FaceError'
          description: The error object.
      required:
      - error
    FaceError:
      type: object
      description: 'The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.'
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        message:
          type: string
          description: A human-readable representation of the error.
      required:
      - code
      - message
    VerificationResult:
      type: object
      description: Verify result.
      properties:
        isIdentical:
          type: boolean
          description: True if the two faces belong to the same person or the face belongs to the person, otherwise false.
        confidence:
          type: number
          format: float
          description: A number indicates the similarity confidence of whether two faces belong to the same person, or whether the face belongs to the person. By default, isIdentical is set to True if similarity confidence is greater than or equal to 0.5. This is useful for advanced users to override 'isIdentical' and fine-tune the result on their own data.
          minimum: 0
          maximum: 1
      required:
      - isIdentical
      - confidence
  securitySchemes:
    AADToken:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            https://cognitiveservices.azure.com/.default: ''
          authorizationUrl: https://api.example.com/oauth2/authorize
          tokenUrl: https://api.example.com/oauth2/token
      description: The Azure Active Directory OAuth2 Flow
    KeyAuth:
      type: apiKey
      description: The secret key for your Azure AI Face subscription.
      name: Ocp-Apim-Subscription-Key
      in: header
x-ms-parameterized-host:
  hostTemplate: '{endpoint}/face/{apiVersion}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: 'Supported Cognitive Services endpoints (protocol and hostname, for example:

      https://{resource-name}.cognitiveservices.azure.com).'
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true


# --- truncated at 32 KB (61 KB total) ---
# Full source: https://artifacts.apis.io/azure-ai-foundry/openapi/azure-ai-foundry-verify-api-openapi.yml