Obtém uma credencial pelo Id

GET

/api/v2/credenciais/{credenciaisId}

Authorizations

• bearerAuth
• ApiKey
• oauth2

Parameters

Path Parameters

credenciaisId

required

string format: uuid

Responses

200

Obtém uma credencial pelo Id

object

sucesso

boolean

erros

Array<string>

nullable

data

object

id

string format: uuid

nullable

clienteId

string format: uuid

tiposCredenciais

object

id

string format: uuid

nullable

operadoras

object

id

string format: uuid

nullable

registro_ans

string

nullable

cnpj

string

nullable

razao_social

string

nullable

ativa

boolean

email

string

nullable

site

string

nullable

representante_nome

string

nullable

representante_cargo

string

nullable

autorizacao_funcionamento_em

string format: date-time

nullable

concessao_registro_definitivo_em

string format: date-time

nullable

registrada_em

string format: date-time

nullable

classificacao_sigla

string

nullable

classificacao_nome

string

nullable

endereco_logradouro

string

nullable

endereco_numero

string

nullable

endereco_complemento

string

nullable

endereco_bairro

string

nullable

endereco_cep

string

nullable

endereco_municipio_codigo

string

nullable

endereco_municipio_nome

string

nullable

endereco_uf_sigla

string

nullable

endereco_valido

boolean

telefone_ddd

string

nullable

telefone_numero

string

nullable

fax_ddd

string

nullable

fax_numero

string

nullable

nome_fantasia

string

nullable

segmentacao_sigla

string

nullable

segmentacao_nome

string

nullable

portalFaturamento

string

nullable

portalAutorizacao

string

nullable

webservice

string

nullable

sistema

string

nullable

idExterno

string

nullable

padraoAcesso

string

nullable

requerToken

string

nullable

utilizaOrizon

boolean

gerenciaSessao

boolean

codigoOperadora

string

nullable

requerGuiaPrestador

boolean

operadorasId

string format: uuid

nomeAmigavel

string

nullable

codigoOperadora

string

nullable

hasCpf

boolean

hasCnpj

boolean

hasTipoLogin

boolean

hasUnidadeLogin

boolean

authThenExec

boolean

hasEligibility

boolean

tiposCredencialElegibility

object recursive

tiposCredencialElegibilityId

string format: uuid

nullable

coordenadaX

number format: double

nullable

coordenadaY

number format: double

nullable

largura

number format: double

nullable

altura

number format: double

nullable

coordenadaXResponsavel

number format: double

nullable

coordenadaYResponsavel

number format: double

nullable

coordenadaXContratado

number format: double

nullable

coordenadaYContratado

number format: double

nullable

coordenadaXSolicitante

number format: double

nullable

coordenadaYSolicitante

number format: double

nullable

iconeX

number format: double

nullable

iconeY

number format: double

nullable

iconeResponsavelX

number format: double

nullable

iconeResponsavelY

number format: double

nullable

iconeContratadoX

number format: double

nullable

iconeContratadoY

number format: double

nullable

iconeSolicitanteX

number format: double

nullable

iconeSolicitanteY

number format: double

nullable

validadeAssinatura

string format: date-time

validadeAssinaturaDias

integer format: int32

nullable

urlPortal

string

nullable

authorizationInfoAfterExecution

boolean

limiteProcedimentosPorRequisicao

integer format: int32

exibirTesteValidacao

boolean

tiposAnexosAceitos

Array<string>

nullable

formatoCapturaBiometriaFacial

string

nullable

limitOfProceduresPerRequest

integer format: int32

nullable

tipoArquivos

Array<object>

nullable

object

id

integer format: int64

nome

string

nullable

contentType

string

nullable

extensoes

Array<string>

nullable

tiposCredenciaisId

string format: uuid

nome

string

nullable

codigoPrestador

string

nullable

observacoes

string

nullable

login

string

nullable

senha

string

nullable

cpf

string

nullable

cnpj

string

nullable

tipoLogin

string

nullable

