Navigation

The challenge object

Attributes

id string

The unique identifier of the challenge.

status enum

Where the challenge is in its lifecycle.

Possible enum values
created

The challenge was created and is waiting to be presented to the user.

presented

The user has opened the hosted challenge.

code_sent

A verification code was sent to the user.

verified

The user entered a valid code.

completed

The challenge finished successfully.

failed

The challenge did not pass.

skipped

The challenge was skipped.

overridden

The challenge was resolved by an override rather than by the user.

type string (optional)

What the challenge is guarding against. One of repeat_trial, account_sharing, account_takeover, multi_accounting, or fake_account.

challenge_mode string (optional)

How the challenge is run. Rupt-hosted challenges return rupt_managed.

delivery_status string (optional)

The delivery state of the verification code. One of pending, sent, delivered, failed, or bounced.

channels array (optional)

The channels the verification code was sent through, in the order they were used. Values are email and text.

reasons array (optional)

The signals that triggered the challenge, for example limit_exceeded, new_fingerprint, or new_ip.

actions array (optional)

The actions available on the challenge, for example verify, view, or skip.

user object (optional)

The user being challenged. See the user object.

evaluation string (optional)

The identifier of the evaluation that created the challenge.

origin_url string (optional)

The URL the user was on when the challenge was triggered.

email_verified boolean (optional)

Whether the user verified ownership of their email during the challenge.

phone_verified boolean (optional)

Whether the user verified ownership of their phone during the challenge.

verify_attempts number (optional)

How many times the user has tried to enter a verification code.

createdAt date

When the challenge was created.

updatedAt date (optional)

When the challenge was last updated.

The challenge object
{
  "id": "649873be6e8b6f9b33722a0c",
  "status": "code_sent",
  "type": "account_takeover",
  "challenge_mode": "rupt_managed",
  "delivery_status": "delivered",
  "channels": ["email"],
  "reasons": ["new_fingerprint", "new_ip"],
  "actions": ["verify", "skip"],
  "user": {
    "rupt_id": "649873be6e8b6f9b33722a0c",
    "id": "external_account_id",
    "email": "user@example.com",
    "phone": "+15551234567"
  },
  "evaluation": "649873be6e8b6f9b33722a0c",
  "origin_url": "https://app.example.com/login",
  "email_verified": false,
  "phone_verified": false,
  "verify_attempts": 1,
  "createdAt": "2021-09-01T00:00:00.000Z",
  "updatedAt": "2021-09-01T00:00:00.000Z"
}