/
Cadastro Atualizado das APIs

ESTE É UM CONTEÚDO EM DESENVOLVIMENTO E NÃO DEVE SER CONSIDERADO COMO VERSÃO FINAL!
Clique aqui para maiores informações

Cadastro Atualizado das APIs

ITEM 2.2 - II

Controle de versão

Versão

Data

Resumo das alterações

1

May 23, 2024

Versão inicial

Introdução e Objetivos

Esta métrica visa garantir que as informações relativas às APIs das instituições participantes armazenadas pela Estrutura Responsável pela Governança do Open Finance estejam corretas e atualizadas. A conformidade com esta métrica assegura a integridade e a eficácia do ecossistema do Open Finance.

Sobre a Métrica

A métrica se baseia na verificação dos recursos das APIs das instituições participantes para determinar a conformidade das informações. Para que uma instituição esteja em conformidade com essa métrica, todos os critérios abaixo devem ser atendidos com sucesso para cada uma de suas marcas. A Estrutura Responsável pela Governança do Open Finance verifica e exige que as informações estejam corretas e atualizadas.

Recursos das APIs

  • Verifica se os recursos das APIs publicadas têm todos os endpoints cadastrados.

  • Confirma se o parâmetro FamilyComplete está definido como True.

Metodologia Simplificada

Para fins de monitoramento deste item, o período de apuração será mensal, conforme orientado pelo Manual de Monitoramento do Open Finance Brasil. A metodologia de análise envolve:

  • Recursos das APIs: Verificação da publicação completa dos endpoints das APIs e confirmação do parâmetro FamilyComplete como True.

Interpretação dos Resultados

Os resultados da métrica serão interpretados para verificar se as instituições estão cumprindo os critérios de conformidade para o cadastro atualizado das APIs no Diretório de Participantes. A conformidade é evidenciada pelo parâmetro FamilyComplete definido como True, indicando que todos os endpoints previstos para uma família de APIs foram cadastrados.

A desconformidade é pontuada quando forem localizadas hipóteses de falha contendo o valor 'Incomplete Family Type', evidenciando que nem todos os endpoints das APIs foram cadastrados para uma determinada família de APIs.

 

Exemplo Ilustrativo

Considere uma instituição que, ao cadastrar seus endpoints no Diretório, não os tenha cadastrado integralmente, resultando no atributo FamilyComplete com o valor False. Nesse caso, a instituição seria pontuada em uma situação de desconformidade.

Dados e Fontes

Para o cálculo da métrica, utilizam-se os dados obtidos a partir do Diretório de Participantes e da