Report that the customer consented to your subscription agreement.
Use this endpoint to report that the company's customer consented to your subscription agreement. A new report replaces the previous one.
Part of Agreement consent. For how this fits into onboarding, see the guide: Agreeing to terms.
What you report
| Field | Notes |
|---|---|
consentedAt | When the customer consented. It can't be in the future. |
method | CLICKWRAP, E_SIGNATURE, WRITTEN or OTHER. |
evidenceReference | Where you keep the proof: a document ID, an envelope ID or a URL. Optional. |
ipAddress, userAgent | Where the customer was, when your method records it. Optional. |
attestation | Must be true: you confirm the customer consented to your agreement, and that you hold the proof and will provide it when Everee asks. |
The consent is recorded for the company's signer. If the company has no signer yet, it is attached when you set one. A different signer invalidates it.
When you can call this
Only for a partner whose customers agree under the partner's agreement, while the onboarding is a DRAFT and the contract documents haven't been signed. Otherwise it returns 409.
Errors
| Status | Meaning |
|---|---|
400 | attestation isn't true, or consentedAt is in the future. |
401 | The API key is missing, malformed or expired. |
404 | No company with this ID belongs to your partner account. |
409 | The customer doesn't agree to terms under your agreement, or the onboarding is no longer a DRAFT, or the contract has been signed. |
422 | A required field is missing or malformed. |
attestation is not true, or consentedAt is in the future.
The API key is missing, malformed or expired.
No company with this ID belongs to your partner account.
This company's customer does not agree to terms under your agreement, or the onboarding is no longer a draft or its contract has been signed.
The request body is invalid. For example, a required field is missing or a value is malformed.