For the complete documentation index, see llms.txt. This page is also available as Markdown.

OCR de documento

Reconhecimento Óptico de Caracteres - extração de dados de documentos enviados.

Seção: ocr

Arquivos obrigatórios: quaisquer imagens de documentos

Atributos específicos (RG)

Atributo
Tipo
Descrição

unidade federativa

String

Estado

rg

String

RG

via

String

dataDeEmissão

String

Data de emissão

name

String

Nome

nomeDoPai

String

Nome do pai

nomeDaMãe

String

Nome da mãe

localDeNascimento

String

Local de nascimento

birthDate

String

Data de nascimento

documentoDeReferência

String

Fonte do documento

cpf

String

CPF

estadoDeEmissão

String

Estado de emissão

órgãoEmissor

String

Órgão emissor

órgão emissor do RG

String

Órgão emissor do RG

ufDeEmissãoDoRG

String

Estado de emissão do RG

departamento

String

Departamento

tipoDeDocumentoDaFrenteDoRG

String

Tipo de documento

rodapéDoVersoDoRG

String

Rodapé do verso do RG

nomeGráfico

String

Nome gráfico

cabeçalhoDaFrenteDoRG

String

Cabeçalho da frente do RG

instituto

String

Instituto

cabeçalhoDaAutoridadeEmissora

String

Cabeçalho da autoridade emissora

leiNoVersoDoRG

String

Lei no verso do RG

separadorDosPais

String

Separador dos pais

Regra
Descrição

is_readable

Verifica se os documentos estão legíveis

is_cnh

Verifica se o documento enviado é uma CNH

has_cpf

Verifica se a transação tem um CPF (lido pelo OCR ou inserido manualmente)

cnh_has_valid_date

Verifica se a data de validade da CNH não está vencida

data_de_emissao_valida

Verifica se a data de emissão do documento é válida.

numero_de_cpf_valido

Verifica se o número do CPF é válido

numero_rg_valido

Verifica se o número do RG é válido.

numero_de_registro_cnh_valido

Verifica se o número de registro da CNH é válido.

orgao_emissor_rg_valido

Verifica se o órgão emissor do RG é válido.

estado_de_emissao_valido

Verifica se a UF do órgão emissor do documento é válida.

parâmetros_e_documento_são_iguais

Verifica se há divergências entre os dados do documento e os inseridos manualmente.

ocr_equals_parameters

A regra será inválida se as informações fornecidas nos parâmetros e lidas pelo OCR forem diferentes.

rg_emitido_ha_menos_de_25_anos

A regra será inválida se o tipo de documento RG tiver sido emitido há mais de 25 anos.

is_literate

A regra será inválida se o OCR identificar que o documento pertence a uma pessoa não alfabetizada.

rg_tem_cpf

A regra será inválida se o tipo de documento RG não tiver o campo CPF preenchido.

company_qsa_data_compatibility

A regra será inválida se o nome e o CPF dos sócios enviados no onboarding de PJ forem diferentes dos do onboarding de PF.

data_and_document_are_equal

A regra será inválida se houver divergência entre as informações do parâmetro e o OCR.

has_cnh_for_more_than_three_years

A regra será inválida se o motorista tiver menos de 3 anos de habilitação.

has_definitive_cnh

A regra será inválida se o motorista não tiver habilitação definitiva.

document_issue_less_than_10

A regra será inválida se o documento tiver sido emitido há mais de 10 anos.

issued_over_16_years

Verifica se a diferença entre a data de nascimento e a emissão do documento de identidade é maior ou igual a 16 anos.

first_and_last_name_similarity

Verifica a semelhança entre a união do nome e sobrenome enviados nos parâmetros em comparação com a união do nome e de cada sobrenome na origem.

is_passport

A regra será inválida se o documento não for um passaporte.

is_not_passport

A regra será inválida se o documento for um passaporte.

is_not_ctps

A regra será inválida se o documento não for uma carteira de trabalho.

document_is_known

A regra será inválida se o documento for categorizado como "outros", "null" ou "inválido".

parâmetros_e_documento_indefinidos_ou_iguais

Verifica a inexistência ou divergência entre os dados do documento e os dados inseridos manualmente.

invalid_range_ages

Verifica se o titular do CPF está dentro da faixa etária configurada.

