See how the company agrees to terms, and the consent reported so far.
Use this endpoint to see how this company's customer agrees to pricing and service terms, and the consent reported so far.
Part of Agreement consent. For how this fits into onboarding, see the guide: Agreeing to terms.
mode is DIRECT when the customer signs the Subscription Agreement in the signing experience, or UMBRELLA when they agree under your own agreement. For UMBRELLA, the response also carries your agreementReference and agreementVersion, whether the consent counts (satisfied), and the current consent.
consent is absent until one is reported, and again after a different signer is set or Everee rejects it. satisfied is true only when a consent is recorded and was made by the company's current signer.
Errors
| Status | Meaning |
|---|---|
401 | The API key is missing, malformed or expired. |
404 | No company with this ID belongs to your partner account. |
The API key is missing, malformed or expired.
No company with this ID belongs to your partner account.