Send an attestation request

curl --request POST \
  --url https://api.clearpolicy.app/api/v1/attestation-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "person_id": "<string>",
  "document_id": "<string>",
  "requested_attestation_type": "signature",
  "recipient_message": "<string>"
}
'

import requests

url = "https://api.clearpolicy.app/api/v1/attestation-requests"

payload = {
    "person_id": "<string>",
    "document_id": "<string>",
    "requested_attestation_type": "signature",
    "recipient_message": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    person_id: '<string>',
    document_id: '<string>',
    requested_attestation_type: 'signature',
    recipient_message: '<string>'
  })
};

fetch('https://api.clearpolicy.app/api/v1/attestation-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clearpolicy.app/api/v1/attestation-requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'person_id' => '<string>',
    'document_id' => '<string>',
    'requested_attestation_type' => 'signature',
    'recipient_message' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.clearpolicy.app/api/v1/attestation-requests"

	payload := strings.NewReader("{\n  \"person_id\": \"<string>\",\n  \"document_id\": \"<string>\",\n  \"requested_attestation_type\": \"signature\",\n  \"recipient_message\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.clearpolicy.app/api/v1/attestation-requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"person_id\": \"<string>\",\n  \"document_id\": \"<string>\",\n  \"requested_attestation_type\": \"signature\",\n  \"recipient_message\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clearpolicy.app/api/v1/attestation-requests")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"person_id\": \"<string>\",\n  \"document_id\": \"<string>\",\n  \"requested_attestation_type\": \"signature\",\n  \"recipient_message\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "organization_id": "<string>",
  "document_id": "<string>",
  "document_revision_id": "<string>",
  "person_id": "<string>",
  "recipient_name": "<string>",
  "recipient_email": "jsmith@example.com",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "recipient_message": "<string>",
  "sent_at": "2023-11-07T05:31:56Z",
  "last_reminded_at": "2023-11-07T05:31:56Z",
  "viewed_at": "2023-11-07T05:31:56Z",
  "attested_at": "2023-11-07T05:31:56Z",
  "canceled_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "expired_at": "2023-11-07T05:31:56Z",
  "requested_by_user_id": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "message": "<string>",
  "payment_url": "<string>"
}

{
  "error": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

{
  "message": "Too Many Attempts."
}

POST

attestation-requests

Send an attestation request

curl --request POST \
  --url https://api.clearpolicy.app/api/v1/attestation-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "person_id": "<string>",
  "document_id": "<string>",
  "requested_attestation_type": "signature",
  "recipient_message": "<string>"
}
'

import requests

url = "https://api.clearpolicy.app/api/v1/attestation-requests"

payload = {
    "person_id": "<string>",
    "document_id": "<string>",
    "requested_attestation_type": "signature",
    "recipient_message": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    person_id: '<string>',
    document_id: '<string>',
    requested_attestation_type: 'signature',
    recipient_message: '<string>'
  })
};

fetch('https://api.clearpolicy.app/api/v1/attestation-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clearpolicy.app/api/v1/attestation-requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'person_id' => '<string>',
    'document_id' => '<string>',
    'requested_attestation_type' => 'signature',
    'recipient_message' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.clearpolicy.app/api/v1/attestation-requests"

	payload := strings.NewReader("{\n  \"person_id\": \"<string>\",\n  \"document_id\": \"<string>\",\n  \"requested_attestation_type\": \"signature\",\n  \"recipient_message\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.clearpolicy.app/api/v1/attestation-requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"person_id\": \"<string>\",\n  \"document_id\": \"<string>\",\n  \"requested_attestation_type\": \"signature\",\n  \"recipient_message\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clearpolicy.app/api/v1/attestation-requests")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"person_id\": \"<string>\",\n  \"document_id\": \"<string>\",\n  \"requested_attestation_type\": \"signature\",\n  \"recipient_message\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "organization_id": "<string>",
  "document_id": "<string>",
  "document_revision_id": "<string>",
  "person_id": "<string>",
  "recipient_name": "<string>",
  "recipient_email": "jsmith@example.com",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "recipient_message": "<string>",
  "sent_at": "2023-11-07T05:31:56Z",
  "last_reminded_at": "2023-11-07T05:31:56Z",
  "viewed_at": "2023-11-07T05:31:56Z",
  "attested_at": "2023-11-07T05:31:56Z",
  "canceled_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "expired_at": "2023-11-07T05:31:56Z",
  "requested_by_user_id": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "message": "<string>",
  "payment_url": "<string>"
}

{
  "error": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

{
  "message": "Too Many Attempts."
}

Authorizations

Authorization

string

header

required

Bearer token created in ClearPolicy API settings with the api:use scope.

Body

application/json

person_id

string

required

The ULID of the person to send the request to.

document_id

string

required

The ULID of the document to send. Must have a published revision.

requested_attestation_type

enum<string>

deprecated

Deprecated. Ignored if sent. New requests always use signature (typed-name electronic signature). acknowledgment is not accepted for writes.

Available options:

signature

recipient_message

string

An optional message to include with the request. This message appears in the emails sent for document requests and on the attestation page.

Maximum string length: 5000

Response

The created attestation request.

string

required

The ULID of the attestation request.

organization_id

string

required

The ULID of the organization.

document_id

string

required

The ULID of the document being attested.

document_revision_id

string

required

The ULID of the published revision that was sent.

person_id

string

required

The ULID of the person the request was sent to.

recipient_name

string

required

The name of the recipient when the request was created.

recipient_email

string<email>

required

The email of the recipient when the request was created.

requested_attestation_type

enum<string>

required

Attestation type frozen on this request. New requests are always signature. acknowledgment is historical (read-only).

Available options:

acknowledgment,

signature

source

enum<string>

required

How the request was created.

Available options:

oauth,

web,

system,

planning_center

status

enum<string>

required

The current status of the request. Delivery problem statuses (bounced, failed, complained) apply to pending requests whose latest email could not be delivered.

Available options:

created,

sent,

viewed,

attested,

canceled,

expired,

bounced,

failed,

complained

created_at

string<date-time>

required

When the request was created.

updated_at

string<date-time>

required

When the request was last updated.

recipient_message

string | null

The message included with the request that appears in emails and on the attestation page, or null if none was provided.

sent_at

string<date-time> | null

When the request was sent, or null.

last_reminded_at

string<date-time> | null

When the most recent reminder was sent, or null.

viewed_at

string<date-time> | null

When the recipient first viewed the request, or null.

attested_at

string<date-time> | null

When the recipient completed the attestation, or null.

canceled_at

string<date-time> | null

When the request was canceled, or null.

expires_at

string<date-time> | null

When the request is scheduled to expire, or null.

expired_at

string<date-time> | null

When the request expired, or null.

requested_by_user_id

string | null

The ULID of the user whose API token issued this request.

Last modified on August 4, 2026

Overview

Me

People

Documents

Groups

Attestation requests

Send an attestation request

Authorizations

Body

Response