swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Verify API
schemes:
- https
tags:
- name: Verify
paths:
  /verify:
    post:
      description: 'Verify whether two faces belong to a same person or whether one face belongs to a person.<br><br>Remarks:<br>* 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.<br>* For the scenarios that are sensitive to accuracy please make your own judgment.<br>* The ''recognitionModel'' associated with the query faces'' faceIds should be the same as the ''recognitionModel'' used by the target face, person group or large person group.<br>'
      operationId: microsoftAzureFaceVerifyfacetoface
      parameters:
      - name: body
        description: Request body for face to face verification.
        in: body
        required: true
        x-ms-client-flatten: true
        schema:
          $ref: '#/definitions/VerifyFaceToFaceRequest'
      consumes:
      - application/json
      produces:
      - application/json
      responses:
        '200':
          description: A successful call returns the verification result.
          schema:
            $ref: '#/definitions/VerifyResult'
        default:
          description: Error response.
          schema:
            $ref: '#/definitions/APIError'
      x-ms-examples:
        Verify faces example:
          $ref: ./examples/VerifyFaceToFace.json
      summary: Microsoft Azure Post Verify
      tags:
      - Verify
definitions:
  VerifyFaceToFaceRequest:
    type: object
    required:
    - faceId1
    - faceId2
    description: Request body for face to face verification.
    properties:
      faceId1:
        type: string
        format: uuid
        description: FaceId of the first face, comes from Face - Detect
      faceId2:
        type: string
        format: uuid
        description: FaceId of the second face, comes from Face - Detect
  APIError:
    type: object
    description: Error information returned by the API
    properties:
      error:
        $ref: '#/definitions/Error'
  VerifyResult:
    type: object
    required:
    - isIdentical
    - confidence
    description: Result of the verify operation.
    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:
        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.
        $ref: '#/definitions/Confidence'
  Error:
    type: object
    description: Error body.
    properties:
      code:
        type: string
      message:
        type: string
  Confidence:
    description: A number ranging from 0 to 1 indicating a level of confidence associated with a property.
    type: number
    minimum: 0
    maximum: 1
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'