VerifyEmail

POST/auth/v1/email/verify

Request Body

required

application/json

{
  "$ref": "#/components/schemas/auth.v1.VerifyEmailRequest",
  "$ref-value": {
    "type": "object",
    "properties": {
      "verification_id": {
        "type": "string",
        "title": "verification_id"
      },
      "code": {
        "type": "string",
        "title": "code"
      }
    },
    "title": "VerifyEmailRequest",
    "additionalProperties": false
  }
}

Response Body

200application/json

Success

type: unknown

{
  "$ref": "#/components/schemas/auth.v1.VerifyEmailResponse",
  "$ref-value": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "title": "message"
      },
      "email": {
        "type": "string",
        "title": "email"
      },
      "verified": {
        "type": "boolean",
        "title": "verified"
      },
      "tokens": {
        "allOf": [
          {
            "$ref": "#/components/schemas/auth.v1.TokenResponse",
            "$ref-value": {
              "type": "object",
              "properties": {
                "access_token": {
                  "type": "string",
                  "title": "access_token"
                },
                "refresh_token": {
                  "type": "string",
                  "title": "refresh_token"
                },
                "expires_in": {
                  "type": "string",
                  "title": "expires_in",
                  "format": "int64"
                },
                "token_type": {
                  "type": "string",
                  "title": "token_type"
                },
                "requires_action": {
                  "type": "string",
                  "title": "requires_action"
                }
              },
              "title": "TokenResponse",
              "additionalProperties": false
            }
          }
        ],
        "title": "tokens"
      }
    },
    "title": "VerifyEmailResponse",
    "additionalProperties": false
  }
}

curl -X POST "https://api.rixl.com/auth/v1/email/verify" \
  -H "Content-Type: application/json" \
  -d '{}'

Success

application/json

{
  "$ref": "#/components/schemas/auth.v1.VerifyEmailResponse",
  "$ref-value": {
    "type": "object",
    "properties": {
      "message": {
        "type": "string",
        "title": "message"
      },
      "email": {
        "type": "string",
        "title": "email"
      },
      "verified": {
        "type": "boolean",
        "title": "verified"
      },
      "tokens": {
        "allOf": [
          {
            "$ref": "#/components/schemas/auth.v1.TokenResponse",
            "$ref-value": {
              "type": "object",
              "properties": {
                "access_token": {
                  "type": "string",
                  "title": "access_token"
                },
                "refresh_token": {
                  "type": "string",
                  "title": "refresh_token"
                },
                "expires_in": {
                  "type": "string",
                  "title": "expires_in",
                  "format": "int64"
                },
                "token_type": {
                  "type": "string",
                  "title": "token_type"
                },
                "requires_action": {
                  "type": "string",
                  "title": "requires_action"
                }
              },
              "title": "TokenResponse",
              "additionalProperties": false
            }
          }
        ],
        "title": "tokens"
      }
    },
    "title": "VerifyEmailResponse",
    "additionalProperties": false
  }
}