Create custom consent

POST

/v2/consents

Configure a new consent prompt structure and associate it with a journey workflow.

Authorizations

• BearerAuth

Request Body ^required

object

journey_id

required

string

header

required

string

body

required

string

Responses

201

Consent template created.

object

data

Endpoint-specific payload; omitted when the operation returns no data.

decision

Scoring decision computed for the request when a scoring system applies.

object

status

Decision status from the scoring engine (e.g. pass, fail, refer).

string

score

number

reasons

Array<string>

meta

required

object

request_id

required

string

message

string

warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

data

object

id

string

journey_id

string

header

string

body

string

created_at

string format: date-time

key

additional properties

any

400

Bad Request / Parameter Validation Failed.

object

error

required

object

code

required

string

invalid_request

message

required

Human-readable message; a string, or a field-error array for validation failures.

meta

required

object

request_id

required

string

message

string

warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

401

Unauthorized / Missing or Invalid Authentication Credentials.

object

error

required

object

code

required

string

invalid_request

message

required

Human-readable message; a string, or a field-error array for validation failures.

meta

required

object

request_id

required

string

message

string

warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

500

Internal Server Error.

object

error

required

object

code

required

string

invalid_request

message

required

Human-readable message; a string, or a field-error array for validation failures.

meta

required

object

request_id

required

string

message

string

warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>