Microsoft Entra ID (formerly Azure AD) Identity.identity Verified ID Root API

The identity.identityVerifiedIdRoot API from Microsoft Entra ID (formerly Azure AD) — 4 operation(s) for identity.identityverifiedidroot.

Business capability
Identity & Access Management BC-620.20

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /identity/verifiedId Get the Verified ID root configuration · Get verifiedId from identity #
Ask an LLM
“How do I read the tenant's Verified ID entry point in Microsoft Entra?”
“What does the top-level Verified ID object for my tenant contain?”
Tell an agent
Get the Verified ID root object for this tenant.
Show my tenant's Verified ID configuration entry point.
PATCH /identity/verifiedId Update the Verified ID root object · Update the navigation property verifiedId in identity #
Ask an LLM
“Can I patch the tenant-level Verified ID object and its profiles in one call?”
“Which fields on the Verified ID root can I change?”
Tell an agent
Update the Verified ID root to hold profiles {profiles}.
Patch the tenant's top-level Verified ID configuration.
DELETE /identity/verifiedId Delete the Verified ID root object · Delete navigation property verifiedId for identity #
Ask an LLM
“Can I remove the whole Verified ID entry point from my tenant's identity settings?”
“What happens if I delete the tenant-level Verified ID object?”
Tell an agent destructive · confirm first
Delete the tenant's Verified ID root object.
Remove the Verified ID navigation property from identity.
GET /identity/verifiedId/profiles List Verified ID profiles · List profiles #
Ask an LLM
“Which Verified ID profiles are configured in my tenant?”
“How do I list all verifiedIdProfile objects with their properties?”
Tell an agent
List all Verified ID profiles.
Show every verification profile configured for Verified ID.
POST /identity/verifiedId/profiles Create a Verified ID profile · Create verifiedIdProfile #
Ask an LLM
“How do I set up a new Verified ID profile with Face Check?”
“Can I set a priority and verifier DID when creating a verification profile?”
Tell an agent
Create a Verified ID profile named {name} with verifier DID {verifier_did}.
Add a new verification profile {name} at priority {priority}.
GET /identity/verifiedId/profiles/{verifiedIdProfile-id} Get a Verified ID profile · Get verifiedIdProfile #
Ask an LLM
“How do I read one Verified ID profile's settings and relationships?”
“What Face Check configuration does a specific verification profile use?”
Tell an agent
Get Verified ID profile {profile}.
Show the Face Check and usage settings of verification profile {profile}.
PATCH /identity/verifiedId/profiles/{verifiedIdProfile-id} Update a Verified ID profile · Update verifiedIdProfile #
Ask an LLM
“Can I change the state or priority of an existing Verified ID profile?”
“Which properties of a verification profile can I edit after creating it?”
Tell an agent
Set the state of Verified ID profile {profile} to {state}.
Change the priority of existing verification profile {profile} to {priority}.
DELETE /identity/verifiedId/profiles/{verifiedIdProfile-id} Delete a Verified ID profile · Delete verifiedIdProfile #
Ask an LLM
“How do I delete a Verified ID profile I no longer need?”
“Can I remove one verification profile without touching the others?”
Tell an agent destructive · confirm first
Delete Verified ID profile {profile}.
Remove verification profile {profile} from the tenant.
GET /identity/verifiedId/profiles/$count Count Verified ID profiles · Get the number of the resource #
Ask an LLM
“How many Verified ID profiles does my tenant have?”
“What's the total number of verification profiles configured?”
Tell an agent
Count the Verified ID profiles.
Tell me how many verification profiles exist in the tenant.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/azure-ad:azure-ad-identity-identityverifiedidroot-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

azure-ad-identity-identityverifiedidroot-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Identity.SignIns Identity.identity Verified ID Root API
  version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
  description: Core
