Listar apólices de um pedido

Lista as apólices geradas por um pedido emitido — a forma de descobrir as policy_key de um pedido, já que a consulta de pedido não retorna apólices. Retorna resumos; para o detalhe completo, use a consulta de apólice.

Request

ENDPOINT

/v1/insurance/policies

MÉTODO

GET

Query params

Parâmetro	Tipo	Obrigatoriedade	Descrição
order_key	string	obrigatório	Chave do pedido cujas apólices serão listadas.

Exemplo de chamada

GET /v1/insurance/policies?order_key=5e2b3f60-7c4b-4c8e-9f1a-6d2e8b4a7c90

Response

STATUS

200

Response Body

{
  "order_key": "5e2b3f60-7c4b-4c8e-9f1a-6d2e8b4a7c90",
  "policies": [
    {
      "policy_key": "0b6e7c1a-9a4e-4c1e-b1d4-2f5a8c9e0d31",
      "provider_product_key": "9d1f8c7a-3b21-4e60-8a2f-1c5d7e9b0a44",
      "provider_key": "c4a2e8b0-1f6d-4e3a-9c7b-5d0a2e8f4b61",
      "status": "issued",
      "external_policy_number": "APL-2026-000123",
      "gross_premium_amount": 617.28,
      "term": {
        "start_date": "2026-07-16",
        "end_date": "2027-07-15"
      },
      "created_at": "2026-07-16T14:03:25.481Z"
    }
  ]
}

Atributos da resposta

Campo	Tipo	Descrição
order_key	string	Chave do pedido consultado.
policies	array	Resumo de cada apólice do pedido. Os campos são um subconjunto da consulta de apólice.

Consistência eventual após a emissão

As apólices são criadas de forma assíncrona logo após o webhook de emitted do pedido. Imediatamente após a emissão, esta lista pode vir vazia ou menor que o product_count do webhook enquanto as apólices são materializadas. Aguarde os webhooks de apólice ou consulte novamente em instantes.

Um order_key desconhecido, ainda não processado ou pertencente a outra integração retorna 200 com a lista vazia — os casos são indistinguíveis.

Possíveis erros

Todo erro (non-2xx) retorna o corpo padrão { "title", "description", "translation", "code" } — trate programaticamente apenas o campo code.

Status	Código	Descrição
400	QIT000001	Parâmetro order_key ausente.
401 / 403	—	Falha de autenticação ou autorização.
429	—	Limite de requisições excedido — repita com backoff.
500	QIT000500	Erro interno — seguro repetir a chamada.
503	POL000030	Serviço indisponível — seguro repetir a chamada.