Verify email with a code

POST/auth/v1/email/verify

Verifies a user's email address using a verification id and the code sent to them.

Request Body

required

application/json

{
  "$ref": "#/components/schemas/internal_auth.verifyEmailBody",
  "$ref-value": {
    "properties": {
      "code": {
        "type": "string"
      },
      "verification_id": {
        "type": "string"
      }
    },
    "required": [
      "code",
      "verification_id"
    ],
    "type": "object"
  }
}

Response Body

200application/json

type: unknown

{
  "$ref": "#/components/schemas/authv1.VerifyEmailResponse",
  "$ref-value": {
    "properties": {
      "email": {
        "type": "string"
      },
      "message": {
        "type": "string"
      },
      "tokens": {
        "$ref": "#/components/schemas/authv1.TokenResponse",
        "$ref-value": {
          "properties": {
            "access_token": {
              "type": "string"
            },
            "expires_in": {
              "type": "integer"
            },
            "refresh_token": {
              "type": "string"
            },
            "requires_action": {
              "type": "string"
            },
            "token_type": {
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "verified": {
        "type": "boolean"
      }
    },
    "type": "object"
  }
}

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

application/json

{
  "$ref": "#/components/schemas/authv1.VerifyEmailResponse",
  "$ref-value": {
    "properties": {
      "email": {
        "type": "string"
      },
      "message": {
        "type": "string"
      },
      "tokens": {
        "$ref": "#/components/schemas/authv1.TokenResponse",
        "$ref-value": {
          "properties": {
            "access_token": {
              "type": "string"
            },
            "expires_in": {
              "type": "integer"
            },
            "refresh_token": {
              "type": "string"
            },
            "requires_action": {
              "type": "string"
            },
            "token_type": {
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "verified": {
        "type": "boolean"
      }
    },
    "type": "object"
  }
}