For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Website Dashboard Get API key

Get Started
Guides
Reference
API Reference

API Reference Consent

Check consent status

GET

https://saperly.com/api/v1/consent

GET

/api/v1/consent

1 const url = 'https://saperly.com/api/v1/consent?phone_number=%2B14155552671&line_id=3fa85f64-5717-4562-b3fc-2c963f66afa6';
2 const options = {
3   method: 'GET',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "status": "active",
3   "consent": {
4     "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
5     "phone_number": "+14155552671",
6     "line_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
7     "consent_type": "implied_inbound",
8     "status": "active",
9     "granted_at": "2024-01-15T09:30:00Z",
10     "revoked_at": null
11   }
12 }

Checks whether a phone number has active consent for the authenticated user.

Authentication

AuthorizationBearer

Send as Authorization: Bearer <your-key>. Obtain keys from the portal — prefix sk_live_ for production, sk_test_ for sandbox.

Query parameters

phone_numberstringRequired

E.164 phone number to check

line_idstringOptionalformat: "uuid"

Optionally scope to a specific line

Response

Consent status

statusenum

Allowed values:

consentobject or null

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

Was this page helpful?

Grant consent

Website Dashboard Get API key