ocr_over_18

Verifica se a idade no documento é menor que 18 anos.

Atributos específicos (CNH)

Atributo
Tipo
Descrição

birthDate

String

Data de nascimento

cpf

String

CPF

name

String

Nome

nomeDaMãe

String

Nome da mãe

nomeDoPai

String

Nome do pai

dataDeEmissão

String

Data de emissão

rg

String

RG

ufDeEmissãoDoRG

String

UF de emissão do RG

órgão emissor do RG

String

órgão emissor do RG

acc

String

Autorização para conduzir ciclomotor

categoria

String

Categoria da CNH

dataDaPrimeiraHabilitação

String

Data da sua primeira habilitação

localDeEmissão

String

Local onde a CNH foi emitida

númeroDoEspelho

String

Número do espelho da CNH

númeroDeRegistro

String

Número de registro da CNH

númeroRENACH

String

Número RENACH

númeroDeSegurança

String

Número de segurança

observações

String

Observações

dataDeValidade

String

Data de validade

ufDeEmissãoDaCNH

String

UF de emissão da CNH

Atributos específicos (CRLV)

Atributo
Tipo
Descrição

estadoDeEmissão

String

UF de emissão

númeroDoCRLV

String

Número do CRLV

via

String

Via

códigoRENAVAM

String

Código Renavam

RNTRC

String

RNTRC

anoDeAtribuição

String

Ano de atribuição

name

String

Nome

cpf

String

CPF

cnpj

String

CNPJ

placa

String

Placa

placaEUfAnteriores

String

Placa e UF anteriores

chassi

String

Chassi

tipo

String

Tipo

combustível

String

Combustível

marcaEModelo

String

Marca e modelo

anoDeFabricação

String

Ano de fabricação

anoDoModelo

String

Ano do modelo

potênciaCilindrada

String

Potência/cilindrada

categoria

String

Categoria

corPredominante

String

Cor predominante

dataDeEmissão

String

Data de emissão

Atributos específicos (CTPS)

Atributo
Tipo
Descrição

PIS/PASEP

String

PIS/PASEP

númeroDoDocumento

String

Número do documento

sérieDoDocumento

String

Série do documento

unidade federativa

String

Unidade federativa

name

String

Nome

nomeDaMãe

String

Nome da mãe

nomeDoPai

String

Nome do pai

birthDate

String

Data de nascimento

estadoCivil

String

Estado civil

documentoDeReferência

String

Documento de referência

cpf

String

CPF

localDeEmissão

String

Local de emissão

dataDeEmissão

String

Data de emissão

Atributos específicos (RNE)

Atributo
Tipo
Descrição

birthDate

String

Data de nascimento

classificação

String

Classificação

dataDeEntrada

String

Data de entrada

nomeDoPai

String

Nome do pai

sexo

String

Sexo

dataDeEmissão

String

Data de emissão

órgãoEmissor

String

Órgão emissor

proteçãoLegal

String

Proteção legal

nomeDaMãe

String

Nome da mãe

mrz

String

MRZ

name

String

Nome

nacionalidade

String

Nacionalidade

paísDeOrigem

String

País de origem

rne

String

RNE

validade

String

Validade

via

String

Via

Atributos específicos (RNM)

Atributo
Tipo
Descrição

birthDate

String

Data de nascimento

classificação

String

Classificação

cpf

String

CPF

nomeDoPai

String

Nome do pai

sexo

String

Sexo

dataDeEmissão

String

Data de emissão

órgãoEmissor

String

Órgão emissor

proteçãoLegal

String

Proteção legal

nomeDaMãe

String

Nome da mãe

mrz

String

MRZ

name

String

Nome

nacionalidade

String

Nacionalidade

protocolo

String

Protocolo

prazoDeResidência

String

Prazo de residência

rnm

String

RNM

validade

String

Validade

Atributos específicos (PASSAPORTE)

Atributo
Tipo
Descrição

birthDate

String

Data de nascimento

dataDeValidade

String

Data de validade

númeroDaFrente

String

Número da frente

sexo

String

Sexo

dataDeEmissão

String

Data de emissão

órgãoEmissor

String

Autoridade emissora

paísEmissor

String

País emissor

nomeDaMãe

String

