Saltar para o conteúdo principal
O campo document_subtype no relatório de verificação de identidade identifica a variante de documento específica que a Didit reconheceu — por exemplo, uma carta de condução de Queensland versus uma carta de condução genérica, ou uma Commercial Driver’s License dos EUA versus uma normal. Esta página enumera todos os valores que o campo pode devolver.
O seu próprio fluxo apenas aceita um subconjunto destes — tudo o que tiver selecionado no passo de definições de documentos do fluxo. Obtenha a lista exata aceite para o seu fluxo através do endpoint workflow-retrieve da Management API (documents_allowed no nó de OCR), em vez de assumir que todos os valores abaixo estão ativados para si.

​
Padrão de nomenclatura

Cada valor de document_subtype tem um de dois formatos:
  • Categoria simples — {CATEGORY}, para documentos que a Didit não precisa de distinguir por região (a maioria dos passaportes, a maioria dos documentos de identificação nacionais), por exemplo PASSPORT_GENERIC, ID_CARD_GENERIC.
  • Com prefixo de região — {REGION}_{CATEGORY}, para documentos cujo formato ou classificação difere genuinamente por estado, província ou território, por exemplo QUEENSLAND_DRIVER_LICENSE_GENERIC (Austrália) ou CALIFORNIA_COMMERCIAL_DL (Estados Unidos). O prefixo de região é o nome do estado/província emissor, em maiúsculas e com os espaços substituídos por underscores.
Um documento só recebe um subtipo com prefixo de região quando o registo de documentos da Didit contém uma variante distinta e classificada separadamente para essa região. A ausência de uma variante com prefixo de região não significa que o tipo de documento não exista nessa região — significa que a Didit atualmente o reporta na categoria simples ao nível do país (consulte a ressalva sobre CDL abaixo para ver um exemplo concreto).

​
Todos os valores de subtipo

A tabela abaixo apresenta a enumeração completa dos valores de document_subtype que o relatório pode devolver, agrupados pela família document_type. Já inclui as variantes com prefixo de região — por exemplo, tanto DRIVER_LICENSE_GENERIC (maioria dos países) como CALIFORNIA_DRIVER_LICENSE_GENERIC surgem como linhas distintas sob Driver’s License. Um código de categoria simples não é exclusivo de um país — é partilhado por todos os países cuja entrada no registo para esse documento não tenha uma variante específica por região. ID_CARD_GENERIC, por exemplo, abrange documentos de identificação nacionais de cerca de 170 países. Consulte um código apenas pelo seu agrupamento de document_type e (quando presente) pelo seu prefixo de região, nunca assumindo que um código corresponde a um único país.

​
Cartas de condução dos EUA: padrão vs. comercial (CDL)

document_type é "Driver's License" tanto para uma carta de condução padrão como para uma Commercial Driver’s License (CDL) — nunca as distingue. A distinção reside inteiramente em document_subtype. Em 48 dos 51 estados e territórios dos EUA classificados pela Didit, uma CDL recebe o seu próprio subtipo {STATE}_COMMERCIAL_DL, distinto de {STATE}_DRIVER_LICENSE_GENERIC desse estado. Tratar um document_subtype que termine em _COMMERCIAL_DL como “isto é uma CDL” é um sinal fiável nesses estados.
O Alasca, o Distrito de Colúmbia e o Havai não possuem atualmente um subtipo de CDL distinto. Uma CDL de uma destas três jurisdições é reportada sob o subtipo padrão _DRIVER_LICENSE_GENERIC dessa jurisdição — indistinguível de uma carta de condução não comercial apenas por document_subtype. Se necessitar de uma deteção rigorosa de CDL especificamente para estas três jurisdições, contacte-nos para registar as variantes de documento em falta, ou aplique um controlo fora de banda (por exemplo, exigindo que o condutor forneça separadamente o respetivo número CDL/DOT para verificação).

​
extra_fields.dl_categories não é um sinal fiável de CDL

Algumas cartas de condução dos EUA também produzem extra_fields.dl_categories — uma lista das letras de classe (A, B, C, …) impressas no cartão, lidas através de OCR. Não utilize isto como o seu sinal de CDL. Atualmente, este campo é preenchido apenas para uma pequena minoria de configurações de cartas de condução dos EUA, os significados das letras de classe variam de estado para estado e não estão normalizados segundo uma semântica comercial/não comercial, e os códigos de averbamento ou restrição (onde “comercial” é de facto assinalado em muitas cartas) não estão de todo expostos no relatório atualmente. O campo document_subtype é hoje o único sinal estruturado e fiável para a distinção entre padrão e comercial.

​
Manter a sincronização

As novas famílias de document_type são anunciadas no registo de alterações mensal quando são lançadas. As adições a document_subtype — como uma nova variante regional de um tipo de documento existente, por exemplo — não são atualmente anunciadas individualmente; o registo de documentos da Didit cresce continuamente à medida que novos formatos de documento são integrados. Não existe nenhum número de versão no payload do webhook para esta lista. Se a sua integração precisar de detetar um subtipo que nunca viu antes em vez de assumir que o conjunto é fixo, trate qualquer valor de document_subtype que o seu código não reconheça como “não classificado, rever manualmente” em vez de gerar um erro, e consulte periodicamente esta página ou a lista de subtipos aceites do seu fluxo através da Management API.

​
Relacionado

Última modificação em 7 de novembro de 2026