Envio de documentos LTDA, S.A. e TS

Este endpoint possibilita enviar os documentos necessários para o cadastro de empresas do tipo LTDA, S.A. e Terceiro Setor. Tais documentos são:

Contratos Sociais;
Estatutos Sociais;
Últimas Alterações Contratuais, Eleição do Síndico ou Responsável Legal;
Balanços Sociais/DRE;
Declarações de Faturamento;
Procurações Públicas Legais;
Comprovante de endereço da empresa.

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/Onboarding/idOnePJ?idClient={{clientId}}&documentNumber={{cnpj}}

--request POST 'https://sandbox.hiperbanco.com.br/Onboarding/idOnePJ?idClient={{clientId}}&documentNumber={{cnpj}}' \
--header 'version: cutting-edge' \
--header 'Content-Type: multipart/form-data' \
--header 'Authorization: Bearer {{accessToken}}' \
--form documentType=BALANCE_SHEET \
--form file=@"/path/to/file.pdf"'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON

Parâmetros da rota (Path / Query)

Nome	Tipo	Descrição	Especificação
`documentNumber`	`query`	Obrigatório. Número do documento do cliente (CNPJ).	Informe somente números.
`clientId`	`query`	Obrigatório. Id do cliente fornecido juntamente com as credenciais	UUID

Corpo da requisição (Body)

No body, envie os seguintes campos em formato de formulário:

Nome	Tipo	Descrição	Especificação
`documentType`	`text`	Obrigatório. Tipo de documento que está sendo enviado.	—
`file`	`file`	Obrigatório. Arquivo do documento.	Só são aceitos envios de arquivos do tipo PDF, e não devem ser superiores a 8.5 MB. Caso o arquivo ultrapasse esse tamanho, recomendamos a sua compactação.

Tipos de documentos (`documentType`)

Tipo	Contexto de envio
ARTICLES_OF_INCORPORATION	Para Contrato Social ou Estatuto Social.
LAST_CONTRACT_CHANGE	Para Última Alteração Contratual ou Última Ata de Eleição do Síndico ou Responsável Legal.
POWER_OF_ATTORNEY	Para Procuração Pública Legal.
BALANCE_SHEET	Para Balanço Social/DRE ou Declaração de Faturamento dos Últimos 12 meses. O envio desse tipo de documento é opcional.
PROOF_OF_ADDRESS	Comprovante de endereço da empresa em formato PDF (conta de luz, água, telefonia e IPTU. Apenas em caso de empresas recém-constituídas é possível encaminhar o alvará de funcionamento do corpo de bombeiro ou contrato de locação).

Resposta (Response)

O status code 200 indicará sucesso no envio dos arquivos.

Sendo bem-sucedido, o retorno irá trazer o seguinte campo em formato JSON:

Nome	Tipo	Descrição
`message`	`string`	Mensagem referente ao status da requisição.
`token`	`string`	Token que identifica o arquivo enviado.

{
    "message": "Arquivo enviado com sucesso",
    "token": "lErA4v7__aG0pgRUQNJ1wxSXf8K2.F84"
}

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.