Nome da mãe

mrz

String

MRZ

name

String

Nome

nacionalidade

String

Nacionalidade

naturalidade

String

Nacionalidade

número

String

Number

tipo

String

Tipo

Atributos específicos (NOVO CRLV)

Atributo
Tipo
Descrição

anoDeAtribuição

String

Ano de atribuição

eixos

String

Eixos

carroceria

String

Carroceria

marca e modelo

String

Marca e modelo

capacidadeEmPessoas

String

Capacidade em pessoas

capacidadeEmPeso

String

Capacidade em peso

potênciaCilindrada

String

Potência/cilindrada

cat

String

Cat

categoria

String

Categoria

chassi

String

Chassi

númeroDeSegurançaDaCLA

String

Número de segurança da CLA

cmt

String

CMT

cnpj

String

CNPJ

cpf

String

CPF

cpfMask

String

Máscara do CPF

númeroDoCRLV

String

Número do CRLV

crvNumber

String

Número do CRV

combustível

String

Combustível

issueAuthority

String

Autoridade emissora

dataDeEmissão

String

Data de emissão

localDeEmissão

String

Local de emissão

estadoDeEmissão

String

UF de emissão

anoDeFabricação

String

Ano de fabricação

anoDoModelo

String

Ano do modelo

motor

String

Motor

name

String

Nome

placa

String

Placa

corPredominante

String

Cor predominante

placaEUfAnteriores

String

Placa e UF anteriores

códigoRENAVAM

String

Código Renavam

tipo

String

Tipo

vehicleObservations

String

Observações do veículo

Atributos específicos (NOVA CNH)

Atributo
Tipo
Descrição

name

String

Nome

dataDaPrimeiraHabilitação

String

Data da primeira CNH

birthDate

String

Data de nascimento

localDeNascimento

String

Local de nascimento

birthState

String

Estado de nascimento

birthDateCityState

String

Data de nascimento, cidade e estado

dataDeEmissão

String

Data de emissão

dataDeValidade

String

Data de validade

acc

String

ACC

definitiveOrPermissionary

String

Definitivo ou permissionário

rg

String

RG

rgMask

String

Máscara do RG

órgão emissor do RG

String

rgIssuingAuthority

ufDeEmissãoDoRG

String

Estado de emissão do RG

rgNumberAuthorityState

String

Estado do número da autoridade do RG

cpf

String

CPF

cpfMask

String

Máscara do CPF

númeroDeRegistro

String

Número de registro

categoria

String

Categoria

nacionalidade

String

Nacionalidade

nomeDoPai

String

Nome do pai

nomeDaMãe

String

Nome da mãe

númeroDoEspelho

String

Número espelho

observações

String

Observações

localDeEmissão

String

Local de emissão

númeroDeSegurança

String

Número de segurança

númeroRENACH

String

Número RENACH

ufDeEmissãoDaCNH

String

UF de emissão da CNH

Atributos específicos (NOVO RG)

Atributo
Tipo
Descrição

birthDate

String

Data de nascimento

localDeNascimento

String

Local de nascimento

cpf

String

CPF

cpfMask

String

Máscara do CPF

departamento

String

Departamento

tipoDeDocumentoDaFrenteDoRG

String

Documento tipo RG frente

dataDeValidade

String

Data de validade

nomeDoPai

String

Nome do pai

unidade federativa

String

Unidade federativa

rodapéDoVersoDoRG

String

Rodapé RG verso

nomeGráfico

String

Nome gráfico

cabeçalhoDaFrenteDoRG

String

Cabeçalho da frente do RG

instituto

String

Instituto

dataDeEmissão

String

Data de emissão

estadoDeEmissão

String

UF de emissão

órgãoEmissor

String

Órgão emissor

cabeçalhoDaAutoridadeEmissora

String

Cabeçalho da autoridade emissora

leiNoVersoDoRG

String

Lei RG verso

nomeDaMãe

String

Nome da mãe

name

String

Nome

separadorDosPais

String

Separador dos pais

documentoDeReferência

String

Documento de referência

rg

String

RG

ufDeEmissãoDoRG

String

Estado de emissão do RG

órgão emissor do RG

String

Autoridade emissora do RG

rgMask

String

Máscara do RG

via

String

Via

Atualizado