Skip to main content

Screen Reference

This guide shows how the employee onboarding screens map to Partner API endpoints.

warning

These UIs are meant to be directional only, please reference the API documentation for the full technical details.

Welcome Screen​

The initial screen that loads employee information and determines which onboarding steps are required.

9:41
📶🔋
💳

Welcome, John!

Let's get you set up with your Paytient account

API Calls on Load:

  • GET /api/employers/{employerId}/employees/{employeeId} - Fetch employee details
  • GET /api/employers/{employerId}/employees/{employeeId}/onboarding/status - Check which requirements are unmet

Ability to Repay (ATR)​

Collects employee income and monthly financial obligations.

9:41
📶🔋
Ability to Repay

Please provide your financial information to verify your ability to repay.

API Call on Submit:

  • POST /api/employers/{employerId}/employees/{employeeId}/atr with annualIncome and monthlyObligations (both in cents)

Condition: Only shown if ATR requirement is unfulfilled.

We Need More Information​

Collects personal information required for identity verification (SSN, date of birth, address, phone). This screen appears when the identity verification initiation fails due to missing employee data.

9:41
📶🔋
We Need More Information

We need a few more details to verify your identity and complete your account setup.

API Calls:

  • On Load: POST /api/employers/{employerId}/employees/{employeeId}/identity-verification/initiate - Attempt to initiate verification (fails with 422 if data is missing)
  • On Submit: PATCH /api/employers/{employerId}/employees/{employeeId} - Updates employee data using JSON Patch (RFC 6902) format

Fields sent as JSON Patch operations:

  • /ssn - Social Security Number
  • /dateOfBirth - Date of birth (ISO 8601 format)
  • /address/line1, /address/city, /address/state, /address/zipCode - Address fields
  • /phoneNumber - Phone number (E.164 format)

Condition: Only shown if POST /api/employers/{employerId}/employees/{employeeId}/identity-verification/initiate returns 422 Unprocessable Entity indicating missing required fields.

Flow: After updating employee data via PATCH, the app will retry the initiate endpoint.

Verify Your Identity (Document Upload)​

Uploads government-issued ID for documentary evidence when identity verification requires additional proof.

9:41
📶🔋
Verify Your Identity

We need to verify your identity. Please upload a photo of your government-issued ID.

📷

Tap to upload photo

Front side of ID

📷

Tap to upload photo

Back side of ID (if applicable)

API Call on Submit:

  • POST /api/employers/{employerId}/employees/{employeeId}/evidence with document images

Fields:

  • documentType - Enum: DRIVERS_LICENSE, PASSPORT, STATE_ID
  • frontImage - Base64-encoded image (front of document)
  • backImage - Base64-encoded image (back of document, required for two-sided IDs)

Condition: Only shown when employee receives identity-verification.needs-documentary-evidence webhook event.

Note: Images must be base64-encoded without the data URL prefix (e.g., remove data:image/png;base64,).

Agreements​

Displays legal agreements that must be accepted before proceeding.

9:41
📶🔋
Agreements

Please review and accept the following agreements to continue.

Terms of Service

Standard terms and conditions for using Paytient services

Privacy Policy

How we collect, use, and protect your personal information

Cardholder Agreement

Terms governing the use of your Paytient card

Accept all agreements to continue

API Calls:

  • On Load: GET /api/employers/{employerId}/employees/{employeeId}/agreements?language=en - Fetch list of agreements
  • On Accept: POST /api/employers/{employerId}/employees/{employeeId}/agreements/{agreementId} - Accept individual agreement (called once per agreement)

Condition: Only shown if agreements requirement is unfulfilled.

Card Creation​

Once all onboarding requirements are met, the employee can create their Paytient card.

9:41
📶🔋
✓

Congratulations!

You've completed onboarding. Let's create your Paytient card.

API Call on Button Click:

  • POST /api/employers/{employerId}/employees/{employeeId}/cards - Creates a new card for the employee

Condition: Only shown when all onboarding requirements are fulfilled.

Card Activation​

After the employee receives their physical card, they must activate it before use.

9:41
📶🔋
Activate Your Card

You've received your Paytient card! Press the button below to activate it.

API Call on Submit:

  • POST /api/employers/{employerId}/employees/{employeeId}/cards/{cardId}/activate-physical-card

Condition: Only shown after the employee has created a physical card.

Next Steps​

For complete API documentation including request/response schemas and examples, see the API Reference.