FIfinix
Compliance Forms

List Compliance Forms

Retrieve a list of Compliance Form resources.

get/compliance_forms

Request

Query parameters

linked_tostring
Example:MUwfZPNW3r4EqLMzwgr6txw4

Filter by the Merchant the Compliance Form resource is linked to.

state'INCOMPLETE' | 'OVERDUE' | 'COMPLETE' | 'EXPIRED' | 'INVALID'
Example:COMPLETE

Filter by the Compliance Form's state. Use comma-separated values to filter for multiple states (for example, you can specify ?state=INCOMPLETE,EXPIRED).

after_cursorstring

Return every resource created after the cursor value.

before_cursorstring

Return every resource created before the cursor value.

created_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where created_at is after the given date.

created_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where created_at is before the given date.

limitinteger
Example:10

The numbers of items to return.

tags.keystring
Example:card_type

Filter by the tag's key. For more information, see Tags.

tags.valuestring
Example:business_card

Filter by the tag's value. For more information, see Tags.

updated_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where updated_at is after the given date.

updated_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where updated_at is before the given date.

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

List of Compliance Form resources

Changes

No recorded changes to this operation across all 27 revisions of this API.