Compliance Forms

Compliance forms are the merchant agreements (terms of service, processing agreements, etc.) that need an authorized signer's name and title before certain platform features unlock.

Accessed via client.compliance_forms.

Methods

list

GET /compliance-forms. Every form your account currently needs.

client.compliance_forms.list

retrieve(id)

GET /compliance-forms/:id.

client.compliance_forms.retrieve("cf_…")

sign(id, name:, title:)

PUT /compliance-forms/:id/sign. Records the signer's name and title against the form.

client.compliance_forms.sign("cf_…", name: "Ada Lovelace", title: "CEO")

Object shape

:id, :type, :state (UNSIGNED, SIGNED), :document_url, :signed_by, :signed_at, :created_at, …

Examples

Sign every outstanding form

client.compliance_forms.list[:data].each do |form|
  next if form[:state] == "SIGNED"

  client.compliance_forms.sign(form[:id], name: "Ada Lovelace", title: "CEO")
end