OpenAPI 3.0.3v1.0.0

Confere API

API para consulta em tempo real de registros profissionais de saúde no Brasil (CRM, CRF, CFP, CRO, CFBM, CFMV, COREN) e estabelecimentos de saúde (CFM, ANVISA, CNES).

Autenticação
A API Confere usa autenticação JWT (Bearer Token).

Inclua o token JWT no cabeçalho da requisição:

Authorization: Bearer SEU_TOKEN_JWT

Dica de segurança: Nunca exponha seu token JWT em código client-side. Sempre faça as chamadas da API do lado do servidor.

Base URL
Todas as requisições devem ser feitas para uma das seguintes URLs.
http://localhost:1337
Servidor de Desenvolvimento
https://api.confere.com.br
Servidor de Produção

Profissionais de Saúde

POST/api/v1/jobs/crm
Consultar CRM (Médico)
Submete um job para consulta de registro CRM no Conselho Federal de Medicina.

Parâmetros

crmobrigatório
string
ufobrigatório
string
callbackUrl
string (uri)

Exemplos de Código

"text-yellow-400">curl "text-cyan-400">-X POST "http://localhost:1337/api/v1/jobs/crm" \
"text-cyan-400">-H "Authorization: Bearer SEU_TOKEN_JWT" \
"text-cyan-400">-H "Content-Type: application/json" \
"text-cyan-400">-d '{"crm": "123456", "uf": "SP"}'
POST/api/v1/jobs/crf
Consultar CRF (Farmacêutico)
Submete um job para consulta de registro CRF no Conselho Federal de Farmácia.

Parâmetros

crfobrigatório
string
ufobrigatório
string
callbackUrl
string (uri)
POST/api/v1/jobs/cfp
Consultar CFP (Psicólogo)
Submete um job para consulta de registro CFP no Conselho Federal de Psicologia.

Parâmetros

cpf
string
nome
string
registro
string
callbackUrl
string (uri)
POST/api/v1/jobs/cro
Consultar CRO (Dentista)
Submete um job para consulta de registro CRO no Conselho Regional de Odontologia.

Parâmetros

croobrigatório
string
ufobrigatório
string
callbackUrl
string (uri)
POST/api/v1/jobs/cfbm
Consultar CFBM (Biomédico)
Submete um job para consulta de registro CFBM no Conselho Federal de Biomedicina.

Parâmetros

nome
string
registro
string
callbackUrl
string (uri)
POST/api/v1/jobs/cfmv
Consultar CFMV (Veterinário)
Submete um job para consulta de registro CFMV no Conselho Federal de Medicina Veterinária.

Parâmetros

queryobrigatório
string
tipo_inscricao
string
uf
string
callbackUrl
string (uri)
POST/api/v1/jobs/coren
Consultar COREN (Enfermeiro)
Submete um job para consulta de registro COREN no Conselho Regional de Enfermagem.

Parâmetros

cpf
string
inscricao
string
nome
string
uf
stringpadrão: "SP"
callbackUrl
string (uri)

Estabelecimentos de Saúde

POST/api/v1/jobs/cfm-estabelecimento
Consultar Estabelecimento de Saúde (CFM)
Submete um job para consulta de estabelecimento de saúde no Conselho Federal de Medicina.

Parâmetros

cnpjobrigatório
string
callbackUrl
string (uri)
POST/api/v1/jobs/anvisa
Consultar Empresa ANVISA
Submete um job para consulta de empresa farmacêutica na ANVISA.

Parâmetros

cnpjobrigatório
string
callbackUrl
string (uri)
POST/api/v1/jobs/cnes
Consultar Estabelecimento CNES
Submete um job para consulta de estabelecimento no Cadastro Nacional de Estabelecimentos de Saúde (DATASUS).

Parâmetros

cnesobrigatório
string
callbackUrl
string (uri)

Gerenciamento de Jobs

GET/api/v1/jobs/{queue}/{jobId}
Obter status do job
Consulta o status e resultado de um job específico.

Parâmetros da URL

queueobrigatório
string
jobIdobrigatório
string

Exemplos de Resposta

{
400">"id": 400">"123",
400">"status": 400">"waiting",
400">"progress": 0
}
Códigos de Resposta
Possíveis códigos de resposta da API
200
Sucesso

Requisição processada com sucesso

400
Bad Request

Parâmetros faltando ou incorretos

401
Não Autorizado

Token JWT inválido ou ausente

404
Não Encontrado

Job ou recurso não encontrado