Atualizar um documento já enviado para a Empresa

put http://{{auth_server_host}}/banking//originator/business/{business_id}/documents/{document_id}

Esse endpoint deve ser utilizado para alterar um documento já associado ao cadastro da Empresa.

No momento da Solicitação de Crédito, o sistema irá checar se todos os documentos obrigatórios indicados na configuração do produto foram cadastrados. Para saber como indicar os tipos de documentos obrigatórios, consulte a documentação de configuração de produtos.

Parâmetros da URL

business_id (string, uuid v4): Identificador do cadastro da Empresa a ser consultada.
document_id (string, uuid v4): Identificador do documento a ser manipulado.

Parâmetros da Requisição

type (string, obrigatório): O tipo do documento a ser enviado.
file (file, obrigatório): Arquivo a ser enviado no formato de base64.
observations (string): Campo para enviar observações e comentários referente ao arquivo que esta sendo enviado.

Tipos de documentos aceitos ('type')

Tipo (parâmetro type)	Descrição
NATIONAL_ID	Documento de Identidade
DRIVERS_LICENSE	Carteira nacional de habilitação (CNH)
MILITARY_ID	Identificação militar
PROOF_OF_INCOME	Comprovante de Renda
BALANCE_SHEETS	Balanço Patrimonial
INCOME_STATEMENT	Comprovante de faturamento
PROOF_OF_ADDRESS	Comprovante de Endereço
BYLAWS	Estatuto Social
INCORPORATION_CERTIFICATE	Registro de Incorporação
FEDERAL_REGISTER_CERTIFICATE	Cartão CNPJ
INVOICE	Comprovante
CERTIFICATE	Certidão
LETTER_OF_ATTORNEY	Procuração
CONTRACT	Contrato
OTHER	Outro

Resposta

Em caso de sucesso na consulta a resposta será um JSON no seguinte formato.

id (string/uuid v4): Identificador do documento enviado.
type (string): Tipo do arquivo enviado. Possíveis valores: NATIONAL_ID, DRIVERS_LICENSE, PROOF_OF_INCOME, CLASS_ID, MILITARY_ID, PROOF_OF_ADDRESS, SCR_AUTHORIZATION, BALANCE_SHEETS, INCOME_STATEMENT, BYLAWS, INCORPORATION_CERTIFICATE, FEDERAL_REGISTER_CERTIFICATE, INVOICE, CERTIFICATE, LETTER_OF_ATTORNEY, CONTRACTS, OTHER.
observations (string): Campo contendo as observações/detalhamento referente ao arquivo enviado.
status (string): Status de recebimento e se o arquivo é válido.
file_extension (string): Extensão/tipo do arquivo.
file_name (string): Nome do arquivo.
created_at (datetime): Data de envio do arquivo no formato ISO 8601.
version (int): Campo utilzado para versionamento do arquivo caso seja necessário.

Exemplo de JSON:

{
    "id": "string/uuid v4",
    "type": "string",
    "observations": "string",
    "status": "string",
    "file_extension": "string",
    "file_name": "string",
    "created_at": "datetime",
    "version": int
}