Business Portal Quickstart — SyncNexa Docs

The SyncID Business Portal at business.syncnexa.co is your command center for managing student verification integrations, API credentials, OAuth client applications, real-time webhooks, team members, and usage telemetry.

1. Create Your Business Account

Navigate to business.syncnexa.co/register and sign up with your company email. Once verified, you will be prompted to enter your Organization Legal Name and primary business website.

All new accounts start in **Sandbox Mode**, giving you unlimited free test verifications and simulated student credentials without any credit card required.

2. Register Your Application

An Application in SyncNexa represents a distinct website, mobile app, or store integration. To create one:

Open the Applications tab in the sidebar.
Click the Create Application button in the top-right corner.
Step 1 (Basic Details): Enter your Application Name (e.g., *Student Discount Store*) and select the Environment (Sandbox or Live).
Step 2 (Webhooks - Optional): Enter your server endpoint URL (e.g., https://api.yourdomain.com/webhooks/syncnexa) and select the events you wish to receive (verification.completed, consent.approved, etc.).
Click Create Application to finalize.

3. Generate an API Key

Once your application is created, generate a secret API key to authenticate your server-side requests:

Navigate to API & OAuth $\rightarrow$ API Keys tab.
Click Create Key.
Select the target Application and Environment (Sandbox generates sk_test_..., Live generates sk_live_...).
Copy the secret key immediately. For security reasons, the full secret key is only shown once in the creation modal.

Never expose `sk_test_` or `sk_live_` secret keys in client-side code, public GitHub repositories, or browser bundles. Always execute API requests from your backend server.

4. Make Your First API Request

Test your new API key by fetching your application metadata from the SyncNexa API Gateway:

curl

1 curl -X GET "https://api.business.syncnexa.co/org/v1/apps" \
2   -H "Authorization: Bearer sk_test_YOUR_SECRET_KEY" \
3   -H "Content-Type: application/json"

Next Steps

Managing Applications

Learn about environments, application credentials, and lifecycle states.

Webhooks & Events

Configure real-time event streaming for student verifications and consents.

OAuth 2.0 Integration

Implement "Verify with SyncID" button on your checkout or sign-up flow.

Was this page helpful?

1	curl -X GET "https://api.business.syncnexa.co/org/v1/apps" \
2	-H "Authorization: Bearer sk_test_YOUR_SECRET_KEY" \
3	-H "Content-Type: application/json"