> ## Documentation Index > Fetch the complete documentation index at: https://docs.spherescout.io/llms.txt > Use this file to discover all available pages before exploring further. # Post apiauthsign up > Register a new user account ## OpenAPI ````yaml /api-reference/openapi.json post /api/auth/sign-up/ openapi: 3.0.3 info: title: SphereScout API version: 1.0.0 description: > # SphereScout API SphereScout provides B2B lead data — business contacts with emails, phone numbers, and location metadata — across multiple countries. ## Authentication All endpoints (except `/api/auth/` and `/api/plans`) require a **JWT Bearer token**. 1. **Register** — `POST /api/auth/sign-up/` 2. **Login** — `POST /api/auth/login/` → returns `access` and `refresh` tokens 3. **Attach header** — `Authorization: Bearer ` 4. **Refresh** — `POST /api/token/refresh/` with `{ "refresh": "" }` Access tokens expire after 60 minutes. Refresh tokens are long-lived. ## Credits Every account has a credit balance. Exporting leads costs **1 credit per lead**. Check your balance via `GET /api/user/profile/`. Credits reset each billing cycle for subscribed users. ## Async Download Workflow Exporting leads is asynchronous: 1. **Search** — `GET /api/companies/` to preview results and get `totalCount` 2. **Export** — `POST /api/download-csv/` to start generation (credits deducted immediately) 3. **Poll** — `GET /api/download-status/{search_id}/` until `status = COMPLETED` 4. **Download** — `GET /api/download-completed-csv/{search_id}/` to get a signed URL ## API Keys (recommended for integrations) Generate a persistent API key from your dashboard under **API Keys**. Attach it to every request: ``` Authorization: Token ``` Keys can be given an expiry date and revoked at any time. JWT Bearer tokens (`Authorization: Bearer `) continue to work for browser sessions and Swagger UI testing. ## Rate Limiting API requests are rate-limited. If you receive a `429` response, back off and retry. ## Versioning This is **v1** of the API. Breaking changes will be communicated in advance. servers: - url: https://www.spherescout.io security: [] tags: - name: Authentication description: Register, login, refresh tokens, and reset passwords. - name: Search description: Search and preview business leads by country, category, and location. - name: Download description: 'Export leads to CSV/Excel. Async workflow: initiate → poll → download.' - name: History description: View past searches and their download status. - name: Credits & Profile description: Check credit balance, subscription plan, and user profile. - name: Geography description: Countries, states/regions, counties, and cities for search filters. - name: API Keys description: Create, list, and revoke persistent API keys for integrations. paths: /api/auth/sign-up/: post: tags: - Authentication description: Register a new user account operationId: auth_sign_up_create requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterRequestRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RegisterRequestRequest' multipart/form-data: schema: $ref: '#/components/schemas/RegisterRequestRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/StatusMessageResponse' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/StatusMessageResponse' description: '' security: - ApiKeyAuth: [] x-codeSamples: - lang: cURL source: |- curl -X POST 'https://www.spherescout.io/api/auth/sign-up/' \ -H 'Authorization: Token YOUR_API_KEY' \ -H 'User-Agent: SphereScout/1.0' \ -H 'Content-Type: application/json' \ -d '{}' - lang: Python source: |- import requests response = requests.post( "https://www.spherescout.io/api/auth/sign-up/", headers={ "Authorization": "Token YOUR_API_KEY", "User-Agent": "SphereScout/1.0", }, json={}, ) print(response.json()) - lang: JavaScript source: >- const response = await fetch("https://www.spherescout.io/api/auth/sign-up/", { method: "POST", headers: { "Authorization": "Token YOUR_API_KEY", "User-Agent": "SphereScout/1.0", "Content-Type": "application/json", }, body: JSON.stringify({}), }); const data = await response.json(); components: schemas: RegisterRequestRequest: type: object properties: email: type: string format: email minLength: 1 description: Account email address. password1: type: string writeOnly: true minLength: 1 description: Password. password2: type: string writeOnly: true minLength: 1 description: Password confirmation (must match password1). fingerprint: type: string description: >- Optional device fingerprint identifier used for signup fraud prevention. fingerprint_request_id: type: string description: >- FingerprintJS request ID used for server-side fingerprint verification. attribution: description: Optional traffic attribution payload captured on the frontend. preferred_language: allOf: - $ref: '#/components/schemas/RegisterRequestPreferredLanguageEnum' default: en description: |- Two-letter UI language preference. * `bg` - bg * `cs` - cs * `da` - da * `de` - de * `el` - el * `fr` - fr * `en` - en * `es` - es * `et` - et * `fi` - fi * `he` - he * `hr` - hr * `hu` - hu * `it` - it * `lt` - lt * `lv` - lv * `nb` - nb * `nl` - nl * `pl` - pl * `pt` - pt * `ro` - ro * `sk` - sk * `sl` - sl * `sr` - sr * `sv` - sv * `th` - th * `tr` - tr required: - email - password1 - password2 StatusMessageResponse: type: object properties: status: type: string message: type: string required: - message - status RegisterRequestPreferredLanguageEnum: enum: - bg - cs - da - de - el - fr - en - es - et - fi - he - hr - hu - it - lt - lv - nb - nl - pl - pt - ro - sk - sl - sr - sv - th - tr type: string description: |- * `bg` - bg * `cs` - cs * `da` - da * `de` - de * `el` - el * `fr` - fr * `en` - en * `es` - es * `et` - et * `fi` - fi * `he` - he * `hr` - hr * `hu` - hu * `it` - it * `lt` - lt * `lv` - lv * `nb` - nb * `nl` - nl * `pl` - pl * `pt` - pt * `ro` - ro * `sk` - sk * `sl` - sl * `sr` - sr * `sv` - sv * `th` - th * `tr` - tr securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: 'API key. Format: Token ' ````