Listar locais de atendimento
/v1/locaisRetorna locais de atendimento / rede credenciada de uma operadora.
Resposta repassada como a operadora envia, sem normalização: o formato desta rota é definido por ela, e pode ser uma lista. Leia o corpo como veio.
Em homologação SulAmérica esta consulta ainda depende de liberação de acesso: a resposta traz a mensagem da operadora informando que o corretor não tem permissão para o recurso. Valide o fluxo antes de usar em produção.
Headers
X-Cnpj-Provedorstringrequired
CNPJ da operadora de destino. É ele que define para qual operadora a requisição é encaminhada. Ex.: SulAmérica 01685053000156.
ex: 01685053000156X-Portal-Loginstring
Login do Portal Empresa da empresa cuja vida esta sendo movimentada ou consultada. Alternativa ao login do corpo nas escritas, e o unico canal nas consultas, que nao tem corpo. Enviado sempre junto de X-Portal-Senha: o par vem inteiro de uma fonte so (corpo OU header), nunca metade de cada. O corpo tem precedencia. Nunca e ecoado.
X-Portal-Senhastring
Senha do Portal Empresa, par de X-Portal-Login. Vai para a operadora exatamente como enviada, sem aparar espacos. Nunca e ecoada.
Responses
Resposta da operadora, repassada sem alteração de formato. Pode ser uma lista, e pode conter mensagem de negócio em vez de locais.
Formato definido pela operadora; não normalizado.
Ver schema bruto / exemplo JSON
{
"description": "Formato definido pela operadora; não normalizado."
}Requisição malformada (campos obrigatórios ausentes/ inválidos).
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.
Token ausente, expirado ou inválido.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.
Não foi possível concluir a operação junto à operadora.
Em consulta, sem repetir no corpo a falha pode ser transitória e nova tentativa é segura.
Em escrita (POST, PATCH, DELETE) o corpo traz repetir: false, e o desfecho é indeterminado: a operadora pode ter processado e só a resposta ter se perdido. Não reenvie. Se o corpo trouxer protocolo, consulte-o em GET /v1/movimentacoes/{protocolo}; se não, confira o beneficiário pelo CPF antes de tentar de novo.
Erro gerado pela própria API, antes ou depois de falar com a operadora. Formato distinto do Erro, que é usado quando o desfecho vem da operadora.
Motivo resumido.
Detalhe técnico, quando existe.
Quando false, não reenvie. Em consulta significa que repetir devolve o mesmo resultado; em escrita significa que o desfecho é indeterminado, porque a operadora pode ter processado e só a resposta ter se perdido. Ausente quando a falha pode ser transitória, o que só ocorre em consulta.
Protocolo da movimentação, quando a operadora devolveu um antes de falhar. **Em escrita com 502, consulte este protocolo em GET /v1/movimentacoes/{protocolo} em vez de reenviar.**
Caminho chamado na operadora, sem host. Para diagnóstico.
Resposta da operadora, para diagnóstico. Formato variável.
Outro status de transporte, repassado da operadora como veio (ex. 403, 404, 409, 429).
Não são desfecho de negócio. Rejeição da operadora chega em HTTP 200 com criticas; ausência de registro também é 200. Um status aqui indica problema de integração, não de cadastro, e vale acionar o suporte.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.
Listar locais de atendimento
/v1/locaisRetorna locais de atendimento / rede credenciada de uma operadora.
Resposta repassada como a operadora envia, sem normalização: o formato desta rota é definido por ela, e pode ser uma lista. Leia o corpo como veio.
Em homologação SulAmérica esta consulta ainda depende de liberação de acesso: a resposta traz a mensagem da operadora informando que o corretor não tem permissão para o recurso. Valide o fluxo antes de usar em produção.
Headers
X-Cnpj-Provedorstringrequired
CNPJ da operadora de destino. É ele que define para qual operadora a requisição é encaminhada. Ex.: SulAmérica 01685053000156.
ex: 01685053000156X-Portal-Loginstring
Login do Portal Empresa da empresa cuja vida esta sendo movimentada ou consultada. Alternativa ao login do corpo nas escritas, e o unico canal nas consultas, que nao tem corpo. Enviado sempre junto de X-Portal-Senha: o par vem inteiro de uma fonte so (corpo OU header), nunca metade de cada. O corpo tem precedencia. Nunca e ecoado.
X-Portal-Senhastring
Senha do Portal Empresa, par de X-Portal-Login. Vai para a operadora exatamente como enviada, sem aparar espacos. Nunca e ecoada.
Responses
Resposta da operadora, repassada sem alteração de formato. Pode ser uma lista, e pode conter mensagem de negócio em vez de locais.
Formato definido pela operadora; não normalizado.
Ver schema bruto / exemplo JSON
{
"description": "Formato definido pela operadora; não normalizado."
}Requisição malformada (campos obrigatórios ausentes/ inválidos).
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.
Token ausente, expirado ou inválido.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.
Não foi possível concluir a operação junto à operadora.
Em consulta, sem repetir no corpo a falha pode ser transitória e nova tentativa é segura.
Em escrita (POST, PATCH, DELETE) o corpo traz repetir: false, e o desfecho é indeterminado: a operadora pode ter processado e só a resposta ter se perdido. Não reenvie. Se o corpo trouxer protocolo, consulte-o em GET /v1/movimentacoes/{protocolo}; se não, confira o beneficiário pelo CPF antes de tentar de novo.
Erro gerado pela própria API, antes ou depois de falar com a operadora. Formato distinto do Erro, que é usado quando o desfecho vem da operadora.
Motivo resumido.
Detalhe técnico, quando existe.
Quando false, não reenvie. Em consulta significa que repetir devolve o mesmo resultado; em escrita significa que o desfecho é indeterminado, porque a operadora pode ter processado e só a resposta ter se perdido. Ausente quando a falha pode ser transitória, o que só ocorre em consulta.
Protocolo da movimentação, quando a operadora devolveu um antes de falhar. **Em escrita com 502, consulte este protocolo em GET /v1/movimentacoes/{protocolo} em vez de reenviar.**
Caminho chamado na operadora, sem host. Para diagnóstico.
Resposta da operadora, para diagnóstico. Formato variável.
Outro status de transporte, repassado da operadora como veio (ex. 403, 404, 409, 429).
Não são desfecho de negócio. Rejeição da operadora chega em HTTP 200 com criticas; ausência de registro também é 200. Um status aqui indica problema de integração, não de cadastro, e vale acionar o suporte.
Estrutura padronizada de erro.
Código HTTP do erro.
Código interno do erro.
Descrição legível do erro.
items
Crítica devolvida pela operadora. Em bloqueante: true rejeita (corrija e reenvie), false é aviso e a movimentação segue (ex. 2401), null a operadora não classificou.