# List Compliance Forms

Get all  linked to your Merchants.

For details on how to query endpoints using the available parameters, see Query Parameters.

Endpoint: GET /compliance_forms
Version: 2022-02-01
Security: BasicAuth

## Query parameters:

  - `state` (string)
    Filter by the Compliance Form's . Use comma-separated values to filter for multiple states (for example, you can specify ).
    Enum: "INCOMPLETE", "OVERDUE", "COMPLETE", "EXPIRED", "INVALID"

  - `linked_to` (string)
    Filter by whom the Compliance Form resource is linked to.
    Example: "MUwfZPNW3r4EqLMzwgr6txw4"

## Response 200 fields (application/json):

  - `_embedded` (object)

  - `_embedded.compliance_forms` (array)
    List of  resources

  - `_embedded.compliance_forms.id` (string)
    ID of the .

  - `_embedded.compliance_forms.created_at` (string)
    Timestamp of when the object was created.

  - `_embedded.compliance_forms.updated_at` (string)
    Timestamp of when the object was last updated.

  - `_embedded.compliance_forms.application` (string)
    ID of the  to which the  belongs.

  - `_embedded.compliance_forms.compliance_form_template` (string)
    ID of the template used to create the .

  - `_embedded.compliance_forms.due_at` (string)
    Timestamp of when the  is due. By default, this is 3 months after the form was created.

  - `_embedded.compliance_forms.files` (object)
    IDs of the  resources for the signed and unsigned  PDFs.

  - `_embedded.compliance_forms.files.signed_file` (string,null)
    ID of the  resource for the signed  PDF.

  - `_embedded.compliance_forms.files.unsigned_file` (string)
    ID of the  resource for the unsigned  PDF.

  - `_embedded.compliance_forms.linked_to` (string)
    ID of the resource to which the  belongs.

  - `_embedded.compliance_forms.linked_type` (string)
    Type of the resource to which the  belongs.
    Enum: "MERCHANT"

  - `_embedded.compliance_forms.pci_saq_a` (object)
    Details about the signee's digital signature

  - `_embedded.compliance_forms.pci_saq_a.ip_address` (string,null)
    IP address of the signee

  - `_embedded.compliance_forms.pci_saq_a.is_accepted` (boolean)
    Whether the signee has signed the form yet

  - `_embedded.compliance_forms.pci_saq_a.name` (string,null)
    Full name of the signee

  - `_embedded.compliance_forms.pci_saq_a.signed_at` (string,null)
    Timestamp of the signee's signature

  - `_embedded.compliance_forms.pci_saq_a.title` (string,null)
    Job title of the signee

  - `_embedded.compliance_forms.pci_saq_a.user_agent` (string,null)
    User-Agent string of the signee's device

  - `_embedded.compliance_forms.state` (string)
    State of the
    Enum: "INCOMPLETE", "OVERDUE", "COMPLETE", "EXPIRED", "INVALID"

  - `_embedded.compliance_forms.tags` (object,null)
    Include up to 50  pairs to annotate requests with custom metadata.
- Maximum character length for individual  is 40.
- Maximum character length for individual  is 500.
(For example, , , )

  - `_embedded.compliance_forms.type` (string)
    Type of the
    Enum: "PCI_SAQ_A"

  - `_embedded.compliance_forms.valid_from` (string,null)
    Timestamp of when the  is valid from. This is set to the form's  timestamp upon signature.

  - `_embedded.compliance_forms.valid_until` (string,null)
    Timestamp of when the  is valid until. This is set to one year after the form's  timestamp upon signature.

  - `_embedded.compliance_forms.version` (string)
    Version of the

  - `_links` (object)
    For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these  to make your follow-up requests and quickly access relevant IDs.

  - `_links.next` (object)
    Link to the next page of entries.

  - `_links.next.href` (string)

  - `_links.self` (object)
    Link to the resource that was used in the request.

  - `page` (object)
    Details the page that's returned.

  - `page.limit` (integer)
    The number of entries to return.

  - `page.next_cursor` (string,null)
    The cursor to use for the next page of results.

## Response 401 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "UNKNOWN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.self` (object)

  - `_embedded.errors._links.self.href` (string)

  - `_embedded.errors._links.source` (object)

## Response 403 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "FORBIDDEN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)

## Response 404 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "NOT_FOUND"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)

## Response 406 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "NOT_FOUND"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)