Pular para o conteúdo principal

Documentos

Nas configurações de documentos dos produtos é onde são parametrizados os tipos de documentos utilizados em processos de empréstimo. As configurações são separadas em duas categorias:

  • Documentos que são gerados automaticamente após a solicitação de um empréstimo. Por exemplo: a Cédula de Crédito Bancário (CCB), certificado de assinatura e contrato do seguro.
  • Documentos do cliente solicitados durante a jornada de contratação de um empréstimo. Por exemplo: frente e verso do documento de identidade, holerite e comprovante de endereço.

Solicitar documentos​

Você pode solicitar um número indefinido de documentos para o cliente.

Image

A atualização da configuração não afeta os empréstimos retroativamente.

Validade dos documentos​

Os documentos podem ter uma validade. A validade é contada em dias a partir da data de criação do documento. Após o vencimento, o documento é considerado inválido e o cliente deve enviar um novo documento.

Responsável pelo envio​

Os documentos podem ser solicitados pela jornada do cliente ou enviados posteriormente pelo Backoffice. Essa configuração pode ser definida em cada documento individualmente, ou seja, alguns podem ser enviados pelo cliente através do Portal do Cliente e outros pelo operador atráves do Backoffice.

Como configurar​

Veja como fazer a configuração de documentos solicitados:

Os documentos solicitados devem respeitar a lista de propósitos de arquivos. Consulte a lista de propósitos disponíveis na referência da API.

Atualize o produto com a configuração dos documentos através do endpoint Atualizar produto da API de Produtos.

{
  "settings": {
    "products": {
      "documents": {
        "toRequest": [
          {
            "purpose": "identity_document_front",
            "name": "Frente do documento de identidade",
            "owner": "customer",
            "expireInDays": 365
          },
          {
            "purpose": "identity_document_back",
            "name": "Verso do documento de identidade",
            "owner": "customer",
            "expireInDays": 365
          },
          {
            "purpose": "pay_stub",
            "name": "Holerite",
            "owner": "customer",
            "expireInDays": 90
          },
        ]
      }
    }
  }
}
dica

Se você precisa solicitar documentos diferentes para determinar empresas, recomendamos a criação de produtos diferentes para cada empresa e fazer a segmentação com a elegibilidade através de uma consulta externa.

Gerar documentos​

Os documentos gerados são criados através de templates configurados em cada produto. Os documentos são gerados através de uma integração com o Google Docs.

Os arquivos gerados são disponibilizados no Backoffice e Portal do Cliente.

O template é um documento que contém campos que serão substituídos pelos dados do empréstimo e do cliente. Os campos são identificados por chaves entre chaves, como [[nome]], [[cpf]], [[valor]], etc.

Você pode gerar múltiplos documentos desde que respeite o conjunto de variáveis de cada propósito. Esses são os conjuntos de variáveis disponíveis:

CCB - Cédula de Crédito Bancário​

VariávelDescrição
loan_contract_numberNúmero da CCB
loan_created_atData e hora de criação do empréstimo. Formato: “dd/MM/yyyy HH:mm:ss”
cust_nameNome do cliente
cust_additional_doc_rg_numberNúmero do RG. Documento adicional filtrado pelo type RG
cust_additional_doc_rg_issuerÓrgão emissor do RG. Documento adicional filtrado pelo type RG
cust_additional_doc_rg_stateEstado da Emissão do RG. Documento adicional filtrado pelo type RG
cust_documentDocumento do cliente, CPF ou CNPJ
cust_birth_dateData do aniversário no formato “dd/MM/yyyy”
cust_birth_placeLocal de nascimento
cust_nationalityNacionalidade do cliente
cust_marital_statusEstado civil do cliente
cust_phoneTelefone do cliente
cust_emailE-mail do cliente
cust_address_line1Endereço do cliente
cust_address_line2Complemento do endereço do cliente
cust_address_numberNúmero do endereço do cliente
cust_address_neighborhoodNome do bairro do cliente
cust_address_cityNome da cidade do cliente
customerAddressStateNome do estado do cliente
cust_address_city_stateJunção do nome da cidade e estado do cliente
cust_address_postal_codeCEP do cliente
empl_hired_atData de contratação do cliente
empl_cust_external_idNúmero empregatício do cliente
comp_nameNome da empresa
comp_documentDocumento da empresa
comp_address_line1Endereço da empresa
comp_address_line2Complemento do endereço da empresa
comp_address_numberNúmero do endereço da empresa
comp_address_neighborhoodNome do bairro da empresa
comp_address_cityNome da cidade da empresa
comp_address_stateNome do estado da empresa
comp_address_postal_codCEP da empresa
loan_offer_total_amountValor total do empréstimo
loan_offer_disbursement_amountValor que o cliente receberá. Caso não exista nenhum valor a ser depositado para o cliente o padrão para a informação é R$ 0,00
loan_offer_iof_amountValor do IOF
loan_offer_inst_amountValor da parcela
loan_offer_first_due_dateData do primeiro vencimento no formato: “dd/MM/yyyy”
calc_last_due_datData do último vencimento no formato “dd/MM/yyyy”
loan_offer_number_of_installmentsNúmero de parcelas
loan_offer_monthly_feeTaxa ao mês
loan_offer_yearly_feeTaxa ao ano
loan_offer_monthly_cetCET ao mês
loan_offer_yearly_cetCET ao ano
loan_offer_insurance_numberNúmero do seguro
loan_offer_insurance_amountValor total do seguro
loan_offer_insurance_typeTipo do seguro
loan_offer_rebate_tac_amountValor total da taxa de cadastro
calc_net_amount_credit_to_issuerPorcentagem do valor líquido desembolsado para o cliente, em cima do valor emitido da dívida (valor desembolsado + taxas de manutenção + iof + seguro)
loan_offer_rebate_calc_percentagePorcentagem do valor das taxas de manutenção em cima do valor emitido da dívida (valor desembolsado + taxas de manutenção + iof + seguro)
loan_offer_calc_iof_amount_percentagePorcentagem do valor do IOF em cima do valor emitido da dívida (valor desembolsado + taxas de manutenção + iof + seguro)
pm_bank_account_branchO número da agência bancária associada à conta
pm_bank_account_digitO dígito verificador da conta
pm_bank_account_numberO número da conta
pm_bank_account_typeO tipo da conta
pm_bank_account_ispbCódigo COMPE da Instituição Financeira. Exclusivo PIX
pm_bank_account_bank_codeNúmero do banco
pm_bank_account_bank_nameO nome da instituição financeira
loan_cashout_boleto_typeableLine_groupTodas as linhas digitaveis de boletos para quitação de dívidas
loan_cashout_boleto_amount_sumSoma de todos os amount dos cashouts do tipo boleto. Caso não existam linhas digitáveis o valor padrão é R$ 0,00
prod_slugTipo do crédito que está sendo fornecido
loan_cashout_payment_method_amount_sumSoma dos cashouts desembolsados na conta bacária do cliente

