> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# 数字身份钱包 API 目录

> 在 Didit 查找数字身份钱包 endpoint，了解各国家/地区的覆盖范围、必填输入项与可用性，便于在您的应用中集成。

使用此经身份验证的目录，查找每个钱包的启动 endpoint、支持的国家/地区和所需输入。
`available` 字段适用于您在所调用环境中，由 API 密钥标识的应用。
仅提供对该应用可用且支持用户所选国家/地区的钱包。
启动验证时，系统仍会检查输入校验、额度要求以及适用的合同费率。

钱包在 `available` 为 `false` 时仍可能出现在目录中。
目录不会激活该钱包，也不会覆盖其生产环境要求。
沙盒应用可以模拟尚未开放生产环境认证的钱包。

请按照[钱包 API 集成指南](https://docs.didit.me/zh/standalone-apis/digital-id-wallets.md)发起验证并接收结果。


## OpenAPI

````yaml zh/openapi-25.json GET /v3/id-verification/wallets/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: 身份证件验证 API。使用 x-api-key 请求头进行身份验证。
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/id-verification/wallets/:
    get:
      tags:
        - Digital ID wallets
      summary: 列出数字身份钱包
      description: 每个数字身份钱包及其启动 endpoint、支持的国家/地区、必填字段，以及该应用当前是否可以在此环境中启动它。列出并不代表已上线。
      operationId: list_wallets
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DigitalIdWalletApiWalletCatalogResponse'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage
          description: '缺少凭据（x-api-key 或 Authorization: Bearer）。'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl --request GET \
              --url https://verification.didit.me/v3/id-verification/wallets/ \
              --header 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.id_wallets.list()
            print(result)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            const result = await didit.idWallets.list();
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.List(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            var result = client.idWallets().list();
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->idWallets->list();
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.id_wallets.list
            puts result.to_h
        - lang: csharp
          label: .NET
          source: |-
            using System;
            using System.Text.Json;
            using Didit;

            // Reads DIDIT_API_KEY.
            using var client = new DiditClient();

            var result = await client.IdWallets.ListAsync();
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    DigitalIdWalletApiWalletCatalogResponse:
      type: object
      properties:
        wallets:
          type: array
          items:
            $ref: '#/components/schemas/DigitalIdWalletApiWalletCatalogEntry'
      required:
        - wallets
    DigitalIdWalletApiClientCredentialsForbiddenErrorMessage:
      type: object
      properties:
        detail:
          type: string
          default: Forbidden - User doesn't have permission
    DigitalIdWalletApiWalletCatalogEntry:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        path:
          type: string
          description: 钱包专属的启动 endpoint。
        countries:
          type: array
          items:
            type: string
        issuing_authority:
          type: string
        level_of_assurance:
          type: string
          nullable: true
        interaction:
          $ref: '#/components/schemas/DigitalIdWalletApiInteractionEnum'
        required_fields:
          type: array
          items:
            type: string
        available:
          type: boolean
          description: 该应用目前能否在此环境中启动它。列出并不代表已在生产环境上线。
      required:
        - available
        - countries
        - id
        - interaction
        - issuing_authority
        - level_of_assurance
        - name
        - path
        - required_fields
    DigitalIdWalletApiInteractionEnum:
      enum:
        - redirect
        - in_app
        - digital_credentials
      type: string
      description: |-
        * `redirect` - 重定向
        * `in_app` - 应用内
        * `digital_credentials` - 数字凭证
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        您的应用 API 密钥，可在 Business Console 的“开发者 -> API
        密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域：针对每个资源设为无权限、只读或读写，限定于特定工作流或已通过的会话、限定于
        IP 地址列表，以及设置到期日期。401 表示密钥错误、已撤销或已过期；403 表示未发送密钥、密钥无权访问该资源或操作，或请求来自其 IP
        列表之外的地址；在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF
        URL 将为 null；没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅
        https://docs.didit.me/console/api-keys。
    BearerAuth:
      type: http
      scheme: bearer
      description: 该应用的客户端凭证访问 token。

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.