Saltar para o conteúdo principal
POST
cURL
Inicie a verificação com cartão de identidade estónio 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 de início descreve a próxima ação de autenticação; não é um resultado de identidade aprovado.

Cobertura e ativação

A ativação da carteira é independente da implementação da API e da elegibilidade da sua aplicação. Um endpoint documentado não ativa uma carteira marcada como Em breve. Para consultar as tarifas publicadas atuais, veja preços das carteiras de identidade digital.

O que a pessoa faz

A pessoa precisa de um cartão de identidade estónio, de um leitor de cartões compatível e do software de cartão exigido. Abra o URL de autorização devolvido no mesmo navegador, no computador com o leitor de cartões. Escolha a interação no mesmo dispositivo; não transfira este fluxo de leitor de cartões para um telemóvel através de código QR.

Receber o resultado

Siga o guia da API de carteiras de identidade digital 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 assuma que estão presentes uma morada, um retrato ou todos os atributos pedidos.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

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.

Cabeçalhos

Idempotency-Key
string

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.

Corpo

Inicie uma verificação Estonian ID-card (EST).

return_url
string<uri>
obrigatório

URL https para o qual o navegador do utilizador regressa após a carteira, com request_id e result anexados. O seu anfitrião tem de estar registado nos allowed_return_hosts da aplicação (ou ser o seu domínio de marca branca). Nunca confie em result por si só: leia o resultado com GET .../verifications/{request_id}/ ou o webhook.

Required string length: 1 - 2048
vendor_data
string | null

A sua própria referência para esta verificação (ex.: o seu ID de utilizador). Devolvida nos resultados e webhooks.

metadata
object | null

Objeto JSON opcional armazenado com a verificação e devolvido nos resultados e webhooks.

sandbox_scenario
string

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

Minimum string length: 1
country
enum<string>
padrão:EST

País ISO 3166-1 alfa-3 da identidade do cartão de identificação estónio (ID-card). A predefinição é EST, o único país a que presta serviço.

  • EST - EST
Opções disponíveis:
EST
device
enum<string>
padrão:same_device

same_device quando o utilizador inicia sessão no dispositivo que mostra a sua página, cross_device quando utiliza outro (por exemplo, o código QR do BankID).

  • same_device - same_device
  • cross_device - cross_device
Opções disponíveis:
same_device,
cross_device

Resposta

Uma verificação de carteira autónoma, tal como é devolvida por todos os endpoints de carteira.

request_id
string<uuid>
obrigatório
wallet_verification
object
obrigatório
vendor_data
string | null
obrigatório
metadata
object | null
obrigatório

O objeto de metadados enviado no início, ou nulo.

created_at
string<date-time>
obrigatório
Última modificação em 7 de novembro de 2026