1. Partner API v2
  2. Resources
  3. Policies

Policies

Policy documents and sign-off tracking.
2 endpointsScope readPolicyPolicyAcknowledgment
GET/v2/clients/{client_id}/policies

List policiesLink to this endpoint

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
GET/v2/clients/{client_id}/policies/{policy_id}/acknowledgments

List who has and has not signedLink to this endpoint

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 →
Coming in 2.x1 more Policies operation is specified for a later 2.x release.See the roadmap