> ## 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.

# UAE PASS: API верификации личности

> Интегрируйте верификацию личности через UAE PASS в своё приложение с Didit. Смотрите покрытие стран, шаги аутентификации, результаты и цены.

Запустите верификацию UAE PASS из своего бэкенда, используя API-ключ вашего приложения.
Сценарий и `workflow_id` не нужны.
Ответ на запуск описывает следующее действие аутентификации, но не является одобренным результатом верификации личности.

## Охват и активация

| Свойство | Значение |
| - | - |
| Кошелёк | UAE PASS |
| ID кошелька | `uae_pass` |
| Страны | ![](https://didit-public-assets.s3.eu-west-1.amazonaws.com/flags/ae.svg)Объединённые Арабские Эмираты |
| Активация кошелька в продакшене | ⏳ Скоро будет доступна |
| Опубликованная цена кошелька | Скоро будет доступна |

Активация кошелька не зависит от развёртывания API и от того, соответствует ли ваше приложение требованиям.
Задокументированный endpoint не активирует кошелёк, который помечен как «Скоро будет доступно».
Актуальные опубликованные тарифы см. в разделе [цены на цифровые кошельки удостоверений личности](https://docs.didit.me/ru/getting-started/pricing.md#цены-на-цифровые-кошельки-удостоверений-личности).

## Что делает пользователь

Выполните следующее действие, которое вернул запрос на запуск.
От сценария аутентификации в кошельке зависит, потребуется ли пользователю браузер, другое устройство или приложение.

## Получение результата

Следуйте [руководству по API цифровых кошельков удостоверений личности](https://docs.didit.me/ru/standalone-apis/digital-id-wallets.md), чтобы отслеживать верификацию и получать её результат.
Считайте доказательством того, что кошелёк аутентифицировал пользователя, только завершённый и подтверждённый результат.
Набор возвращаемых атрибутов личности зависит от кошелька; не предполагайте, что адрес, портрет или каждый запрошенный атрибут присутствуют.

## Связанные материалы

* [API цифровых кошельков удостоверений личности](https://docs.didit.me/ru/standalone-apis/digital-id-wallets.md)
* [Охват кошельков и атрибуты](https://docs.didit.me/ru/core-technology/id-verification/digital-id-wallets.md)
* [Цены](https://docs.didit.me/ru/getting-started/pricing.md#цены-на-цифровые-кошельки-удостоверений-личности)


## OpenAPI

````yaml ru/openapi-25.json POST /v3/id-verification/wallets/uae-pass/
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/uae-pass/:
    post:
      tags:
        - Digital ID wallets
      summary: Запустить верификацию через UAE PASS
      description: >-
        Запустить вход через UAE PASS (UAE Digital Government Authority; ARE)
        без сценария. Тарифицируется один раз, только при успешной верификации
        личности. Ответ содержит next_action.type=redirect с URL, на который
        следует перенаправить браузер пользователя; пользователь возвращается на
        return_url с добавленными request_id и result. Получайте результат с
        помощью GET /v3/id-verification/wallets/verifications/{request_id}/ или
        из webhook, но ни в коем случае не из URL. Приложения в песочнице
        получают детерминированную симуляцию (simulated: true), которая не
        обращается к провайдеру.
      operationId: start_uae_pass_wallet_verification
      parameters:
        - in: header
          name: Idempotency-Key
          schema:
            type: string
          description: >-
            Необязательный ключ для безопасного повтора запроса (макс. 255
            символов). Повторная попытка с тем же ключом, кошельком и телом
            запроса возвращает исходную верификацию без запуска повторного
            входа; тот же ключ с другим кошельком или телом запроса возвращает
            409 idempotency_key_reused.
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartRequest
            example:
              country: ARE
              vendor_data: your-customer-reference
              metadata:
                reference: example
              return_url: https://app.example.com/identity/complete
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartRequest
          multipart/form-data:
            schema:
              $ref: >-
                #/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartRequest
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/DigitalIdWalletApiWalletVerificationResponse
              example:
                request_id: 00000000-0000-4000-8000-000000000001
                wallet_verification:
                  wallet:
                    id: uae_pass
                    name: UAE PASS
                    issuing_authority: UAE Digital Government Authority
                  country: ARE
                  status: Not Finished
                  outcome: pending
                  error: null
                  interaction: redirect
                  simulated: false
                  expires_at: '2026-01-01T10:10:00Z'
                  next_action:
                    type: redirect
                    url: https://wallet.example.com/authorize
                  identity: null
                  attributes: null
                  level_of_assurance: null
                  verified_at: null
                  signature_valid: null
                  credential_type: person_identification
                vendor_data: your-customer-reference
                metadata:
                  reference: example
                created_at: '2026-01-01T10:00:00Z'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/DigitalIdWalletApiWalletVerificationStartBadRequest
          description: >-
            Ошибки валидации полей ({field: [messages]}) или ошибка
            return_url_invalid, return_url_not_allowed, invalid_personal_code,
            invalid_phone_number либо idempotency_key_invalid.
        '403':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden
          description: >-
            Отсутствуют учетные данные ({detail}), либо возникла ошибка
            wallet_unavailable, insufficient_credits или contract_rate_missing.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DigitalIdWalletApiWalletVerificationError'
          description: >-
            ошибка idempotency_key_reused или idempotency_key_in_progress (с
            заголовком Retry-After).
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DigitalIdWalletApiWalletVerificationError'
          description: >-
            ошибка wallet_provider_unavailable: не удалось запустить провайдера;
            ничего не было создано.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DigitalIdWalletApiWalletVerificationError'
          description: >-
            ошибка wallet_not_configured: эта среда не может связаться с
            кошельком.
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl --request POST \
              --url https://verification.didit.me/v3/id-verification/wallets/uae-pass/ \
              --header 'x-api-key: YOUR_API_KEY' \
              --header 'Idempotency-Key: your-unique-attempt-key' \
              --header 'Content-Type: application/json' \
              --data '{
              "country": "ARE",
              "vendor_data": "your-customer-reference",
              "metadata": {
                "reference": "example"
              },
              "return_url": "https://app.example.com/identity/complete"
            }'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.id_wallets.start_uae_pass(
                vendor_data="your-customer-reference",
                metadata={"reference": "example"},
                country="ARE",
                return_url="https://app.example.com/identity/complete",
            )
            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.startUaePass({
              vendor_data: "your-customer-reference",
              metadata: { reference: "example" },
              country: "ARE",
              return_url: "https://app.example.com/identity/complete",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.IDWallets.StartUaePass(ctx, didit.IDWalletsStartUaePassParams{\n\tBody: didit.DigitalIDWalletAPIUaePassWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata:   didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry:    didit.Some(didit.DigitalIDWalletAPIUaePassWalletVerificationStartCountryEnum(\"ARE\")),\n\t\tReturnURL:  \"https://app.example.com/identity/complete\",\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import java.util.Map;

            import me.didit.Didit;

            import
            me.didit.types.DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum;

            import
            me.didit.types.DigitalIdWalletApiUaePassWalletVerificationStartRequest;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.idWallets().startUaePass(DigitalIdWalletApiUaePassWalletVerificationStartRequest.builder()
                    .vendorData("your-customer-reference")
                    .metadata(Map.of("reference", "example"))
                    .country(DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum.of("ARE"))
                    .returnUrl("https://app.example.com/identity/complete")
                    .build());
            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->startUaePass([
                'vendor_data' => 'your-customer-reference',
                'metadata' => ['reference' => 'example'],
                'country' => 'ARE',
                'return_url' => 'https://app.example.com/identity/complete',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.id_wallets.start_uae_pass(
              vendor_data: "your-customer-reference",
              metadata: { reference: "example" },
              country: "ARE",
              return_url: "https://app.example.com/identity/complete"
            )
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Collections.Generic;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await client.IdWallets.StartUaePassAsync(new
            DigitalIdWalletApiUaePassWalletVerificationStartRequest

            {
                VendorData = "your-customer-reference",
                Metadata = new Dictionary<string, object> { ["reference"] = "example" },
                Country = new DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum("ARE"),
                ReturnUrl = "https://app.example.com/identity/complete",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    DigitalIdWalletApiUaePassWalletVerificationStartRequest:
      type: object
      description: Запустить верификацию UAE PASS (ARE).
      properties:
        vendor_data:
          type: string
          nullable: true
          description: >-
            Ваш собственный референс этой верификации (например, идентификатор
            пользователя). Возвращается в результатах и webhook.
        metadata:
          type: object
          additionalProperties: {}
          nullable: true
          description: >-
            Необязательный объект JSON, сохраняемый вместе с верификацией и
            возвращаемый в результатах и webhook.
        sandbox_scenario:
          type: string
          minLength: 1
          description: >-
            Только для приложений в песочнице: имитируемый результат -
            'wallet_cancelled', 'wallet_timeout' или 'wallet_provider_error';
            любой другой сценарий (или его отсутствие) проходит верификацию.
            Отклоняется для приложений в продакшн-среде. Полный каталог доступен
            по адресу GET /v1/sandbox/scenarios/.
        country:
          allOf:
            - $ref: >-
                #/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum
          default: ARE
          description: >-
            Код страны ISO 3166-1 alpha-3 для удостоверения UAE PASS. По
            умолчанию ARE, единственная обслуживаемая страна.


            * `ARE` - ARE
        return_url:
          type: string
          format: uri
          minLength: 1
          description: >-
            URL https, на который браузер пользователя возвращается после
            кошелька, с добавленными параметрами request_id и result. Его хост
            должен быть зарегистрирован в allowed_return_hosts приложения (или
            являться его доменом White label). Никогда не полагайтесь только на
            result: получайте результат с помощью GET
            .../verifications/{request_id}/ или через webhook.
          maxLength: 2048
        device:
          allOf:
            - $ref: '#/components/schemas/DigitalIdWalletApiDeviceEnum'
          default: same_device
          description: >-
            same_device, если пользователь выполняет вход на устройстве,
            отображающем вашу страницу; cross_device, если он использует другое
            устройство (например, QR-код BankID).


            * `same_device` - same_device

            * `cross_device` - cross_device
      required:
        - return_url
    DigitalIdWalletApiWalletVerificationResponse:
      type: object
      description: >-
        Одна отдельная верификация кошелька в том виде, в котором её возвращает
        каждый endpoint для кошельков.
      properties:
        request_id:
          type: string
          format: uuid
        wallet_verification:
          $ref: '#/components/schemas/DigitalIdWalletApiWalletVerificationResult'
        vendor_data:
          type: string
          nullable: true
        metadata:
          type: object
          additionalProperties: {}
          nullable: true
          description: Объект метаданных, переданный при запуске, или null.
        created_at:
          type: string
          format: date-time
      required:
        - created_at
        - metadata
        - request_id
        - vendor_data
        - wallet_verification
    DigitalIdWalletApiWalletVerificationStartBadRequest:
      oneOf:
        - $ref: '#/components/schemas/DigitalIdWalletApiWalletVerificationError'
        - $ref: '#/components/schemas/DigitalIdWalletApiWalletVerificationFieldErrors'
    DigitalIdWalletApiWalletVerificationStartForbidden:
      oneOf:
        - $ref: >-
            #/components/schemas/DigitalIdWalletApiClientCredentialsForbiddenErrorMessage
        - $ref: '#/components/schemas/DigitalIdWalletApiWalletVerificationError'
    DigitalIdWalletApiWalletVerificationError:
      type: object
      properties:
        error:
          type: string
          description: Постоянный машиночитаемый код, например wallet_unavailable.
        detail:
          type: string
      required:
        - detail
        - error
    DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum:
      enum:
        - ARE
      type: string
      description: '* `ARE` - ARE'
    DigitalIdWalletApiDeviceEnum:
      enum:
        - same_device
        - cross_device
      type: string
      description: |-
        * `same_device` - same_device
        * `cross_device` - cross_device
    DigitalIdWalletApiWalletVerificationResult:
      type: object
      properties:
        wallet:
          allOf:
            - $ref: '#/components/schemas/DigitalIdWalletApiWallet'
          readOnly: true
        country:
          type: string
        status:
          type: string
          description: >-
            Не завершена (Not Finished), пока находится в ожидании, затем
            Одобрена (Approved / верифицирована) или Отклонена (Declined).
        outcome:
          $ref: >-
            #/components/schemas/DigitalIdWalletApiWalletVerificationResultOutcomeEnum
        error:
          type: string
          nullable: true
          readOnly: true
        interaction:
          allOf:
            - $ref: '#/components/schemas/DigitalIdWalletApiInteractionEnum'
          readOnly: true
        simulated:
          type: boolean
          readOnly: true
        expires_at:
          type: string
          format: date-time
        next_action:
          allOf:
            - $ref: '#/components/schemas/DigitalIdWalletApiWalletNextAction'
          nullable: true
          readOnly: true
        identity:
          allOf:
            - $ref: '#/components/schemas/DigitalIdWalletApiWalletIdentity'
          nullable: true
          readOnly: true
        attributes:
          type: object
          additionalProperties: {}
          nullable: true
          readOnly: true
        level_of_assurance:
          type: string
          nullable: true
        verified_at:
          type: string
          format: date-time
          nullable: true
        signature_valid:
          type: boolean
          nullable: true
          description: >-
            True, если подпись учётных данных была подтверждена; null для
            имитированных учётных данных.
        credential_type:
          type: string
          nullable: true
      required:
        - attributes
        - country
        - credential_type
        - error
        - expires_at
        - identity
        - interaction
        - level_of_assurance
        - next_action
        - outcome
        - signature_valid
        - simulated
        - status
        - verified_at
        - wallet
    DigitalIdWalletApiWalletVerificationFieldErrors:
      type: object
      description: >-
        Ошибки валидации запроса: каждое отклонённое поле с соответствующими
        сообщениями.
      additionalProperties:
        type: array
        items:
          type: string
    DigitalIdWalletApiClientCredentialsForbiddenErrorMessage:
      type: object
      properties:
        detail:
          type: string
          default: Forbidden - User doesn't have permission
    DigitalIdWalletApiWallet:
      type: object
      properties:
        id:
          type: string
          description: Каталожный идентификатор кошелька, например bankid_se.
        name:
          type: string
        issuing_authority:
          type: string
          nullable: true
      required:
        - id
        - issuing_authority
        - name
    DigitalIdWalletApiWalletVerificationResultOutcomeEnum:
      enum:
        - pending
        - verified
        - cancelled
        - timeout
        - failed
      type: string
      description: |-
        * `pending` - В ожидании
        * `verified` - Подтверждено
        * `cancelled` - Отменено пользователем
        * `timeout` - Время ожидания истекло
        * `failed` - Не удалось
    DigitalIdWalletApiInteractionEnum:
      enum:
        - redirect
        - in_app
        - digital_credentials
      type: string
      description: |-
        * `redirect` - redirect
        * `in_app` - in_app
        * `digital_credentials` - digital_credentials
    DigitalIdWalletApiWalletNextAction:
      type: object
      properties:
        type:
          allOf:
            - $ref: '#/components/schemas/DigitalIdWalletApiWalletNextActionTypeEnum'
          description: >-
            redirect: перенаправьте браузер пользователя на url. confirm_in_app:
            покажите verification_code пользователю, который сверяет его с кодом
            в приложении своего кошелька и подтверждает там; затем выполняйте
            опрос. request_digital_credential: при взаимодействии пользователя в
            исходном источнике запросите кошелёк с помощью
            digital_credentials.request, затем отправьте возвращённый результат
            в POST .../verifications/{request_id}/response/.


            * `redirect` - redirect

            * `confirm_in_app` - confirm_in_app

            * `request_digital_credential` - request_digital_credential
        url:
          type: string
          format: uri
          description: >-
            Только для redirect: адрес, по которому пользователь входит в
            систему с помощью кошелька.
        digital_credentials:
          allOf:
            - $ref: >-
                #/components/schemas/DigitalIdWalletApiWalletDigitalCredentialsRequest
          description: >-
            Только для request_digital_credential: запрос для передачи в
            кошелёк.
        verification_code:
          type: string
          description: >-
            Только для confirm_in_app: 4-значный код сравнения, который также
            отображается в приложении кошелька.
        poll_interval_seconds:
          type: integer
          description: >-
            Только для confirm_in_app: как часто вызывать POST
            .../verifications/{request_id}/poll/ для быстрого получения статуса.
            Didit также выполняет фоновые опросы незавершённых входов, поэтому
            webhook сообщит о результате, даже если вы не выполняете опросы.
      required:
        - type
    DigitalIdWalletApiWalletIdentity:
      type: object
      properties:
        full_name:
          type: string
          nullable: true
        first_name:
          type: string
          nullable: true
        last_name:
          type: string
          nullable: true
        date_of_birth:
          type: string
          format: date
          nullable: true
        nationality:
          type: string
          nullable: true
          description: >-
            Гражданство по ISO3, только если оно прямо заявлено кошельком
            (никогда не определяется косвенно).
        issuing_state:
          type: string
          description: Страна по ISO3, схема которой выдала удостоверение.
      required:
        - date_of_birth
        - first_name
        - full_name
        - issuing_state
        - last_name
        - nationality
    DigitalIdWalletApiWalletNextActionTypeEnum:
      enum:
        - redirect
        - confirm_in_app
        - request_digital_credential
      type: string
      description: |-
        * `redirect` - redirect
        * `confirm_in_app` - confirm_in_app
        * `request_digital_credential` - request_digital_credential
    DigitalIdWalletApiWalletDigitalCredentialsRequest:
      type: object
      properties:
        protocol:
          type: string
          description: openid4vp-v1-signed.
        request:
          type: object
          additionalProperties: {}
          description: >-
            Передайте как есть: navigator.credentials.get({digital: request}) в
            браузере или JSON.stringify(request) как requestJson для
            GetDigitalCredentialOption на Android. Подписано Didit для вашего
            приложения.
      required:
        - protocol
        - request
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в
        Business Console. Основной ключ имеет полный доступ. Именованный ключ
        может иметь ограниченную область действия: без доступа, чтение или
        запись для каждого ресурса, ограничение определенными сценариями или
        одобренными сессиями, списком IP-адресов и сроком действия. 401
        означает, что ключ неверен, отозван или его срок действия истек; 403
        означает, что ключ не был передан, у ключа нет доступа к этому ресурсу
        или действию, либо запрос поступил с адреса вне его списка IP-адресов;
        404 на маршруте сессии означает, что сессия не входит в сценарии или
        статусы ключа. Ключ без доступа к медиа получает URL изображений, видео
        и PDF как null, а ключ без прав на запись сессий получает ссылки на
        сессии и токены как null. См. https://docs.didit.me/console/api-keys.
    BearerAuth:
      type: http
      scheme: bearer
      description: Токен доступа приложения, полученный по учётным данным клиента.

````

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