Skip to main content

Quick Start Guide

v1 → v2 migration

If your integration still uses API v1 (https://api.corpxapi.com), read the Quick migration guide (2 min) before your cutover. Support: suporte-api@corpx.com.

Welcome to the CorpX API documentation. This guide will help you make your first integration and understand the basic concepts of our platform.

1. Obtaining Credentials​

To start integrating, you will need access credentials. Contact our support team to receive:

  • Client ID
  • Client Secret
  • X-Tenant-Id (Your Tenant identifier)

2. Authentication​

Our API uses OAuth2 with the client_credentials flow. You must request an access token to make API calls.

Token Request Example (Bash/cURL)​

curl -X POST "https://auth.api.corpx.com/oauth2/token" \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "grant_type=client_credentials" \
     -d "client_id=YOUR_CLIENT_ID" \
     -d "client_secret=YOUR_CLIENT_SECRET"

3. Making Your First Call​

With the access token in hand, you can check the balance of an account, for example.

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. Next Steps​

  • Explore the Integrator Guide for details on required headers and idempotency.
  • Check the API Reference to see all available endpoints.
  • Check the Webhooks guide to receive real-time notifications.
  • Use the Transaction Timeline to display the full lifecycle of any transaction inside your application.

Need help? Reach out through your private Slack channel (request access during onboarding) or send an email to suporte-api@corpx.com.