Retrieve onboarding status

See what's missing before a company can be submitted, and how review is going.

Use this endpoint to see everything about where a company is in onboarding in one call. Poll it, or use it to reconcile after you receive a webhook.

📘

Part of Submission and status. For how this fits into onboarding, see the guide: Overview: the readiness check.

Lifecycle

statusMeaning
DRAFTYou're filling in the onboarding. Data can be edited until the contract is signed.
UNDER_REVIEWSubmitted. Everee is reviewing and may open requests.
APPROVEDApproved.
DECLINEDDeclined. decision.reasonCode carries a generic reason code.
WITHDRAWNWithdrawn. Final.

Readiness

readiness.missing lists what still has to happen before Submit will succeed. Each is a code:

CodeWhat it needs
LEGAL_ENTITY_TYPE, FORMATION_STATE, BUSINESS_ADDRESSCompany details
IRS_EIN_LETTER, BUSINESS_FORMATIONThe IRS EIN letter and business formation documents. Required before the signature is requested, while Everee requires them.
AGREEMENT_CONSENTOnly when your customers agree to terms under your own agreement: report the customer's consent.
WORKER_TYPES, EMPLOYEE_COUNT, CONTRACTOR_COUNT, PAY_FREQUENCY, PAY_PERIOD_START_DAY, ANNUAL_REVENUE, NATURE_OF_BUSINESS, NAICS_CODEPayroll profile
SIGNER, SIGNER_IDENTITY, SIGNER_RELATIONSHIPSigner
CONTROL_PERSONControl person
OWNERSHIP_DECLARATION, OWNERSHIP_TOTALOwnership declaration and beneficial owners of 25% or more that agree with it and don't exceed 100% in total. Not asked when the control person owns more than 75%.
TAX_STATESTax setup, for companies that pay W-2 employees
CERTIFICATE_OF_AUTHORITYCertificate of authority, for a signer who is neither the control person nor an owner
PICTURE_IDA picture ID for each person who must be verified. Only listed when you capture IDs yourself (journey.documentCapture is PARTNER).
SIGNED_CONTRACT, BANK_ACCOUNTThe signer signing the documents and selecting the bank in the hosted experience

Other fields

FieldNotes
releasedWhether the contract-signing workflow is open for the company. It is true for companies you create through this API.
takeoverRequiredUsed for Everee's own customers who onboard themselves. Always false for partner companies.
identityVerificationOne entry per person being verified. status is GETTING_READY, LINK_SENT, IN_REVIEW, EXPIRED_CONTACT_US or VERIFIED. Outcomes other than verified or expired are deliberately shown as IN_REVIEW.
agreementHow the customer agrees to terms: mode (DIRECT or UMBRELLA), agreementId and revision (the agreement revision the company is bound to) and, for UMBRELLA, consentRecorded. See Agreeing to terms.
journeyThe compliance requirements the company is measured against: baselineVersion and, if your account has one, overlayVersion, plus documentCapture: who captures pictures of IDs, ALLOY (Everee's identity provider, the default) or PARTNER (you upload them). Everee sets it for your account. See Requirements can change.
requestsEveree's review requests, open and resolved. See List review requests.
contractA summary of the contract. Absent until a signature has been requested.
goLiveWhether the company is live, the target and firm go-live dates, and what's outstanding. See Get go-live status.
payrollHistoryThe company's payroll history status and files. See Get payroll history.
statusAbsent only for a company that has no onboarding at all.

Errors

StatusMeaning
401The API key is missing, malformed or expired.
404No company with this ID belongs to your partner account.
Path Params
integer
required

The company's ID, as returned when the company was created.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json