How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Firma.dev Email Domains API

Email domain setup and verification for sending signing request emails from custom domains

Firma.dev Email Domains API is one of 12 APIs that Firma.dev publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Email Domains. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 16 operations across 12 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 01.38.00.

Requests are made against 2 base URLs: https://api.firma.dev/functions/v1/signing-request-api, https://api.firma.dev/api/v1.

16 operations 12 paths 10 schemas 2 DELETE4 GET10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
01.38.00
Servers
https://api.firma.dev/functions/v1/signing-request-api
https://api.firma.dev/api/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Firma.dev Email Domains API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Paths & Operations 16

Across 12 paths, the API surfaces 16 operations — 2 DELETE, 4 GET, 10 POST. Each is listed below with its method, path, parameters, and response codes.

Email Domains 16

Email domain setup and verification for sending signing request emails from custom domains

GET
/company/domains
List company domains
listCompanyDomains → 200401429
POST
/company/domains
Add company domain
createCompanyDomain body → 201400401429
GET
/company/domains/{id}
Get company domain
getCompanyDomain 1 param → 200401404429
DELETE
/company/domains/{id}
Delete company domain
deleteCompanyDomain 1 param → 200401404429
POST
/company/domains/{id}/verify-ownership
Verify domain ownership
verifyCompanyDomainOwnership 1 param → 200400401404429
POST
/company/domains/{id}/finalize
Finalize domain setup
finalizeCompanyDomain 1 param → 200400401404429
POST
/company/domains/{id}/verify-dns
Verify DNS records
verifyCompanyDomainDns 1 param → 200400401404429
POST
/company/domains/{id}/set-primary
Set primary domain
setCompanyPrimaryDomain 1 param → 200400401404429
GET
/workspace/{workspace_id}/domains
List workspace domains
listWorkspaceDomains 1 param → 200401404429
POST
/workspace/{workspace_id}/domains
Add workspace domain
createWorkspaceDomain 1 param body → 201400401404429
GET
/workspace/{workspace_id}/domains/{id}
Get workspace domain
getWorkspaceDomain 2 params → 200401404429
DELETE
/workspace/{workspace_id}/domains/{id}
Delete workspace domain
deleteWorkspaceDomain 2 params → 200401404429
POST
/workspace/{workspace_id}/domains/{id}/verify-ownership
Verify workspace domain ownership
verifyWorkspaceDomainOwnership 2 params → 200400401404429
POST
/workspace/{workspace_id}/domains/{id}/finalize
Finalize workspace domain setup
finalizeWorkspaceDomain 2 params → 200400401404429
POST
/workspace/{workspace_id}/domains/{id}/verify-dns
Verify workspace domain DNS records
verifyWorkspaceDomainDns 2 params → 200400401404429
POST
/workspace/{workspace_id}/domains/{id}/set-primary
Set primary workspace domain
setWorkspacePrimaryDomain 2 params → 200400401404429

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Domain (10 properties), DomainDnsRecord (6 properties), Error (5 properties), DomainVerifyDnsResponse (4 properties). Each schema is shown below with its type and property counts.

DomainVerifyDnsResponse
object
DNS verification result
4 properties 3 required
Domain
object
Email domain configuration for sending signing request emails
10 properties 4 required
DomainSetPrimaryResponse
object
Primary domain update confirmation
2 properties 2 required
Error
object
Organization Seal error codes: SEALSDISABLED, SEALALREADYREVOKED, SEALCREATIONDISABLEDEDGE, SEALERASENOTELIGIBLE, SEALIMAGEINVALID, SEALMUTATIONNOTALLOWED, SEA…
5 properties 1 required
DomainVerifyOwnershipResponse
object
Domain ownership verification result
3 properties 3 required
DomainDeleteResponse
object
Domain deletion confirmation
2 properties 2 required
DomainCreateResponse
object
Domain created with verification instructions
2 properties 2 required
DomainListResponse
object
List of domains with workspace context
2 properties 1 required
DomainDnsRecord
object
DNS record required for email domain verification
6 properties
DomainFinalizeResponse
object
Domain finalization with DNS records
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

firma-dev-email-domains-api-openapi.yml Raw ↑

Other APIs Firma.dev publishes across the network.

Firma.dev Company API
Firma.dev Custom Fields API
Firma.dev Email Templates API
Firma.dev JWT Management API
Firma.dev Organization Seals API
Firma.dev Signer Terms API
Firma.dev Signing Requests API
Firma.dev Templates API
Firma.dev Webhooks API
Firma.dev Workspace Settings API
Firma.dev Workspaces API
Where this information came from

This is an independent, third-party profile of Firma.dev Email Domains API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.