Create the enrollment profile

put

https://sandbox.checkhq.com/companies/{company}/enrollment_profile

Create the enrollment profile for the company

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

employee_count

int32

Defaults to null

Number of payees who are W2 employees

contractor_count

int32

Defaults to null

Number of payees who are 1099 contractors

pay_period_amount

string

Defaults to null

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

previous_payroll_provider

string

enum

Defaults to null

The payroll provider previously used by the company

previous_payroll_provider_other

string

Defaults to null

A custom label for the previous payroll provider, if the previous payroll provider is not available in the above set of options.

first_payroll

boolean

Defaults to false

Whether or not the company has ever paid people before.

first_payroll_of_year

boolean

Defaults to false

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

user_since

date

Defaults to null

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

expected_first_payday

date

Defaults to null

The company's expected first payday on Check

approved_for_payment_processing

boolean

Defaults to false

Whether or not the company has been approved for payment processing on the partner's platform

existing_payroll_customer_processing_period

string

Defaults to null

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_revenue

float

Defaults to null

The average monthly revenue of the company

earliest_known_revenue

date

Defaults to null

The earliest known date that the company generated revenue

months_on_previous_payroll_provider

int32

Defaults to null

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

social_media

array of strings

Defaults to []

Any social media account URLs associated with the company

social_media

products_actively_used

array of strings

Defaults to []

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.

products_actively_used

account_contacts

array of strings

Defaults to []

A list of partner employee emails associated with the company

account_contacts

fraud_score

float

Defaults to null

A value between 0 and 100 representing the fraud risk presented by the company

predicted_fraud

boolean

Defaults to false

Whether the fraud score was over the expected threshold for fraud (the company is predicted to be fraudulent)

paying_user

boolean

Defaults to false

Whether the company pays the partner for services

missed_payments_count

int32

Defaults to null

The number of times that the company has failed to pay the partner

payroll_history_access_method

string

enum

Defaults to null

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

Allowed:

implementation_services_submission_comment

string

Defaults to null

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

200200

400400