security:
- azureaadv2: []
tags:
- name: identity.identityVerifiedIdRoot
paths:
  /identity/verifiedId:
    get:
      tags:
      - identity.identityVerifiedIdRoot
      summary: Get verifiedId from identity
      description: Entry point for verified ID operations.
      operationId: identity_GetVerifiedId
      parameters:
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved navigation property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.identityVerifiedIdRoot'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - identity.identityVerifiedIdRoot
      summary: Update the navigation property verifiedId in identity
      operationId: identity_UpdateVerifiedId
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.identityVerifiedIdRoot'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.identityVerifiedIdRoot'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - identity.identityVerifiedIdRoot
      summary: Delete navigation property verifiedId for identity
      operationId: identity_DeleteVerifiedId
      parameters:
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /identity/verifiedId/profiles:
    get:
      tags:
      - identity.identityVerifiedIdRoot
      summary: List profiles
      description: Get a list of the verifiedIdProfile objects and their properties.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/identityverifiedidroot-list-profiles?view=graph-rest-1.0
      operationId: identity.verifiedId_ListProfile
      parameters:
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/count'
      - name: $orderby
        in: query
        description: Order items by property values
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          $ref: '#/components/responses/microsoft.graph.verifiedIdProfileCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - identity.identityVerifiedIdRoot
      summary: Create verifiedIdProfile
      description: Create a new verifiedIdProfile object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/identityverifiedidroot-post-profiles?view=graph-rest-1.0
      operationId: identity.verifiedId_CreateProfile
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.verifiedIdProfile'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.verifiedIdProfile'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /identity/verifiedId/profiles/{verifiedIdProfile-id}:
    get:
      tags:
      - identity.identityVerifiedIdRoot
      summary: Get verifiedIdProfile
      description: Read the properties and relationships of verifiedIdProfile object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/verifiedidprofile-get?view=graph-rest-1.0
      operationId: identity.verifiedId_GetProfile
      parameters:
      - name: verifiedIdProfile-id
        in: path
        description: The unique identifier of verifiedIdProfile
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: verifiedIdProfile
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved navigation property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.verifiedIdProfile'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - identity.identityVerifiedIdRoot
      summary: Update verifiedIdProfile
      description: Update the properties of a verifiedIdProfile object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/verifiedidprofile-update?view=graph-rest-1.0
      operationId: identity.verifiedId_UpdateProfile
      parameters:
      - name: verifiedIdProfile-id
        in: path
        description: The unique identifier of verifiedIdProfile
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: verifiedIdProfile
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.verifiedIdProfile'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.verifiedIdProfile'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - identity.identityVerifiedIdRoot
      summary: Delete verifiedIdProfile
      description: Delete a verifiedIdProfile object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/identityverifiedidroot-delete-profiles?view=graph-rest-1.0
      operationId: identity.verifiedId_DeleteProfile
      parameters:
      - name: verifiedIdProfile-id
        in: path
        description: The unique identifier of verifiedIdProfile
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: verifiedIdProfile
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /identity/verifiedId/profiles/$count:
    get:
      tags:
      - identity.identityVerifiedIdRoot
      summary: Get the number of the resource
      operationId: identity.verifiedId.profile_GetCount
      parameters:
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
components:
  responses:
    error:
      description: error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
    microsoft.graph.verifiedIdProfileCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.verifiedIdProfileCollectionResponse'
    ODataCountResponse:
      description: The count of the resource
      content:
        text/plain:
          schema:
            $ref: '#/components/schemas/ODataCountResponse'
  schemas:
    microsoft.graph.verifiedIdProfileCollectionResponse:
      title: Collection of verifiedIdProfile
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.verifiedIdProfile'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.InnerError:
      type: object
      additionalProperties:
        type: object
      description: The structure of this object is service-specific
    microsoft.graph.ODataErrors.MainError:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
          x-ms-primary-error-message: true
        target:
          type:
          - string
          - 'null'
        details:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
        innerError:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
      additionalProperties:
        type: object
    microsoft.graph.verifiedIdUsageConfigurationPurpose:
      title: verifiedIdUsageConfigurationPurpose
      enum:
      - recovery
      - onboarding
      - all
      - unknownFutureValue
      type: string
    microsoft.graph.claimBindingSource:
      title: claimBindingSource
      enum:
      - directory
      - unknownFutureValue
      type: string
    microsoft.graph.matchConfidenceLevel:
      title: matchConfidenceLevel
      enum:
      - exact
      - relaxed
      - unknownFutureValue
      type: string
    microsoft.graph.identityVerifiedIdRoot:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: identityVerifiedIdRoot
        type: object
        properties:
          profiles:
            type: array
            items:
              $ref: '#/components/schemas/microsoft.graph.verifiedIdProfile'
            description: Profile containing properties about a Verified ID provider and purpose
            x-ms-navigationProperty: true
        additionalProperties:
          type: object
    microsoft.graph.verifiedIdProfileConfiguration:
      title: verifiedIdProfileConfiguration
      type: object
      properties:
        acceptedIssuer:
          type: string
          description: Trusted Verified ID issuer.
        claimBindings:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.claimBinding'
          description: Claim bindings from Verified ID to source attributes.
        claimBindingSource:
          $ref: '#/components/schemas/microsoft.graph.claimBindingSource'
        claimValidation:
          $ref: '#/components/schemas/microsoft.graph.claimValidation'
        type:
          type: string
          description: Verified ID type.
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ODataError:
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
      additionalProperties:
        type: object
    microsoft.graph.faceCheckConfiguration:
      title: faceCheckConfiguration
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Defines if Face Check is required. Currently must always be true.
        sourcePhotoClaimName:
          type: string
          description: Source of photo to validate Face Check against. Currently must always be portrait.
      additionalProperties:
        type: object
    microsoft.graph.claimBinding:
      title: claimBinding
      type: object
      properties:
        matchConfidenceLevel:
          $ref: '#/components/schemas/microsoft.graph.matchConfidenceLevel'
        sourceAttribute:
          type: string
          description: Source attribute name from the source system, for example a directory attribute.
        verifiedIdClaim:
          type: string
          description: Verified ID claim name or path, for example vc.credentialSubject.firstName.
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ErrorDetails:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.entity:
      title: entity
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for an entity. Read-only.
      additionalProperties:
        type: object
    microsoft.graph.claimValidation:
      title: claimValidation
      type: object
      properties:
        customExtensionId:
          type: string
          description: The identifier of a custom extension for claim validation.
        isEnabled:
          type: boolean
          description: Indicates whether claim validation is enabled.
      additionalProperties:
        type: object
    microsoft.graph.verifiedIdUsageConfiguration:
      title: verifiedIdUsageConfiguration
      type: object
      properties:
        isEnabledForTestOnly:
          type: boolean
          description: Sets profile usage for evaluation (test-only) or production.
        purpose:
          $ref: '#/components/schemas/microsoft.graph.verifiedIdUsageConfigurationPurpose'
      additionalProperties:
        type: object
    microsoft.graph.verifiedIdProfile:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: verifiedIdProfile
        type: object
        properties:
          description:
            type: string
            description: Description for the verified ID profile. Required.
          faceCheckConfiguration:
            $ref: '#/components/schemas/microsoft.graph.faceCheckConfiguration'
          lastModifiedDateTime:
            pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
            type:
            - string
            - 'null'
            description: DateTime the profile was last modified. Optional.
            format: date-time
          name:
            type: string
            description: Display name for the verified ID profile. Required.
          priority:
            maximum: 2147483647
            minimum: -2147483648
            type:
            - number
            - 'null'
            description: Defines profile processing priority if multiple profiles are configured. Optional.
            format: int32
          state:
            $ref: '#/components/schemas/microsoft.graph.verifiedIdProfileState'
          verifiedIdProfileConfiguration:
            $ref: '#/components/schemas/microsoft.graph.verifiedIdProfileConfiguration'
          verifiedIdUsageConfigurations:
            type: array
            items:
              $ref: '#/components/schemas/microsoft.graph.verifiedIdUsageConfiguration'
            description: Collection defining the usage purpose for the profile. Required.
          verifierDid:
            type: string
            description: Decentralized Identifier (DID) string that represents the verifier in the verifiable credential exchange. Required.
        additionalProperties:
          type: object
    microsoft.graph.verifiedIdProfileState:
      title: verifiedIdProfileState
      enum:
      - enabled
      - disabled
      - unknownFutureValue
      type: string
    ODataCountResponse:
      type: integer
      format: int32
  parameters:
    top:
      name: $top
      in: query
      description: Show only the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
      example: 50
    skip:
      name: $skip
      in: query
      description: Skip the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
    filter:
      name: $filter
      in: query
      description: Filter items by property values
      style: form
      explode: false
      schema:
        type: string
    search:
      name: $search
      in: query
      description: Search items by search phrases
      style: form
      explode: false
      schema:
        type: string
    count:
      name: $count
      in: query
      description: Include count of items
      style: form
      explode: false
      schema:
        type: boolean
  securitySchemes:
    azureaadv2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes: {}