Compliance & Consent

Consent state and history for a number

The answer to "show me this person's consent": the current state per purpose (derived from the newest event — unknown when no event exists, never assumed granted), whether the number sits on the opt-out list, and the full event history, newest first.

get/consents/{phone}

Request

  • Base URL: https://api.envoisms.ma/v1
  • URL: https://api.envoisms.ma/v1/consents/{phone}
  • Auth: HTTP bearer

Path parameters

phonestring required
Example:+212612345678

Response

Derived state and history

phonestring
opted_outboolean
opted_out_atstring nullable
stateobject

Example response

{
  "history": [
    {
      "id": "cns_9f2a...",
      "phone": "+212612345678"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.