Skip to content
Authrim

Start an email address addition or replacement.

POST
/api/account/identifier-replacements/start
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/account/identifier-replacements/start \
  --header 'Content-Type: application/json' \
  --cookie authrim_session=<authrim_session> \
  --data '{ "email": "hello@example.com" }'

Requires authentication within the last five minutes and sends a one-time code to the new address. Adds the first email address when the account does not have one; otherwise replaces the current address.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
email
required
string format: email
<= 320 characters
key
additional properties
Example generated
{
  "email": "hello@example.com"
}

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Verification challenge accepted.

Media type application/json
object
challenge_id
required
string
expires_in
required
integer
Example generated
{
  "challenge_id": "example",
  "expires_in": 1
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
error_code

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
error_code

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
error_code

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

503

Section titled “503 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
error_code

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}