Initiate custom signature (v1)

initiateCustomSignature

Overview

Endpoint to initiate custom signature process in external Identity Provider system. The response may optionally include a display code that should be shown to the user to confirm they are signing the correct operation.

POST (/internal/v1/custom-auth:init-signature)

Parameters

  • X-Request-ID (header): Request ID used for tracing. A new one will be generated if not provided.

Request Body

Responses

200 OK

Identity Provider signature initiation response

400 Bad Request

Returned in case of an error, internal server error or invalid request

500 Internal Server Error

Returned in case of an error, internal server error or invalid request

Architecture

7 properties

Identity Provider signature initiation request

correlationId string

Correlation ID to help correlate with signature confirmation request

signatureContextData object

Context data related to the signature being performed

additionalDetails object

Details required to initiate signature in Identity Provider

1 property

Identity Provider signature initiation response

code string

Optional verification code to display to the user, confirming they are signing the correct operation. When present, the client should show this code to the user.

2 properties

Returned in case of an error, internal server error or invalid request

error string

Error message

code string

Error code

2 properties

Returned in case of an error, internal server error or invalid request

error string

Error message

code string

Error code