For the complete documentation index, see llms.txt. This page is also available as Markdown.

MIDAPI v2

MIDAPI v2 é a API REST síncrona do ecossistema de APIs da Facephi. Expõe os serviços de Verificação de Identidade e antifraude por meio de endpoints REST autenticados com OAuth2, pensados para integradores e desenvolvedores backend.

Conceitos: plataforma do cliente e consumer

Antes de integrar qualquer serviço da MIDAPI v2, convém conhecer os dois conceitos sobre os quais o acesso é organizado:

  • Plataforma do cliente: representa a relação única entre o cliente e Facephi. É identificada pelo cabeçalho platform-id e tem associada uma API Key. Existe uma única plataforma por cliente.

  • Consumer: representa um canal ou vertical de negócio do cliente (por exemplo, o canal web e o app móvel, ou verticais como seguros e investimentos). É identificado pelo cabeçalho consumer-id. Cada consumer tem habilitados apenas os serviços contratados para esse canal, com limites de uso e rastreabilidade independentes.

Como parte do cadastro do serviço, será fornecida ao cliente a URL base da API, as credenciais da plataforma e ao menos um consumer (um por cada canal ou vertical que precise integrar). Todas as rotas deste guia são relativas a essa URL base (por exemplo, POST <URL base>/consumer/token). Esse modelo permite gerenciar permissões, limites e rastreabilidade de forma independente por canal, mantendo uma única plataforma por cliente.

Com esses dois conceitos, obtém-se o Token de acesso: a plataforma emite tokens para seus consumers, e cada chamada operacional é feita em nome de um consumer. O detalhe está em Autenticação.

Serviços disponíveis

Serviço
Descrição

Validação antifraude de documentos de identidade, com selfie opcional e diagnóstico final (APROVADO/RECUSADO).

Atualizado