Docusign Identity Verifications API

openapi: 3.2.0
info:
  title: Docusign Identity Verifications API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged IdentityVerifications across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: Identity Verifications
  description: ''
paths:
  /v2/accounts/{accountId}/identity_verification:
    get:
      tags:
      - Identity Verifications
      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
      summary: Account identity verification get account identity verification
      x-summary-source: derived
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/identity_verification:
    parameters: []
    get:
      tags:
      - Identity Verifications
      summary: Retrieves the Identity Verification workflows available to an account
      operationId: getV21AccountsByAccountIdIdentityVerification
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: identity_verification_workflow_status
        in: query
        required: false
        description: 'Filters the workflows returned according to status. Valid values:


          - `active`: Only active workflows are returned. This is the default.

          - `deactivated`: Only deactivated workflows are returned.

          - `all`: All workflows are returned.

          '
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/accountIdentityVerificationResponse_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getAccountIdentityVerification
      description: 'This method returns a list of Identity Verification workflows that are available to an account.


        **Note:** To use this method, you must either be an account administrator or a sender.


        ### Related topics


        - How to require ID Verification (IDV) for a recipient'
      x-ds-method: list
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: AccountIdentityVerification_GetAccountIdentityVerification
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    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: ''
    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: ''
    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.
    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: ''
    signatureProviderRequiredOption:
      type: object
      properties:
        requiredSignatureProviderOptionIds:
          description: Reserved for Docusign.
          type: array
          items:
            type: string
        signerType:
          description: Reserved for Docusign.
          type: string
      description: Contains additional information that a specific signature provider requires.
      x-ds-definition-name: signatureProviderRequiredOption
      x-ms-summary: Contains additional information that a specific signature provider requires.
    accountIdentityInputOption:
      type: object
      properties:
        isRequired:
          description: ''
          type: boolean
        optionName:
          description: ''
          type: string
        valueType:
          description: ''
          type: string
      x-ds-definition-name: accountIdentityInputOption
      description: ''
      x-ms-summary: ''
    accountSignatureProviderOption:
      type: object
      properties:
        signatureProviderOptionDisplayName:
          description: Reserved for Docusign.
          type: string
        signatureProviderOptionHintOverrideValue:
          description: ''
          type: string
        signatureProviderOptionId:
          description: Reserved for Docusign.
          type: string
        signatureProviderOptionName:
          description: Reserved for Docusign.
          type: string
        signatureProviderOptionRegexValidationPattern:
          description: ''
          type: string
      description: Reserved for Docusign.
      x-ds-definition-name: accountSignatureProviderOption
      x-ms-summary: Reserved for Docusign.
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
    accountIdentityVerificationWorkflow_2:
      type: object
      properties:
        defaultDescription:
          description: Text describing the purpose of the Identity Verification workflow.
          type: string
        defaultName:
          description: The name of the Identity Verification workflow.
          type: string
        displayOrder:
          format: int32
          description: The position on the page where the display section appears.
          type: string
        inputOptions:
          description: ''
          type: array
          items:
            $ref: '#/components/schemas/accountIdentityInputOption'
        isDisabled:
          description: When **true,** the workflow is disabled.
          type: string
        ownerType:
          description: ''
          type: string
        signatureProvider:
          $ref: '#/components/schemas/accountSignatureProvider'
          description: The signature provider associated with the Identity Verification workflow.
        workflowId:
          description: 'Workflow unique ID</br>This is the ID you must specify when setting ID Verification in an envelope using the `identityVerification`

            [core recipient parameter](/docs/esign-rest-api/reference/envelopes/enveloperecipients/#core-recipient-parameters)'
          type: string
        workflowLabel:
          description: ''
          type: string
        workflowResourceKey:
          description: Reserved for Docusign.
          type: string
      description: Specifies an Identity Verification workflow.
      x-ds-definition-name: accountIdentityVerificationWorkflow
      x-ms-summary: Specifies an Identity Verification workflow.
    accountSignatureProvider:
      type: object
      properties:
        isRequired:
          description: Reserved for Docusign.
          type: string
        priority:
          description: Reserved for Docusign.
          type: string
        signatureProviderDisplayName:
          description: Reserved for Docusign.
          type: string
        signatureProviderId:
          description: Reserved for Docusign.
          type: string
        signatureProviderName:
          description: 'The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/). You can also retrieve the list by using the [AccountSignatureProviders: List](/docs/esign-rest-api/reference/accounts/accountsignatureproviders/list/) method.


            Example: `universalsignaturepen_default`


            '
          type: string
        signatureProviderOptionsMetadata:
          description: Reserved for Docusign.
          type: array
          items:
            $ref: '#/components/schemas/accountSignatureProviderOption'
        signatureProviderRequiredOptions:
          description: Reserved for Docusign.
          type: array
          items:
            $ref: '#/components/schemas/signatureProviderRequiredOption'
      description: 'Contains information about the signature provider associated with the Identity Verification workflow.

        If empty, then this specific workflow is not intended for signers.

        '
      x-ds-definition-name: accountSignatureProvider
      x-ms-summary: 'Contains information about the signature provider associated with the Identity Verification workflow.

        If empty, then this specific workflow is not intended for signers.

        '
    accountIdentityVerificationResponse_2:
      type: object
      properties:
        identityVerification:
          description: Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/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/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) 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).
          type: array
          items:
            $ref: '#/components/schemas/accountIdentityVerificationWorkflow_2'
      x-ds-definition-name: accountIdentityVerificationResponse
      description: ''
      x-ms-summary: ''
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
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'