Consultar dados do beneficiário

Link para consultar os dados do beneficiário https://api.dentaluni.com.br/beneficiario/dados-completos

Metódo de consulta

GET/POST

Parâmetros

cpf = Número do CPF não obrigatório se informar o número do cartão
cartao = Número do cartão não obrigatório se informar o cpf
format = json,xml

Incluir dependentes

Link para incluir dependentes ao beneficiário https://api.dentaluni.com.br/beneficiario/comercial/inclusao-dependente

Metódo de consulta

POST

Parâmetros

dtNasc[] = Data de nascimento do dependente (Y-m-d) [array]
cpf[] = CPF do dependente [array]
nome[] = Nome do dependente [array]
rg[] = RG do dependente [array] (opcional)
orgEmiss[] = Orgão emissor do RG [array] (opcional)
cns[] = CNS do dependente [array] (opcional)
sexo[] = Sexo do dependente (F/M) [array]
estCivil[] = Código do estado civil do dependente [array]
parentesco[] = Código do parentesco do dependente com o titular [array]
nomeMae[] = Nome da mãe do dependente [array]
cartao = Número do cartão do titular
deps = Número de dependentes sendo incluídos
representante = Código do representante do contrato do titular (obrigatório somente se houver vendedor)
vendedor = Código do vendedor do contrato do titular (opcional)

Gerar token

Link para gerar token https://api.dentaluni.com.br/beneficiario/gerar-token

Metódo de consulta

GET/POST

Parâmetros

cpf = Número do CPF não obrigatório se informar o número do cartão
cartao = Número do cartão não obrigatório se informar o cpf
format = json,xml

Consultar status do beneficiário

Link para consultar status do beneficiário https://api.dentaluni.com.br/beneficiario/status

Metódo de consulta

GET/POST

Parâmetros

ncartao_cpf = Número do cartão ou CPF
format = json,xml

Consultar guia

Link para consultar atendimento utilizando numero da guia https://api.dentaluni.com.br/beneficiario/guia

Metódo de consulta

GET/POST

Parâmetros

ncartao = Número do cartão do usuário
guia = Número da guia
format = json,xml

Consultar guias

Link para consultar guias https://api.dentaluni.com.br/beneficiario/guias

Metódo de consulta

GET/POST

Parâmetros

ncartao = Número do cartão do beneficiário
pagina = Número da página os registros são listados em uma paginação de 50 format = json,xml

Informe de rendimentos

Link para consultar o informe de rendimentos https://api.dentaluni.com.br/beneficiario/informe-rendimentos

Metódo de consulta

GET/POST

Parâmetros

ncartao = Número do cartão hash do beneficiário
ano_base = Ano base para o relatório

Retorno

pdf = Arquivo pdf com o arquivo de rendimentos

Consultar adesão ao boleto digital

Link para consultar adesão ao boleto digital https://api.dentaluni.com.br/beneficiario/consulta-boleto-digital

Metódo de consulta

GET/POST

Parâmetros

ncartao = Número do cartão
format = json,xml

Retorno

error = true ou false
msg = Mensagem de informação
adesao = (TRUE) Já fez adesão ou (FALSE) ainda não aderiu

Adesão ao boleto digital

Link para consultar adesão ao boleto digital https://api.dentaluni.com.br/beneficiario/aderir-boleto-digital

Metódo de consulta

GET/POST

Parâmetros

ncartao = Número do cartão
email = E-mail para receber os boletos
format = json,xml

Retorno

error = true ou false
msg = Mensagem de informação

Consulta cartões bloqueados

Link para consultar cartões bloqueados https://api.dentaluni.com.br/beneficiario/cartoes/bloqueados

Metódo de consulta

GET

Parâmetros

cod_cli = Código do cliente
seq_assoc = Sequencial associado
format = json,xml

Desbloquear cartão

Link para desbloquear o cartão do beneficiário https://api.dentaluni.com.br/beneficiario/desbloquear/cartao

Metódo de consulta

GET/POST

Parâmetros

cartao = Recebe o número do cartão do beneficiário (obrigatório)

