> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.withpersona.com/2025-12-08/api-reference/relay/generate-a-relay-claim/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withpersona.com/_mcp/server.

# Generate a Relay claim

POST https://api.withpersona.com/api/privacy/v1/relays/{relay-token}/generate-claim

Returns a relay's claim.

Reference: https://docs.withpersona.com/api-reference/relay/generate-a-relay-claim

## Authentication

- `Authorization` header (required) (prefixed with ` PrivateToken token=  `) — Privacy Pass token per RFC 9577. Provide as `Authorization: PrivateToken token=<privacyPassToken>`.

## Request

### Path parameters

- `relay-token` (string, required) — The public Relay token returned by `POST /relays`.

### Headers

- `Key-Inflection` (enum, optional) — Determines casing for the API response.
  - Allowed values: `camel`, `kebab`, `snake`
- `Idempotency-Key` (string, optional) — Ensures the request is idempotent.
- `Persona-Version` (enum, optional) — Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).
  - Allowed values: `2025-12-08`, `2025-10-27`, `2023-01-05`, `2022-09-01`, `2021-08-18`, `2021-07-05`, `2021-02-21`, `2020-05-18`
- `Persona-Relay-Secret` (string, required) — The `relay-secret` value returned at Relay creation. Required for every read of the claim payload; an incorrect secret returns 404.

## Response

### 200

Returns the claim payload and whether the Privacy Pass token was consumed.

- `claim-payload` (string, required) — The claim payload. If an `encryption-key-pem` was provided at Relay creation, this is a base64-encoded RSA OAEP ciphertext that must be decrypted client-side. Otherwise, this is a JSON string containing `claim_type`, `claim_result`, and an optional `methodology` array.
- `token-consumed` (boolean, required) — `true` if the Privacy Pass token was consumed by this request. `false` if the underlying claim did not pass and the token was refunded to the client.

## Errors

### 400 Bad Request Error

The request was unacceptable, often due to invalid parameters.

- `errors` (list of RelaysRelayTokenGenerateClaimPostResponsesContentApplicationJsonSchemaErrorsItems, optional)

### 401 Unauthorized Error

No valid Privacy Pass token was presented.

- `errors` (list of RelaysRelayTokenGenerateClaimPostResponsesContentApplicationJsonSchemaErrorsItems, required)

### 403 Forbidden Error

The given API key doesn’t have permissions to perform the request or a quota has been exceeded.

- `errors` (list of RelaysRelayTokenGenerateClaimPostResponsesContentApplicationJsonSchemaErrorsItems, optional)

### 404 Not Found Error

The requested resource doesn’t exist.

- `errors` (list of RelaysRelayTokenGenerateClaimPostResponsesContentApplicationJsonSchemaErrorsItems, optional)

### 409 Conflict Error

The request conflicts with another request, often due to attempting to create a duplicate resource.

- `errors` (list of RelaysRelayTokenGenerateClaimPostResponsesContentApplicationJsonSchemaErrorsItems, optional)

### 422 Unprocessable Entity Error

The request modifies the resource in an unacceptable way, often due to an invalid action or parameter.

- `errors` (list of RelaysRelayTokenGenerateClaimPostResponsesContentApplicationJsonSchemaErrorsItems, optional)

### 429 Too Many Requests Error

Your organization’s rate limit has been exceeded. We recommend an exponential backoff on requests.

- `errors` (list of RelaysRelayTokenGenerateClaimPostResponsesContentApplicationJsonSchemaErrorsItems, optional)

## Types

### RelaysRelayTokenGenerateClaimPostResponsesContentApplicationJsonSchemaErrorsItems

- `title` (string, optional)
- `details` (string, optional)

## Examples

**Response**

```json
{
  "claim-payload": "{\"claim_type\":\"live_human_presence\",\"claim_result\":\"passed\",\"methodology\":[]}",
  "token-consumed": true
}
```

**SDK Code**

```python Success
import requests

url = "https://api.withpersona.com/api/privacy/v1/relays/relay-token/generate-claim"

headers = {
    "Persona-Relay-Secret": "Persona-Relay-Secret",
    "Authorization": "PrivateToken token= <privacyPassToken>"
}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript Success
const url = 'https://api.withpersona.com/api/privacy/v1/relays/relay-token/generate-claim';
const options = {
  method: 'POST',
  headers: {
    'Persona-Relay-Secret': 'Persona-Relay-Secret',
    Authorization: 'PrivateToken token= <privacyPassToken>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Success
package main

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

func main() {

	url := "https://api.withpersona.com/api/privacy/v1/relays/relay-token/generate-claim"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Persona-Relay-Secret", "Persona-Relay-Secret")
	req.Header.Add("Authorization", "PrivateToken token= <privacyPassToken>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Success
require 'uri'
require 'net/http'

url = URI("https://api.withpersona.com/api/privacy/v1/relays/relay-token/generate-claim")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Persona-Relay-Secret"] = 'Persona-Relay-Secret'
request["Authorization"] = 'PrivateToken token= <privacyPassToken>'

response = http.request(request)
puts response.read_body
```

```java Success
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.withpersona.com/api/privacy/v1/relays/relay-token/generate-claim")
  .header("Persona-Relay-Secret", "Persona-Relay-Secret")
  .header("Authorization", "PrivateToken token= <privacyPassToken>")
  .asString();
```

```php Success
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.withpersona.com/api/privacy/v1/relays/relay-token/generate-claim', [
  'headers' => [
    'Authorization' => 'PrivateToken token= <privacyPassToken>',
    'Persona-Relay-Secret' => 'Persona-Relay-Secret',
  ],
]);

echo $response->getBody();
```

```csharp Success
using RestSharp;

var client = new RestClient("https://api.withpersona.com/api/privacy/v1/relays/relay-token/generate-claim");
var request = new RestRequest(Method.POST);
request.AddHeader("Persona-Relay-Secret", "Persona-Relay-Secret");
request.AddHeader("Authorization", "PrivateToken token= <privacyPassToken>");
IRestResponse response = client.Execute(request);
```

```swift Success
import Foundation

let headers = [
  "Persona-Relay-Secret": "Persona-Relay-Secret",
  "Authorization": "PrivateToken token= <privacyPassToken>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.withpersona.com/api/privacy/v1/relays/relay-token/generate-claim")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```