--- updatedAt: 2026-01-17T20:52:25.000Z agentTools: projectIndex: https://docs.checkhq.com/llms.txt --- # Create the enrollment profile Create the enrollment profile for the company # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "check-api", "version": "2025-01-01" }, "servers": [ { "url": "https://sandbox.checkhq.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "Authorization", "x-bearer-format": "bearer", "x-default": "YOUR_API_KEY" } } }, "security": [ { "sec0": [] } ], "paths": { "/companies/{company}/enrollment_profile": { "put": { "summary": "Create the enrollment profile", "description": "Create the enrollment profile for the company", "operationId": "create-the-enrollment-profile", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "employee_count": { "type": "integer", "description": "Number of payees who are W2 employees", "default": null, "format": "int32" }, "contractor_count": { "type": "integer", "description": "Number of payees who are 1099 contractors", "default": null, "format": "int32" }, "pay_period_amount": { "type": "string", "description": "Estimated total amount of money paid to employees and contractors per pay period", "default": "null" }, "previous_payroll_provider": { "type": "string", "description": "The payroll provider previously used by the company", "default": null, "enum": [ "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_go", "paychex_preview", "paycom", "paycor", "paydayonesource", "payrollmatters", "payroll_people", "paylocity", "payworks", "prime_pay", "proliant", "quickbooks_online", "quickbooks_desktop", "rasi", "rippling", "sage_100", "sage_300", "sage_hr", "square_payroll", "sure", "toast", "trinet", "trupay", "ultipro_online", "ultipro_pc", "wave", "zeal", "zendona", "zenefits", "manual", "accountant", "other" ] }, "previous_payroll_provider_other": { "type": "string", "description": "A custom label for the previous payroll provider, if the previous payroll provider is not available in the above set of options.", "default": "null" }, "first_payroll": { "type": "boolean", "description": "Whether or not the company has ever paid people before.", "default": false }, "first_payroll_of_year": { "type": "boolean", "description": "Whether or not this is the first payroll of the current calendar year for the company", "default": false }, "user_since": { "type": "string", "description": "The date at which the company joined the partner's platform", "default": "null", "format": "date" }, "expected_first_payday": { "type": "string", "description": "The company's expected first payday on Check", "default": "null", "format": "date" }, "approved_for_payment_processing": { "type": "boolean", "description": "Whether or not the company has been approved for payment processing on the partner's platform", "default": false }, "existing_payroll_customer_processing_period": { "type": "string", "description": "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`.", "default": "null" }, "average_monthly_revenue": { "type": "number", "description": "The average monthly revenue of the company", "default": null, "format": "float" }, "earliest_known_revenue": { "type": "string", "description": "The earliest known date that the company generated revenue", "default": "null", "format": "date" }, "months_on_previous_payroll_provider": { "type": "integer", "description": "The number of months that the company used their previous payroll provider", "default": null, "format": "int32" }, "social_media": { "type": "array", "description": "Any social media account URLs associated with the company", "default": [ "[]" ], "items": { "type": "string" } }, "products_actively_used": { "type": "array", "description": "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`.", "default": [ "[]" ], "items": { "type": "string" } }, "account_contacts": { "type": "array", "description": "A list of partner employee emails associated with the company", "default": [ "[]" ], "items": { "type": "string" } }, "fraud_score": { "type": "number", "description": "A value between 0 and 100 representing the fraud risk presented by the company", "default": null, "format": "float" }, "predicted_fraud": { "type": "boolean", "description": "Whether the fraud score was over the expected threshold for fraud (the company is predicted to be fraudulent)", "default": false }, "paying_user": { "type": "boolean", "description": "Whether the company pays the partner for services", "default": false }, "missed_payments_count": { "type": "integer", "description": "The number of times that the company has failed to pay the partner", "default": null, "format": "int32" }, "payroll_history_access_method": { "type": "string", "description": "The mechanism by which Check Implementation Services will be able to access and migrate payroll history", "default": null, "enum": [ "authorized_access_to_previous_provider", "provided_credentials", "provided_reports" ] }, "implementation_services_submission_comment": { "type": "string", "description": "Optional comment for including additional context when submitting a company for Implementation Services", "default": "null" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"company\": \"com_097YZQgrXZQb8VHtI76S\",\n \"employee_count\": 10,\n \"contractor_count\": 0,\n \"pay_period_amount\": \"1000.50\",\n \"previous_payroll_provider\": \"gusto\",\n \"first_payroll_of_year\": true,\n \"user_since\": \"2020-05-05\",\n \"expected_first_payday\": \"2023-01-01\",\n \"approved_for_payment_processing\": true,\n \"existing_payroll_customer_processing_period\": null,\n \"average_monthly_revenue\": \"30005.27\",\n \"earliest_known_revenue\": \"2022-08-22\",\n \"months_on_previous_payroll_provider\": 12,\n \"social_media\": [\"https://twitter.com/check_hq\"],\n \"products_actively_used\": [\"payments\", \"timetracking\"],\n \"account_contacts\": [\"person@partner.com\"],\n \"fraud_score\": \"21.03\",\n \"predicted_fraud\": false,\n \"paying_user\": true,\n \"missed_payments_count\": 0\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```