The Enrollment Profile object captures information about the company that pertains to the company enrollment and onboarding process. All fields are optional.
{
"employee_count": 10,
"contractor_count": 3,
"pay_period_amount": "1000.50",
"previous_payroll_provider": "gusto",
"months_on_previous_payroll_provider": 12,
"social_media": ["https://twitter.com/check_hq"],
"products_actively_used": ["payments", "timetracking"],
"account_contacts": ["[email protected]"],
"first_payroll_of_year": false,
"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",
"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",
"previous_payroll_provider_account_id": "32763",
"first_payroll": false,
"previous_payroll_provider_other": null,
"enrollment_mode": "implementation_services"
}| Attribute | Description |
|---|---|
employee_countinteger | Number of payees who are W2 employees |
contractor_countinteger | Number of payees who are 1099 contractors |
pay_period_amountstring | Estimated total amount of money paid to employees and contractors per pay period |
previous_payroll_providerstring | The payroll provider previously used by the company. One of: accupay, adp_enterprise, adp_payforce, adp_pcpw, adp_run, adp_totalsource, adp_workforce_now, benefit_mall_compupay, cbiz, ceridian, emangrove, evolution, execupay, gusto, heartland_payroll, isolved, microsoft_dynamics_gp, mint, netpay, onpay, patriot, paychex_flex, paychex_preview, paycom, paycor, payrollmatters, payroll_people, paylocity, payworks, prime_pay, proliant, quickbooks_online, quickbooks_desktop, sage_hr, square_payroll, sure, toast, trinet, trupay, ultipro_online, ultipro_pc, wave, zeal, zendona, zenefits, manual, accountant |
months_on_previous_payroll_providerinteger | The number of months that the company used their previous payroll provider |
social_mediaarray of strings | Any social media account URLs associated with the company |
products_actively_usedarray 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_contactsarray of strings | A list of partner employee emails associated with the company |
first_payroll_of_yearboolean | Whether or not the first payroll the company is processing with Check is the first payroll of the calendar year for the company |
user_sincedate | The date the company joined the partner's platform |
expected_first_paydaydate | The company's expected first payday on Check |
approved_for_payment_processingboolean | Whether or not the company has been approved for payment processing on the partner's platform |
existing_payroll_customer_processing_periodstring | 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, three_day or one_day if present. Should be null if company is not currently running payroll. |
average_monthly_revenuefloat | The average monthly revenue of the company |
earliest_known_revenuedate | The earliest known date that the company generated revenue |
fraud_scorefloat | A value between 0 and 100 representing the fraud risk presented by the company |
predicted_fraudboolean | Whether the fraud score was over the expected threshold for fraud (the company is predicted to be fraudulent) |
paying_userboolean | Whether the company pays the partner for services |
missed_payments_countinteger | The number of times that the company has failed to pay the partner |
payroll_history_access_methodenum | 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 |
implementation_services_submission_commentstring | Optional comment for including additional context when submitting a company for Implementation Services |
previous_payroll_provider_account_idstring | Required when the payroll_history_access_method is provided_previous_payroll_provider_account_id |
first_payrollboolean | Whether or not the company has ever paid people before. |
previous_payroll_provider_otherstring | A custom label for the previous payroll provider, if the previous payroll provider is not available in the above set of options. |
enrollment_modeenum | One of self_service or implementation_services |

