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.

Página do Portal do Cliente que solicita os documentos

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:

Pela API

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
          },
        ]
      }
    }
  }
}

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ável	Descrição
ccbNumber	Número da CCB
updatedAt	Data e hora de criação do empréstimo. Formato: “dd/MM/yyyy HH:mm:ss”
customerName	Nome do cliente
rgNumber	Número do RG
rgIssuer	Órgão emissor do RG
rgState	Estado do RG
cpf	Documento do cliente
birthDate	Formato: “dd/MM/yyyy”
birthPlace	Formato: “dd/MM/yyyy”
nationality	Nacionalidade do cliente
maritalStatus	Estado civil do cliente
customerPhone	Telefone do cliente
customerEmail	E-mail do cliente
customerAddressLine1	Endereço do cliente
customerAddressLine2	Complemento do endereço do cliente
customerAddressNumber	Número do endereço do cliente
customerAddressNeighborhood	Nome do bairro do cliente
customerAddressCity	Nome da cidade do cliente
customerAddressState	Nome do estado do cliente
customerAddressCityAndState	Junção do nome da cidade e estado do cliente
customerAddressPostalCode	CEP do cliente
hiredAt	Data de contratação do cliente
employeeNumber	Número empregatício do cliente
companyName	Nome da empresa
cnpj	Documento da empresa
companyAddressLine1	Endereço da empresa
companyAddressLine2	Complemento do endereço da empresa
companyAddressNumber	Número do endereço da empresa
companyAddressNeighborhood	Nome do bairro da empresa
companyAddressCity	Nome da cidade da empresa
companyAddressState	Nome do estado da empresa
companyAddressPostalCode	CEP da empresa
totalAmount	Valor total do empréstimo
disbursementAmount	Valor total do empréstimo
iofAmount	Valor do IOF
installmentAmount	Valor da parcela
firstDueDate	Formato: “dd/MM/yyyy”
lastDueDate	Formato: “dd/MM/yyyy”
numberOfInstallments	Número de parcelas
monthlyFee	Taxa ao mês
yearlyFee	Taxa ao ano
monthlyCET	CET ao mês
yearlyCET	CET ao ano
insuranceNumber	Número do seguro
insuranceAmount	Valor total do seguro
insuranceType	Tipo do seguro
rebateTacAmount	Valor total da taxa de cadastro
bankAccountBranch	O número da agência bancária associada à conta
bankAccountDigit	O dígito verificador da conta
bankAccountNumber	O número da conta
bankAccountType	O tipo da conta
bankAccountIspb	Código COMPE da Instituição Financeira
bankAccountBankCode	Número do banco
bankAccountBankName	O nome da instituição financeira

Certificado de assinatura

Variável	Descrição
id	Identificador único do empréstimo
generationDateIso	Data de geração em formato ISO
generationDateLine	Data de geração em formato de linha
generationDateWithTime	Data de geração com informações de hora
customerName	Nome do cliente
customerEmail	E-mail do cliente
cpf	Documento do cliente
fingerprint	Assinatura digital da operação
ip	IP de origem da operação
latitude	Latitude da origem da operação
longitude	Longitude da origem da operação
fileName	Nome do arquivo associado
fileVersion	Versão do arquivo
fileHashSha256	Hash SHA-256 do arquivo
fileHashSha512	Hash SHA-512 do arquivo

Contrato de seguro prestamista

Variável	Descrição
id	Identificador único do empréstimo
ccbNumber	Número da CCB
createdAt	Data de criação do registro. Formato: “dd/MM/yyyy HH:mm:ss”
customerName	Nome do cliente
customerEmail	E-mail do cliente
cpf	Documento do cliente
birthDate	Data de nascimento do cliente. Formato: “dd/MM/yyyy”
customerPhone	Telefone do cliente
customerAddressLine1	Endereço do cliente
customerAddressLine2	Complemento do endereço do cliente
customerAddressNeighborhood	Nome do bairro do cliente
customerAddressPostalCode	CEP do cliente
customerAddressCityAndState	Junção do nome da cidade e estado do cliente
customerAddressCity	Nome da cidade do cliente
customerAddressState	Nome do estado do cliente
customerAddressNumber	Nú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 [e-mail];
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:

Pela API

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>"
            }
          }
        ]
      }
    }
  }
}