Skip to main content

VeriScute - Verify users with Scute

Verifications are useful if you want to verify a user and approve an action by an user identifier, such as an email or a phone number. With Scute, there are a few different ways to create a verification flow, depending on your system's architecture, security requirements, and user experience goals.

Verification includes 2 elements:

  • VerificationRequest
  • VerificationAttempt

VerificationRequest​

{
  "id": "uuid", // Unique identifier
  "app_id": "uuid", // Scute App id
  "app_user_id": "uuid", // User id
  "status": { "pending", "failed", "verified", "cancelled", "expired" },
  "channel": { "sms", "email", "metafield", "user_identifier" }, // Verification channel
  "created_at": "datetime",
  "to_user_id": "uuid", // Recipient user id
  "metadata": {}, // Channel-specific data (e.g., new_identifier, identifier_type)
  "cached_code": "string", // OTP code for metafield/user_identifier channels
  "attemtps": [ // maxAttempts can be set at application settings
    {
        "id": "uuid", // attempt id
        "verified_at": "datetime|null", // if verified
        "created_at": "datetime", // 
        "data": {}, // attached data (analytics)
        "magic_link_id": "uuid" // if attached (email channel only)
    },
    ...
  ]
}

Channel Types​

  • sms: OTP verification via SMS message
  • email: Magic link verification via email
  • metafield: OTP verification for custom user data fields
  • user_identifier: OTP verification for changing user email/phone with automatic update

Verification Types​

Email Verification​

See Self-serve email verification for a guide on implementing user verification with email.

OTP Verification​

See OTP verification for dashboard-initiated OTP verification flows.

User Identifier Verification​

See User identifier verification for securely changing user email addresses and phone numbers with verification.

Metafield Verification​

Verify custom user data fields (metafields) via OTP codes sent to the specified identifier.

Verification with Intent​

See Verification with intent for creating email verification requests with specific intent payloads.

Monitoring and Management​

Checking Verification Status​

See Tracking verification status for details on monitoring verification request progress.

Webhooks​

Configure webhooks to receive real-time notifications about verification events.

Webhook functionality is currently in development