1. Partner API v2
  2. Resources
  3. Policies

Policies

Policy documents and sign-off tracking.
6 endpointsScope readPolicyPolicyAcknowledgment
GET/v2/clients/{client_id}/policies
RequiresreadscopeCursor-paginatedReturns Page of Policy

Active policy documents for the client with sign-off progress.

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

Query parametersall optional unless marked

limitinteger

Default 100min 1 · max 500

cursorstring

Opaque cursor from the previous page's page.next_cursor.

curl "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/policies" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of Policy
dataarray of Policy
Show item properties(11)
idstring
client_idstring
titlestring
descriptionstringNullable
versioninteger
requires_acknowledgmentboolean
renewal_period_daysinteger

0 means a signature never expires.

audienceobject
Show properties(3)
typestring
One ofallgroupcollection
idstringNullable
namestringNullable
acknowledgmentsobjectNullable

Null when the policy does not require acknowledgment.

Show properties(3)
audience_countinteger
signed_countinteger
signed_ratenumber (float)
created_atstring (date-time)
updated_atstring (date-time)
pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
POST/v2/clients/{client_id}/policies
RequireswritescopeReturns Policy

Publishes a policy document to everyone in the client, the dashboard's Upload policy. Upload the PDF first with POST /clients/{client_id}/policies/uploads and send its upload_key; the upload must be a PDF of at most 25 MB, and one that is missing, not a PDF or too big returns 400 on upload_key.

  • requires_acknowledgment (default true): users must complete the policy.
  • completion_mode: acknowledgment (a click, the default) or signature.
  • renewal_period_days (0 to 3650, default 365): days before a completion expires and the user completes it again; 0 means never.

Send an Idempotency-Key: a retried request replays the original 201 instead of creating a second policy.

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

Request bodyapplication/json

titlestringRequired

max length 255

descriptionstring
upload_keystringRequired
requires_acknowledgmentboolean

Default true

completion_modestring
One ofacknowledgmentsignature

Default "acknowledgment"

renewal_period_daysinteger
curl -X POST "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/policies" \
  -H "X-API-Key: $INFIMA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Acceptable Use Policy",
    "description": "Rules for company devices, accounts, and data.",
    "upload_key": "1731254400123456789",
    "requires_acknowledgment": true,
    "completion_mode": "acknowledgment",
    "renewal_period_days": 365
  }'
Response objectPolicy
idstring
client_idstring
titlestring
descriptionstringNullable
versioninteger
requires_acknowledgmentboolean
renewal_period_daysinteger

0 means a signature never expires.

audienceobject
Show properties(3)
typestring
One ofallgroupcollection
idstringNullable
namestringNullable
acknowledgmentsobjectNullable

Null when the policy does not require acknowledgment.

Show properties(3)
audience_countinteger
signed_countinteger
signed_ratenumber (float)
created_atstring (date-time)
updated_atstring (date-time)
Errors400Invalid requestError envelope →
POST/v2/clients/{client_id}/policies/uploads
Requireswritescope

Returns a URL to upload one PDF to, for a new policy or a new version of one. PUT the file's bytes to upload_url with Content-Type: application/pdf before expires_at (15 minutes), then send upload_key to POST /clients/{client_id}/policies or POST /clients/{client_id}/policies/{policy_id}/versions. The upload is private to the client and nobody sees it until a policy uses it.

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

curl -X POST "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/policies/uploads" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectObject
upload_urlstring (uri)
upload_keystring
expires_atstring (date-time)
GET/v2/clients/{client_id}/policies/{policy_id}/acknowledgments
RequiresreadscopeCursor-paginatedReturns Page of PolicyAcknowledgment

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

policy_idstringRequired

Policy id (the policy's INFIMA id).

Query parametersall optional unless marked

statusstring
One ofsignedunsignedall

Default "all"

limitinteger

Default 100min 1 · max 500

cursorstring

Opaque cursor from the previous page's page.next_cursor.

curl "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/policies/2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e/acknowledgments" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of PolicyAcknowledgment
dataarray of PolicyAcknowledgment
Show item properties(6)
user_idstring
emailstring
namestring
signedboolean
signed_atstring (date-time)Nullable
expires_atstring (date-time)Nullable

When the signature lapses under the renewal period.

pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
Errors404Not found within the key's accessError envelope →
POST/v2/clients/{client_id}/policies/{policy_id}/reminders
Requireswritescope

Sends the standard reminder email to everyone in the policy's audience who has not completed its current version, the same email the dashboard's "Send reminder" button sends. Limited to once per policy per day: a second call within 24 hours returns 429 with Retry-After; the day's slot is only used by a reminder that was actually queued. A policy that is not active, or does not require completion, returns 409.

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

policy_idstringRequired

Policy id (the policy's INFIMA id).

curl -X POST "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/policies/2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e/reminders" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectObject
recipient_countinteger

Users who will receive the reminder. 0 means everyone has completed the policy and nothing was sent.

Errors404Not found within the key's access409The object already exists429Too many requestsError envelope →
POST/v2/clients/{client_id}/policies/{policy_id}/versions
RequireswritescopeReturns Policy

Replaces the policy's document with a new version, the dashboard's Upload new version. Upload the PDF with POST /clients/{client_id}/policies/uploads first and send its upload_key. Title, audience, renewal period and completion mode stay as they are; version goes up by one, everyone in the audience must complete the new version, and completions of earlier versions stay on record. A policy that is not active returns 409.

Send an Idempotency-Key: a retried request replays the original 201 instead of publishing another version.

Returns 201: Published

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

policy_idstringRequired

Policy id (the policy's INFIMA id).

Request bodyapplication/json

upload_keystringRequired
curl -X POST "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/policies/2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e/versions" \
  -H "X-API-Key: $INFIMA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "upload_key": "1731254400123456789"
  }'
Response objectPolicy
idstring
client_idstring
titlestring
descriptionstringNullable
versioninteger
requires_acknowledgmentboolean
renewal_period_daysinteger

0 means a signature never expires.

audienceobject
Show properties(3)
typestring
One ofallgroupcollection
idstringNullable
namestringNullable
acknowledgmentsobjectNullable

Null when the policy does not require acknowledgment.

Show properties(3)
audience_countinteger
signed_countinteger
signed_ratenumber (float)
created_atstring (date-time)
updated_atstring (date-time)
Errors400Invalid request404Not found within the key's access409The object already existsError envelope →