unidadeLogin

string

nullable

tabela

string

nullable

hasBiometrics

boolean

hasExecution

boolean

visivel

boolean

ativa

boolean

acceptJustification

boolean

solicitaTokenPreAutorizacao

boolean

requerTokenAutorizacao

boolean

obrigarAnexoNaAutorizacao

boolean

minimoAnexosPreAutorizacao

integer format: int32

nomeContratado

string

nullable

createdAt

string format: date-time

updatedAt

string format: date-time

nullable

credencialElegibility

object recursive

credencialElegibilityId

string format: uuid

nullable

tiposToken

Array<object>

nullable

object

id

string

nullable

descricao

string

nullable

tipoPermissao

string

Allowed values: Nenhum Usuario Unidade PontoAtendimento

arquivo

object

base64

string

nullable

name

string

nullable

path

string

nullable

type

string

nullable

size

integer format: int32

novo

boolean

id

string format: uuid

nullable

nomeAnexo

string

nullable

tamanhoAnexo

integer format: int32

caminhoStorage

string

nullable

nomeOriginal

string

nullable

conselho

string

nullable

ufConselho

string

nullable

numeroConselho

string

nullable

nomeSolicitante

string

nullable

especialidadeSolicitante

object

label

string

nullable

value

integer format: int32

executantePadrao

object

id

string format: uuid

nullable

clienteId

string format: uuid

pessoaId

string format: uuid

nullable

pessoa

object

id

string format: uuid

nullable

nome

string

nullable

razaoSocial

string

nullable

tipo

string

nullable

sexo

string

nullable

dataNascimento

string format: date-time

nullable

cpfCnpj

string

nullable

rg

string

nullable

ie

string

nullable

situacao

string

nullable

mae

string

nullable

pai

string

nullable

telefone1

string

nullable

telefone2

string

nullable

telefone1DDI

string

nullable

telefone2DDI

string

nullable

site

string

nullable

email

string

nullable

observacoes

string

nullable

foto

string

nullable

usa2FA

boolean

idEndereco

string format: uuid

nullable

endereco

object

id

string format: uuid

nullable

logradouro

string

nullable

numero

string

nullable

bairro

string

nullable

cep

string

nullable

complemento

string

nullable

idCidade

integer format: int32

cidade

object

idCidade

integer format: int32

nullable

nome

string

nullable

ibge

integer format: int32

nullable

idEstado

integer format: int32

estado

object

idEstado

integer format: int32

nullable

nome

string

nullable

sigla

string

nullable

idUsuarioInclusao

string format: uuid

dataInclusao

string format: date-time

idUsuarioAlteracao

string format: uuid

nullable

dataAlteracao

string format: date-time

nullable

idUsuarioExclusao

string format: uuid

nullable

dataExclusao

string format: date-time

nullable

idade

integer format: int32

cboId

string format: uuid

nullable

nome

string

nullable

cpfCnpj

string

nullable

registroConselho

string

nullable

idTipoConselho

integer format: int32

nullable

ufConselho

string

nullable

conselho

object

idTipoConselho

integer format: int32

siglaConselho

string

nullable

nomeConselho

string

nullable

cbo

object

id

string format: uuid

codigo

string

nullable

descricao

string

nullable

tipo

string

nullable

situacao

string

nullable

grupo

string

nullable

versao

string

nullable

executantePadrao

boolean

especialidades

Array<object>

nullable

object

id

string format: uuid

nullable

profissionalId

string format: uuid

nullable

especialidadeId

integer format: int32

nullable

padrao

boolean

especialidade

object

label

string

nullable

value

integer format: int32

indicacaoClinicaTexto

string

nullable

indicacaoClinicaMin

integer format: int32

indicacaoClinicaMax

integer format: int32

regimeAtendimento

string

nullable

tipoAcidente

string

nullable

tipoConsulta

string

nullable

procedimentosPorGuia

integer format: int32

permitirAssinaturaBeneficiario

boolean

permitirAssinaturaResponsavel

