Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Edge Impulse EmailVerification API

The EmailVerification API from Edge Impulse — 4 operation(s) for emailverification.

Edge Impulse EmailVerification API is one of 34 APIs that Edge Impulse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include EmailVerification. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://studio.edgeimpulse.com/v1.

4 operations 4 paths 8 schemas 1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://studio.edgeimpulse.com/v1
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Edge Impulse EmailVerification API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuthentication). An API key is passed in the cookie as jwt (JWTAuthentication). An API key is passed in the header as x-jwt-token (JWTHttpHeaderAuthentication). By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

EmailVerification 4
POST
/api/emails/{email}/request-verification
Request email verification
requestEmailVerification 1 param body → 200
POST
/api/emails/verify
Verify email
verifyEmail body → 200
POST
/api/emails/validate
Validate email for account sign-up
validateEmail body → 200
GET
/api/emails/{emailId}
Get email verification status
getEmailVerificationStatus 1 param → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are GenericApiResponse (2 properties), ActivateUserOrVerifyEmailRequest (1 property), RequestEmailVerificationRequest (1 property), EmailValidationRequest (1 property). Each schema is shown below with its type and property counts.

EmailValidationRequest
object
1 property 1 required
RequestEmailVerificationRequest
object
1 property 1 required
EntityCreatedResponse
ActivateUserOrVerifyEmailRequest
object
1 property 1 required
ValidateEmailResponse
VerifyEmailResponse
GetEmailVerificationStatusResponse
GenericApiResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-emailverification-api-openapi.yml Raw ↑

Other APIs Edge Impulse publishes across the network.

Edge Impulse Admin API
Edge Impulse Auth API
Edge Impulse Canary API
Edge Impulse CDN API
Edge Impulse Classify API
Edge Impulse Deployment API
Edge Impulse Devices API
Edge Impulse DSP API
Edge Impulse Export API
Edge Impulse FeatureFlags API
Edge Impulse Health API
Edge Impulse Impulse API