Skip to main content
Record an agreement acceptance

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Minimum string length: 1

Body

application/json
agreement
object
required

The current version of one agreement, usually from the onboarding's or a capability's required actions.

is_accepted
boolean
required
accepted_at
string<date-time>
required

When the person accepted. Before the agreement took effect, more than 5 minutes in the future or more than 30 days old is refused, with CONSENT_ACCEPTED_AT_INVALID.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
accepted_by
object
required
accepted_ip
required
wording
string
required

The exact text the person saw, with no control character but a line break or a tab.

Required string length: 1 - 10000
Pattern: ^[^\x00-\x08\x0B\x0C\x0E-\x1F\x7F]*$
locale
string
required
Maximum string length: 35
Pattern: ^[A-Za-z]{2,3}(-[A-Za-z0-9]{1,8})*$
bank_account
object

The merchant's owned account a bank_debit_authorization authorises debits from. Required for that agreement, and refused for any other.

Response

The agreement_acceptance already there, in the full view: a repeat records nothing.

result
object
required
entities
object
required

Nothing can be included here.

not_included
object[]
required