Generate Login Link
Accounts
Generate Login Link
Generate a new secure login link for client access to their Fifteenth account
POST
Generate Login Link
Overview
The Generate Login Link endpoint creates a new secure, time-limited login link for clients to access their Fifteenth account. This is useful when:- The original login link has expired (7-day expiry)
- A client has lost their login link
- You need to provide additional login links to multiple users
- Security requires generating a fresh login link
Each login link is single-use for initial access but allows the client to set up permanent login credentials once used.
Request
Path Parameters
number
required
The unique Fifteenth account identifier to generate a login link for.Format: Numeric ID
Example:
Example:
12345Headers
string
required
Bearer token with your Partner API key
string
required
Must be
application/jsonBody Parameters
string
Email address of the specific user to generate a login link for. If not provided, generates a link for the primary account holder.Validation: Must be an existing user on the account
Example:
Example:
john.doe@example.cominteger
Number of hours until the login link expires.Range: 1-168 hours (1 hour to 7 days)
Default: 168 hours (7 days)
Example:
Default: 168 hours (7 days)
Example:
48string
Purpose for generating the login link (for audit logging).Options:
initial_access- First time account accessexpired_link- Replacing an expired linklost_credentials- Client lost their login informationadditional_user- Link for additional account usersupport_request- Generated for customer support
expired_linkstring
URL to redirect the client to after successful login. Must be a permitted domain for your partner account.Format: Valid HTTPS URL
Example:
Example:
https://yourplatform.com/tax-dashboardboolean
Whether to send an email notification to the user with the new login link.Default:
trueobject
Email notification customization options.
Response
Success Response
string
The generated secure login link for the client.Format:
Security: Token is cryptographically secure and single-use for initial access
https://app.fifteenth.com/auth/partner-login/{token}Security: Token is cryptographically secure and single-use for initial access
string
Email address of the user this login link is for.
string
ISO 8601 timestamp when the login link expires.
integer
Number of hours until the login link expires.
string
The purpose specified for generating this login link.
string
URL the client will be redirected to after login (if specified).
boolean
Whether an email notification was sent to the user.
integer
Number of previous login links that were invalidated when generating this new one.
string
ISO 8601 timestamp when the login link was generated.
number
The account ID this login link provides access to.
Examples
Basic Login Link Generation
Custom Login Link with Settings
Generate for Specific User
Silent Link Generation (No Email)
Response Examples
Basic Link Generation Response
Response
Custom Link Generation Response
Response (Custom Settings)
Error Responses
object
Account not found or user email not associated with account.
object
Invalid request parameters.
object
Account access denied or suspended.
object
Too many login link generation requests.
Security Considerations
Link Security Features
- Single-use for initial access: After first use, clients set up permanent credentials
- Time-limited: Links automatically expire (default 7 days, max 7 days)
- Cryptographically secure: Uses secure random token generation
- Invalidation: Previous links are automatically invalidated when new ones are generated
- Audit logging: All link generation and usage is logged for security
Best Practices
Expiry Time Selection
Expiry Time Selection
Choose appropriate expiry times based on urgency:
- Immediate support: 1-4 hours
- Normal client access: 24-48 hours
- Account setup: 7 days (default)
- High security situations: 1 hour minimum
Notification Security
Notification Security
When sending notifications:
- Always use partner branding for legitimacy
- Include expiry information in emails
- Warn clients not to share links
- Use custom messages to provide context
Manual Delivery
Manual Delivery
For sensitive situations:
- Set
send_notification: false - Deliver links through secure channels
- Use shorter expiry times
- Track delivery method for your records
Rate Limiting
Rate Limiting
Respect rate limits to prevent abuse:
- Max 10 links per account per hour
- Use purpose field for audit trails
- Monitor link generation patterns
- Implement client-side rate limiting
Monitoring and Alerts
Monitor login link usage for security:Usage Patterns
Automated Link Replacement
Support Ticket Integration
Next Steps
Retrieve Account
Check account status and user information
Add Users
Add additional users who need login links
Account Activity
Monitor login link usage and account activity
Authentication
Learn about API security and authentication