boolean

permitirAssinaturaContratado

boolean

permitirAssinaturaSolicitante

boolean

object

sucesso

boolean

erros

Array<string>

nullable

data

object

id

string format: uuid

nullable

clienteId

string format: uuid

tiposCredenciais

object

id

string format: uuid

nullable

operadoras

object

id

string format: uuid

nullable

registro_ans

string

nullable

cnpj

string

nullable

razao_social

string

nullable

ativa

boolean

email

string

nullable

site

string

nullable

representante_nome

string

nullable

representante_cargo

string

nullable

autorizacao_funcionamento_em

string format: date-time

nullable

concessao_registro_definitivo_em

string format: date-time

nullable

registrada_em

string format: date-time

nullable

classificacao_sigla

string

nullable

classificacao_nome

string

nullable

endereco_logradouro

string

nullable

endereco_numero

string

nullable

endereco_complemento

string

nullable

endereco_bairro

string

nullable

endereco_cep

string

nullable

endereco_municipio_codigo

string

nullable

endereco_municipio_nome

string

nullable

endereco_uf_sigla

string

nullable

endereco_valido

boolean

telefone_ddd

string

nullable

telefone_numero

string

nullable

fax_ddd

string

nullable

fax_numero

string

nullable

nome_fantasia

string

nullable

segmentacao_sigla

string

nullable

segmentacao_nome

string

nullable

portalFaturamento

string

nullable

portalAutorizacao

string

nullable

webservice

string

nullable

sistema

string

nullable

idExterno

string

nullable

padraoAcesso

string

nullable

requerToken

string

nullable

utilizaOrizon

boolean

gerenciaSessao

boolean

codigoOperadora

string

nullable

requerGuiaPrestador

boolean

operadorasId

string format: uuid

nomeAmigavel

string

nullable

codigoOperadora

string

nullable

hasCpf

boolean

hasCnpj

boolean

hasTipoLogin

boolean

hasUnidadeLogin

boolean

authThenExec

boolean

hasEligibility

boolean

tiposCredencialElegibility

object recursive

tiposCredencialElegibilityId

string format: uuid

nullable

coordenadaX

number format: double

nullable

coordenadaY

number format: double

nullable

largura

number format: double

nullable

altura

number format: double

nullable

coordenadaXResponsavel

number format: double

nullable

coordenadaYResponsavel

number format: double

nullable

coordenadaXContratado

number format: double

nullable

coordenadaYContratado

number format: double

nullable

coordenadaXSolicitante

number format: double

nullable

coordenadaYSolicitante

number format: double

nullable

iconeX

number format: double

nullable

iconeY

number format: double

nullable

iconeResponsavelX

number format: double

nullable

iconeResponsavelY

number format: double

nullable

iconeContratadoX

number format: double

nullable

iconeContratadoY

number format: double

nullable

iconeSolicitanteX

number format: double

nullable

iconeSolicitanteY

number format: double

nullable

validadeAssinatura

string format: date-time

validadeAssinaturaDias

integer format: int32

nullable

urlPortal

string

nullable

authorizationInfoAfterExecution

boolean

limiteProcedimentosPorRequisicao

integer format: int32

exibirTesteValidacao

boolean

tiposAnexosAceitos

Array<string>

nullable

formatoCapturaBiometriaFacial

string

nullable

limitOfProceduresPerRequest

integer format: int32

nullable

tipoArquivos

Array<object>

nullable

object

id

integer format: int64

nome

string

nullable

contentType

string

nullable

extensoes

Array<string>

nullable

tiposCredenciaisId

string format: uuid

nome

string

nullable

codigoPrestador

string

nullable

observacoes

string

nullable

login

string

nullable

senha

string

nullable

cpf

string

nullable

cnpj

string

nullable

tipoLogin

string

nullable

unidadeLogin

string

nullable

tabela

string

nullable

hasBiometrics

boolean

hasExecution

boolean

visivel

boolean

ativa

boolean

acceptJustification

