The Enrollment Profile object

The Enrollment Profile object captures information about the company that pertains to the company enrollment and onboarding process. All fields are optional.

{
    "company": "com_097YZQgrXZQb8VHtI76S",
    "employee_count": 10,
    "contractor_count": 0,
    "pay_period_amount": "1000.50",
    "previous_payroll_provider": "gusto",
    "first_payroll_of_year": true,
    "user_since": "2020-05-05",
    "expected_first_payday": "2023-01-01",
    "approved_for_payment_processing": true,
    "existing_payroll_customer_processing_period": null,
    "average_monthly_revenue": "30005.27",
    "earliest_known_revenue": "2022-08-22",
    "months_on_previous_payroll_provider": 12,
    "social_media":  ["https://twitter.com/check_hq"],
    "products_actively_used": ["payments", "timetracking"],
    "account_contacts": ["[email protected]"],
    "fraud_score": "21.03",
    "predicted_fraud": false,
    "paying_user": true,
    "missed_payments_count": 0,
    "payroll_history_access_method": "authorized_access_to_previous_provider",
    "implementation_services_submission_comment": "Client has authorized Accountant Access to Gusto"
}
AttributeDescription
company
string
Unique identifier of the associated company
employee_count
integer
Number of payees who are W2 employees
contractor_count
integer
Number of payees who are 1099 contractors
pay_period_amount
string
Estimated total amount of money paid to employees and contractors per pay period
previous_payroll_provider
string
The payroll provider previously used by the company. Recognized values which prompt provider-specific product experiences can be found here.
first_payroll_of_year
boolean
Whether or not the first payroll the company is processing with Check is the first payroll of the calendar year for the company
user_since
date
The date the company joined the partner's platform
expected_first_payday
date
The company's expected first payday on Check
approved_for_payment_processing
boolean
Whether or not the company has been approved for payment processing on the partner's platform
existing_payroll_customer_processing_period
string
If the company is currently running payroll through the partner platform but via another payroll provider, their processing period. One of four_day, two_day, or one_day if present. Should be null if company is not currently running payroll.
average_monthly_revenue
float
The average monthly revenue of the company
earliest_known_revenue
date
The earliest known date that the company generated revenue
months_on_previous_payroll_provider
integer
The number of months that the company used their previous payroll provider
social_media
array of strings
Any social media account URLs associated with the company
products_actively_used
array of strings
A list of the products offered by the partner's platform used by the associated company. Values must be one of timetracking, payments, or scheduling.
account_contacts
array of strings
A list of partner employee emails associated with the company
fraud_score
float
A value between 0 and 100 representing the fraud risk presented by the company
predicted_fraud
boolean
Whether the fraud score was over the expected threshold for fraud (the company is predicted to be fraudulent)
paying_user
boolean
Whether the company pays the partner for services
missed_payments_count
integer
The number of times that the company has failed to pay the partner
payroll_history_access_method
enum
The mechanism by which Check Implementation Services will be able to access and migrate payroll history. Value must be one of: authorized_access_to_previous_provider, provided_reports or provided_previous_payroll_provider_account_id
previous_payroll_provider_account_id
string
Required when the payroll_history_access_method is provided_previous_payroll_provider_account_id
implementation_services_submission_comment
string
Optional comment for including additional context when submitting a company for Implementation Services