Term

POST/api/v1/term/bundles

Create_bundle

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

effective_at?|

Effective timestamp (defaults to now when omitted)

Formatdate-time

mandatory?boolean

Whether the bundle is mandatory

name*string

Logical bundle name

required_documents*array<string>

Document ids that must be accepted together

routing?null|

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/term/bundles" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "required_documents": [      "string"    ]  }'

{  "bundle_id": "string",  "mandatory": true,  "name": "string",  "required_documents": [    "string"  ]}

GET/api/v1/term/check

Check_consent

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

user_id*string

User to evaluate

action*string

Action being attempted (e.g. commercial.use)

locale?string

Locale for language-specific evaluation

region?string

Region for availability evaluation

age?integer

Age context for age-gate evaluation

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/term/check?user_id=string&action=string"

{  "action": "string",  "age_gate": null,  "allowed": true,  "mandatory_update_required": true,  "reason": "string",  "required_documents": [    {      "document_id": "string",      "language": "string",      "name": "string",      "status": "missing",      "version": "string"    }  ],  "route": "string",  "user_id": "string"}

POST/api/v1/term/consents

Record_consent

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

actor?null|

age?|

Age supplied for age-gate evaluation

Formatint32

Range0 <= value

bundle_id?|

Bundle id to accept

consent_surface?|

UI surface where consent was captured

document_hash?|

Content hash the user saw, validated against the stored document hash

document_id?|

Document id to accept (one of document_id or bundle_id is required)

language?|

Language of the document the user accepted

request_context?null|

user_id*string

User whose consent is being recorded

visual_signature_id?|

Visual signature id when higher assurance is required

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/term/consents" \  -H "Content-Type: application/json" \  -d '{    "user_id": "string"  }'

{  "accepted_events": [    {      "created_at": "2019-08-24T14:15:22Z",      "document_hash": "string",      "document_id": "string",      "document_name": "string",      "document_version": "string",      "event_hash": "string",      "event_id": "string",      "event_type": "accepted",      "language": "string",      "user_id": "string"    }  ],  "complete": true,  "remaining_required_documents": [    "string"  ]}

POST/api/v1/term/consents/batch

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A batch of consent records. Each is authorized per-entry by the handler and applied independently and fail-fast; the server enforces a per-batch cap.

consents*array<>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/term/consents/batch" \  -H "Content-Type: application/json" \  -d '{    "consents": [      {        "user_id": "string"      }    ]  }'

{  "count": 0,  "results": [    {      "accepted_events": [        {          "created_at": "2019-08-24T14:15:22Z",          "document_hash": "string",          "document_id": "string",          "document_name": "string",          "document_version": "string",          "event_hash": "string",          "event_id": "string",          "event_type": "accepted",          "language": "string",          "user_id": "string"        }      ],      "complete": true,      "remaining_required_documents": [        "string"      ]    }  ]}

POST/api/v1/term/consents/revoke

Revoke_consent

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

action?|

Action to revoke consent for

actor?null|

bundle_id?|

Bundle id to revoke

document_id?|

Document id to revoke

reason?|

Reason for revocation

user_id*string

User whose consent is being revoked

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/term/consents/revoke" \  -H "Content-Type: application/json" \  -d '{    "user_id": "string"  }'

{  "cleared_bits": 0,  "revoked_events": [    {      "created_at": "2019-08-24T14:15:22Z",      "document_hash": "string",      "document_id": "string",      "document_name": "string",      "document_version": "string",      "event_hash": "string",      "event_id": "string",      "event_type": "accepted",      "language": "string",      "user_id": "string"    }  ]}

GET/api/v1/term/documents

List_documents

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

name?string

Filter by document name

language?string

Filter by language

status?string

Filter by status (draft, published, superseded, withdrawn, archived)

mandatory?boolean

Filter by mandatory flag

action?string

Filter by required action

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Page size

Formatint64

Range0 <= value

sort_by?string

Sort field

sort_order?string

Sort order (asc or desc)

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/term/documents"

