A API de Seguros possibilita a utilização dos benefícios de Seguro Viagem, Seguro Garantia Estendida e Seguro Proteção de Compra por portadores de cartão Elo.

Seguros

Estados de verificação.

Utilizado, por exemplo, para verificação de contatos de um portador.

VerifiedStatus

UNVERIFIED

Iniciou-se o processo de verificação, porém ele ainda não foi concluído.
Após a conclusão mudará para `VERIFIED` ou `FAILED`.

PENDING

VERIFIED

FAILED

O processo de verificação não se aplica a este ítem.

NOT_APPLICABLE

Gender

FEMALE

MALE

OTHER

MaritalStatus

DIVORCED

MARRIED

SINGLE

WIDOWED

COMMON_LAW_MARRIED

Tipo do seguro.

Os tipo de seguro são:

- TRAVEL
- PURCHASEPROTECTION
- EXTENDEDWARRANTY

InsuranceType

TRAVEL

PURCHASEPROTECTION

EXTENDEDWARRANTY

Estados de processamento assíncrono.

Utilizado em processos assíncronos

RequestAsyncStatus

SUBMITTED

número do RG (dígitos) sem hífen ou pontos.

number

organização emissora do documento (exemplo: `SSP`)

issuerOrganization

estado de emissão do documento (exemplo: `SP`)

issuerState

issueDate

RGInput

cnpj

LegalIdsInput

Entrada com dados básicos para redes sociais.

Nome do provedor da rede social, ex: Facebook, Twitter...

provider

username

SocialNetworkInput

Entrada para mutação `requestSecondWayOfInsurancePolicy()`.

