Authentication

Complete email sign-in and issue a bearer credential

Verify the one-time email challenge and return the bearer credential used by authenticated requests.

POST/v1/email/verifications

Body parameters

application/json · required
email string required

Email address associated with the identity.

Maximum length: 254 characters.

Exampleowner@example.com
code string required

Stable code used to identify this catalog value or machine-readable result.

Example123456

Response

200Success

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
access_token string

Bearer credential returned by authentication.

Minimum length: 1 character.

Exampleexample_access_token
token_type string

Bearer token type returned by authentication.

Allowed values: "bearer"

Examplebearer
expires_at number

Unix timestamp when the credential expires.

Example1768482000

Possible errors

400 Invalid request

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
error object

Error details returned for a failed request.

ShowHide 4 properties
error.code string

Stable machine-readable error or resource code.

Exampleinvalid_input
error.message string

Human-readable explanation of the result or error.

ExampleThe request could not be validated.
error.requestId string

Correlation identifier for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000
error.details object nullable

Additional structured details about the result or error.

ShowHide 1 property
error.details.issues object[]

Structured field issues returned when request validation fails.

ShowHide 2 properties
error.details.issues[].path string | number[]

Field path where the validation issue occurred.

One of: string alternative 1, number alternative 2

Example0 items
error.details.issues[].reason string

Machine-readable reason for the validation issue.

Allowed values: "expected_type", "required", "unexpected_property", "invalid_value", "invalid_json", "unsupported_media_type", "body_too_large", "body_timeout", "invalid_request"

Exampleinvalid_request
Example 400 response
{
  "error": {
    "code": "invalid_input",
    "message": "The request could not be validated.",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "details": {
      "issues": [
        {
          "path": [],
          "reason": "invalid_request"
        }
      ]
    }
  }
}
View raw OpenAPI operation

Use the machine-readable contract for client generation and payload validation.

Open OpenAPI contract ↗