atualizarDados = Se irá fazer atualização de dados do beneficiário (true ou false) (default: false)
Se atualizarDados for true ao menos um dos parametros abaixo deve ser preenchido!
nomeMae = Nome da mãe (não obrigatório)
dataNascimento = Data de nascimento DD/MM/YYYY (não obrigatório)
sexo = Sexo (F ou M) (não obrigatório)
estadoCivil = Código estado cívil (não obrigatório)
rg = RG (não obrigatório)
orgaoExpRg = Cód Orgão expeditor do RG (não obrigatório)
ufEmissorRg = Cód Uf Emissor do RG (não obrigatório)
dataExpedicaoRg = Data de expedição do RG DD/MM/YYYY (não obrigatório)
email = E-mail (não obrigatório)
DDDTelefone = DDD Telefone (não obrigatório)
telefone = Telefone (não obrigatório)
DDDCelular = DDD Celular (não obrigatório)
celular = Celular (não obrigatório)
DDDCelularSms = DDD Celular SMS (não obrigatório)
celularSms = Celular SMS (não obrigatório)

cep = Cep (não obrigatório)
logradouro = Logradouro (não obrigatório)
numero = Númerdo do beneficiário (não obrigatório)
complemento = Complemento do endereço (não obrigatório)
codigoBairro = Código do bairro (não obrigatório)
codigoCidade = Código da cidade (não obrigatório)

Duplicatas

Link para consultar duplicatas do beneficiário https://api.dentaluni.com.br/beneficiario/duplicatas

Metódo de consulta

GET/POST

Parâmetros

ncartao = (Recebe o número do CRO informado na busca dentista)

Retorno

codigo = Código da duplicata
sequencia = Sequência da duplicata
situacao = Situação
descricao = Descrição
vencimento = Data de vencimento
valor = Valor do boleto
moramulta = Multa
outrosacrescimos = Acrécimos
valorcobrado = Valor do boleto
linha_digitavel = Código para pahamento do boleto
link = Link do boleto

Pesquisar carteirinha de um cliente

Link para consultar carteirinha https://api.dentaluni.com.br/beneficiario/carteirinha/cliente/{cpf}

Metódo de consulta

GET

Consultar detalhes de uma carteirinha

Link para consultar detalhes de uma carteirinha https://api.dentaluni.com.br/beneficiario/carteirinha/{numero}/cpf/{cpf}

Metódo de consulta

GET

Atualizar dados

Atualiza os dados do beneficiário https://api.dentaluni.com.br/beneficiario/atualizar/dados

Metódo de consulta

GET/POST

Parâmetros

ncartao = (Recebe o número da carteirinha do beneficiário)
abertura = (Recebe o id da da forma de abertura do chamado)
uf = (Recebe o estado)
cidade = (Recebe a cidade)
bairro = (Recebe o bairro)
logradouro = (Recebe o logradouro)
numero = (Recebe o número)
cep = (Recebe o CEP)
tel_ddd = (Recebe o DDD do telefone)
tel = (Recebe o número do telefone)
tel1_ddd = (Recebe o DDD do primeiro telefone)
tel1 = (Recebe o número do primeiro telefone)
tel2_ddd = (Recebe o DDD do segundo telefone)
tel2 = (Recebe o número do segundo telefone)
cel_ddd = (Recebe o DDD do celular)
cel = (Recebe o número do celular)
celsms_ddd = (Recebe o DDD do celular para sms)
celsms = (Recebe o número do celular para sms)

Retorno

error = true ou false
msg = Mensagem de informação
codigo_atendimento = Retorna o número do atendimento cadastrado
id_atendimento = Retorna o id do atendimento cadastrado que deve ser repassado para a tela do atendente

Cartões por CPF

Retorna os cartões do beneficiário https://api.dentaluni.com.br/beneficiario/cartoes

Metódo de consulta

POST

Parâmetros

cpf = (Recebe o CPF do beneficiário)

Retorno

error = true ou false
cartoes = Lista de cartões
qt = Quantidade de cadastros

Perguntas para validação

Retorna perguntas para validar o beneficiário https://api.dentaluni.com.br/validacoes/listar

Metódo de consulta

POST

Parâmetros

codigo = Recebe o codigo retornado na consulta Cartões por CPF
tipo = informar BENEFICIARIO

Retorno

