On Consent Submitted
Triggered when your customer consents to what the session will read. From this point their banks may be connected on their behalf.
This is the event to store. data carries what was agreed and the proof of it: accepted_features is the scope granted, accepted_documents the version and hash of every text accepted — with the moment it was signed, for a document that asked for a signature —, and the address, the agent and the timestamp say from where and when.
A session created with consent_level: none shows no consent screen and sends no consent event: you collected the consent yourself, and you answer for it.
What data carries, and what actually travels
The schema below describes data decrypted — on purpose, so this reference has a model you can read and code against. What arrives at your endpoint depends on how the session was created:
- With an
aes_key:datais a single string,aes::Base64(IV + Ciphertext + Tag). Decrypt it and you get exactly the object documented below. The walkthrough and the code are in Payload Encryption. - Without an
aes_key:datais not in the body at all — absent, notnull. Read the consent from Get Session Results.
Answer 2xx as soon as the payload reaches you, whatever your processing does with it afterwards: any other status is recorded as a failed delivery even though the event arrived. Answering a delivery has the handler to copy.
Payload
Payload class discriminator — always this value for Financial Rider events.
The event type: consent.
What your customer agreed to, and the proof of it — the same object the results publish as
consent. Documented decrypted: on the wire it is the aes::… string of this object when the
session carries an aes_key, and absent when it does not.