Company Onboarding Events

These events tell you what is happening to a company you created with the Company Onboarding API. They are sent to the webhook endpoint of the company, which you can set when you create the company or later with Set webhook, and they use the same envelope, signature, and retry behavior as every other Everee webhook event. Verify each event as described in Authenticating events.

The companyId in the envelope is the company's ID. In every event below, data.object always includes companyId.

Events are notifications. They can arrive more than once, so make your handler idempotent, and read Get onboarding status for the current state.

Status Changed

Sent when the company's onboarding status changes: it was submitted (UNDER_REVIEW), approved (APPROVED), declined (DECLINED), or withdrawn (WITHDRAWN).

Webhook event type: company-onboarding.status-changed

{
  "companyId": 10011,
  "status": "APPROVED"
}

Signature Requested

Sent when the company's signer can sign the agreements: the draft is complete and Everee has loaded the contract terms. It is also sent when updated documents need a new signature. signatureReason is FIRST_REQUEST the first time and RE_SIGN_REQUIRED after a previous signature was voided. Create a signing session in response.

Webhook event type: company-onboarding.signature-requested

{
  "companyId": 10011,
  "contractVersion": 1,
  "signatureReason": "FIRST_REQUEST"
}

contractVersion counts the rounds of signing: it increases by one each time a new signature is requested.

Contract Signed

Sent when the signer has signed the agreements.

Webhook event type: company-onboarding.contract-signed

{
  "companyId": 10011,
  "contractVersion": 1
}

Contract Executed

Sent when Everee has countersigned the agreements. The executed documents are then available from Download a signed contract document.

Webhook event type: company-onboarding.contract-executed

{
  "companyId": 10011,
  "contractVersion": 1
}

Contract Voided

Sent when a signature is voided because the information on the documents changed. A new company-onboarding.signature-requested event follows. voidReason is DATA_CHANGED, DOCUMENT_CORRECTION, or OTHER. See Changing information after signing.

Webhook event type: company-onboarding.contract-voided

{
  "companyId": 10011,
  "contractVersion": 1,
  "voidReason": "DATA_CHANGED"
}

Request Created

Sent when Everee needs something from you during review. Read the request, including its message, with List requests. See Responding to requests.

Webhook event type: company-onboarding.request-created

{
  "companyId": 10011,
  "requestId": 5512,
  "requestType": "DOCUMENT_NEEDED",
  "documentType": "PROOF_OF_BUSINESS_ADDRESS"
}

documentType appears only on document requests, and personRef only on requests about a particular person.

Request Resolved

Sent when a request is resolved: you answered it, or the thing it asked for is done. It has the same fields as company-onboarding.request-created.

Webhook event type: company-onboarding.request-resolved

{
  "companyId": 10011,
  "requestId": 5512,
  "requestType": "DOCUMENT_NEEDED",
  "documentType": "PROOF_OF_BUSINESS_ADDRESS"
}

Identity Verification Changed

Sent when the identity verification status of a person you provided changes. personRef identifies the person, as in the identityVerification list of Get onboarding status. identityVerificationStatus is one of GETTING_READY, LINK_SENT, IN_REVIEW, EXPIRED_CONTACT_US, or VERIFIED. See Identity verification.

Webhook event type: company-onboarding.identity-verification-changed

{
  "companyId": 10011,
  "personRef": "control-person",
  "identityVerificationStatus": "VERIFIED"
}