# Consent state and append-only history for one number

Source: https://jointextkit.com/docs/api/consent/get
Index: https://jointextkit.com/llms.txt

`GET /v1/consent/{phone}`

Send your API key as a bearer token: `Authorization: Bearer ssms_sk_...`. Test keys run this endpoint against the [sandbox](/docs/sandbox); see [Authentication](/docs/authentication) for key modes and scopes.

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `phone` | string | Yes | Example: `+14155550132`. |

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | Consent record | `ConsentDetail` |
| 401 | Missing, malformed, or revoked API key | `Error` |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | `Error` |
| 429 | Rate limit or quota exceeded | `Error` |

### 200: `ConsentDetail` fields

| Field | Type | Description |
| --- | --- | --- |
| `object` | `consent` |  |
| `phone` | string | Example: `+14155550132`. |
| `status` | `opted_out`, `opted_in`, `no_record` |  |
| `updated_at` | string (date-time) |  |
| `via` | string | Example: `sms_phrase`. |
| `method` | `keyword`, `phrase`, `ai`, `api`, `import`, `hosted_page` |  |
| `detected` | string | The keyword or phrase that triggered detection |
| `confidence` | number | Intent-tier detections only, 0 to 1 |
| `campaign_id` | string | On the response to an opt-in recorded for one registration |
| `proof` | OptInProof | Opt-in evidence (Messaging Policy 1.4). Accepted only with status opted_in. |
| `campaigns` | array of object | The registrations this number has an opt-in on file for (empty while opted out: STOP clears every scope) |
| `campaigns[].campaign_id` | string | Example: `reg_a1B2c3D4e5F6`. |
| `campaigns[].opted_in_at` | string (date-time) |  |
| `campaigns[].via` | string | Example: `api_set`. |
| `campaigns[].proof_source` | `web_form`, `keyword`, `paper`, `checkout`, `verbal` |  |
| `history` | array of object | Append-only consent history, newest first |
| `history[].at` | string (date-time) |  |
| `history[].type` | `opt_out`, `opt_in`, `exempt_send`, `import`, `api_set`, `topic_unsubscribe`, `topic_subscribe`, `blocked_send`, `help`, `opt_in_request` | `import` is opt-in evidence from a contact import; `topic_*` are per-topic preferences; `opt_in_request` is a sign-up on your hosted opt-in page from a number that had opted out (kept as evidence; they stay opted out until they text START); `blocked_send` and `help` record a refused send and a HELP request. None of these changes the opt-out status. |
| `history[].via` | string |  |
| `history[].method` | string |  |
| `history[].detected` | string |  |
| `history[].confidence` | number |  |
| `history[].note` | string |  |
| `history[].proof` | OptInProof | Opt-in evidence (Messaging Policy 1.4). Accepted only with status opted_in. |
| `history[].campaign_id` | string | The registration an opt-in was given for; absent on account-level opt-ins and on every opt-out |

## Errors

| Status | When |
| --- | --- |
| 401 | Missing, malformed, or revoked API key |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged |
| 429 | Rate limit or quota exceeded |

Every error has the same JSON shape, and `request_id` matches the `X-Request-Id` response header. [Errors](/docs/errors) lists every code and what to do about it.

```json
{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}
```

## Examples

### Node.js

```javascript
import { TextKit } from 'jointextkit'; // npm install jointextkit

const sms = new TextKit(process.env.TEXTKIT_API_KEY);

const consent = await sms.consent.get('+14155550132');

console.log(consent.status);
```

### PHP

```php
<?php

$ch = curl_init('https://api.jointextkit.com/v1/consent/+14155550132');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('TEXTKIT_API_KEY'),
    ],
]);

$data = json_decode(curl_exec($ch), true);
```

### Python

```python
import os
from jointextkit import TextKit  # pip install jointextkit

client = TextKit(os.environ["TEXTKIT_API_KEY"])

consent = client.consent.get("+14155550132")

print(consent["status"])
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://api.jointextkit.com/v1/consent/+14155550132")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer #{ENV["TEXTKIT_API_KEY"]}"

res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### Go

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.jointextkit.com/v1/consent/+14155550132", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("TEXTKIT_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(data))
}
```

### Rust

```rust
// cargo add reqwest --features blocking,json
// cargo add serde_json

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let key = std::env::var("TEXTKIT_API_KEY")?;
    let res = reqwest::blocking::Client::new()
        .get("https://api.jointextkit.com/v1/consent/+14155550132")
        .bearer_auth(key)
        .send()?
        .error_for_status()?;
    let data: serde_json::Value = res.json()?;
    println!("{data}");
    Ok(())
}
```

### Java

```java
import java.net.URI;
import java.net.http.*;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder(URI.create("https://api.jointextkit.com/v1/consent/+14155550132"))
            .header("Authorization", "Bearer " + System.getenv("TEXTKIT_API_KEY"))
            .GET()
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
```

### .NET

```csharp
using System.Net.Http.Headers;

var http = new HttpClient();
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(
    "Bearer", Environment.GetEnvironmentVariable("TEXTKIT_API_KEY"));

var res = await http.GetAsync("https://api.jointextkit.com/v1/consent/+14155550132");
res.EnsureSuccessStatusCode();

var data = await res.Content.ReadAsStringAsync();
```

### cURL

```bash
curl -X GET "https://api.jointextkit.com/v1/consent/+14155550132" \
  -H "Authorization: Bearer $TEXTKIT_API_KEY"
```

## Related

- Guide: [Opt-out, consent & TCPA](/docs/opt-out)
- [All consent endpoints](/docs/api#consent)
- [API reference](/docs/api)