{
  "info": {
    "name": "ProValidFace API v1",
    "description": "Chamadas principais da API de verificacao de identidade do ProValidFace. Preencha as variaveis base_url e api_key da colecao. Use uma chave vf_test_ para o sandbox.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://api.provalidface.com.br/api/v1",
      "type": "string"
    },
    {
      "key": "api_key",
      "value": "vf_test_sua_chave_de_teste",
      "type": "string"
    }
  ],
  "auth": {
    "type": "bearer",
    "bearer": [
      {"key": "token", "value": "{{api_key}}", "type": "string"}
    ]
  },
  "item": [
    {
      "name": "Criar verificacao",
      "request": {
        "method": "POST",
        "header": [
          {"key": "Content-Type", "value": "application/json"},
          {"key": "Idempotency-Key", "value": "pedido-1042"}
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"journey\": \"padrao\",\n  \"external_reference\": \"pedido-1042\",\n  \"callback_url\": \"https://api.suaempresa.com.br/webhooks/validface\",\n  \"subject_cpf\": \"390.533.447-05\"\n}"
        },
        "url": {
          "raw": "{{base_url}}/verifications",
          "host": ["{{base_url}}"],
          "path": ["verifications"]
        },
        "description": "Abre uma sessao de verificacao. Unico campo obrigatorio: journey (leve, padrao ou rigorosa). Responde 201 com a sessao em pending e o session_url do titular."
      }
    },
    {
      "name": "Consultar verificacao",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "{{base_url}}/verifications/:id",
          "host": ["{{base_url}}"],
          "path": ["verifications", ":id"],
          "variable": [
            {"key": "id", "value": "3f1c8e0a-9d4b-4c2e-8a10-2b7c5e9f0a11"}
          ]
        },
        "description": "Le a sessao pelo id. Traz status, score, reasons e as etapas executadas."
      }
    },
    {
      "name": "Listar jornadas",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "{{base_url}}/journeys",
          "host": ["{{base_url}}"],
          "path": ["journeys"]
        },
        "description": "Lista as jornadas disponiveis para a empresa: as padrao da plataforma mais as personalizadas."
      }
    },
    {
      "name": "Consultar consumo",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "{{base_url}}/usage",
          "host": ["{{base_url}}"],
          "path": ["usage"]
        },
        "description": "Consumo da empresa: cota do mes, limite, situacao do trial e historico por status e por jornada."
      }
    },
    {
      "name": "Cadastrar webhook",
      "request": {
        "method": "POST",
        "header": [
          {"key": "Content-Type", "value": "application/json"}
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"url\": \"https://api.suaempresa.com.br/webhooks/validface\",\n  \"description\": \"Producao\"\n}"
        },
        "url": {
          "raw": "{{base_url}}/webhooks",
          "host": ["{{base_url}}"],
          "path": ["webhooks"]
        },
        "description": "Cadastra um endpoint de webhook. A resposta 201 traz o secret de assinatura uma unica vez."
      }
    },
    {
      "name": "Reenviar entrega de webhook",
      "request": {
        "method": "POST",
        "header": [],
        "url": {
          "raw": "{{base_url}}/webhooks/deliveries/:delivery_id/resend",
          "host": ["{{base_url}}"],
          "path": ["webhooks", "deliveries", ":delivery_id", "resend"],
          "variable": [
            {"key": "delivery_id", "value": "00000000-0000-0000-0000-000000000000"}
          ]
        },
        "description": "Reenfileira uma entrega que falhou ate o limite ou ficou parada. Responde 202 (reenfileirada), 409 (em andamento) ou 503 (fila indisponivel)."
      }
    }
  ]
}