Bem-vindo à documentação da MobFácil

Esta documentação reúne as APIs que a MobFácil disponibiliza para consulta de
dados, análise de crédito e validação de identidade. Ela é organizada como uma
referência de endpoints: cada página descreve uma rota, seus parâmetros, os
exemplos de requisição e as respostas possíveis.

Este guia é o ponto de partida — em cinco minutos você entende como a
documentação está dividida, como autenticar e como fazer a primeira chamada.

Antes de começar: o acesso às APIs depende de credenciais emitidas pela
MobFácil e da URL base do ambiente contratado (homologação e produção têm
endereços distintos). Se você ainda não recebeu esses dados, fale com seu
contato comercial ou com o time de integração antes de seguir.

O que você encontra aqui

A documentação está dividida em três projetos, selecionáveis no menu lateral:

Projeto	Para que serve
Bureaus Externo	Consulta e enriquecimento de dados: análise de crédito (SPC Brasil), pessoa física (Midia100 / Ph3a), renda presumida, Receita Federal, SCR/BCB, produtor rural, além das integrações FestCard e KeshBank.
IdGuard	Validação de identidade: validação e OCR de documentos, comparação facial, detecção de faces, prova de vida (liveness), anti-spoofing, biometria e score comportamental.
Tipificação Api	Identificação do tipo de documento (CNH, RG, CPF, passaporte), extração de campos e facematch documento × selfie.

Cada projeto tem também uma seção Esquemas, com a estrutura dos objetos de
requisição e resposta usados pelos endpoints, e um Health check, útil para
validar conectividade e credencial antes de subir uma integração.

Autenticação

Todas as rotas exigem o header Authorization. O formato depende do tipo de
credencial que você recebeu:

Alguns endpoints usam um segundo header de sessão, obtido em uma chamada
anterior — é o caso das integrações FestCard (/v1/festcard/token) e
AcertPix (/v1/acertpix/token), que devolvem um token a ser enviado em:

Nesses casos a própria página do endpoint indica o header obrigatório. Requisições
sem credencial válida retornam 401.

Sua primeira chamada

O exemplo abaixo faz uma análise de crédito completa a partir de um CPF:

Resposta esperada (resumida):

{
  "data": {
    "detalheScoreCadastroPositivo": {
      "indiceRiscoCreditoScore": "BAIXO",
      "probabilidadeInadimplencia": 0.05,
      "score": 750
    },
    "totalRestCred": { "qtdDeRestTotal": 0, "valorDeRestTotal": 0 },
    "alertaDocumento": 0
  },
  "parametro": "CPF",
  "valor": "12345678901",
  "codigo_retorno": 0,
  "mensagem_retorno": "Análise de crédito realizada com sucesso.",
  "tempo": 1.12
}

Se preferir validar a credencial primeiro, comece pelo Health check do
projeto que você vai consumir.

Como ler as respostas

As respostas seguem um envelope comum: o resultado útil vem em data, e os
campos ao redor descrevem o processamento.

Campo	O que traz
`data`	Payload do resultado. Vem `null` quando a chamada falha.
`codigo_retorno`	Status do processamento.
`mensagem` / `mensagem_retorno`	Descrição do resultado ou da falha.
`tempo` / `tempo_total`	Tempo de processamento, em segundos.

Atenção ao codigo_retorno: a convenção varia entre os projetos. Nos
serviços de bureaus e tipificação, 0 indica sucesso e -1 indica erro; nos
endpoints de IdGuard, o campo espelha o status HTTP (200, 400, 401,
500). Trate-o sempre junto com o status HTTP da resposta, e não como um valor
único e global.

Uma resposta 200 no HTTP não garante resultado positivo na regra de negócio:
uma validação pode retornar sucesso técnico com verificaTexto: false. Sempre
avalie o conteúdo de data.

Convenções que valem para quase todos os endpoints

CPF sem formatação. Envie somente os dígitos: 12345678901, nunca
123.456.789-01.

Rastreabilidade. A maioria das rotas aceita um identificador de correlação
opcional. Envie um valor único por operação — ele é o que permite localizar a
chamada em caso de suporte. Confira o nome exato do campo na página do
endpoint: a maior parte usa conversation_id, mas algumas rotas de IdGuard
usam conversation-id, com hífen.

Imagens: URL ou base64. Endpoints que recebem documentos ou selfies aceitam
os dois formatos, sinalizados por um campo próprio (

tipoDocumento: "Url" |
"Base64"

, base64: "true", ou base64: "S", conforme o endpoint). URLs devem
ser publicamente acessíveis. Payloads em base64 são descartados antes dos logs
e da auditoria.

Fallback entre fontes. Alguns endpoints consultam mais de um provedor em
sequência — a consulta de pessoa física, por exemplo, tenta o Midia100 e recai
no Ph3a em caso de falha. Isso é transparente para você, mas afeta o tempo de
resposta: dimensione seus timeouts com folga.

Rotas legadas. Endpoints marcados como legados continuam funcionando, porém
não recebem melhorias. Para integrações novas, use sempre a rota indicada como
preferencial na descrição.

Como navegar

Busca (Ctrl+K) — a via mais rápida. Busque pelo dado que você precisa
("renda", "selfie", "SCR"), não pelo nome do endpoint.

Testar — dispara a requisição a partir da própria página, com seus
parâmetros, sem escrever código.

Gerar Código — monta o snippet pronto em cURL, JavaScript, Java,
PowerShell, Httpie e outras linguagens.

Examples — cada endpoint traz exemplos nomeados que cobrem as variações
de uso (envio por URL, envio por base64, com e sem verificação de face).

Esquemas — consulte quando quiser mapear o contrato completo para as
classes da sua aplicação.

Última modificação — exibido no topo de cada página; use para saber se
algo mudou desde a sua última integração.

Copiar Página e /llms.txt — exportam o conteúdo em formato de texto,
úteis se você usa assistentes de IA para apoiar a integração.

Recomendações para a sua integração

Comece pelo Health check para confirmar credencial e conectividade.

Valide em homologação antes de apontar para produção.

Guarde o identificador de correlação de cada chamada nos seus logs.

Trate 401, 400 e 500 separadamente — respectivamente credencial,
payload e indisponibilidade do provedor. O terceiro caso merece política de
retry; os dois primeiros, não.

Nunca versione credenciais no seu repositório.

Suporte

Dúvidas sobre contrato de campos, comportamento de um provedor específico ou
liberação de novos endpoints: acione o canal de suporte definido no seu
contrato de integração com a MobFácil.

MobFácil Docs

Bem-vindo à documentação da MobFácil#

O que você encontra aqui#

Autenticação#

Sua primeira chamada#

Como ler as respostas#

Convenções que valem para quase todos os endpoints#

Como navegar#

Recomendações para a sua integração#

Suporte#