> ## 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 de verificação UAE PASS > Integre a verificação de identidade UAE PASS à sua aplicação com a Didit. Veja cobertura, etapas de autenticação, resultados e preços. Inicie a verificação com UAE PASS a partir do seu backend usando a chave de API da sua aplicação. Você não precisa de um fluxo de verificação (workflow) nem de um `workflow_id`. A resposta inicial descreve a próxima ação de autenticação; ela não é um resultado de identidade aprovado. ## Cobertura e ativação | Propriedade | Valor | | - | - | | Carteira | UAE PASS | | ID da carteira | `uae_pass` | | Países | ![](https://didit-public-assets.s3.eu-west-1.amazonaws.com/flags/ae.svg)Emirados Árabes Unidos | | Ativação da carteira em produção | ⏳ Em breve | | Preço publicado da carteira | Em breve | A ativação da carteira é independente da implantação da API e da elegibilidade da sua aplicação. Um endpoint documentado não ativa uma carteira marcada como Em breve. Para as tarifas publicadas atuais, consulte [preços das carteiras de identidade digital](https://docs.didit.me/pt-br/getting-started/pricing.md#preços-das-carteiras-de-identidade-digital). ## O que a pessoa faz Siga a próxima ação retornada pela requisição de início. A experiência de autenticação da carteira determina se a pessoa usa um navegador, outro dispositivo ou um aplicativo. ## Receber o resultado Siga o [guia da API de carteiras de identidade digital](https://docs.didit.me/pt-br/standalone-apis/digital-id-wallets.md) para acompanhar a verificação e obter o resultado. Considere apenas um resultado concluído e verificado como prova de que a carteira autenticou a pessoa. Os atributos de identidade retornados variam conforme a carteira; não presuma que um endereço, um retrato ou todos os atributos solicitados estejam presentes. ## Relacionados * [APIs de carteiras de identidade digital](https://docs.didit.me/pt-br/standalone-apis/digital-id-wallets.md) * [Cobertura e atributos das carteiras](https://docs.didit.me/pt-br/core-technology/id-verification/digital-id-wallets.md) * [Preços](https://docs.didit.me/pt-br/getting-started/pricing.md#preços-das-carteiras-de-identidade-digital) ## OpenAPI ````yaml pt-br/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 de verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/id-verification/wallets/uae-pass/: post: tags: - Digital ID wallets summary: Iniciar verificação com UAE PASS description: >- Inicie um login com UAE PASS (UAE Digital Government Authority; ARE) sem nenhum fluxo de verificação (workflow). Cobrado uma única vez, somente quando a identidade é verificada. A resposta traz next_action.type=redirect com a URL para a qual o navegador do usuário deve ser enviado; o usuário retorna para return_url com request_id e result anexados. Leia o resultado com GET /v3/id-verification/wallets/verifications/{request_id}/ ou pelo webhook, nunca pela URL. Aplicações em sandbox recebem uma simulação determinística (simulated: true) que nunca contata o provedor. operationId: start_uae_pass_wallet_verification parameters: - in: header name: Idempotency-Key schema: type: string description: >- Chave opcional de segurança para novas tentativas (máximo de 255 caracteres). Tentar novamente com a mesma chave, carteira e corpo retorna a verificação original sem iniciar um segundo login; a mesma chave com outra carteira ou outro corpo retorna 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: >- Erros de validação de campo ({field: [messages]}) ou erro return_url_invalid, return_url_not_allowed, invalid_personal_code, invalid_phone_number ou idempotency_key_invalid. '403': content: application/json: schema: $ref: >- #/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden description: >- Credenciais ausentes ({detail}), ou erro wallet_unavailable, insufficient_credits ou contract_rate_missing. '409': content: application/json: schema: $ref: '#/components/schemas/DigitalIdWalletApiWalletVerificationError' description: >- Erro idempotency_key_reused ou idempotency_key_in_progress (com Retry-After). '502': content: application/json: schema: $ref: '#/components/schemas/DigitalIdWalletApiWalletVerificationError' description: >- Erro wallet_provider_unavailable: não foi possível iniciar o provedor; nada foi criado. '503': content: application/json: schema: $ref: '#/components/schemas/DigitalIdWalletApiWalletVerificationError' description: >- Erro wallet_not_configured: este ambiente não consegue acessar a carteira. 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: |- 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 { ["reference"] = "example" }, Country = new DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum("ARE"), ReturnUrl = "https://app.example.com/identity/complete", }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: DigitalIdWalletApiUaePassWalletVerificationStartRequest: type: object description: Inicie uma verificação com UAE PASS (ARE). properties: vendor_data: type: string nullable: true description: >- Sua própria referência para esta verificação (por exemplo, o id do seu usuário). Retornada nos resultados e nos webhooks. metadata: type: object additionalProperties: {} nullable: true description: >- Objeto JSON opcional armazenado com a verificação e retornado nos resultados e webhooks. sandbox_scenario: type: string minLength: 1 description: >- Apenas aplicações de sandbox: o resultado simulado - 'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error'; qualquer outro cenário (ou nenhum) resulta em verificação. Rejeitado em aplicações em produção. O catálogo completo está disponível em GET /v1/sandbox/scenarios/. country: allOf: - $ref: >- #/components/schemas/DigitalIdWalletApiUaePassWalletVerificationStartCountryEnum default: ARE description: >- País ISO 3166-1 alpha-3 da identidade UAE PASS. O padrão é ARE, o único país atendido. * `ARE` - ARE return_url: type: string format: uri minLength: 1 description: >- URL https para a qual o navegador do usuário retorna após a carteira, com request_id e result anexados. O host deve estar registrado em allowed_return_hosts da aplicação (ou ser o domínio de marca própria dela). Nunca confie apenas em result: leia o resultado com GET .../verifications/{request_id}/ ou pelo webhook. maxLength: 2048 device: allOf: - $ref: '#/components/schemas/DigitalIdWalletApiDeviceEnum' default: same_device description: >- same_device quando o usuário faz login no dispositivo que exibe sua página, cross_device quando ele usa outro (por exemplo, o QR code do BankID). * `same_device` - same_device * `cross_device` - cross_device required: - return_url DigitalIdWalletApiWalletVerificationResponse: type: object description: >- Uma verificação de carteira avulsa, como todo endpoint de carteira a retorna. 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: O objeto de metadados enviado no início, ou nulo. 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: >- Código estável e legível por máquina, por exemplo 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 enquanto pendente e, depois, Approved (verificado) ou 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 quando a assinatura da credencial foi verificada; null para uma credencial simulada. 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: >- Erros de validação da requisição: cada campo rejeitado com suas mensagens. 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: Id de catálogo da carteira, por exemplo, 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` - Pendente * `verified` - Verificado * `cancelled` - Cancelado pelo usuário * `timeout` - Tempo esgotado * `failed` - Falhou 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: envie o navegador do usuário para url. confirm_in_app: mostre verification_code ao usuário, que confere se ele corresponde ao código no app da carteira e confirma lá; depois, faça polling. request_digital_credential: em um gesto do usuário na mesma origem em que você iniciou, solicite à carteira com digital_credentials.request e envie o que ela retornar para 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: 'Somente redirect: onde o usuário faz login com a carteira.' digital_credentials: allOf: - $ref: >- #/components/schemas/DigitalIdWalletApiWalletDigitalCredentialsRequest description: >- Somente request_digital_credential: a requisição a ser entregue à carteira. verification_code: type: string description: >- Somente confirm_in_app: o código de comparação de 4 dígitos que o app da carteira também exibe. poll_interval_seconds: type: integer description: >- Somente confirm_in_app: com que frequência chamar POST .../verifications/{request_id}/poll/ para obter um retorno rápido. A Didit também consulta os logins pendentes em segundo plano, então o webhook informa o resultado mesmo quando você não faz a consulta. 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: >- Nacionalidade ISO3, somente quando a carteira a declara (nunca inferida). issuing_state: type: string description: País ISO3 cujo esquema emitiu a identidade. 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: >- Passe sem alterações: navigator.credentials.get({digital: request}) no navegador, ou JSON.stringify(request) como requestJson de GetDigitalCredentialOption no Android. Assinado pela Didit para a sua aplicação. required: - protocol - request securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys. BearerAuth: type: http scheme: bearer description: O token de acesso de client credentials da aplicação. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.