v2

latestOpenAPI 3.0.22026-08-081303782.1 MB

Compliance Forms

Fetch a Compliance Form

Finix sends a webhook whenever a new Compliance Form is created for your Merchant. Using the ID, you can retrieve the Compliance Form.

get/compliance_forms/{compliance_form_id}

Finix-Versionstring

Example:2022-02-01

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

A single Compliance Form

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

applicationstring

ID of the Application to which the Compliance Form belongs.

compliance_form_templatestring

The ID of the template used to create the Compliance Form.

due_atstring date-time

Timestamp of when the Compliance Form is due. By default, this is 3 months after the form was created.

linked_tostring

The ID of the resource to which the Compliance Form belongs.

linked_type'MERCHANT'

Type of the resource to which the Compliance Form belongs.

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

The state of the Compliance Form.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

Maximum character length for individual keys is 40.
Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)

type'PCI_SAQ_A'

The type of the Compliance Form.

valid_fromstring date-time nullable

The timestamp of when the Compliance Form is valid from. This is set to the form's signed_at timestamp upon signature.

valid_untilstring date-time nullable

The timestamp of when the Compliance Form is valid until. This is set to one year after the form's signed_at timestamp upon signature.

versionstring

The version of the Compliance Form.