Skip to main content

Client Onboarding

Welcome to GoRoute! This guide walks you through the complete onboarding process โ€” from receiving your welcome email to sending your first Peppol invoice. The entire setup takes about 10 minutes.

How It Worksโ€‹

After your account request is approved, GoRoute provisions your organization and sends you a welcome email with everything you need. Here's the full flow:

Request Approved โ†’ Welcome Email โ†’ First Login โ†’ Set Password โ†’ Enter API Key โ†’ Send Invoices

Step 1: Welcome Emailโ€‹

Once your account is approved, you'll receive a welcome email from admin@goroute.ai with:

ItemDescription
API KeyYour personal API key (starts with sk_test_ for sandbox or pk_goroute_ for production)
Temporary PasswordA one-time password for your first login
Organization NameYour company name as registered in GoRoute
Dashboard URLLink to app.goroute.ai/app/
Test Participant IDYour assigned sender identifier on the Peppol network
Expiry DateWhen your sandbox access expires (if applicable)
Save your API key

Copy your API key from the email and store it securely. You'll need it in Step 4.

Learn more: Authentication โ€” how API keys work, key formats, and security best practices.


Step 2: First Loginโ€‹

  1. Open the dashboard at app.goroute.ai/app/
  2. Enter the email address you registered with
  3. Enter the temporary password from your welcome email
  4. Click Sign In

Login screen

First-time login

The system will immediately ask you to set a new password (Step 3). This is a one-time security requirement.

Learn more: Environments โ€” understand the difference between sandbox and production URLs.


Step 3: Set Your Passwordโ€‹

On your first login, you'll be prompted to create a new password. Your password must meet these requirements:

  • At least 8 characters
  • Contains uppercase and lowercase letters
  • Contains at least one number
  • Contains at least one special character (e.g., !@#$%)

After setting your password, you'll be automatically logged into the dashboard.

Password manager

We recommend using a password manager (1Password, Bitwarden, etc.) to generate and store a strong password.


Step 4: Enter Your API Keyโ€‹

The API key connects your dashboard to your GoRoute organization. You need to enter it once:

  1. After login, click API Keys in the left sidebar
  2. In the API Key input field, paste the key from your welcome email
  3. Click Save
  4. The dashboard will confirm: "API key saved successfully"

Your API key is stored locally in your browser. You won't need to enter it again on this device unless you clear your browser data.

Why do I enter the API key manually?

Your API key is a secret that authenticates all API calls. By entering it manually, you confirm you have access to the welcome email and control over the key. We're working on auto-linking your key to your login in a future update.

Learn more: Authentication โ€” storing keys securely, rotating keys, and using them in code (Python, Node.js, C#).


Step 5: Explore the Dashboardโ€‹

Once your API key is saved, you'll have full access to the dashboard:

SectionWhat You Can Do
DashboardOverview of recent activity, transaction stats, and account status
Send InvoiceCreate and send Peppol invoices using the built-in form
TransactionsView all sent and received documents with status tracking
ParticipantsManage your registered Peppol participants
Peppol ID LookupLook up any business on the Peppol network
Received DocumentsView and download incoming invoices
WebhooksConfigure real-time notifications for incoming documents
API KeysManage your API keys
Company SettingsUpdate your organization details

Learn more:


Step 6: Send Your First Invoiceโ€‹

Ready to send? You have two options:

Option A: Use the Dashboardโ€‹

  1. Click Send Invoice in the sidebar
  2. Fill in the sender and receiver details
  3. Add line items (description, quantity, unit price)
  4. Click Validate to check the invoice
  5. Click Send to transmit via the Peppol network

Option B: Use the APIโ€‹

Send an invoice programmatically:

curl -X POST https://app.goroute.ai/peppol-api/api/v1/invoices \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"invoice_number": "INV-2026-001",
"issue_date": "2026-02-15",
"due_date": "2026-03-15",
"currency": "EUR",
"sender": {
"name": "Your Company",
"peppol_id": "9915:your-participant-id",
"country": "NL"
},
"receiver": {
"name": "Customer Corp",
"peppol_id": "0204:DE123456789",
"country": "DE"
},
"lines": [
{
"description": "Consulting services",
"quantity": 10,
"unit_price": 100.00,
"vat_rate": 21.0
}
]
}'

Learn more:


Sandbox vs. Productionโ€‹

FeatureSandboxProduction
API key prefixsk_test_pk_goroute_
NetworkPeppol ACC (test)Peppol Production
Invoices go toTest receivers onlyReal businesses
Expiry14 days (extendable)No expiry
Rate limits30 req/min, 1K/day60 req/min, 10K/day
Test receiver9999:test-successReal Peppol participants
Testing in sandbox

Use the test receiver 9999:test-success to verify your integration. This endpoint always accepts invoices successfully.

Learn more: Test Identifiers โ€” full list of test participants and expected behaviors.


Troubleshootingโ€‹

"Invalid API key" errorโ€‹

  • Double-check you copied the full key from the welcome email (no extra spaces)
  • Make sure the key hasn't expired (sandbox keys expire after 14 days)
  • Try clearing your browser's local storage and re-entering the key

"Temporary password expired"โ€‹

  • Temporary passwords expire after 7 days
  • Contact admin@goroute.ai to get a new temporary password

Dashboard shows no dataโ€‹

  • Verify your API key is entered correctly in API Keys section
  • Check that your organization has an active status
  • Try refreshing the page

Can't find the welcome emailโ€‹

  • Check your spam/junk folder
  • Search for emails from admin@goroute.ai
  • Contact admin@goroute.ai to resend the welcome email

What's Next?โ€‹

Now that you're set up, explore these guides:


Need Help?โ€‹