Início rápido BaaS

Bem-vindo à documentação BaaS da API CorpX. Este guia é para o tenant / banco que recebeu credencial da CorpX. Chamadas vão para https://tenant.api.corpx.com, sem assinar request.

Se a credencial veio do internet banking, saia daqui: Início rápido Internet banking.

1. Obtendo Credenciais

Para começar a integrar, você precisará de credenciais de acesso. Entre em contato com nossa equipe de suporte para receber:

Client ID
Client Secret
X-Tenant-Id (Identificador do seu Tenant)

2. Autenticação

Nossa API utiliza OAuth2 com o fluxo client_credentials. Você deve solicitar um access token para realizar chamadas à API.

Endpoints

Ambiente	Token endpoint	API base
Produção	`https://auth.api.corpx.com/oauth2/token`	`https://tenant.api.corpx.com`

Exemplo de Requisição de Token (Bash/cURL)

curl -X POST "https://auth.api.corpx.com/oauth2/token" \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -u "$CLIENT_ID:$CLIENT_SECRET" \
     -d "grant_type=client_credentials&scope=api2/read+api2/write"

A resposta inclui um access_token válido por 5 minutos (expires_in: 300).

Reutilize o token. Não peça um token por chamada.

O mesmo access_token vale para todas as chamadas até expirar. É obrigatório reutilizá-lo: gerar um token novo a cada request esgota o Cognito, atrasa a sua integração e pode fazer a emissão ser recusada.

Guarde o token no seu lado e só chame /oauth2/token de novo quando faltar cerca de 60 segundos para o expires_in acabar — ou quando a API responder 403 de token expirado. Detalhes no guia de autenticação.

3. Realizando Sua Primeira Chamada

Com o access token em mãos, você pode consultar o saldo de uma conta, por exemplo.

curl -X GET "https://tenant.api.corpx.com/v1/accounts/123456/balance" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "X-Tenant-Id: YOUR_TENANT_ID"

4. Próximos Passos

Explore o Guia do Integrador para detalhes sobre headers obrigatórios e idempotência.
Consulte a Referência da API para ver todos os endpoints disponíveis.
Confira o guia de Webhooks para receber notificações em tempo real.
Use o Timeline de transações para visualizar o ciclo de vida completo de qualquer transação na sua aplicação.

5. Documentação para agentes e LLMs

Leia Qual documentação? primeiro — há duas audiências e dois hosts. Filtre o OpenAPI por x-audience.

llms.txt — roteador + índice
llms-full.txt — guias concatenados
openapi.yaml — contrato (paths, schemas, x-audience)

Precisa de ajuda? Entre em contato pelo seu canal Slack privado (solicite acesso durante o onboarding) ou envie um e-mail para api@corpx.com.