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

OCR de documentos

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

unidadeFederativa

String

Estado

rg

String

RG

via

String

issueDate

String

Data de Emissão

nome

String

Nome

fatherName

String

Nome do pai

motherName

String

Nome da mãe

birthPlace

String

Local de nascimento

birthDate

String

Data de nascimento

documentoReferencia

String

Fonte do documento

cpf

String

CPF

estadoEmissao

String

Estado de Emissão

issuingAuthority

String

Órgão emissor

orgaoEmissorRG

String

Órgão emissor do RG

estadoEmissaoRG

String

Estado de Emissão do RG

departamento

String

Departamento

tipoDocumentoRGFrente

String

Tipo de documento

rodapeVersoRg

String

Rodapé do verso do RG

nomeGrafico

String

Nome gráfico

cabecalhoFrenteRg

String

Cabeçalho da frente do RG

instituto

String

Instituto

cabecalhoOrgaoEmissor

String

Cabeçalho do órgão emissor

leiVersoRg

String

Lei do 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 possui CPF (lido pelo OCR ou inserido manualmente)

cnh_has_valid_date

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

valid_issue_date

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

valid_cpf_number

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

valid_rg_number

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

valid_cnh_registration_number

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

valid_rg_issue_authority

Verifica se o órgão emissor do documento de identidade é válido.

valid_issue_state

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

parameters_and_document_are_equal

Verifica discrepâncias entre os dados do documento e os informados manualmente.

ocr_equals_parameters

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

rg_issue_less_than_25

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

rg_has_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 discrepâ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 condutor tiver menos de 3 anos de habilitação.

has_definitive_cnh

A regra será inválida se o condutor não possuir habilitação permanente.

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 similaridade entre a união do primeiro e do último nome enviados nos parâmetros em comparação com a união do primeiro 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 estiver categorizado como "outros", "nulo" ou "inválido".

parameters_and_document_undefined_or_equal

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

invalid_range_ages

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

ocr_maior_de_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

nome

String

Nome

motherName

String

Nome da mãe

fatherName

String

Nome do pai

issueDate

String

Data de emissão

rg

String

RG

estadoEmissaoRG

String

Estado emissor do RG

orgaoEmissorRG

String

Órgão emissor do RG

acc

String

Permissão para ciclomotor

categoria

String

Categoria da CNH

dataDaPrimeiraCNH

String

Data da sua primeira CNH

localDeEmissao

String

Local de emissão da CNH

numeroEspelho

String

Número espelho da CNH

numeroDeRegistro

String

Número de registro da CNH

renachNumber

String

Número do RENACH

securityNumber

String

Número de segurança

notes

String

Observações

expirationDate

String

Data de validade

estadoEmissaoCNH

String

Estado de emissão da CNH

Atributos específicos (CRLV)

Atributo
Tipo
Descrição

estadoEmissao

String

Estado de emissão

numeroCRLV

String

Número do CRLV

via

String

Via

codigoRenavam

String

Código do Renavam

rntrc

String

rntrc

anoDeAtribuicao

String

Ano de atribuição

nome

String

Nome

cpf

String

CPF

cnpj

String

CNPJ

placa

String

Placa

placaAnteriorEEstado

String

Placa anterior e estado

chassi

String

Chassi

tipo

String

Tipo

combustível

String

Combustível

marcaEMovel

String

Marca e Movel

anoDeFabricacao

String

Ano de fabricação

anoDoModelo

String

Ano do modelo

capacidadePotenciaCilindros

String

Capacidade de potência dos cilindros

categoria

String

Categoria

corPredominante

String

Cor predominante

issueDate

String

Data de emissão

Atributos específicos (CTPS)

Atributo
Tipo
Descrição

pisPasep

String

PIS/PASEP

documentNumber

String

Número do documento

serieDocumento

String

Série do documento

unidadeFederativa

String

Unidade Federativa

nome

String

Nome

motherName

String

Nome da mãe

fatherName

String

Nome do pai

birthDate

String

Data de nascimento

estadoCivil

String

Estado civil

documentoReferencia

String

Documento de referência

cpf

String

CPF

issuePlace

String

Local de emissão

issueDate

String

Data de emissão

Atributos específicos (RNE)

Atributo
Tipo
Descrição

birthDate

String

Data de nascimento

classificação

String

Classificação

entryDate

String

Data de entrada

fatherName

String

Nome do pai

gênero

String

Gênero

issueDate

String

Data de emissão

issuingAuthority

String

Órgão emissor

proteçãoLegal

String

Proteção legal

motherName

String

Nome da mãe

mrz

String

MRZ

nome

String

Nome

nationality

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

fatherName

String

Nome do pai

gênero

String

Gênero

issueDate

String

Data de emissão

issuingAuthority

String

Órgão emissor

