> ## 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 verificació amb targeta d'identitat estoniana

> Verifica la identitat amb la targeta d'identitat estoniana amb Didit. Consulta la cobertura, els passos d'autenticació, els resultats i els preus.

Inicia la verificació amb la targeta d'identitat estoniana des del teu backend, amb la clau d'API de la teva aplicació.
No necessites un flux de treball ni un `workflow_id`.
La resposta de l'inici descriu la següent acció d'autenticació; no és un resultat d'identitat aprovat.

## Cobertura i activació

| Propietat | Valor |
| - | - |
| Cartera | Targeta d'identitat estoniana |
| ID de la cartera | `idcard_ee` |
| Països | ![](https://didit-public-assets.s3.eu-west-1.amazonaws.com/flags/ee.svg)Estònia |
| Activació de la cartera en producció | ⏳ Properament |
| Preu publicat de la cartera | \$0.55 per verificació completada |

L'activació de la cartera és independent del desplegament de l'API i de l'elegibilitat de la teva aplicació.
Un endpoint documentat no activa una cartera marcada com a Properament.
Per consultar les tarifes publicades actuals, consulta els [preus de les carteres d'identitat digital](https://docs.didit.me/ca/getting-started/pricing.md#preus-de-les-carteres-d’identitat-digital).

## Què fa la persona

La persona necessita una targeta d'identitat estoniana, un lector de targetes compatible i el programari de la targeta necessari.
Obre l'URL d'autorització retornada al mateix navegador de l'ordinador que té el lector de targetes.
Tria la interacció al mateix dispositiu; no passis aquest flux amb lector de targetes a un telèfon mitjançant un codi QR.

## Rebre el resultat

Segueix la [guia de l'API de carteres d'identitat digital](https://docs.didit.me/ca/standalone-apis/digital-id-wallets.md) per fer el seguiment de la verificació i obtenir-ne el resultat.
Considera només un resultat completat i verificat com a prova que la cartera ha autenticat la persona.
Els atributs d'identitat retornats varien segons la cartera; no donis per fet que hi hagi una adreça, un retrat o tots els atributs sol·licitats.

## Relacionats

* [API de carteres d'identitat digital](https://docs.didit.me/ca/standalone-apis/digital-id-wallets.md)
* [Cobertura i atributs de les carteres](https://docs.didit.me/ca/core-technology/id-verification/digital-id-wallets.md)
* [Preus](https://docs.didit.me/ca/getting-started/pricing.md#preus-de-les-carteres-d’identitat-digital)


## OpenAPI

````yaml ca/openapi-25.json POST /v3/id-verification/wallets/idcard-ee/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/id-verification/wallets/idcard-ee/:
    post:
      tags:
        - Digital ID wallets
      summary: Inicia la verificació amb Estonian ID-card
      description: >-
        Inicia un inici de sessió amb targeta d'identitat estoniana (Junta de
        Policia i Guàrdia de Fronteres (Estònia); EST) sense cap flux de
        treball. Es factura un sol cop, només quan la identitat està verificada.
        La resposta inclou next_action.type=redirect amb l'URL al qual cal
        redirigir el navegador de l'usuari; l'usuari torna a return_url amb
        request_id i result afegits. Llegeix el resultat amb GET
        /v3/id-verification/wallets/verifications/{request_id}/ o des del
        webhook, mai des de l'URL. Les aplicacions en sandbox reben una
        simulació determinista (simulated: true) que mai contacta amb el
        proveïdor.
      operationId: start_idcard_ee_wallet_verification
      parameters:
        - in: header
          name: Idempotency-Key
          schema:
            type: string
          description: >-
            Clau opcional de seguretat en reintents (màxim 255 caràcters). Si es
            reintenta amb la mateixa clau, cartera i cos, es retorna la
            verificació original sense iniciar un segon inici de sessió; la
            mateixa clau amb una altra cartera o cos retorna 409
            idempotency_key_reused.
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/DigitalIdWalletApiIdcardEeWalletVerificationStartRequest
            example:
              country: EST
              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/DigitalIdWalletApiIdcardEeWalletVerificationStartRequest
          multipart/form-data:
            schema:
              $ref: >-
                #/components/schemas/DigitalIdWalletApiIdcardEeWalletVerificationStartRequest
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/DigitalIdWalletApiWalletVerificationResponse
              example:
                request_id: 00000000-0000-4000-8000-000000000001
                wallet_verification:
                  wallet:
                    id: idcard_ee
                    name: Estonian ID-card
                    issuing_authority: Police and Border Guard Board (Estonia)
                  country: EST
                  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: >-
            Errors de validació de camp ({field: [messages]}), o error
            return_url_invalid, return_url_not_allowed, invalid_personal_code,
            invalid_phone_number o idempotency_key_invalid.
        '403':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/DigitalIdWalletApiWalletVerificationStartForbidden
          description: >-
            Falten les credencials ({detail}), o s'ha produït l'error
            wallet_unavailable, insufficient_credits o contract_rate_missing.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DigitalIdWalletApiWalletVerificationError'
          description: >-
            error idempotency_key_reused o idempotency_key_in_progress (amb
            Retry-After).
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DigitalIdWalletApiWalletVerificationError'
          description: >-
            error wallet_provider_unavailable: el proveïdor no s'ha pogut
            iniciar; no s'ha creat res.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DigitalIdWalletApiWalletVerificationError'
          description: >-
            error wallet_not_configured: aquest entorn no pot comunicar-se amb
            la cartera.
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl --request POST \
              --url https://verification.didit.me/v3/id-verification/wallets/idcard-ee/ \
              --header 'x-api-key: YOUR_API_KEY' \
              --header 'Idempotency-Key: your-unique-attempt-key' \
              --header 'Content-Type: application/json' \
              --data '{
              "country": "EST",
              "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_idcard_ee(
                vendor_data="your-customer-reference",
                metadata={"reference": "example"},
                country="EST",
                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.startIdcardEe({
              vendor_data: "your-customer-reference",
              metadata: { reference: "example" },
              country: "EST",
              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.StartIdcardEe(ctx, didit.IDWalletsStartIdcardEeParams{\n\tBody: didit.DigitalIDWalletAPIIdcardEeWalletVerificationStartRequest{\n\t\tVendorData: didit.String(\"your-customer-reference\"),\n\t\tMetadata:   didit.Some(map[string]any{\"reference\": \"example\"}),\n\t\tCountry:    didit.Some(didit.DigitalIDWalletAPIIdcardEeWalletVerificationStartCountryEnum(\"EST\")),\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.DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum;

            import
            me.didit.types.DigitalIdWalletApiIdcardEeWalletVerificationStartRequest;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.idWallets().startIdcardEe(DigitalIdWalletApiIdcardEeWalletVerificationStartRequest.builder()
                    .vendorData("your-customer-reference")
                    .metadata(Map.of("reference", "example"))
                    .country(DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum.of("EST"))
                    .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->startIdcardEe([
                'vendor_data' => 'your-customer-reference',
                'metadata' => ['reference' => 'example'],
                'country' => 'EST',
                '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_idcard_ee(
              vendor_data: "your-customer-reference",
              metadata: { reference: "example" },
              country: "EST",
              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.StartIdcardEeAsync(new
            DigitalIdWalletApiIdcardEeWalletVerificationStartRequest

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

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    DigitalIdWalletApiIdcardEeWalletVerificationStartRequest:
      type: object
      description: Inicia una verificació de targeta d'identitat estoniana (EST).
      properties:
        vendor_data:
          type: string
          nullable: true
          description: >-
            La teva pròpia referència per a aquesta verificació (p. ex., el teu
            identificador d'usuari). Es retorna als resultats i als webhooks.
        metadata:
          type: object
          additionalProperties: {}
          nullable: true
          description: >-
            Objecte JSON opcional emmagatzemat amb la verificació i retornat en
            resultats i webhooks.
        sandbox_scenario:
          type: string
          minLength: 1
          description: >-
            Només per a aplicacions de sandbox: el resultat simulat
            ('wallet_cancelled', 'wallet_timeout' o 'wallet_provider_error');
            amb qualsevol altre escenari (o sense), la verificació és correcta.
            Es rebutja en aplicacions en producció. El catàleg complet està
            disponible a GET /v1/sandbox/scenarios/.
        country:
          allOf:
            - $ref: >-
                #/components/schemas/DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum
          default: EST
          description: >-
            País ISO 3166-1 alpha-3 de la identitat d'Estonian ID-card. Per
            defecte és EST, l'únic país al qual dóna servei.


            * `EST` - EST
        return_url:
          type: string
          format: uri
          minLength: 1
          description: >-
            URL https a la qual torna el navegador de l'usuari després de la
            cartera, amb request_id i result afegits. El seu amfitrió ha d'estar
            registrat a allowed_return_hosts de l'aplicació (o ser el seu domini
            de marca blanca). No confiïs mai en result per si sol: consulta el
            resultat amb GET .../verifications/{request_id}/ o el webhook.
          maxLength: 2048
        device:
          allOf:
            - $ref: '#/components/schemas/DigitalIdWalletApiDeviceEnum'
          default: same_device
          description: >-
            same_device quan l'usuari inicia sessió al dispositiu que mostra la
            teva pàgina, cross_device quan n'utilitza un altre (p. ex., el codi
            QR de BankID).


            * `same_device` - same_device

            * `cross_device` - cross_device
      required:
        - return_url
    DigitalIdWalletApiWalletVerificationResponse:
      type: object
      description: >-
        Una verificació de cartera independent, tal com respon cada endpoint de
        carteres.
      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: L'objecte de metadades enviat a l'inici, o 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: Codi llegible per màquina estable, p. ex. wallet_unavailable.
        detail:
          type: string
      required:
        - detail
        - error
    DigitalIdWalletApiIdcardEeWalletVerificationStartCountryEnum:
      enum:
        - EST
      type: string
      description: '* `EST` - EST'
    DigitalIdWalletApiDeviceEnum:
      enum:
        - same_device
        - cross_device
      type: string
      description: |-
        * `same_device` - mateix dispositiu
        * `cross_device` - entre dispositius
    DigitalIdWalletApiWalletVerificationResult:
      type: object
      properties:
        wallet:
          allOf:
            - $ref: '#/components/schemas/DigitalIdWalletApiWallet'
          readOnly: true
        country:
          type: string
        status:
          type: string
          description: >-
            Not Finished mentre està pendent, després Approved (verificada) o
            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: >-
            Cert un cop s'ha verificat la signatura de la credencial; null per a
            una de 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: >-
        Errors de validació de la sol·licitud: cada camp rebutjat amb els seus
        missatges.
      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: Identificador de catàleg de la cartera, p. 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` - Pendent
        * `verified` - Verificat
        * `cancelled` - Cancel·lat per l'usuari
        * `timeout` - Temps esgotat
        * `failed` - Fallit
    DigitalIdWalletApiInteractionEnum:
      enum:
        - redirect
        - in_app
        - digital_credentials
      type: string
      description: |-
        * `redirect` - redirecció
        * `in_app` - a l'aplicació
        * `digital_credentials` - credencials digitals
    DigitalIdWalletApiWalletNextAction:
      type: object
      properties:
        type:
          allOf:
            - $ref: '#/components/schemas/DigitalIdWalletApiWalletNextActionTypeEnum'
          description: >-
            redirect: envia el navegador de l'usuari a url. confirm_in_app:
            mostra verification_code a l'usuari, que comprova que coincideixi
            amb el codi de la seva aplicació de cartera i confirma allà; després
            fes una consulta periòdica. request_digital_credential: en un gest
            de l'usuari a l'origen amb què has començat, sol·licita-ho a la
            cartera amb digital_credentials.request i, a continuació, envia el
            que retorni a 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: 'només redirect: on l''usuari inicia sessió amb la cartera.'
        digital_credentials:
          allOf:
            - $ref: >-
                #/components/schemas/DigitalIdWalletApiWalletDigitalCredentialsRequest
          description: >-
            només request_digital_credential: la sol·licitud que s'ha de passar
            a la cartera.
        verification_code:
          type: string
          description: >-
            Només confirm_in_app: el codi de comparació de 4 dígits que també
            mostra l'aplicació de la cartera.
        poll_interval_seconds:
          type: integer
          description: >-
            Només confirm_in_app: amb quina freqüència s'ha de cridar POST
            .../verifications/{request_id}/poll/ per obtenir informació
            immediata. Didit també fa sondejos en segon pla dels inicis de
            sessió pendents, de manera que el webhook informa del resultat fins
            i tot si no fas sondejos.
      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: Nacionalitat ISO3, només quan la cartera n'afirmi una (mai deduïda).
        issuing_state:
          type: string
          description: País ISO3 l'esquema del qual ha emès la identitat.
      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` - redirecció
        * `confirm_in_app` - confirma a l'aplicació
        * `request_digital_credential` - sol·licita una credencial digital
    DigitalIdWalletApiWalletDigitalCredentialsRequest:
      type: object
      properties:
        protocol:
          type: string
          description: openid4vp-v1-signed.
        request:
          type: object
          additionalProperties: {}
          description: >-
            Passa-ho tal com està: navigator.credentials.get({digital: request})
            al navegador, o JSON.stringify(request) com a requestJson de
            GetDigitalCredentialOption a Android. Signat per Didit per a la teva
            aplicació.
      required:
        - protocol
        - request
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clau d'API de la teva aplicació, des de Developers -> API keys a la
        Business Console. La clau primària té accés complet. Una clau amb nom
        pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
        limitada a determinats fluxos de treball o a sessions aprovades, a una
        llista d'adreces IP i a una data de caducitat. 401 significa que la clau
        és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
        clau, que la clau no té accés a aquest recurs o acció, o que la
        sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
        ruta de sessió significa que la sessió està fora dels fluxos de treball
        o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
        URL d'imatge, vídeo i PDF com a null, i una clau sense permís
        d'escriptura de sessions rep els enllaços de sessió i els tokens com a
        null. Consulta https://docs.didit.me/console/api-keys.
    BearerAuth:
      type: http
      scheme: bearer
      description: El token d'accés de credencials de client de l'aplicació.

````

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