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

SignWell Regional API

Access region-specific endpoints for data residency compliance.

SignWell Regional API is one of 7 APIs that SignWell publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Regional. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 1 operation across 1 path, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://www.signwell.com.

1 operations 1 paths 7 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://www.signwell.com/api/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

SignWell Regional API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (api_key).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Regional 1

Access region-specific endpoints for data residency compliance.

GET
/api/v1/documents/{id}/nom151_certificate
MX – NOM-151 Certificate
getNom151Certificate 3 params → 200404422429

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (2 properties), RateLimitErrorResponse (1 property), ValidationErrorResponse (1 property), Nom151UrlResponse (1 property). Each schema is shown below with its type and property counts.

ObjectOnly
boolean
If true, returns raw NOM-151 constancia certificate object as JSON instead of a zip file or URL.
Nom151UrlResponse
object
NOM-151 download URL returned when urlonly=true
1 property 1 required
UrlOnly
boolean
Whether to return the URL of the completed PDF or the actual PDF content. Defaults to false.
ErrorResponse
object
Standard error response
2 properties
ValidationErrorResponse
object
Validation error response. The errors object contains field-specific error details with dynamic keys.
1 property 1 required
RateLimitErrorResponse
object
Rate limit exceeded error response (HTTP 429)
1 property 1 required
CompletedDocumentId
string
Unique identifier for a completed document.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signwell-regional-api-openapi.yml Raw ↑

Other APIs SignWell publishes across the network.

SignWell API Application API
SignWell Bulk Send API
SignWell Document API
SignWell Me API
SignWell Template API
SignWell Webhooks API
Where this information came from

This is an independent, third-party profile of SignWell Regional 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.