proteçãoLegal

String

Proteção legal

motherName

String

Nome da mãe

mrz

String

MRZ

nome

String

Nome

nationality

String

Nacionalidade

protocolo

String

Protocolo

termoDeResidencia

String

Termo de residência

rnm

String

RNM

validade

String

Validade

Atributos específicos (PASSAPORTE)

Atributo
Tipo
Descrição

birthDate

String

Data de nascimento

expirationDate

String

Data de validade

numeroFrente

String

Número da frente

gênero

String

Gênero

issueDate

String

Data de emissão

issuingAuthority

String

Órgão emissor

paisEmissor

String

País emissor

motherName

String

Nome da mãe

mrz

String

MRZ

nome

String

Nome

nationality

String

Nacionalidade

naturalidade

String

Nacionalidade

número

String

Número

tipo

String

Tipo

Atributos específicos (NOVO CRLV)

Atributo
Tipo
Descrição

anoDeAtribuicao

String

Ano de atribuição

eixos

String

Eixos

carroceria

String

Carroceria

marcaEModelo

String

Marca e modelo

capacidadeEmPessoas

String

Capacidade em pessoas

capacidadeEmPeso

String

Capacidade em peso

capacidadePotenciaCilindros

String

Capacidade de potência dos cilindros

cat

String

Cat

categoria

String

Categoria

chassi

String

Chassi

numeroDeSegurancaCla

String

Número de segurança CLA

cmt

String

CMT

cnpj

String

CNPJ

cpf

String

CPF

máscaraCPF

String

Máscara de CPF

numeroCRLV

String

Número do CRLV

númeroCRV

String

Número do CRV

combustível

String

Combustível

autoridadeEmissora

String

Autoridade emissora

issueDate

String

Data de emissão

issuePlace

String

Local de emissão

estadoEmissao

String

Estado de emissão

anoDeFabricacao

String

Ano de fabricação

anoDoModelo

String

Ano do modelo

motor

String

Motor

nome

String

Nome

placa

String

Placa

corPredominante

String

Cor predominante

placaAnteriorEEstado

String

Placa anterior e estado

codigoRenavam

String

Código do Renavam

tipo

String

Tipo

observaçõesDoVeículo

String

Observações do veículo

Atributos específicos (NOVA CNH)

Atributo
Tipo
Descrição

nome

String

Nome

dataDaPrimeiraCNH

String

Data da primeira habilitação

birthDate

String

Data de nascimento

birthPlace

String

Local de nascimento

estadoNascimento

String

Estado de nascimento

dataNascimentoCidadeEstado

String

Data de nascimento, cidade e estado

issueDate

String

Data de emissão

expirationDate

String

Data de validade

acc

String

ACC

definitivoOuPermissionário

String

Definitivo ou permissionário

rg

String

RG

máscaraRG

String

Máscara do RG

orgaoEmissorRG

String

Órgão emissor do RG

estadoEmissaoRG

String

Estado de emissão do RG

númeroAutoridadeEstadoRG

String

Número, autoridade e estado do RG

cpf

String

CPF

máscaraCPF

String

Máscara de CPF

numeroDeRegistro

String

Número de registro

categoria

String

Categoria

nationality

String

Nacionalidade

fatherName

String

Nome do pai

motherName

String

Nome da mãe

numeroEspelho

String

Número espelho

notes

String

Observações

localDeEmissao

String

Local de emissão

securityNumber

String

Número de segurança

renachNumber

String

Número do Renach

estadoEmissaoCNH

String

Estado de emissão da CNH

Atributos específicos (NOVO RG)

Atributo
Tipo
Descrição

birthDate

String

Data de nascimento

birthPlace

String

Local de nascimento

cpf

String

CPF

máscaraCPF

String

Máscara de CPF

departamento

String

Departamento

tipoDocumentoRGFrente

String

Tipo de documento RG frente

expirationDate

String

Data de validade

fatherName

String

Nome do pai

unidadeFederativa

String

Unidade Federativa

rodapeVersoRg

String

Rodapé RG verso

nomeGrafico

String

Nome gráfico

cabecalhoFrenteRg

String

Cabeçalho da frente do RG

instituto

String

Instituto

issueDate

String

Data de emissão

estadoEmissao

String

Estado de emissão

issuingAuthority

String

Órgão emissor

cabecalhoOrgaoEmissor

String

Cabeçalho do órgão emissor

leiVersoRg

String

Lei RG verso

motherName

String

Nome da mãe

nome

String

Nome

separadorDosPais

String

Separador dos pais

documentoReferencia

String

Documento de referência

rg

String

RG

estadoEmissaoRG

String

Estado de emissão do RG

orgaoEmissorRG

String

Órgão emissor do RG

máscaraRG

String

Máscara do RG

via

String

Via

Atualizado