Fluxo de upload documental - Plataforma ID

Como funciona

É permitida a configuração de um ou mais documentos, com título e obrigatoriedade, respectivamente. Após finalização do processo, a transação vai guardar informações desses documentos, como tipo, tamanho, entre outros.

Como obter o documento enviado

Com o webhook configurado, ao fim do processo será enviado no corpo da mensagem um objeto JSON com formato similar a esse:

{
  "requestId": "11111111-1111-4111-8111-111111111111",
  "resource": "upload",
  "cpf": "111.111.111-11",
  "status": "FINISHED",
  "uploadResponse": {
    "files": [
      {
        "id": "22222222-2222-4222-8222-222222222222",
        "created_at": "2026-09-17T18:04:14.841Z",
        "updated_at": "2026-09-17T18:04:14.841Z",
        "externalId": "11111111-1111-4111-8111-111111111111",
        "file_type": "pdf",
        "file_size": 13264,
        "file_name": "33333333-3333-4333-8333-333333333333.pdf",
        "file_path": "gcp/onboarding/44444444-4444-4444-8444-444444444444/55555555-5555-4555-8555-555555555555/step/11111111-1111-4111-8111-111111111111/33333333-3333-4333-8333-333333333333.pdf",
        "file_category": "Documento",
        "service": "step"
      }
    ],
    "status": "FINISHED"
  }
}

Cada objeto dentro de uploadResponse.files representa um arquivo que foi enviado. O valor em id pode ser usado no endpoint de download do storage para obter o conteúdo do arquivo em si.

⌘I