Confirm an address with the code mailed to it

POST

/me/emails/{id}/verify

An address that is already confirmed answers 200 with

That address is
already confirmed

When the address was asked for as the sign-in address with PUT /me
(within the last day), confirming it makes it the sign-in address: the
answer then carries user and emails as well, and both addresses
are told. Otherwise the account's address is told it was added.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Confirmed (or already confirmed)

Bodyapplication/json

🟠400

🟠403

🟠409

🟠429

🟠401KlockUnauthorized

🟠404NotFound

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.prod-orm.io/me/emails//verify' \
--header 'Content-Type: application/json' \
--data '{
    "code": "string"
}'

Response Example

200 - Example 1

{
    "message": "string",
    "email": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "email": "user@example.com",
        "primary": true,
        "verified": true
    },
    "user": {
        "id": 0,
        "email": "user@example.com",
        "username": "string",
        "fname": "string",
        "lname": "string",
        "fullname": "string",
        "age": 0,
        "role": "admin",
        "birthday": "2019-08-24",
        "guardian": {
            "email": "user@example.com",
            "username": "string",
            "relationship": "parent",
            "approved": true
        },
        "emancipatedAt": "2019-08-24T14:15:22.123Z",
        "restrictions": {
            "provisioning": true,
            "signin": true
        },
        "verified": true
    },
    "emails": [
        {
            "id": 0,
            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
            "email": "user@example.com",
            "primary": true,
            "verified": true
        }
    ]
}

Modified at 2026-10-05 04:04:32

Add an address

Mail a fresh code to an unconfirmed address