<aside> <img src="/icons/map-pin_blue.svg" alt="/icons/map-pin_blue.svg" width="40px" />

Índice de páginas

Core AI Docs

Versões

1.2

1.1

1.0

</aside>

Resumo

O Outpost é o principal meio de integração com a Core AI. Através dele, é possível enviar dados, realizar análises de crédito e efetuar operações de antecipação. Além disso, ele permite o fornecimento de informações detalhadas sobre essas operações de forma simples e eficiente, utilizando apenas alguns endpoints. Abaixo segue o diagrama de endpoints da API:

Utilização

Authentication

Para interagir com a API Outpost, o processo inicia-se pela autenticação para obter um token JWT de acesso, através do endpoint [POST] /auth/token para autenticação.

<aside> ⚠️

Um aspecto fundamental da nossa abordagem é a utilização de IDs próprios de identificação. Em vez de gerar códigos internos, adotamos identificadores do cliente para proporcionar:

• Integração simplificada: A eliminação da necessidade de mapear diferentes sistemas de identificação agiliza a conexão com sua infraestrutura.
• Rastreabilidade clara: O uso de códigos familiares facilita o acompanhamento e a identificação de cada operação.
• Redução de erros: A ausência de tradução de IDs entre sistemas minimiza inconsistências e falhas na comunicação de dados.

Portanto, para interagir com o Outpost, basta utilizar IDs próprios, simplificando todo o processo.

</aside>

Payment history

É fundamental enviar o histórico de pagamentos através do [POST] /upload_external_data](https://docs.coreai.com.br/POST-upload_external_data-2bd84d476d9781579ad8d2acf6c33435). Os dados fornecidos aqui são cruciais para a análise de elegibilidade para antecipação e ajuste das taxas de desconto.

Anticipation

Fluxo de Solicitação**:**

• Primeiro, verifique os recebíveis pré-aprovados por meio do endpoint [GET] /get_pre_approved;
• O processo continua com o aceite dos termos em [POST] /accept_terms. Para cumprir as políticas da LGPD e do Banco Central do Brasil, o solicitante da antecipação deve aceitar os termos através desse endpoint;
• Em seguida, a antecipação é habilitada no endpoint [POST] /enable_anticipation;
• Com a antecipação habilitada, as ofertas disponíveis podem ser consultadas em [POST] /get_offers;
• Finalmente, a solicitação de antecipação é efetivada através do [POST] /request_anticipation;
• Paralelamente, a qualquer momento, é possível obter dados detalhados de um recebível específico usando [GET] /get_receivable_data.

Cash management

Após a antecipação, a gestão dos repasses é feita pelo endpoint [POST] /core_split.

User management

A API também oferece recursos para a gestão de usuários e permissões:

• Usuários:
  • Criar um novo usuário: [POST] /create_user;
  • Consultar usuários: [GET] /get_users;
  • Remover um usuário: [DELETE] /delete_user.
• Permissões:
  • Atualizar as permissões de um usuário no Watchtower: [POST] /update_role;
  • Para consultar as roles disponíveis: [GET] /get_roles.

Exemplos de uso do Outpost

Medical - Antecipação de plantões realizados por médicos

Rental - Antecipação de aluguel para proprietários