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

# Verificação de identidade com Google Wallet: API

> Integre a verificação de identidade do Google Wallet ID com a Didit. Veja cobertura por país, passos de autenticação, resultados e preços.

Inicie a verificação de identidade com a Google Wallet a partir do seu backend, usando a chave de API da sua aplicação.
Não precisa de um fluxo nem de um `workflow_id`.
A resposta inicial descreve a próxima ação de autenticação; não é um resultado de identidade aprovado.

## Cobertura e ativação

| Propriedade | Valor |
| - | - |
| Carteira | Google Wallet ID |
| ID da carteira | `google_wallet` |
| Países | ![](https://didit-public-assets.s3.eu-west-1.amazonaws.com/flags/us.svg)Estados Unidos, ![](https://didit-public-assets.s3.eu-west-1.amazonaws.com/flags/gb.svg)Reino Unido, ![](https://didit-public-assets.s3.eu-west-1.amazonaws.com/flags/br.svg)Brasil, ![](https://didit-public-assets.s3.eu-west-1.amazonaws.com/flags/sg.svg)Singapura, ![](https://didit-public-assets.s3.eu-west-1.amazonaws.com/flags/tw.svg)Taiwan |
| Ativação da carteira em produção | ✅ Disponível |
| Preço publicado da carteira | \$0.20 por verificação concluída |

A ativação da carteira é separada da disponibilização da API e da elegibilidade da sua aplicação.
Um endpoint documentado não ativa uma carteira marcada como Em breve.
Para os preços publicados atuais, consulte os [preços das carteiras de identidade digital](https://docs.didit.me/pt/getting-started/pricing.md#preços-de-carteiras-de-identidade-digital).

## O que a pessoa faz

A sua página ou aplicação pede diretamente à Google Wallet: não há redirecionamento nem página alojada pela Didit.
Passe `next_action.digital_credentials.request` a `navigator.credentials.get({digital: request})` num gesto do utilizador, na `origin` a partir da qual iniciou, ou ao Android Credential Manager como `GetDigitalCredentialOption`.
Em seguida, envie o que a carteira devolve para [Submeter resposta da carteira](https://docs.didit.me/pt/standalone-apis/digital-id-wallet-response.md).
O navegador oferece o seu próprio código QR quando a carteira está noutro dispositivo.

## Receber o resultado

Siga o [guia da API de carteiras de identidade digital](https://docs.didit.me/pt/standalone-apis/digital-id-wallets.md) para acompanhar a verificação e obter o respetivo resultado.
Considere apenas um resultado concluído e verificado como prova de que a carteira autenticou a pessoa.
Os atributos de identidade devolvidos variam consoante a carteira; não presuma que estão presentes uma morada, um retrato ou todos os atributos pedidos.

## Relacionados

* [APIs de carteiras de identidade digital](https://docs.didit.me/pt/standalone-apis/digital-id-wallets.md)
* [Cobertura e atributos das carteiras](https://docs.didit.me/pt/core-technology/id-verification/digital-id-wallets.md)
* [Preços](https://docs.didit.me/pt/getting-started/pricing.md#preços-de-carteiras-de-identidade-digital)


## OpenAPI

````yaml pt/openapi-25.json POST /v3/id-verification/wallets/google-wallet/
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/google-wallet/:
    post:
      tags:
        - Digital ID wallets
      summary: Iniciar verificação Google Wallet
      description: >-
        Inicie uma sessão com Google Wallet (Google Wallet (ID pass) e emissores
        estatais dos EUA (carta de condução móvel); USA, GBR, BRA, SGP, TWN) sem
        qualquer fluxo. Faturado uma única vez, apenas quando a identidade for
        verificada. A resposta contém
        next_action.type=request_digital_credential com um pedido que a Didit
        assinou para a sua aplicação, utilizável apenas a partir da origem. Num
        gesto do utilizador nessa origem, passe
        next_action.digital_credentials.request para
        navigator.credentials.get({digital: ...}) (ou para o Android Credential
        Manager como GetDigitalCredentialOption requestJson) e, em seguida,
        envie, através de POST, o que a carteira devolver para
        /v3/id-verification/wallets/verifications/{request_id}/response/. O
        navegador apresenta o seu próprio código QR quando a carteira estiver
        noutro dispositivo. As aplicações em sandbox obtêm uma simulação
        determinística (simulated: true) que nunca contacta o fornecedor.
      operationId: start_google_wallet_wallet_verification
      parameters:
        - in: header
          name: Idempotency-Key
          schema:
            type: string
          description: >-
            Chave opcional de segurança contra tentativas repetidas (máx. 255
            caracteres). Tentar novamente com a mesma chave, carteira e corpo
            devolve a verificação original sem iniciar sessão uma segunda vez; a
            mesma chave com outra carteira ou corpo devolve 409
            idempotency_key_reused.
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest
            example:
              country: USA
              vendor_data: your-customer-reference
              metadata:
                reference: example
              origin: https://app.example.com
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest
          multipart/form-data:
            schema:
              $ref: >-
                #/components/schemas/DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/DigitalIdWalletApiWalletVerificationResponse
              example:
                request_id: 00000000-0000-4000-8000-000000000001
                wallet_verification:
                  wallet:
                    id: google_wallet
                    name: Google Wallet
                    issuing_authority: >-
                      Google Wallet (ID pass) and US state issuers (mobile
                      driving licence)
                  country: USA
                  status: Not Finished
                  outcome: pending
                  error: null
                  interaction: digital_credentials
                  simulated: false
                  expires_at: '2026-01-01T10:10:00Z'
                  next_action:
                    type: request_digital_credential
                    digital_credentials:
                      protocol: openid4vp-v1-signed
                      request:
                        requests:
                          - protocol: openid4vp-v1-signed
                            data:
                              request: <compact JWS signed by Didit>
                  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 campos ({field: [messages]}), ou erro
            return_url_invalid, return_url_not_allowed, origin_invalid,
            origin_not_allowed, invalid_personal_code, invalid_phone_number ou
            idempotency_key_invalid.
        '403':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden
          description: >-
            Credenciais em falta ({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: o fornecedor não conseguiu
            iniciar; nada foi criado.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DigitalIdWalletApiWalletVerificationError'
          description: >-
            erro wallet_not_configured: este ambiente não consegue aceder à
            carteira.
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl --request POST \
              --url https://verification.didit.me/v3/id-verification/wallets/google-wallet/ \
              --header 'x-api-key: YOUR_API_KEY' \
              --header 'Idempotency-Key: your-unique-attempt-key' \
              --header 'Content-Type: application/json' \
              --data '{
              "country": "USA",
              "vendor_data": "your-customer-reference",
              "metadata": {
                "reference": "example"
              },
              "origin": "https://app.example.com"
            }'
components:
  schemas:
    DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest:
      type: object
      description: Iniciar uma verificação com Google Wallet (USA, GBR, BRA, SGP, TWN).
      properties:
        vendor_data:
          type: string
          nullable: true
          description: >-
            A sua própria referência para esta verificação (ex.: o seu ID de
            utilizador). Devolvida nos resultados e webhooks.
        metadata:
          type: object
          additionalProperties: {}
          nullable: true
          description: >-
            Objeto JSON opcional armazenado com a verificação e devolvido nos
            resultados e webhooks.
        sandbox_scenario:
          type: string
          minLength: 1
          description: >-
            Apenas aplicações em sandbox: o resultado simulado -
            'wallet_cancelled', 'wallet_timeout' ou 'wallet_provider_error';
            qualquer outro cenário (ou a ausência de cenário) resulta numa
            verificação bem-sucedida. Rejeitado em aplicações em produção. O
            catálogo completo está disponível em GET /v1/sandbox/scenarios/.
        country:
          allOf:
            - $ref: >-
                #/components/schemas/DigitalIdWalletApiGoogleWalletWalletVerificationStartCountryEnum
          description: |-
            País ISO 3166-1 alfa-3 da identidade Google Wallet.

            * `USA` - USA
            * `GBR` - GBR
            * `BRA` - BRA
            * `SGP` - SGP
            * `TWN` - TWN
        origin:
          type: string
          minLength: 1
          description: >-
            Onde a sua página ou aplicação irá solicitar à carteira: a origem
            https da sua página (o seu host deve constar de allowed_return_hosts
            da aplicação, ou ser o seu domínio de marca branca), por exemplo,
            https://app.example.com, ou android:apk-key-hash:<base64 SHA-256 of
            your app's signing certificate, no padding>. A carteira recusa o
            pedido em qualquer outro local.
          maxLength: 256
      required:
        - country
        - origin
    DigitalIdWalletApiWalletVerificationResponse:
      type: object
      description: >-
        Uma verificação de carteira autónoma, tal como é devolvida por todos os
        endpoints de carteira.
      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 legível por máquina estável, por exemplo, wallet_unavailable.
        detail:
          type: string
      required:
        - detail
        - error
    DigitalIdWalletApiGoogleWalletWalletVerificationStartCountryEnum:
      enum:
        - USA
        - GBR
        - BRA
        - SGP
        - TWN
      type: string
      description: |-
        * `USA` - USA
        * `GBR` - GBR
        * `BRA` - BRA
        * `SGP` - SGP
        * `TWN` - TWN
    DigitalIdWalletApiWalletVerificationResult:
      type: object
      properties:
        wallet:
          allOf:
            - $ref: '#/components/schemas/DigitalIdWalletApiWallet'
          readOnly: true
        country:
          type: string
        status:
          type: string
          description: >-
            Não terminada enquanto pendente, depois Aprovada (verificada) ou
            Recusada.
        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 após a assinatura da credencial ter sido 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 do pedido: cada campo rejeitado com as respetivas
        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 ex. 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 utilizador
        * `timeout` - Tempo limite excedido
        * `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 utilizador para url. confirm_in_app:
            mostre verification_code ao utilizador, que verifica se coincide com
            o código na respetiva aplicação de carteira e confirma aí; depois,
            faça polling. request_digital_credential: num gesto do utilizador na
            origem em que iniciou o processo, solicite à carteira com
            digital_credentials.request e, em seguida, envie o que ela devolver
            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: 'apenas redirect: onde o utilizador inicia sessão com a carteira.'
        digital_credentials:
          allOf:
            - $ref: >-
                #/components/schemas/DigitalIdWalletApiWalletDigitalCredentialsRequest
          description: 'apenas request_digital_credential: o pedido a entregar à carteira.'
        verification_code:
          type: string
          description: >-
            Apenas confirm_in_app: o código de comparação de 4 dígitos que a
            aplicação de carteira também apresenta.
        poll_interval_seconds:
          type: integer
          description: >-
            Apenas confirm_in_app: com que frequência chamar POST
            .../verifications/{request_id}/poll/ para obter feedback imediato. O
            Didit também consulta inícios de sessão pendentes em segundo plano,
            pelo que o webhook comunica o resultado mesmo que não efetue
            consultas.
      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, apenas quando a carteira afirmar uma (nunca
            deduzida).
        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 tal como está: 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: >-
        A chave de API da sua aplicação, a partir de Programadores -> Chaves de
        API na Business Console. A chave principal tem acesso total. Uma chave
        nomeada pode ter o âmbito definido: nenhum, 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á
        incorreta, 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 o
        pedido veio de um endereço fora da sua lista de IP; 404 numa rota de
        sessão significa que a sessão está fora dos fluxos ou estados da chave.
        Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs
        como nulos, e uma chave sem permissão de escrita em sessões recebe
        ligações de sessão e tokens como nulos. Consulte
        https://docs.didit.me/console/api-keys.
    BearerAuth:
      type: http
      scheme: bearer
      description: O token de acesso de credenciais de cliente da aplicação.

````

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