Listar os envios disponíveis para cadastro

Listar as referências de envio disponíveis

Use este endpoint depois de enviar documentos de cadastro quando precisar encontrar referências que ainda estejam disponíveis para anexar documentos. Use uma conta habilitada da API da MultiTEL por HTTPS, com suas credenciais e restrições de IP configuradas. A lista se limita à sua conta.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/get_encrypted_files

Não são necessários corpo de requisição nem parâmetros de consulta. O manipulador lista os registros de envios criados pela API cujo indicador de expiração está desativado e cuja data e hora de expiração são posteriores à data e hora atuais do servidor. Não há parâmetros de paginação, pesquisa ou ordenação. Esta não é uma lista de todas as identidades, comprovantes ou documentos históricos da sua conta.

Consultar metadados, não os bytes do documento

Consulte o resultado HTTP e o campo status.code do JSON. Uma resposta bem-sucedida contém um array em response; um resultado vazio é um array vazio, não um erro de conta inexistente. O exemplo usa metadados e identificadores fictícios.

{
  "status": {"code": 200, "msg": ""},
  "response": [{
    "id": "0123456789abcdef0123456789abcdef",
    "proof_type": "abcdef0123456789abcdef0123456789",
    "entity_type": "addresses",
    "description": "Example address proof",
    "file_name": "example-document.pdf",
    "date": "2026-10-01 12:00:00"
  }]
}

Campos de metadados do envio
Campo	Significado
`id`	A referência externa do envio. Copie-a exatamente para a requisição correspondente de anexação. Não calcule um identificador por conta própria nem use em seu lugar um identificador de identidade, endereço ou modelo.
`proof_type`	A referência mascarada do tipo registrado, quando presente; caso contrário, uma string vazia. Para envios de comprovantes, corresponde ao tipo de comprovante; os envios de documentos complementares registram a referência do modelo nesta mesma chave. Consulte entity_type para distingui-los. Não é o identificador do envio.
`entity_type`	A categoria registrada para anexação, como identities, addresses ou supporting_documents. Escolha o fluxo de anexação correspondente.
`description`	A descrição armazenada do envio.
`file_name`	O nome original do arquivo. Não é uma URL para baixar o arquivo.
`date`	A data e hora de criação registradas, formatadas pelo servidor sem indicação do deslocamento de fuso horário.

A resposta não contém os bytes do documento, uma URL de armazenamento nem a data e hora de expiração. Guarde expired_at da resposta original do envio. A inclusão de um envio na lista não estende sua validade, não o anexa a uma identidade nem comprova que uma operadora de telecomunicações o aprovou.

Anexar antes que a referência expire

Use o fluxo de anexação de comprovantes ou anexação de documentos complementares adequado. O fluxo de envio atual concede às referências um período de validade curto; não adie a anexação apenas porque uma referência apareceu nesta lista. Uma referência pode expirar ou ficar indisponível entre a consulta da lista e a anexação. Processe a resposta da anexação em vez de presumir que ela foi bem-sucedida.

Se a lista estiver vazia de forma inesperada, verifique a conta e se o envio expirou ou foi criado por outro fluxo. Não envie automaticamente os mesmos documentos de novo sem verificar os resultados originais do envio e da anexação.

Privacidade

Os nomes de arquivo e as descrições podem identificar pessoas ou documentos mesmo sem o conteúdo dos arquivos. Limite o acesso e evite gravar respostas completas nos registros do sistema. Para remover uma referência local de envio que não esteja sendo usada, consulte remover uma referência de envio; essa operação não é um serviço de exclusão integral de documentos.