Documentação B2B
Start typing to search…

Upload de Documentos

Essa seção descreve como você pode fazer o upload de documentos.

Essa funcionalidade está em beta tester, se você tem interesse fale com a pessoa consultora para verificar com a área de tecnologia se é possível liberar essa funcionalidade pra você
Para efetuar essa ação você precisa ter uma proposta no status de DOCUMENTS.


Envio de Documentos


Esta seção descreve como funciona o envio de documentos principais e em qual momento é possível dar início nesta etapa.

No fluxo atual da Creditas o envio dos documentos é iniciado quando a proposta chega na etapa de formalização, que ocorre após a aprovação de crédito.

Para saber se a proposta está elegível ao envio de documentos, você precisa consultar o status da solicitação e observar se o step de documents foi iniciado. Se sim, você pode dar início a esta etapa.

São ao todo 3 (três) documentos que devem ser enviados. O envio para cada um dele é feito de forma individual - ou seja, um documento por request (sendo que você consegue enviar mais de um arquivo por tipo de documento).

Neste momento, apenas é possível enviar os documentos. Você não conseguirá ter o retorno sobre a aprovação/rejeição de cada documento.

Ao decorrer do fluxo, outros documentos podem ser solicitados. Se isso for necessário, nosso time de formalização entrará em contato direto com o cliente.


Tipos de arquivos aceitos

  • JPEG
  • PDF
  • PNG
  • PPM
  • DOCX
  • TIF

Tamanho dos documentos aceitos

  • 50mb (máximo)

Tipos de Documentos

Status Descrição Recomendações
`INCOME_STATEMENT` **Comprovante de renda** 
    IMPORTANTE:\
    O comprovante de renda solicitado varia de acordo com a situação profissional do cliente, preenchida no momento de criação da proposta. Por isso, veja abaixo as possibilidades

    * **Assalariado/Registrado/Funcionário Público**\
      Documentos aceitos: contracheque/holerite do último mês.

    * **Aposentado/Pensionista**\
      Documentos aceitos: extrato do último benefício

    * **Autônomo/ Profissional Liberal / Empresário**\
      Documentos aceitos: Extrato bancário completo dos 3 últimos meses
  </td>
  <td>
    * Escolha um documento válido e com as informações legíveis. 
    * Verifique se o documento está sem o plástico de proteção.
    * Tire a foto em um local iluminado e sem usar o flash.
    * Se for enviar seu RG, lembre-se de tirar foto da frente e do verso do seu documento.
  </td>
</tr>
<tr>
  <td>
    `PROOF_RESIDENCE`
  </td>
  <td>
    **Comprovante de residência**
  </td>
  <td>
    * Escolha um documento válido e com as informações legíveis. 
    * Verifique se o documento contém seus dados pessoais, residenciais, descrição dos gastos e o código de barras.
    * Tire a foto com o documento aberto e todas as informações visíveis.
    * Tire a foto em um local iluminado e sem usar o flash
  </td>
</tr>
<tr>
  <td>
    `PROOF_IDENTITY`
  </td>
  <td>
    **Comprovante de identificação**
  </td>
  <td>
    * Escolha um documento válido e com as informações legíveis. 
    * Verifique se no documento conta seus dados e ganhos.
    * Tire a foto em um local iluminado e sem usar o flash.
    * Tire a foto com o documento aberto e todas as informações visíveis.
  </td>
</tr>

Como realizar o upload de documentos


Request HTTP POST

Tipo de Requisição URL Exemplo
`POST` {{url_base}}**/proposals/:proposalId/documents** [https://stg-api.creditas.io/b2**/proposals/:proposalId/documents**]()

Exemplo de Request e Response

curl --location --request POST '{{url_base}}/proposals/B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0/documents' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: multipart/form-data' \
--header 'Authorization: Bearer {{your_access_token}}'
--form 'file=@"{{your_file}}"' \
--form 'group="PROOF_RESIDENCE"'

{
    "id": "Id do documento"
}


Como ver os documentos já registrados


Request HTTP GET

Tipo de Requisição URL Exemplo
`GET` {{url_base}}**/proposals/:proposalId/documents** [https://stg-api.creditas.io/b2**/proposals/:proposalId/documents**]()

Exemplo de Request e Response

curl --location --request GET '{{url_base}}/proposals/B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0/documents' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Authorization: Bearer {{your_access_token}}'

{
    "items": [
        {
            "id": "Id do Documento",
            "type": "INCOME_STATEMENT"
        },
        {
            "id": "Id do Documento",
            "type": "PROOF_IDENTITY"
        },
        {
            "id": "Id do Documento",
            "type": "PROOF_RESIDENCE"
        },
        {
            "id": "Id do Documento",
            "type": "INCOME_STATEMENT"
        },
        {
            "id": "Id do Documento",
            "type": "PROOF_IDENTITY"
        },
        {
            "id": "Id do Documento",
            "type": "PROOF_RESIDENCE"
        }
    ],
    "cursors": {}
}


Possíveis Erros

Consulte os possíveis retornos de erros, clique aqui

Updated 25 days ago