Documentation

Risk Insights Input Fields

A description of the fields used for risk insight metrics from Salsa

Describes the fields passed on the request payload for POST /api/rest/v1/paystream/risk-insight-inputs endpoint to send Risk Insight Metrics from Employers to Salsa.

Full reference: https://docs.salsa.dev/reference/employerriskmetricsonpartnerplatformcreate

FieldDescriptionType
type (required)Fixed, must be PaystreamEmployerRiskMetricsOnPartnerPlatformUpsertInputstring
employerId (required)Employer identifier provided by Salsa (i.e., er_309...).string
revenueInfo.averageMonthlyRevenueAverage monthly revenue in major units as a string, e.g., "1000.00".string, decimal
payingUserInfo:
  • totalPaymentsCount
If the user is a paying user, the number of total payments the user has made to your platform.integer ≥0
  • subscriptionStatus
  • FREE_ACCOUNT: User has a free account in your platform.
  • FREE_TRIAL: User is on a free trial in your platform.
  • PAYING_USER: User has an active subscription on your platform.
  • PAYING_USER_DELINQUENT: User has an active subscription in your platform, but the payment is overdue.
  • BLOCKED: User has been blocked or permanently banned from using your platform.
  • CANCELED: User subscription has been canceled on your platform.
enum
riskAssessment.riskClassificationThe risk assessment of this employer is on your platform.
  • LOW_RISK
  • MEDIUM_RISK
  • HIGH_RISK
  • NOT_EVALUATED
enum
signUpDateThe date the user signed up on your platform.date, ISO‑8601 YYYY‑MM‑DD
activeFeatures[]:The list of features the user is actively using on your platformarray
  • name
  • PAYMENT_PROCESSING: A feature in your application that allows for payment processing.
  • TIME_TRACKING: A feature in your application that allows for time tracking.
  • SCHEDULING: A feature in your application that allows for scheduling.
  • ACCOUNTING: A feature in your application that allows for accounting.
enum
  • activeSince
The date the user started using this feature.date, ISO‑8601
  • paymentsProcessedAmount
If type is PAYMENT_PROCESSING, the total amount of payments the user has processed on your platform.string, decimal
  • lastSchedulingDate
If type is SCHEDULING, the date the scheduling feature was used for the last time by the user.date, ISO‑8601
acquisitionChannelThe acquisition channel of this employer on your platform.
  • INBOUND_SALES: Employer requested contact after encountering marketing or a sales form (SEO/ads/content) and had a conversation with Sales or Customer Success.
  • OTHER: None of the other channels apply. Use only when the acquisition path doesn’t fit Referral, Outbound, Inbound, or Web
  • OUTBOUND_SALES: Employer was proactively scouted and invited to join your platform. E.g.: SDR/Account-Executive outreach.
  • REFERRAL: Employer has been introduced by a trusted partner or existing customer referral. E.g.: an accountant referring users to your platform.
  • WEB: The employer created an account via self-serve web signup with no sales touch. E.g.: product-led onboarding from the company website.
enum
businessWebsiteThe employer's business website.string

Unless marked required, all fields are optional; send what you have. Omit unknowns (don’t send nulls).