id = Código da pergunta
tipo = Tipo de usuário BENEFICIARIO
texto = Pergunta

Validar resposta

Consulta para validar a resposta do beneficiário https://api.dentaluni.com.br/validacoes/validar/beneficiario

Metódo de consulta

POST

Parâmetros

codigo = Recebe o codigo retornado na consulta Cartões por CPF
id = Informar id retornado na consulta de perguntas
tipo = Informar BENEFICIARIO
local = Local onde está realizando a validação por exemplo (SITE, APP, DESBLOQUEIO)
valor = Resposta a ser validada

Retorno

telefone = Telefone para envio do token
email = Email para envio do token
error = true ou false
bloqueado = Bloqueio por tentativas incorretas
msg = Mensagem de retorno

Envio do token

Envia token para o beneficiário https://api.dentaluni.com.br/token/beneficiario

Metódo de consulta

POST

Parâmetros

codigo = Recebe o codigo retornado na consulta Cartões por CPF
local = Local onde está realizando a validação por exemplo (SITE, APP, DESBLOQUEIO)
telefone = Não obrigatório recebe apenas quando o número deverá ser corrigido
email = Não obrigatório recebe apenas quando o email deverá ser corrigido

Retorno

error = true ou false
msg = Mensagem de retorno

Confirma o token

Confirma o token informado pelo beneficiário https://api.dentaluni.com.br/token/beneficiario/confirmar

Metódo de consulta

POST

Parâmetros

codigo = Recebe o codigo retornado na consulta Cartões por CPF
local = Local onde está realizando a validação por exemplo (SITE, APP, DESBLOQUEIO)
token = Recebe o token informado pelo beneficiário
tipo = Tipo do token (EMAIL, SMS)
novo = Enviar este campo para desconsiderar o token de email

Retorno

error = true ou false
msg = Mensagem de retorno

Termos de desbloqueio

Texto de aceite para o desbloqueio do cartão https://api.dentaluni.com.br/beneficiario//desbloqueio/cartao/termos

Metódo de consulta

GET

Retorno

texto = Texto do termo

Desbloqueio de cartão com o token

Realiza o despbloqueio do cartão com o token https://api.dentaluni.com.br/beneficiario/desbloqueio

Metódo de consulta

POST

Parâmetros

token_email = Token recebido por email
token_sms = Token recebido por SMS
cartao = Cartão do nbeneficiário
nomeMae = Nome da mãe
dataNascimento = Data de nascimento no formato (d/m/Y)
sexo = Sexo no formato M ou F
estadoCivil =
cep = CEP do endereço
logradouro = Nome da rua
numero = Número do endereço
complemento = Complemento do endereço
bairro = Bairro do endereço
cidade = Cidade do beneficiário
uf = Estado do beneficiário
rg = RG do beneficiário não obrigatório
orgaoExpRg = Orgão RG do beneficiário não obrigatório
ufEmissorRg = Uf emissor do RG do beneficiário não obrigatório
dataExpedicaoRg = Data de expedição do RG do beneficiário não obrigatório
telefone = Telefone principal no formato (41)00000000 não obrigatório
telefone1 = Telefone no formato (41)00000000 não obrigatório
telefone2 = Telefone no formato (41)00000000 não obrigatório
celular = Celular principal no formato (410)00000000 não obrigatório se não informado será usado o número confirmado por sms
celular1 = Celular no formato (410)00000000 não obrigatório
celular2 = Celular no formato (410)00000000 não obrigatório
enviar_cartao = Não obrigatório, se informado envia uma cópia do cartão no email do beneficiário
novo = Campo deve ser enviado para desconsiderar a atualização cadastral e email

Retorno

protocolo = Número do protocolo de desbloqueio
error = true ou false
msg = Mensagem de retorno

Envia cartão virtual

Envia cartão virtual no email cadastrado do beneficiário https://api.dentaluni.com.br/beneficiario/beneficiario/enviar/cartao

Metódo de consulta

POST

Parâmetros

cartao = Recebe o codigo retornado na consulta Cartões por CPF
email = Recebe o email que receberá o cartão
email_faturamento = Recebe email para recebimento das faturas

Retorno

error = true ou false
msg = Mensagem de retorno