{  "documents": [    {      "content_hash": "string",      "content_uri": "string",      "created_at": "2019-08-24T14:15:22Z",      "document_id": "string",      "effective_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z",      "language": "string",      "machine_constraints": {        "bundle_id": "string",        "commercial_use_required": true,        "minimum_age": 0,        "regions": [          "string"        ],        "requires_acceptance_for": [          "string"        ]      },      "mandatory": true,      "name": "string",      "published_at": "2019-08-24T14:15:22Z",      "published_by": "string",      "status": "draft",      "supersedes_document_id": "string",      "title": "string",      "updated_at": "2019-08-24T14:15:22Z",      "version": "string"    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/term/documents

Publish_document

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

content_hash*string

Content hash of the document text

content_uri?|

URI of the stored content body (typically blob://)

effective_at?|

Effective timestamp (defaults to now when omitted)

Formatdate-time

expires_at?|

Expiry timestamp

Formatdate-time

language*string

BCP-47 language tag of the published text

machine_constraints?null|

mandatory?boolean

Whether acceptance of this version is mandatory

name*string

Logical document name (e.g. "tos")

supersedes_document_id?|

Prior version this document supersedes

title*string

Human-facing title

version*string

Semantic version of the document

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/term/documents" \  -H "Content-Type: application/json" \  -d '{    "content_hash": "string",    "language": "string",    "name": "string",    "title": "string",    "version": "string"  }'

{  "content_hash": "string",  "document_id": "string",  "language": "string",  "mandatory": true,  "name": "string",  "status": "draft",  "version": "string"}

GET/api/v1/term/documents/{document_id}

Get_document

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

document_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/term/documents/string"

{  "content_hash": "string",  "content_uri": "string",  "created_at": "2019-08-24T14:15:22Z",  "document_id": "string",  "effective_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "language": "string",  "machine_constraints": {    "bundle_id": "string",    "commercial_use_required": true,    "minimum_age": 0,    "regions": [      "string"    ],    "requires_acceptance_for": [      "string"    ]  },  "mandatory": true,  "name": "string",  "published_at": "2019-08-24T14:15:22Z",  "published_by": "string",  "status": "draft",  "supersedes_document_id": "string",  "title": "string",  "updated_at": "2019-08-24T14:15:22Z",  "version": "string"}

GET/api/v1/term/export

Export_report

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

user_id?string

User to scope the export to

document_name?string

Document name to scope the export to

bundle_id?string

Bundle id to scope the export to

from?string

Inclusive lower bound for event creation time

Formatdate-time

to?string

Inclusive upper bound for event creation time

Formatdate-time

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/term/export"

{  "chain": {    "complete_chain": true,    "event_count": 0,    "gaps": [      "string"    ],    "verified": true  },  "documents": {    "property1": 0,    "property2": 0  },  "events": [    {      "created_at": "2019-08-24T14:15:22Z",      "document_hash": "string",      "document_name": "string",      "document_version": "string",      "event_hash": "string",      "event_id": "string",      "event_type": "accepted",      "language": "string",      "previous_event_hash": "string"    }  ],  "export_id": "string",  "report_hash": "string",  "signature": "string",  "signature_algorithm": "string",  "user_id": "string"}

GET/api/v1/term/export/verify

Verify_export

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

export_id*string

Id of the previously generated export to verify

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/term/export/verify?export_id=string"

{  "chain": {    "complete_chain": true,    "event_count": 0,    "gaps": [      "string"    ],    "verified": true  },  "event_count": 0,  "export_id": "string",  "recomputed_report_hash": "string",  "report_hash": "string",  "signature_valid": true}

POST/api/v1/term/signatures

Store_signature

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

blob_id?|

Blob id of the stored signature image

capture_metadata?unknown

Capture metadata (device, timestamp, geometry)

document_id?|

Document this signature is associated with

signature_hash*string

Content hash of the signature

user_id*string

User the signature belongs to

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/term/signatures" \  -H "Content-Type: application/json" \  -d '{    "signature_hash": "string",    "user_id": "string"  }'

{  "signature_hash": "string",  "signature_id": "string",  "user_id": "string"}

GET/api/v1/term/status/{user}

User_status

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

user*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/term/status/string"

{  "active": [    {      "accepted_at": "2019-08-24T14:15:22Z",      "document_hash": "string",      "document_id": "string",      "language": "string",      "name": "string",      "version": "string"    }  ],  "mandatory_update_required": true,  "missing": [    {      "document_id": "string",      "language": "string",      "name": "string",      "status": "missing",      "version": "string"    }  ],  "revoked": [    {      "accepted_at": "2019-08-24T14:15:22Z",      "document_hash": "string",      "document_id": "string",      "language": "string",      "name": "string",      "version": "string"    }  ],  "superseded": [    {      "accepted_at": "2019-08-24T14:15:22Z",      "document_hash": "string",      "document_id": "string",      "language": "string",      "name": "string",      "version": "string"    }  ],  "user_id": "string"}

201application/json

400

403

200application/json

200application/json

400

403

404

200application/json

400

403

200application/json

400

404

200application/json

201application/json

400

403

409

200application/json

404

200application/json

403

200application/json

400

403

201application/json

400

200application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`