Certificado de assinatura​

VariávelDescrição
loan_idIdentificador único do empréstimo
file_generation_date_isoData e hora da geração no formato ISO-8601
file_generation_date_lineData e hora da geração no formato 31 de dezembro de 2019, 21:00:00
file_generation_date_with_timeData e hora da geração no formato 01/01/2022 01:01:01
customer_nameNome do cliente
customer_emailE-mail do cliente
customer_documentDocumento do cliente (CPF)
loan_context_fingerprintAssinatura digital do empréstimo, saiba mais
loan_context_ipIP do cliente no momento da assinatura do empréstimo
loan_context_geolocation_0Latitude do cliente no momento da assinatura do contrato
loan_context_geolocation_1Longitude do cliente no momento da assinatura do contrato
file_idNome do arquivo armazenado no filesystem
file_hash_versionVersão imutável do arquivo armazenado
file_hash_sha_256Resumo do arquivo usando o algoritmo sha256
file_hash_sha_512Resumo do arquivo usando o algoritmo sha512

Contrato de seguro prestamista​

VariávelDescrição
loan_idIdentificador único do empréstimo
loan_contract_numberNúmero da CCB
loan_created_atData de criação do registro. Formato: “dd/MM/yyyy HH:mm:ss”
customer_nameNome do cliente
customer_emailE-mail do cliente
customer_documentDocumento do cliente (CPF)
cust_birth_dateData de nascimento do cliente. Formato: “dd/MM/yyyy”
cust_phoneTelefone do cliente
cust_address_line1Endereço do cliente
cust_address_line2Complemento do endereço do cliente
cust_address_neighborhoodNome do bairro do cliente
cust_address_postal_codeCEP do cliente
cust_address_city_stateJunção do nome da cidade e estado do cliente
cust_address_cityNome da cidade do cliente
cust_address_stateNome do estado do cliente
cust_address_numberNúmero do endereço do cliente

Criar um template no Google Docs​

A personalização de arquivos gerados consiste em criar um novo documento a partir do Google Docs e configurá-lo no produto. Siga os passos:

  1. Crie um documento no Google Docs;
  2. Compartilhe o documento (apenas com permissão de leitura) com o e-mail [email protected];
  3. Copie o ID do arquivo presente na URL do arquivo que aparece no endereço no navegador. Exemplo https://docs.google.com/document/d/<id-do-documento>/edit;
  4. Adicione os templates na configuração do produto.

Como configurar​

Você precisa do ID do documento para configurar o template. Veja como fazer a configuração de documentos gerados:

Atualize o produto com a configuração dos templates através da API Atualizar produto.

{
  "settings": {
    "products": {
      "documents": {
        "toCreate": [
          {
            "purpose": "ccb",
            "method": "google",
            "methodData": {
              "template": "<id-do-google-docs>"
            }
          },
          {
            "purpose": "signature",
            "method": "google",
            "methodData": {
              "template": "<id-do-google-docs>"
            }
          },
          {
            "purpose": "insurance",
            "method": "google",
            "methodData": {
              "template": "<id-do-google-docs>"
            }
          }
        ]
      }
    }
  }
}