API reference
Consent
Write an audit record of the consent an end user gave for a session you own. Capture it before any biometric processing begins. The record stores the granted scopes, the version of the policy that was shown, and the request context. The caller IP is taken from the request itself and cannot be supplied in the body.
Requires the verification:create permission on the calling key.
Authorization
secretKey AuthorizationBearer <token>
Secret API key, e.g. kyc_live_... (server-side) or kyc_test_... (sandbox).
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/consent" \ -H "Content-Type: application/json" \ -d '{ "session_id": "string", "consent_types": [ "biometric" ], "policy_version": "string" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "consent_record", "session_id": "string", "consent_types": [ "biometric" ], "policy_version": "string", "granted_at": "2019-08-24T14:15:22Z"}