CHcheckhq

Update the enrollment profile

Changed on

Update the existing enrollment profile for the company

patch/companies/{company}/enrollment_profile (COPY)

Request

Request body

employee_countinteger

Number of payees who are W2 employees

contractor_countinteger

Number of payees who are 1099 contractors

pay_period_amountinteger

Estimated total amount of money paid to employees and contractors per pay period

previous_payroll_providerstring

The payroll provider previously used by the company

first_payroll_of_yearboolean

Whether or not this is the first payroll of the current calendar year for the company

user_sincestring date

The date at which the company joined the partner's platform

expected_first_paydaystring date

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 business is already running payroll with you, the processing period they are currently using. One of null, four_day, two_day, or one_day.

average_monthly_revenuenumber float

The average monthly revenue of the company

earliest_known_revenuestring date

The earliest known date that the company generated revenue

months_on_previous_payroll_providerinteger

The number of months that the company used their previous payroll provider

social_mediastring[]

Any social media account URLs associated with the company

products_actively_usedstring[]

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_contactsstring[]

A list of partner employee emails associated with the company

fraud_scorenumber float

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_method'"authorized_access_to_previous_provider"' | '"provided_credentials"' | '"provided_reports"'

The mechanism by which Check Implementation Services will be able to access and migrate payroll history

implementation_services_submission_commentstring

Optional comment for including additional context when submitting a company for Implementation Services

Response

200

Changes