Docs
Anexos

Listar anexos por membro

Veja todos os anexos solicitados a um assinante e quais já foram enviados.

Lista todos os slots de anexo definidos para um assinante na criação da operação (via attachments[]) e indica quais já foram preenchidos. É a porta de entrada do fluxo de revisão — você usa essa lista pra decidir o que vai aprovar, rejeitar ou baixar.

Esse endpoint não devolve metadados ricos do arquivo (nome original, MIME, tamanho). Ele te dá o id do anexo e um booleano dizendo se foi enviado. Pra inspecionar o conteúdo, baixe via Download de anexo.

Quando usar

Auditoria

Saber o que cada assinante enviou antes de aprovar em lote.

Checagem de prontidão

Verificar se todos os anexos obrigatórios já chegaram.

Telas de revisão

Alimentar um backoffice interno com a fila de anexos pendentes.

Validação cruzada

Confirmar que um reenvio (após rejeição) realmente aconteceu.

Endpoint

GET
/api/v2/attachment/member/{memberId}
X-Api-Key<token>

Token de integracao. Envie no header X-Api-Key.

In: header

Path Parameters

memberId*integer
Formatint64

Header Parameters

Response Body

curl -X GET "https://example.com/api/v2/attachment/member/0"
Empty

Path parameters

CampoTipoDescrição
memberIdlongID do membro (o assinante dentro de uma operação). Não confundir com o id do contato/usuário. Obtido na resposta de Criar operação.

Resposta

{
  "data": [
    {
      "id": 12345,
      "isUploaded": true
    },
    {
      "id": 12346,
      "isUploaded": false
    }
  ]
}
CampoTipoSignificado
idlongID do anexo. Use em Download, Aprovar e Rejeitar.
isUploadedbooltrue quando o arquivo já foi enviado pelo assinante (status Review ou Completed). false quando ainda está em Progress (esperando upload) ou Canceled.

Estados internos do anexo

Internamente o anexo passa por um pequeno ciclo. O endpoint colapsa esses estados em isUploaded (true/false), mas é útil conhecer o quadro completo — ele aparece em outros endpoints e nas regras de aprovação:

Status internoisUploadedSignificado
ProgressfalseSlot criado, assinante ainda não fez upload (ou anexo foi rejeitado e aguarda reenvio).
ReviewtrueUpload feito, aguardando sua aprovação.
CompletedtrueAprovado por você.
CanceledfalseOperação cancelada antes da conclusão.

Erros comuns

StatusCasoDetalhe
404memberId não existeMembro não encontrado. Verifique o ID.
403Membro pertence a outra contaVocê só lista anexos de operações da sua conta.
401X-Api-Key ausente/invalidaVeja Autenticação.

Se o assinante não tem nenhum slot de anexo configurado, a resposta é data: [] (lista vazia) — não é erro. Anexos só existem quando attachments[] foi definido na criação da operação.

Veja também

On this page