boolean

solicitaTokenPreAutorizacao

boolean

requerTokenAutorizacao

boolean

obrigarAnexoNaAutorizacao

boolean

minimoAnexosPreAutorizacao

integer format: int32

nomeContratado

string

nullable

createdAt

string format: date-time

updatedAt

string format: date-time

nullable

credencialElegibility

object recursive

credencialElegibilityId

string format: uuid

nullable

tiposToken

Array<object>

nullable

object

id

string

nullable

descricao

string

nullable

tipoPermissao

string

Allowed values: Nenhum Usuario Unidade PontoAtendimento

arquivo

object

base64

string

nullable

name

string

nullable

path

string

nullable

type

string

nullable

size

integer format: int32

novo

boolean

id

string format: uuid

nullable

nomeAnexo

string

nullable

tamanhoAnexo

integer format: int32

caminhoStorage

string

nullable

nomeOriginal

string

nullable

conselho

string

nullable

ufConselho

string

nullable

numeroConselho

string

nullable

nomeSolicitante

string

nullable

especialidadeSolicitante

object

label

string

nullable

value

integer format: int32

executantePadrao

object

id

string format: uuid

nullable

clienteId

string format: uuid

pessoaId

string format: uuid

nullable

pessoa

object

id

string format: uuid

nullable

nome

string

nullable

razaoSocial

string

nullable

tipo

string

nullable

sexo

string

nullable

dataNascimento

string format: date-time

nullable

cpfCnpj

string

nullable

rg

string

nullable

ie

string

nullable

situacao

string

nullable

mae

string

nullable

pai

string

nullable

telefone1

string

nullable

telefone2

string

nullable

telefone1DDI

string

nullable

telefone2DDI

string

nullable

site

string

nullable

email

string

nullable

observacoes

string

nullable

foto

string

nullable

usa2FA

boolean

idEndereco

string format: uuid

nullable

endereco

object

id

string format: uuid

nullable

logradouro

string

nullable

numero

string

nullable

bairro

string

nullable

cep

string

nullable

complemento

string

nullable

idCidade

integer format: int32

cidade

object

idCidade

integer format: int32

nullable

nome

string

nullable

ibge

integer format: int32

nullable

idEstado

integer format: int32

estado

object

idEstado

integer format: int32

nullable

nome

string

nullable

sigla

string

nullable

idUsuarioInclusao

string format: uuid

dataInclusao

string format: date-time

idUsuarioAlteracao

string format: uuid

nullable

dataAlteracao

string format: date-time

nullable

idUsuarioExclusao

string format: uuid

nullable

dataExclusao

string format: date-time

nullable

idade

integer format: int32

cboId

string format: uuid

nullable

nome

string

nullable

cpfCnpj

string

nullable

registroConselho

string

nullable

idTipoConselho

integer format: int32

nullable

ufConselho

string

nullable

conselho

object

idTipoConselho

integer format: int32

siglaConselho

string

nullable

nomeConselho

string

nullable

cbo

object

id

string format: uuid

codigo

string

nullable

descricao

string

nullable

tipo

string

nullable

situacao

string

nullable

grupo

string

nullable

versao

string

nullable

executantePadrao

boolean

especialidades

Array<object>

nullable

object

id

string format: uuid

nullable

profissionalId

string format: uuid

nullable

especialidadeId

integer format: int32

nullable

padrao

boolean

especialidade

object

label

string

nullable

value

integer format: int32

indicacaoClinicaTexto

string

nullable

indicacaoClinicaMin

integer format: int32

indicacaoClinicaMax

integer format: int32

regimeAtendimento

string

nullable

tipoAcidente

string

nullable

tipoConsulta

string

nullable

procedimentosPorGuia

integer format: int32

permitirAssinaturaBeneficiario

boolean

permitirAssinaturaResponsavel

boolean

permitirAssinaturaContratado

boolean

permitirAssinaturaSolicitante

boolean

object

sucesso

boolean

erros

Array<string>

nullable

