Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Compliance Forms

Complete a Compliance Form

As part of onboarding, your Merchants need to review and agree to their Compliance Form. Afterward, you need to update their Compliance Form with details about their digital signature. Finix will update their Compliance Form with those details, along with a reference to the new signed_file with their digital signature.

For more information, see Managing Compliance Forms.

put/compliance_forms/{compliance_form_id}

Request body

Response

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.