Overview
The company registration endpoint allows property management companies to onboard themselves to the Arqqin platform. This creates a company record in the system and is typically the first step before you can start managing locations and vehicle whitelists.Company registration requires an API key for authentication. Contact hello@arqqin.com to obtain a registration API key.
Registration Process
Step 1: Prepare Company Information
Gather the following required information:- Company details: Name, slug, business address
- Optional details: External company ID, description, contact information, logo
- Settings: Company-specific configuration (optional)
Step 2: Register Your Company
Step 3: Registration Complete
After successful registration, you’ll receive confirmation with your company details:After registration, you can use the
/companies endpoint to list your registered companies and begin adding locations.Required Fields
Your company’s display name (1-100 characters, alphanumeric with spaces and common symbols)
URL-friendly company identifier (lowercase letters, numbers, hyphens only, 1-50 characters)
Optional Fields
Validation Rules
Company Name Format
- Must contain only alphanumeric characters, spaces, and common symbols:
-&.,() - Must be between 1-100 characters
- Cannot be empty or only whitespace
Company Slug Format
- Must contain only lowercase letters, numbers, and hyphens
- Cannot start or end with a hyphen
- Cannot contain consecutive hyphens (
--) - Must be between 1-50 characters
- Must be unique across all companies
Address Requirements
- Must be between 1-200 characters
- Cannot be empty or only whitespace
Optional Field Validation
- Email: Must be valid email format or empty string
- Website/Logo: Must be valid URL format or empty string
- Phone: Maximum 20 characters
- Description: Maximum 500 characters
- External Company ID: Maximum 50 characters
Common Errors
Company Slug Already Exists
Invalid Company Name
Invalid Address
Invalid Slug Format
Error Handling Best Practices
Next Steps
After successful company registration:- Add your first location - Use the Location Management guide
- Set up vehicle whitelists - Follow the Whitelist Management guide
- Integrate with your system - Check out Integration Examples
Testing Your Registration
You can test the registration process using the staging environment:- Staging URL:
https://apistg.arqq.in/api/register/company - Use test data during development
- The staging environment is isolated from production data