data

object

id

string format: uuid

nullable

clienteId

string format: uuid

tiposCredenciais

object

id

string format: uuid

nullable

operadoras

object

id

string format: uuid

nullable

registro_ans

string

nullable

cnpj

string

nullable

razao_social

string

nullable

ativa

boolean

email

string

nullable

site

string

nullable

representante_nome

string

nullable

representante_cargo

string

nullable

autorizacao_funcionamento_em

string format: date-time

nullable

concessao_registro_definitivo_em

string format: date-time

nullable

registrada_em

string format: date-time

nullable

classificacao_sigla

string

nullable

classificacao_nome

string

nullable

endereco_logradouro

string

nullable

endereco_numero

string

nullable

endereco_complemento

string

nullable

endereco_bairro

string

nullable

endereco_cep

string

nullable

endereco_municipio_codigo

string

nullable

endereco_municipio_nome

string

nullable

endereco_uf_sigla

string

nullable

endereco_valido

boolean

telefone_ddd

string

nullable

telefone_numero

string

nullable

fax_ddd

string

nullable

fax_numero

string

nullable

nome_fantasia

string

nullable

segmentacao_sigla

string

nullable

segmentacao_nome

string

nullable

portalFaturamento

string

nullable

portalAutorizacao

string

nullable

webservice

string

nullable

sistema

string

nullable

idExterno

string

nullable

padraoAcesso

string

nullable

requerToken

string

nullable

utilizaOrizon

boolean

gerenciaSessao

boolean

codigoOperadora

string

nullable

requerGuiaPrestador

boolean

operadorasId

string format: uuid

nomeAmigavel

string

nullable

codigoOperadora

string

nullable

hasCpf

boolean

hasCnpj

boolean

hasTipoLogin

boolean

hasUnidadeLogin

boolean

authThenExec

boolean

hasEligibility

boolean

tiposCredencialElegibility

object recursive

tiposCredencialElegibilityId

string format: uuid

nullable

coordenadaX

number format: double

nullable

coordenadaY

number format: double

nullable

largura

number format: double

nullable

altura

number format: double

nullable

coordenadaXResponsavel

number format: double

nullable

coordenadaYResponsavel

number format: double

nullable

coordenadaXContratado

number format: double

nullable

coordenadaYContratado

number format: double

nullable

coordenadaXSolicitante

number format: double

nullable

coordenadaYSolicitante

number format: double

nullable

iconeX

number format: double

nullable

iconeY

number format: double

nullable

iconeResponsavelX

number format: double

nullable

iconeResponsavelY

number format: double

nullable

iconeContratadoX

number format: double

nullable

iconeContratadoY

number format: double

nullable

iconeSolicitanteX

number format: double

nullable

iconeSolicitanteY

number format: double

nullable

validadeAssinatura

string format: date-time

validadeAssinaturaDias

integer format: int32

nullable

urlPortal

string

nullable

authorizationInfoAfterExecution

boolean

limiteProcedimentosPorRequisicao

integer format: int32

exibirTesteValidacao

boolean

tiposAnexosAceitos

Array<string>

nullable

formatoCapturaBiometriaFacial

string

nullable

limitOfProceduresPerRequest

integer format: int32

nullable

tipoArquivos

Array<object>

nullable

object

id

integer format: int64

nome

string

nullable

contentType

string

nullable

extensoes

Array<string>

nullable

tiposCredenciaisId

string format: uuid

nome

string

nullable

codigoPrestador

string

nullable

observacoes

string

nullable

login

string

nullable

senha

string

nullable

cpf

string

nullable

cnpj

string

nullable

tipoLogin

string

nullable

unidadeLogin

string

nullable

tabela

string

nullable

hasBiometrics

boolean

hasExecution

boolean

visivel

boolean

ativa

boolean

acceptJustification

boolean

solicitaTokenPreAutorizacao

boolean

requerTokenAutorizacao

boolean

obrigarAnexoNaAutorizacao

boolean