Compatível com [Relay](https://facebook.github.io/relay/docs/en/mutations.html).

Identificador de cliente opaco, normalmente em formato UUIDv4.

Deve ser usado por clientes para rastrear mutações e respostas,
podendo ser usado pelo servidor para perder requisições duplicadas
devido a falhas de rede e retransmissões.

Compatível com [Relay](https://facebook.github.io/relay/docs/en/mutations.html).

clientMutationId

Identificador Global Único do Seguro viagem a ser cancelado.

insuranceId

type

RequestSecondWayOfInsurancePolicyInput

Documento Legal (CNPJ ou CPF) que identifica o comerciante.

Apenas dígitos, sem hífen ou pontos.

legalId

name

legalName

MerchantInsuranceInput

Entrada para mutação `createExtendedWarrantyInsurance()`.

Compatível com [Relay](https://facebook.github.io/relay/docs/en/mutations.html).

BIN (_Bank Identification Number_) do cartão.

O BIN é um prefixo de tamanho variável (em geral entre 6 e 9
dígitos) do cartão que oferece o seguro. Para detalhes
sobre BINs, confira `binTable()`, a qual lista a faixa de
tamanhos de BIN, bem como os serviços (benefícios) oferecidos ao
portador.

Identificador global único do cartão para o qual o seguro está disponível.

cardId

merchant

invoiceNumber

invoiceDate

serialNumber

brand

model

description

value

Número de meses a estender a garantia original do fabricante.

extendedWarrantyMonths

Número de meses cobertos pela garantia do fabricante.

manufacturerWarrantyMonths

Identificador Global Único do ProductCategory.

productId

CreateExtendedWarrantyInsuranceInput

Entrada para mutação `createPurchaseProtectionInsurance()`.

Compatível com [Relay](https://facebook.github.io/relay/docs/en/mutations.html).

Número de dias para proteger o produto comprado.

**NOTA:** O número de dias pode resultar em custo adicional que
será automaticamente adicionado ao valor final pelo
sistema. Sempre informe o usuário do custo final total.

coverageDays

Identificador Global Único do `ProductCategory`.

CreatePurchaseProtectionInsuranceInput

companyTravel

journeyLocator

trips

Propósito da viagem (lazer, negócios...)

purpose

JourneyInput

Entrada para mutação `createTravelInsurance()`.

Compatível com [Relay](https://facebook.github.io/relay/docs/en/mutations.html).

journey

CreateTravelInsuranceInput

input

Inicia o processo de solicitar a segunda via do seguro.

requestSecondWayOfInsurancePolicy

Cria (emite) um Seguro de Garantia Estendida.

**Antes** de criar um seguro de extensão de garantia original, o
usuário da API deverá requisitar permissão para emitir seguros de
garantia estendida ao portador utilizando o processo de
**OAuth**. O processo de OAuth e renovação de _tokens_ de acesso
poderão pedir ao usuário que entre novamente com a senha e
confirme os dados do perfil antes de retornar o novo
`accessToken`.

Uma vez apresentados os detalhes do seguro, prossiga então para
coleta dos dados dos produtos (formulários) e então realize uma
chamada a `createExtendedWarrantyInsurance()` para cada produto.

Comerciantes que venderam produtos deverão informar
automaticamente os campos `invoiceNumber`, `invoiceDate`,
`serialNumber`, `brand`, `model`, `description` e `value`, não
sendo necessário que o usuário final digite esta informação
novamente.

Seguros podem ser cancelados com `cancelCardHolderInsurance()`
passando-se o identificador global único retornado em
`CreateExtendedWarrantyInsurancePayload {
extendedWarrantyInsurance { id } }`

> **NOTA:** Lembre-se que em GraphQL pode-se enviar várias
> mutações de uma única vez, logo não é necessário executar várias
> requisições HTTP ao servidor, faça apenas uma e diferencie cada
> pedido com `clientMutationId`.

createExtendedWarrantyInsurance

Cria (emite) um Seguro de Proteção de Compra de Produtos.

**Antes** de criar um seguro de proteção de compra de produtos, o
usuário da API deverá requisitar permissão para emitir seguros de
proteção de compra ao portador utilizando o processo de
**OAuth**. O processo de OAuth e renovação de _tokens_ de acesso
poderão pedir ao usuário que entre novamente com a senha e
confirme os dados do perfil antes de retornar o novo
`accessToken`.

Uma vez apresentados os detalhes do seguro, prossiga então para
coleta dos dados dos produtos (formulários) e então realize uma
chamada a `createPurchaseProtectionInsurance()` para cada produto.

Comerciantes que venderam produtos deverão informar
automaticamente os campos `invoiceNumber`, `invoiceDate`,
`serialNumber`, `brand`, `model`, `description` e `value`, não
sendo necessário que o usuário final digite esta informação
novamente.

Seguros podem ser cancelados com `cancelCardHolderInsurance()`
passando-se o identificador global único retornado em
`CreatePurchaseProtectionInsurancePayload {
PurchaseProtectionInsurance { id } }`

> **NOTA:** Lembre-se que em GraphQL pode-se enviar várias
> mutações de uma única vez, logo não é necessário executar várias
> requisições HTTP ao servidor, faça apenas uma e diferencie cada
> pedido com `clientMutationId`.

createPurchaseProtectionInsurance

Cria (emite) um Seguro Viagem.

**Antes** de criar um seguro viagem, o usuário da API deverá
requisitar permissão para emitir seguros viagem ao portador
utilizando o processo de **OAuth**. O processo de OAuth e
renovação de _tokens_ de acesso poderão pedir ao usuário que entre
novamente com a senha e confirme os dados do perfil antes de
retornar o novo `accessToken`.

Uma vez apresentados os detalhes do seguro, prossiga então para
coleta dos dados dos viajantes (formulários) e então realize uma
chamada a `createTravelInsurance()` para cada viajante.

A emissão de seguro ao portador e sem listagem de beneficiários
explícitos deverá ser tratada pela interface de forma "rápida",
apenas o propósito da viagem deve ser perguntado ao usuário.

Comerciantes que emitiram as passagens deverão informar
automaticamente os campos `startDate`e `endDate`, não sendo
necessário que o usuário final digite esta informação
novamente. Caso o seguro permita outros viajantes
(`allowsOtherTravelers`), os dados destes também deverão ser
automaticamente populados caso sejam conhecidos.

Seguros podem ser cancelados com `cancelCardHolderInsurance()`
passando-se o identificador global único retornado em
`CreateTravelInsurancePayload { travelInsurance { id } }`

> **NOTA:** Lembre-se que em GraphQL pode-se enviar várias
> mutações de uma única vez, logo não é necessário executar várias
> requisições HTTP ao servidor, faça apenas uma e diferencie cada
> pedido com `clientMutationId`.

createTravelInsurance

Identificador opaco da categoria de produto

productCategoryId

Se `null` ou vazio, não realiza filtragem.
Caso contrário, define texto que deve estar contido display da categoria de produto.

displayContains

Consulta todas as categorias de produtos.

O outro campo retornado na lista é o texto a ser exibido
(`display`) para o usuário na seleção da categoria.

Esta lista é raramente modificada e pode (deve) ser armazenada do
lado do integrador por até um dia.

insuranceProductCategory

Procura o usuário pelo identificador global único

Procura o usuário pelo seu `username` na rede social especificada.

socialNetwork

Procura pelo usuário associado ao portador de cartões com o
identificador global único especificado.

cardHolderId

Procura pelo usuário associado ao comerciante com o
identificador global único especificado.

Caso o comerciante tenha mais de um usuário responsável, retorna
o mais antigo.

merchantId

_Query_ (consulta) de usuário por vários meios de entrada.

Esta consulta deve ser feita com apenas um parâmetro não-`null`
para designar o método de procura. Utilizar mais de um pode
resultar em resultados distintos em cada chamada.

user

Identificador Global Único para este objeto.

Texto a ser exibido ao usuário em formulários e consultas.

display

ProductCategory

products

InsuranceProductCategory

Toda a possível identificação legal de uma pessoa ou empresa

LegalIds

Renda anual de uma pessoa física (individual e familiar).

Renda anual pessoal (individual) da pessoa física.

personal

Renda anual total da família da pessoa física.

family

Moeda associada aos valores informados.

Código da moeda com 3 letras
[ISO4217](https://en.wikipedia.org/wiki/ISO_4217)
Exemplo: `EUR`, `USD`, `BRL`...

currency

PersonYearlyIncome

Profissão (ocupação) de uma pessoa física.

Identificador opaco da Profissão

Deve ser informado como entrada em mutações que precisam de profissão.

Texto a ser exibido ao usuário em formulários e consultas.

Este texto é localizado (traduzido) para a linguagem informada na
consulta.

PersonOccupation

width

height

Tipo do arquivo na convenção (_MIME - Multipurpose Internet Mail
Extensions_), como `image/png`, `image/jpeg`

mimeType

ImageUrl

Ítem de contato com pessoa física, como email ou telefone...

Com o intuito de manter a privacidade, o campo `value` pode ser
mascarado.

Identificador global único para este objeto

Tipo designa como interpretar o valor, podendo ser telefone,
email, ou aplicativo de mensagens instantâneas.

Contexto do contato, que varia com o tipo:
 - Se o tipo for `PHONE`, `WHATSAPP` ou `EMAIL`, este poderia ser: vendas, suporte ...
 - Se o tipo for `IM`, pode ser: skype, whatsapp, facebook messenger...
 - Se for `OTHER`, pode ser qualquer texto

context

Valor do contato. Exemplos: `+12345678` para telefone,
`user@server.com` para email, etc.

Este campo pode ser transformado dependendo de regras de acesso e
permissões. Um comerciante pode receber valores mascarados com o
intuito de manter a privacidade da pessoa física. Um exemplo seria
receber apenas os últimos 4 dígitos do telefone, ou apenas as
primeiras letras do email seguida do domínio.

O processo de verificação é feito por nosso sistema enviando uma
mensagem ao contato e então pedindo que a chave enviada seja
reenviada ao sistema.

> **NOTA:** apenas os tipos de contatos `PHONE` e `EMAIL` são
> verificáveis. Os demais retornarão sempre `NOT_APPLICABLE`.

verified

PersonContact

Endereço Físico Mundial, que pode ser usado para envios ou contas

Contexto do endereço, por exemplo: Casa, Trabalho, Matriz, Filial

Análogo a campo de mesmo nome em `PersonContact` e `CompanyContact`.

Código do país com 3 letras
([ISO3166-alpha3](https://pt.wikipedia.org/wiki/ISO_3166-1_alfa-3)).
Exemplos: `USA`, `BRA`...

country

city

abbrev

Nome do estado por completo ou abreviado (opcional).

Abreviações de estados podem não estar disponíveis para alguns países,
casos em que o nome por completo é retornado.

state

district

O tipo deve ser `Av.` (Avenida), `R.` (Rua), `Rd.` (Rodovia)...

kind

Nome da via, para ser usado em conjunto com `kind` e `number`, compondo
a primeira linha de endereço.

place

Complemento opcional, como número de apartamento.

complement

Ponto de referência (exemplo: próximo ao posto)

reference

Instruções (exemplo: autorização do receptor)

instructions

Longitude, opcional: em graus.

Contém a longitude caso seja manualmente provido ou automaticamente
descoberto à partir do endereço. Caso não seja possível prover, será
`null`.

Latitude, opcional: em graus.

Contém a latitude caso seja manualmente provido ou automaticamente
descoberto à partir do endereço. Caso não seja possível prover, será
`null`.

Address

Portador de cartão

Usualmente uma pessoa

Identificador Global Único para este objeto

Nome completo do portador como nos documentos oficiais (RG, CPF)

firstName

lastName

Nome de usuário a ser exibido (exemplo: encurtado, alias...)

displayName

Nome da empresa.

Para cartões corporativos (pessoa jurídica), este campo informa o
nome fantasia da empresa. Para a razão social, veja
`companyLegalName`.

Para cartões de pessoa física será sempre `null`.

companyName

Nome legal da empresa, como escrito em documentos.

Para cartões corporativos (pessoa jurídica), este campo informa a
razão social da empresa. Para nome fantasia, veja `companyName`

Para cartões de pessoa física será sempre `null`.

companyLegalName

Todos os documentos legais de identificação de empresas ou pessoas.

legalIds

birthday

Masculino ou Feminino, conforme documentos oficiais

gender

maritalStatus

Renda anual do portador (individual e familiar).

Este campo é informacional e pode ser utilizado no preenchimento
de formulários de outros serviços, por exemplo para emissão de
seguros.

income

Língua a ser utilizada no retorno da consulta.

Por padrão adota-se a língua de quem faz a requisição, porém uma
diferente pode ser requisitada e está será utilizada, ou a mais
próxima disponível. O formato é: `en_US` (Inglês dos EUA), `en`
(Inglês genérico), `pt_BR` (Português do Brasil), `pt`
(Português genérico). O formato é o mesmo de [IETF language
tag](https://en.wikipedia.org/wiki/IETF_language_tag).

language

Profissão do portador.

Este campo é informacional e pode ser utilizado no preenchimento
de formulários de outros serviços, por exemplo para emissão de
seguros.

Por padrão adota-se a língua de quem faz a requisição, porém uma
diferente pode ser requisitada e está será utilizada, ou a mais
próxima disponível. O formato é: `en_US` (Inglês dos EUA), `en`
(Inglês genérico), `pt_BR` (Português do Brasil), `pt` (Português
genérico). O formato é o mesmo de [IETF language
tag](https://en.wikipedia.org/wiki/IETF_language_tag).

occupation

Caso fornecido, largura da imagem, em _pixels_.

Caso fornecido, altura da imagem, em _pixels_.

Caso fornecido, o tipo de arquivo desejado (`mime-type`).

URL para foto de perfil.
Caso sejam providos sugestões de altura e largura (opcionais) para
o tamanho a ser mostrado, o servidor irá retornar a URL para a imagem
com o tamanho mais próximo ao requisitado.
Caso seja provido o `mimeType`, a este será dada preferência, o que
é muito útil em dispositivos que lidam com um único formato de imagens.
Tanto o tamanho quanto o `mimeType` da imagem apontada pela URL
são retornados.