Skip to main content
POST
Esta rota gera um token de upload: uma credencial temporária, válida por 5 minutos, que só serve para enviar documentos de uma subconta em POST /v1/document-uploads. Com ele, o upload pode sair direto do navegador do vendedor, sem que a chave secreta saia do seu servidor. É também o único caminho para enviar os documentos pessoais de um sócio adicional.

Quando usar

Antes de chamar

  • Tenha o id da subconta, devolvido em Criar subconta.
  • Para um sócio, tenha o id dele: vem em legalRepresentatives na resposta da criação (itens com isPrimary: false) ou em Listar representantes.
  • Autentique com a chave secreta (sk_) da conta master, sempre no servidor (Credenciais e ambientes).

Parâmetros de caminho

string
required
Id da subconta. Ex.: 36OO3bcGjhPjjF3tzrqOGcmQuKo.

Corpo da requisição

Formato application/json. O corpo é opcional.
Sócio ao qual os documentos de pessoa (responsible_document_front, responsible_document_back, selfie_with_document) serão vinculados. Precisa pertencer à subconta; caso contrário, a resposta é 404. Quando omitido, os documentos ficam no representante legal. Ex.: 2vorkEbbbCccDddEeeFffGggHhh.
O legalRepresentativeId só afeta documentos de pessoa. Documentos de empresa (cnpj_card, social_contract, irs_letter) valem para a subconta como um todo, com ou sem sócio no token.

Respostas

string
Token de upload. Use no cabeçalho Authorization: Bearer da chamada POST /v1/document-uploads. Ex.: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9....
integer
Validade do token em segundos. Ex.: 300 (5 minutos).
O token expira em 300 segundos (5 minutos) e é de uso único. Gere o token no momento do envio. Token vencido é recusado com 401 “Token de upload inválido ou expirado”; token já usado, com 403 “Token de upload expirado ou já utilizado”. Nos dois casos, gere outro token.
Para o desenvolvedor: a subconta e o sócio ficam gravados dentro do token. O front-end recebe só o token e não consegue trocar de subconta ou de sócio. Gere um token por sócio: um token emitido para Bruno vincula os documentos de pessoa a Bruno, mesmo que o arquivo seja de outra pessoa.
Para o negócio: com o token, cada sócio pode enviar os próprios documentos por um link ou tela do seu sistema, e a chave secreta da sua conta continua guardada no servidor.

Erros comuns

Veja também

Enviar documentos com token

Upload usando o token gerado aqui.

Sócios e documentos

Fluxo completo de documentos por sócio.

Listar representantes

Ids dos sócios e status dos documentos.

Criar subconta

Cadastro com sócios adicionais.