Skip to content
Authrim

Verify an exact-email tenant discovery code.

POST
/api/auth/discovery/email/verify
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/auth/discovery/email/verify \
  --header 'Content-Type: application/json' \
  --data '{ "challenge_id": "discovery-42-00000000-0000-4000-8000-000000000001", "code": "123456" }'

Consumes a one-time code and only then resolves exact email memberships from the Lookup directory.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
challenge_id
required
string
<= 128 characters
code
required
string
/^\d{6}$/
key
additional properties
Example 
{
  "challenge_id": "discovery-42-00000000-0000-4000-8000-000000000001",
  "code": "123456"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
One of:
object
result
required
string
Allowed values: resolved
candidate
required
object
tenant_id
required
string
tenant_code
required
string
display_name
required
string
logo_url
string | null format: uri
login_url
required
string format: uri
source
required
string
Allowed values: email_exact tenant_code tenant_slug wayf invitation app_hint
invited_email
string | null
Example 
{
  "result": "resolved",
  "candidate": {
    "tenant_id": "tenant_123",
    "tenant_code": "acme",
    "display_name": "Acme",
    "logo_url": null,
    "login_url": "https://acme.auth.example.com/login",
    "source": "email_exact"
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

503

Section titled “503 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}