Skip to main content

​
O que é

Disponibilizamos uma coleção Postman com os endpoints documentados de todos os produtos da Plataforma ID: Assinatura Digital, Documentoscopia, ID Check, Card Check, TrustPass, Background Check, Storage, Mensageria e Onboarding. Use-a para explorar as requisições, testar chamadas com suas próprias credenciais e acelerar o início da integração com a plataforma.

​
Qual arquivo baixar

A coleção é disponibilizada em dois formatos, com o mesmo conteúdo:
  • JSON (Collection v2.1): para importar em um workspace na nuvem do Postman (File > Import) ou em outras ferramentas compatíveis com o formato v2.1.
  • YAML (Collection v3): para o Local Mode do Postman, que não aceita mais coleções em JSON. É um .zip com a pasta da coleção no formato v3.

​
Como usar

  1. Baixe o arquivo da coleção no formato adequado ao seu uso.
  2. Importe no Postman:
    • Workspace na nuvem: File > Import e selecione o arquivo JSON.
    • Local Mode: extraia o .zip e mova a pasta Plataforma ID - Todas as APIs para dentro da pasta do seu projeto aberto no Postman. Ela passa a ser reconhecida como coleção local.
  3. Configure as variáveis da coleção:
    • base_url: a URL base do ambiente que você vai utilizar.
    • api_key: sua chave de API, enviada como header x-api-key em todos os requests. Os endpoints de sessão de assinatura e de validação de envelope, em Assinatura Digital, não exigem chave e não enviam o header.
  4. Preencha as demais variáveis conforme for usando a coleção, com os identificadores retornados pelas chamadas anteriores:
    • requestId e externalId: processos do Onboarding e requisições do Background Check.
    • id: pacotes de datasets, documentos e transações.
    • storageFileId e fileId: arquivos no Storage.
    • uuid, signerUuid, sessionToken e sessionUuid: envelopes, templates, signatários e sessões da Assinatura Digital.
Os requests trazem exemplos de corpo prontos para envio e, nos produtos Background Check e Onboarding, exemplos de resposta para consulta.

Baixar coleção (JSON v2.1)

Para importar em um workspace na nuvem do Postman

Baixar coleção (YAML v3)

Para o Local Mode do Postman