Docusign IdentityVerifications API

openapi: 3.0.1
info:
  title: DocuSign Admin AccountBrands IdentityVerifications API
  description: An API for an organization administrator to manage organizations, accounts and users
  termsOfService: https://www.docusign.com/company/terms-and-conditions/developers
  contact:
    name: DocuSign Developer Center
    url: https://developers.docusign.com
    email: devcenter@docusign.com
  version: v2.1
servers:
- url: https://api.docusign.net/Management
tags:
- name: IdentityVerifications
  description: ''
paths:
  /v2/accounts/{accountId}/identity_verification:
    get:
      tags:
      - IdentityVerifications
      operationId: AccountIdentityVerification_GetAccountIdentityVerification
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/accountIdentityVerificationResponse'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getAccountIdentityVerification
      x-ds-method: list
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
components:
  schemas:
    accountIdentityVerificationWorkflow:
      type: object
      properties:
        defaultName:
          type: string
          description: ''
        steps:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/accountIdentityVerificationStep'
        workflowId:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: accountIdentityVerificationWorkflow
      x-ms-summary: ''
    accountIdentityVerificationStep:
      type: object
      properties:
        name:
          type: string
          description: ''
        type:
          type: string
          description: 'Type of the user. Valid values: type_owner, type_participant.'
      description: ''
      x-ds-definition-name: accountIdentityVerificationStep
      x-ms-summary: ''
    accountIdentityVerificationResponse:
      type: object
      properties:
        identityVerification:
          type: array
          description: Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications/list) method in the [IdentityVerifications](https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).
          items:
            $ref: '#/components/schemas/accountIdentityVerificationWorkflow'
      description: ''
      x-ds-definition-name: accountIdentityVerificationResponse
      x-ms-summary: ''
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
  securitySchemes:
    accessCode:
      type: oauth2
      description: OAuth2 Access code Grant
      flows:
        authorizationCode:
          authorizationUrl: https://account.docusign.com/oauth/auth
          tokenUrl: https://account.docusign.com/oauth/auth
          scopes:
            organization_read: ''
            permission_read: ''
            group_read: ''
            user_read: ''
            account_read: ''
            account_write: ''
            user_write: ''
            identity_provider_read: ''
            domain_read: ''
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'