Compliance Features

Templates include 10DLC compliance metadata to help with campaign registration.

Compliance Metadata

Code
 
import { getTemplate } from '@relay-works/templates';

const template = getTemplate('otp-verify');

console.log(template.compliance);
// {
//   campaignType: '2FA',
//   riskLevel: 'LOW',
//   requiresOptIn: false,
//   containsAuthCode: true,
//   shaftScore: 0
// }

Campaign Types

Templates map to 10DLC campaign types:

2FA (Two-Factor Authentication)

• OTP Verification
• Password Reset
• New Login Alert
• Account Security Alert

Characteristics:

• Low risk
• No opt-in required
• Contains authentication codes
• High deliverability

Transactional

• Order Confirmed
• Order Shipped
• Payment Confirmed
• Payment Failed
• Appointment Reminder

Characteristics:

• Low risk
• No opt-in required
• Transaction-related content
• High deliverability

Risk Levels

All templates are classified as LOW risk:

• Pre-approved message patterns
• Compliant with carrier guidelines
• No promotional content
• Clear business purpose

Opt-In Requirements

Authentication and transactional templates:

• requiresOptIn: false
• No consent collection needed
• Triggered by user actions

SHAFT Compliance

All templates have shaftScore: 0:

• No sex content
• No hate speech
• No alcohol promotion
• No firearms content
• No tobacco/vape content

Using Compliance Data

When registering 10DLC campaigns (Pro tier and above):

Code
 
const template = getTemplate('otp-verify');

// Use compliance data for campaign registration
const campaignData = {
  useCase: template.compliance.campaignType,
  description: template.description,
  sampleMessages: [
    renderTemplate(template, {
      code: '123456',
      company: 'Your Company'
    }).text
  ],
  optInRequired: template.compliance.requiresOptIn,
  helpMessage: 'Reply HELP for assistance',
  stopMessage: 'Reply STOP to unsubscribe'
};

Carrier Requirements

Templates help meet carrier requirements:

• Clear business purpose
• Appropriate use case classification
• Sample message format
• Compliance metadata ready

Next Steps:

• TypeScript Support
• Best Practices
• View API Reference