minimoAnexosPreAutorizacao

integer format: int32

nomeContratado

string

nullable

createdAt

string format: date-time

updatedAt

string format: date-time

nullable

credencialElegibility

object recursive

credencialElegibilityId

string format: uuid

nullable

tiposToken

Array<object>

nullable

object

id

string

nullable

descricao

string

nullable

tipoPermissao

string

Allowed values: Nenhum Usuario Unidade PontoAtendimento

arquivo

object

base64

string

nullable

name

string

nullable

path

string

nullable

type

string

nullable

size

integer format: int32

novo

boolean

id

string format: uuid

nullable

nomeAnexo

string

nullable

tamanhoAnexo

integer format: int32

caminhoStorage

string

nullable

nomeOriginal

string

nullable

conselho

string

nullable

ufConselho

string

nullable

numeroConselho

string

nullable

nomeSolicitante

string

nullable

especialidadeSolicitante

object

label

string

nullable

value

integer format: int32

executantePadrao

object

id

string format: uuid

nullable

clienteId

string format: uuid

pessoaId

string format: uuid

nullable

pessoa

object

id

string format: uuid

nullable

nome

string

nullable

razaoSocial

string

nullable

tipo

string

nullable

sexo

string

nullable

dataNascimento

string format: date-time

nullable

cpfCnpj

string

nullable

rg

string

nullable

ie

string

nullable

situacao

string

nullable

mae

string

nullable

pai

string

nullable

telefone1

string

nullable

telefone2

string

nullable

telefone1DDI

string

nullable

telefone2DDI

string

nullable

site

string

nullable

email

string

nullable

observacoes

string

nullable

foto

string

nullable

usa2FA

boolean

idEndereco

string format: uuid

nullable

endereco

object

id

string format: uuid

nullable

logradouro

string

nullable

numero

string

nullable

bairro

string

nullable

cep

string

nullable

complemento

string

nullable

idCidade

integer format: int32

cidade

object

idCidade

integer format: int32

nullable

nome

string

nullable

ibge

integer format: int32

nullable

idEstado

integer format: int32

estado

object

idEstado

integer format: int32

nullable

nome

string

nullable

sigla

string

nullable

idUsuarioInclusao

string format: uuid

dataInclusao

string format: date-time

idUsuarioAlteracao

string format: uuid

nullable

dataAlteracao

string format: date-time

nullable

idUsuarioExclusao

string format: uuid

nullable

dataExclusao

string format: date-time

nullable

idade

integer format: int32

cboId

string format: uuid

nullable

nome

string

nullable

cpfCnpj

string

nullable

registroConselho

string

nullable

idTipoConselho

integer format: int32

nullable

ufConselho

string

nullable

conselho

object

idTipoConselho

integer format: int32

siglaConselho

string

nullable

nomeConselho

string

nullable

cbo

object

id

string format: uuid

codigo

string

nullable

descricao

string

nullable

tipo

string

nullable

situacao

string

nullable

grupo

string

nullable

versao

string

nullable

executantePadrao

boolean

especialidades

Array<object>

nullable

object

id

string format: uuid

nullable

profissionalId

string format: uuid

nullable

especialidadeId

integer format: int32

nullable

padrao

boolean

especialidade

object

label

string

nullable

value

integer format: int32

indicacaoClinicaTexto

string

nullable

indicacaoClinicaMin

integer format: int32

indicacaoClinicaMax

integer format: int32

regimeAtendimento

string

nullable

tipoAcidente

string

nullable

tipoConsulta

string

nullable

procedimentosPorGuia

integer format: int32

permitirAssinaturaBeneficiario

boolean

permitirAssinaturaResponsavel

boolean

permitirAssinaturaContratado

boolean

permitirAssinaturaSolicitante

boolean

204

NoContent

400

Erro durante a requisição. Retorna mensagens de erro de validação

object

mensagens

Array<string>

nullable

object

mensagens

Array<string>

nullable

object

mensagens

Array<string>

nullable

500

Server Error