BizVerify Account API
The Account API from BizVerify — 5 operation(s) for account.
OpenAPI Specification
openapi: 3.2.0
info:
title: BizVerify Account API
description: Business entity verification API. Verify company registrations, search business entities,
and check good standing across US states and international jurisdictions. Authenticate with an API
key via the X-API-Key header.
version: 1.0.0
tags:
- name: Account
paths:
/v1/account/:
get:
operationId: getAccount
tags:
- Account
description: Get your account details including email, plan, credit balance, and all API keys. Use
this to check your current credit balance before making API calls.
security:
- apiKey: []
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Your account ID
email:
type: string
description: Account email address
email_verified:
type: boolean
description: Whether the email has been verified
plan:
type: string
enum:
- free
- paid
description: Current billing plan
credit_balance:
type: number
description: Current credit balance available for API calls
api_keys:
type: array
items:
type: object
properties:
id:
type: string
description: Unique API key identifier
label:
type: string
description: Human-readable label for the key
prefix:
type: string
description: First 8 characters of the key for identification
rate_limit:
type: number
description: Requests per minute allowed for this key
is_active:
type: boolean
description: Whether the key is currently active
created_at:
description: When the key was created
type: string
format: date-time
required:
- id
- label
- prefix
- rate_limit
- is_active
- created_at
additionalProperties: false
description: All API keys associated with this account
created_at:
description: When the account was created
type: string
format: date-time
required:
- id
- email
- email_verified
- plan
- credit_balance
- api_keys
- created_at
additionalProperties: false
'401':
description: Default Response
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
details: {}
suggestion:
type: string
required:
- code
- message
additionalProperties: false
required:
- error
additionalProperties: false
patch:
operationId: updateEmail
tags:
- Account
description: Update your account email address. Sets email_verified to false and sends a verification
email to the new address. You must re-verify before using credit-consuming endpoints.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
description: New email address. A verification email will be sent to this address.
required:
- email
security:
- apiKey: []
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Your account ID
email:
type: string
description: Account email address
email_verified:
type: boolean
description: Whether the email has been verified
plan:
type: string
enum:
- free
- paid
description: Current billing plan
credit_balance:
type: number
description: Current credit balance available for API calls
api_keys:
type: array
items:
type: object
properties:
id:
type: string
description: Unique API key identifier
label:
type: string
description: Human-readable label for the key
prefix:
type: string
description: First 8 characters of the key for identification
rate_limit:
type: number
description: Requests per minute allowed for this key
is_active:
type: boolean
description: Whether the key is currently active
created_at:
description: When the key was created
type: string
format: date-time
required:
- id
- label
- prefix
- rate_limit
- is_active
- created_at
additionalProperties: false
description: All API keys associated with this account
created_at:
description: When the account was created
type: string
format: date-time
required:
- id
- email
- email_verified
- plan
- credit_balance
- api_keys
- created_at
additionalProperties: false
'401':
description: Default Response
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
details: {}
suggestion:
type: string
required:
- code
- message
additionalProperties: false
required:
- error
additionalProperties: false
'409':
description: Default Response
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
details: {}
suggestion:
type: string
required:
- code
- message
additionalProperties: false
required:
- error
additionalProperties: false
/v1/account/usage:
get:
operationId: getUsageStats
tags:
- Account
description: Get API usage statistics for your account, broken down by day, endpoint, and jurisdiction.
Useful for monitoring consumption and identifying usage patterns.
parameters:
- schema:
default: 30
type: integer
minimum: 1
maximum: 90
in: query
name: days
required: false
description: Number of days to look back (default 30, max 90)
security:
- apiKey: []
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema: {}
'401':
description: Default Response
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
details: {}
suggestion:
type: string
required:
- code
- message
additionalProperties: false
required:
- error
additionalProperties: false
/v1/account/data-export:
get:
operationId: getDataExport
tags:
- Account
description: Export all your account data including profile, API keys, credit transactions, verification
jobs, and usage statistics (GDPR right to data portability).
security:
- apiKey: []
- bearerAuth: []
responses:
'200':
description: Default Response
content:
application/json:
schema: {}
'401':
description: Default Response
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
details: {}
suggestion:
type: string
required:
- code
- message
additionalProperties: false
required:
- error
additionalProperties: false
/v1/account/keys:
post:
operationId: createApiKey
tags:
- Account
description: Create a new API key with a descriptive label. The full key is returned only once —
store it securely. You can create multiple keys for different environments or integrations.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
label:
type: string
minLength: 1
maxLength: 100
description: A descriptive label for the API key, e.g. "Production" or "CI/CD"
required:
- label
security:
- apiKey: []
- bearerAuth: []
responses:
'201':
description: Default Response
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Unique key identifier
key:
type: string
description: The full API key. Store securely — it will not be shown again.
prefix:
type: string
description: First 8 characters of the key for identification
label:
type: string
description: The label you provided
message:
type: string
description: Reminder to store the key securely
required:
- id
- key
- prefix
- label
- message
additionalProperties: false
'401':
description: Default Response
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
details: {}
suggestion:
type: string
required:
- code
- message
additionalProperties: false
required:
- error
additionalProperties: false
/v1/account/keys/{keyId}:
delete:
operationId: revokeApiKey
tags:
- Account
description: Revoke an API key immediately. The key will no longer authenticate requests. This action
is irreversible.
parameters:
- schema:
type: string
in: path
name: keyId
required: true
description: The API key ID to revoke
security:
- apiKey: []
- bearerAuth: []
responses:
'204':
description: Key revoked
'401':
description: Default Response
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
details: {}
suggestion:
type: string
required:
- code
- message
additionalProperties: false
required:
- error
additionalProperties: false
'403':
description: Default Response
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
details: {}
suggestion:
type: string
required:
- code
- message
additionalProperties: false
required:
- error
additionalProperties: false
'404':
description: Default Response
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
details: {}
suggestion:
type: string
required:
- code
- message
additionalProperties: false
required:
- error
additionalProperties: false
components:
securitySchemes:
apiKey:
type: apiKey
name: X-API-Key
in: header
description: API key authentication. Obtain a key via POST /v1/auth/request-access and POST /v1/auth/verify-access.
bearerAuth:
type: http
scheme: bearer
bearerFormat: OAuth
description: OAuth 2.1 Bearer token. Obtain via the /oauth/authorize flow.