> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scanify.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Tipos de Documentos
> Veja os tipos de documentos suportados atualmente pela API Scanify e os campos extraídos de cada um
O Scanify suporta extração e validação de dados para os tipos de documentos suportados listados abaixo.
O campo `documentType` na requisição é opcional. Se omitido, o Scanify detecta automaticamente o tipo do documento. Se informado, força a extração para aquele tipo. Os valores aceitos são os códigos da coluna **Código** na tabela abaixo.
## Tipos suportados
| Código | Descrição |
| ------------------------------------- | -------------------------------------------- |
| `NFE` | Nota fiscal eletrônica (NF-e) |
| `BOLETO` | Boleto bancário |
| `CONTRATO` | Contrato |
| `RECIBO` | Recibo |
| `CNH` | Carteira Nacional de Habilitação |
| `RG` | Documento de identidade |
| `COMPROVANTE_RESIDENCIA` | Comprovante de residência |
| `CONTRATO_SOCIAL` | Contrato social |
| `IRPF` | Declaração do Imposto de Renda Pessoa Física |
| `CERTIDAO_NASCIMENTO` | Certidão de nascimento |
| `CERTIDAO_CASAMENTO` | Certidão de casamento |
| `LAUDO_MEDICO` | Laudo médico |
| `CERTIDAO_OBITO` | Certidão de óbito |
| `PROCURACAO` | Procuração |
| `HOLERITE` | Holerite / contracheque |
| `DOCUMENTO_VEICULAR` | Documento veicular (CRLV) |
| `DOCUMENTO_JURIDICO` | Documento jurídico |
| `EXTRATO_BANCARIO` | Extrato bancário |
| `INFORME_RENDIMENTOS_EMPREGADOR_INSS` | Informe de rendimentos (empregador/INSS) |
| `INFORME_RENDIMENTOS_BANCOS` | Informe de rendimentos (bancos) |
| `INFORME_RENDIMENTOS_CORRETORAS` | Informe de rendimentos (corretoras) |
| `INFORME_PLANO_SAUDE` | Informe de plano de saúde |
| `DESPESA_MEDICA` | Despesa médica |
| `COMPROVANTE_EDUCACAO` | Comprovante de educação |
| `DECLARACAO_IR_ANTERIOR` | Declaração de IR de ano anterior |
## NF-e (Nota Fiscal Eletrônica)
Campos extraídos:
| Campo | Descrição |
| ------------------------ | ---------------------------------------------------------------------- |
| `access_key` | Chave de acesso da NF-e (44 dígitos) |
| `issuer_cnpj` | CNPJ da empresa emissora da nota |
| `issuer_name` | Razão social da empresa emissora |
| `issue_date` | Data de emissão da nota fiscal |
| `total_amount` | Valor total da nota fiscal |
| `products_description` | Lista ou texto com a descrição dos produtos ou serviços da NF |
| `invoice_number` | Número da nota fiscal |
| `operation_nature` | Natureza da operação fiscal (ex: venda, devolução) |
| `pis` | Valor do PIS (Programa de Integração Social) |
| `cofins` | Valor do COFINS (Contribuição para Financiamento da Seguridade Social) |
| `ir` | Valor do IR (Imposto de Renda) |
| `inss` | Valor do INSS (Instituto Nacional do Seguro Social) |
| `csll` | Valor do CSLL (Contribuição Social sobre o Lucro Líquido) |
| `unconditional_discount` | Valor do desconto incondicional |
| `conditional_discount` | Valor do desconto condicionado |
| `federal_retentions` | Valor total das retenções federais |
| `other_retentions` | Valor de outras retenções |
| `iss_base` | Base de cálculo do ISS |
| `iss_rate` | Alíquota do ISS em percentual |
| `iss` | Valor do ISS (Imposto Sobre Serviços) |
| `iss_withheld` | Valor do ISS retido |
| `allowed_deductions` | Valor das deduções permitidas em lei |
***
## Boleto bancário
Campos extraídos:
| Campo | Descrição |
| --------------------- | ----------------------------------------------------- |
| `digitable_line` | Linha digitável completa do boleto (47 ou 48 dígitos) |
| `amount` | Valor do boleto em reais |
| `due_date` | Data de vencimento do boleto |
| `issuer_name` | Nome da empresa ou pessoa que emitiu o boleto |
| `payer_name` | Nome da pessoa que deve pagar o boleto |
| `document_number` | Número de controle/documento do boleto |
| `agency_account_code` | Agência e código do beneficiário |
***
## Contrato
Campos extraídos:
| Campo | Descrição |
| ----------------- | -------------------------------------- |
| `contract_title` | Título ou objeto principal do contrato |
| `party_a` | Nome da primeira parte contratante |
| `party_b` | Nome da segunda parte contratante |
| `start_date` | Data de início da vigência |
| `end_date` | Data de término da vigência |
| `value` | Valor total do contrato |
| `contract_number` | Número ou código do contrato |
***
## Recibo
Campos extraídos:
| Campo | Descrição |
| ---------------- | ------------------------------------- |
| `receipt_number` | Número do recibo |
| `issue_date` | Data de emissão do recibo |
| `payer_name` | Nome de quem pagou (pode não constar) |
| `receiver_name` | Nome de quem recebeu |
| `amount` | Valor recebido |
| `description` | Descrição do pagamento |
***
## Carteira Nacional de Habilitação (CNH)
Campos extraídos:
| Campo | Descrição |
| -------------------- | ---------------------------------- |
| `register_number` | Número do registro da CNH |
| `name` | Nome completo do condutor |
| `birth_date` | Data de nascimento |
| `cnh_number` | Número da CNH |
| `first_license_date` | Data da primeira habilitação |
| `validity_date` | Data de validade da CNH |
| `full_name` | Nome completo do titular |
| `cpf` | CPF, se constar |
| `date_of_birth` | Data de nascimento |
| `document_type` | Tipo do documento de identificacao |
| `document_number` | Numero do documento |
| `uf` | UF de emissao |
| `issue_date` | Data de emissao, se constar |
***
## Documento de identidade (RG)
Campos extraídos:
| Campo | Descrição |
| ----------------- | ------------------------------------ |
| `rg_number` | Número do RG |
| `name` | Nome completo |
| `birth_date` | Data de nascimento |
| `father_name` | Nome do pai, se constar no documento |
| `mother_name` | Nome da mãe, se constar no documento |
| `issue_date` | Data de emissão do RG |
| `issuing_agency` | Órgão emissor |
| `full_name` | Nome completo do titular |
| `cpf` | CPF, se constar |
| `date_of_birth` | Data de nascimento |
| `document_type` | Tipo do documento de identificacao |
| `document_number` | Numero do documento |
| `uf` | UF de emissao |
***
## Comprovante de residência
Campos extraídos:
| Campo | Descrição |
| ------------------ | -------------------------------- |
| `name` | Nome do titular do endereço |
| `address` | Endereço completo |
| `issue_date` | Data de emissão do comprovante |
| `issuer_name` | Nome da empresa ou órgão emissor |
| `reference_number` | Número de referência ou conta |
***
## Contrato social
Campos extraídos:
| Campo | Descrição |
| --------------------- | ------------------ |
| `company_name` | Nome da empresa |
| `cnpj` | CNPJ da empresa |
| `opening_date` | Data de abertura |
| `partners` | Lista de sócios |
| `capital` | Capital social |
| `registration_number` | Número de registro |
***
## Declaração de IRPF
Campos extraídos:
| Campo | Descrição |
| ---------------- | ----------------------------- |
| `taxpayer_name` | Nome do declarante |
| `cpf` | CPF do declarante |
| `tax_year` | Ano da declaração |
| `receipt_number` | Número do recibo |
| `delivery_date` | Data de entrega da declaração |
***
## Certidão de nascimento
Campos extraídos:
| Campo | Descrição |
| --------------------- | -------------------- |
| `name` | Nome completo |
| `birth_date` | Data de nascimento |
| `mother_name` | Nome da mãe |
| `father_name` | Nome do pai |
| `registration_number` | Número de registro |
| `registry_office` | Cartório de registro |
| `issue_date` | Data de emissão |
***
## Certidão de casamento
Campos extraídos:
| Campo | Descrição |
| --------------------- | -------------------- |
| `spouse_a` | Nome do cônjuge A |
| `spouse_b` | Nome do cônjuge B |
| `marriage_date` | Data do casamento |
| `registration_number` | Número de registro |
| `registry_office` | Cartório de registro |
| `issue_date` | Data de emissão |
***
## Laudo médico
Campos extraídos:
| Campo | Descrição |
| ------------------- | ------------------------------------ |
| `patient_name` | Nome completo do paciente |
| `patient_cpf` | CPF do paciente |
| `patient_birthdate` | Data de nascimento do paciente |
| `patient_sex` | Sexo do paciente |
| `doctor_name` | Nome do médico |
| `doctor_crm` | CRM do médico |
| `doctor_specialty` | Especialidade do médico |
| `issue_date` | Data de emissão do laudo ou receita |
| `cid10` | Diagnóstico (CID-10) |
| `exams` | Exames solicitados ou realizados |
| `medications` | Medicamentos prescritos |
| `observations` | Observações ou recomendações médicas |
| `clinic_name` | Nome do hospital ou clínica |
| `clinic_cnpj` | CNPJ do hospital/clínica |
***
## Certidão de óbito
Campos extraídos:
| Campo | Descrição |
| ---------------------- | ------------------------------ |
| `deceased_name` | Nome completo do falecido |
| `death_date` | Data de óbito |
| `death_place` | Local do óbito (cidade/estado) |
| `age` | Idade do falecido |
| `cause_of_death` | Causa da morte |
| `father_name` | Nome do pai |
| `mother_name` | Nome da mãe |
| `registry_date` | Data de registro da certidão |
| `book_number` | Número do livro |
| `page_number` | Número da folha |
| `term_number` | Número do termo |
| `registry_office` | Cartório emissor |
| `registry_office_cnpj` | CNPJ do cartório |
| `registry_office_city` | Município do cartório |
***
## Procuração
Campos extraídos:
| Campo | Descrição |
| ------------------ | ------------------------ |
| `grantor_name` | Nome do outorgante |
| `grantor_document` | CPF/CNPJ do outorgante |
| `grantee_name` | Nome do outorgado |
| `grantee_document` | CPF/CNPJ do outorgado |
| `powers` | Poderes concedidos |
| `start_date` | Data de início |
| `end_date` | Prazo de validade |
| `issue_place` | Local de emissão |
| `book_number` | Número do livro |
| `page_number` | Número das folhas |
| `witnesses` | Testemunhas e documentos |
***
## Holerite
Campos extraídos:
| Campo | Descrição |
| ----------------- | ----------------------------------------- |
| `employee_name` | Nome completo do funcionário/contribuinte |
| `cpf` | CPF |
| `reference_month` | Competência/mês de referência |
| `gross_salary` | Salário bruto |
| `deductions` | Descontos (INSS, IRRF, etc.) |
| `net_salary` | Salário líquido |
| `benefits` | Benefícios e adicionais |
| `employer_name` | Nome da empresa empregadora |
| `employer_cnpj` | CNPJ da empresa |
| `issue_date` | Data de emissão do holerite |
***
## Documento veicular (CRLV)
Campos extraídos:
| Campo | Descrição |
| ---------------- | ---------------------------- |
| `plate` | Placa do veículo |
| `renavam` | Número do Renavam |
| `chassis` | Número do chassi |
| `model` | Marca/modelo/ano do veículo |
| `color` | Cor e tipo do veículo |
| `category` | Categoria |
| `owner_name` | Nome do proprietário atual |
| `owner_document` | CPF/CNPJ do proprietário |
| `buyer_name` | Nome do comprador (DUT) |
| `buyer_document` | CPF/CNPJ do comprador |
| `issue_date` | Data de emissão do documento |
| `crv_number` | Número do CRV/DUT |
***
## Documento jurídico
Campos extraídos:
| Campo | Descrição |
| ----------------- | ---------------------------------------- |
| `parties` | Partes envolvidas (nomes e CPFs/CNPJs) |
| `object` | Objeto do contrato ou documento |
| `amount` | Valores envolvidos |
| `term_start` | Data de início |
| `term_end` | Data de término |
| `clauses` | Cláusulas específicas |
| `witnesses` | Testemunhas e assinaturas |
| `register_number` | Número do processo ou registro cartorial |
***
## Extrato bancário
Campos extraídos:
| Campo | Descrição |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `bank_name` | Nome do banco |
| `account_holder` | Nome do titular da conta |
| `account_number` | Número da conta bancária |
| `statement_start_date` | Data inicial do extrato (YYYY-MM-DD) |
| `statement_end_date` | Data final do extrato (YYYY-MM-DD) |
| `transactions` | Lista de transações com data, descrição, valor e tipo (credit ou debit). A categorização será feita automaticamente. (array de objetos com os campos abaixo) |
| Subcampo | Descrição |
| ------------- | --------------------------------------- |
| `date` | Data da transação no formato YYYY-MM-DD |
| `description` | Descrição da transação |
| `amount` | Valor da transação em reais |
| `type` | Tipo da transação: credit ou debit |
***
## Informe de rendimentos (empregador/INSS)
Campos extraídos:
| Campo | Descrição |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `source_payer_name` | Nome da fonte pagadora (empresa ou INSS) |
| `source_payer_cnpj` | CNPJ da fonte pagadora ou identificador do INSS, se constar |
| `tax_year` | Ano-base do informe |
| `sources` | Lista de fontes pagadoras do informe (uma por fonte), inclusive quando vierem em paginas diferentes (array de objetos com os campos abaixo) |
| Subcampo | Descrição |
| -------------------------------------- | ----------------------------------------------------------- |
| `source_payer_name` | Nome da fonte pagadora |
| `source_payer_cnpj` | CNPJ da fonte pagadora ou identificador do INSS, se constar |
| `taxable_income_total` | Total de rendimentos tributaveis da fonte |
| `income_tax_withheld_total` | Total de IRRF da fonte |
| `social_security_contribution_total` | Total de INSS da fonte, se constar |
| `thirteenth_salary_total` | Total de 13o salario da fonte, se constar |
| `thirteenth_salary_tax_withheld_total` | Total de IRRF sobre 13o salario da fonte, se constar |
| `exempt_income_total` | Total de rendimentos isentos da fonte, se houver |
| `dependent_count` | Quantidade de dependentes da fonte, se constar |
| Campo | Descrição |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `tax_categories` | Categorizacao fiscal do informe por fonte e consolidado. Use a taxonomia fixa e classifique itens em cada categoria. Contém objetos `by_source` (array por fonte pagadora) e `consolidated` (totais do documento), cada um com as categorias `assets_and_rights`, `taxable_income`, `exclusive_taxation_income`, `exempt_income`, `withholding_tax`, `official_social_security` e `thirteenth_salary`. |
| `taxable_income_total` | Total de rendimentos tributaveis |
| `income_tax_withheld_total` | Total de imposto de renda retido na fonte (IRRF) |
| `social_security_contribution_total` | Total de contribuicao previdenciaria (INSS), se constar |
| `thirteenth_salary_total` | Total de 13o salario, se constar |
| `thirteenth_salary_tax_withheld_total` | Total de IRRF sobre 13o salario, se constar |
| `exempt_income_total` | Total de rendimentos isentos, se houver |
| `dependent_count` | Quantidade de dependentes, se constar |
***
## Informe de rendimentos (bancos)
Campos extraídos:
| Campo | Descrição |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `institution_name` | Nome da instituicao financeira |
| `institution_cnpj` | CNPJ da instituicao financeira, se constar |
| `tax_year` | Ano-base do informe |
| `sources` | Lista de instituicoes financeiras do informe (uma por fonte), inclusive quando vierem em paginas diferentes (array de objetos com os campos abaixo) |
| Subcampo | Descrição |
| ----------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `institution_name` | Nome da instituicao financeira |
| `institution_cnpj` | CNPJ da instituicao financeira, se constar |
| `account_balance_12_31_total` | Saldo total da fonte em 31/12 do ano-base do informe (campo legado) |
| `account_balance_previous_year_total` | Saldo total da fonte em 31/12 do ano anterior, se houver |
| `account_balance_current_year_total` | Saldo total da fonte em 31/12 do ano-base do informe, se houver |
| `investment_position_12_31_total` | Posicao de investimentos da fonte em 31/12 do ano-base do informe, se vier consolidado (campo legado) |
| `investment_position_previous_year_total` | Posicao de investimentos da fonte em 31/12 do ano anterior, se houver |
| `investment_position_current_year_total` | Posicao de investimentos da fonte em 31/12 do ano-base do informe, se houver |
| `taxable_financial_income_total` | Total de rendimentos financeiros tributaveis da fonte |
| `exclusive_tax_income_total` | Total de rendimentos de tributacao exclusiva da fonte, se separado |
| `exempt_financial_income_total` | Total de rendimentos financeiros isentos da fonte, se separado |
| `income_tax_withheld_total` | Total de IRRF da fonte, se houver |
| Campo | Descrição |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `tax_categories` | Categorizacao fiscal do informe por fonte e consolidado. Use a taxonomia fixa e classifique itens em cada categoria. Contém objetos `by_source` (array por fonte pagadora) e `consolidated` (totais do documento), cada um com as categorias `assets_and_rights`, `taxable_income`, `exclusive_taxation_income`, `exempt_income`, `withholding_tax`, `official_social_security` e `thirteenth_salary`. |
| `account_balance_12_31_total` | Saldo total em 31/12 do ano-base do informe (campo legado) |
| `account_balance_previous_year_total` | Saldo total em 31/12 do ano anterior, se houver |
| `account_balance_current_year_total` | Saldo total em 31/12 do ano-base do informe, se houver |
| `investment_position_12_31_total` | Posicao total de investimentos em 31/12 do ano-base do informe, se vier consolidado (campo legado) |
| `investment_position_previous_year_total` | Posicao total de investimentos em 31/12 do ano anterior, se houver |
| `investment_position_current_year_total` | Posicao total de investimentos em 31/12 do ano-base do informe, se houver |
| `taxable_financial_income_total` | Total de rendimentos financeiros tributaveis |
| `exclusive_tax_income_total` | Total de rendimentos sujeitos a tributacao exclusiva/definitiva, se separado |
| `exempt_financial_income_total` | Total de rendimentos financeiros isentos, se separado |
| `income_tax_withheld_total` | Total de IRRF sobre rendimentos financeiros, se houver |
***
## Informe de rendimentos (corretoras)
Campos extraídos:
| Campo | Descrição |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `broker_name` | Nome da corretora |
| `broker_cnpj` | CNPJ da corretora, se constar |
| `tax_year` | Ano-base do informe |
| `sources` | Lista de corretoras no informe (uma por fonte), inclusive quando vierem em paginas diferentes (array de objetos com os campos abaixo) |
| Subcampo | Descrição |
| -------------------------------------- | ------------------------------------------------------------------------------------------ |
| `broker_name` | Nome da corretora |
| `broker_cnpj` | CNPJ da corretora, se constar |
| `custody_position_12_31_total` | Valor total da custodia em 31/12 do ano-base do informe da fonte, se houver (campo legado) |
| `custody_position_previous_year_total` | Valor total da custodia em 31/12 do ano anterior da fonte, se houver |
| `custody_position_current_year_total` | Valor total da custodia em 31/12 do ano-base do informe da fonte, se houver |
| `dividends_total` | Total de dividendos da fonte, se houver |
| `jcp_total` | Total de JCP da fonte, se houver |
| `jcp_tax_withheld_total` | Total de IRRF de JCP da fonte, se houver |
| `fii_income_total` | Total de rendimentos de FIIs da fonte, se houver |
| `other_investment_income_total` | Total de outros rendimentos/proventos da fonte, se houver |
| Campo | Descrição |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `tax_categories` | Categorizacao fiscal do informe por fonte e consolidado. Use a taxonomia fixa e classifique itens em cada categoria. Contém objetos `by_source` (array por fonte pagadora) e `consolidated` (totais do documento), cada um com as categorias `assets_and_rights`, `taxable_income`, `exclusive_taxation_income`, `exempt_income`, `withholding_tax`, `official_social_security` e `thirteenth_salary`. |
| `custody_position_12_31_total` | Valor total da custodia em 31/12 do ano-base do informe, se houver (campo legado) |
| `custody_position_previous_year_total` | Valor total da custodia em 31/12 do ano anterior, se houver |
| `custody_position_current_year_total` | Valor total da custodia em 31/12 do ano-base do informe, se houver |
| `dividends_total` | Total de dividendos, se houver |
| `jcp_total` | Total de juros sobre capital proprio, se houver |
| `jcp_tax_withheld_total` | Total de IRRF sobre JCP, se houver |
| `fii_income_total` | Total de rendimentos de FIIs, se houver |
| `other_investment_income_total` | Total de outros proventos/rendimentos de investimentos, se houver |
***
## Informe de plano de saúde
Campos extraídos:
| Campo | Descrição |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `operator_name` | Nome da operadora do plano de saude |
| `operator_cnpj` | CNPJ da operadora, se constar |
| `tax_year` | Ano-base do informe |
| `policy_holder_name` | Nome do titular do plano |
| `policy_holder_cpf` | CPF do titular, se constar |
| `annual_premiums_total` | Total pago no ano |
| `annual_reimbursements_total` | Total reembolsado no ano, se houver |
| `dependents` | Lista de dependentes e seus valores anuais, se houver detalhamento por pessoa (array de objetos com os campos abaixo) |
| Subcampo | Descrição |
| ----------------------- | --------------------------------------------------------- |
| `name` | Nome do dependente |
| `cpf` | CPF do dependente, se constar |
| `annual_premiums` | Total anual pago do dependente, se vier por pessoa |
| `annual_reimbursements` | Total anual reembolsado do dependente, se vier por pessoa |
***
## Despesa médica
Campos extraídos:
| Campo | Descrição |
| --------------------------- | -------------------------------------------- |
| `service_provider_name` | Nome do prestador do servico medico |
| `service_provider_cpf_cnpj` | CPF ou CNPJ do prestador do servico |
| `service_date` | Data da prestacao do servico |
| `amount_paid` | Valor pago pelo servico |
| `patient_name` | Nome do paciente, se constar |
| `patient_cpf` | CPF do paciente, se constar |
| `description` | Descricao do procedimento/servico, se houver |
| `reimbursed_amount` | Valor reembolsado, se constar |
***
## Comprovante de educação
Campos extraídos:
| Campo | Descrição |
| --------------------- | ------------------------------------------------------------------ |
| `institution_name` | Nome da instituicao de ensino |
| `institution_cnpj` | CNPJ da instituicao de ensino, se constar |
| `tax_year` | Ano-base ou periodo do comprovante |
| `student_name` | Nome do aluno |
| `student_cpf` | CPF do aluno, se constar |
| `amount_paid_total` | Valor total pago no ano/periodo |
| `service_description` | Descricao do servico educacional (mensalidade/anuidade), se houver |
***
## Declaração de IR de ano anterior
Campos extraídos:
| Campo | Descrição |
| ----------------- | ----------------------------------------- |
| `receipt_number` | Numero do recibo da declaracao anterior |
| `tax_year` | Ano-base da declaracao |
| `taxpayer_name` | Nome do contribuinte |
| `taxpayer_cpf` | CPF do contribuinte |
| `submission_date` | Data de entrega da declaracao, se constar |