Skip to content

Latest commit

 

History

History
20 lines (17 loc) · 3.18 KB

ErrorDetailsMultiStepAuthentication.md

File metadata and controls

20 lines (17 loc) · 3.18 KB

# ErrorDetailsMultiStepAuthentication

Properties

Name Type Description Notes
hash string Hash for this multi-step authentication flow. Must be passed back to finAPI when continuing the flow.
status \OpenAPI\Client\Model\MsaStatus
challenge_message string In case of status = CHALLENGE_RESPONSE_REQUIRED, this field contains a message from the bank containing instructions for the user on how to proceed with the authorization. [optional]
answer_field_label string Suggestion from the bank on how you can label your input field where the user should enter his challenge response. [optional]
redirect_url string In case of status = REDIRECT_REQUIRED, this field contains the URL to which you must direct the user. It already includes the redirect URL back to your client that you have passed when initiating the service call. [optional]
redirect_context string Set in case of status = REDIRECT_REQUIRED. When the bank redirects the user back to your client, the redirect URL will contain this string, which you must process to identify the user context for the callback on your side. [optional]
redirect_context_field string Set in case of status = REDIRECT_REQUIRED. This field is set to the name of the query parameter that contains the 'redirectContext' in the redirect URL from the bank back to your client. [optional]
two_step_procedures \OpenAPI\Client\Model\TwoStepProcedure[] In case of status = TWO_STEP_PROCEDURE_REQUIRED, this field contains the available two-step procedures. Note that this set does not necessarily match the set that is stored in the respective bank connection interface. You should always use the set from this field for the multi-step authentication flow.<br/> <strong>Type:</strong> TwoStepProcedure [optional]
photo_tan_mime_type string In case that the 'photoTanData' field is set (i.e. not null), this field contains the MIME type to use for interpreting the photo data (e.g.: 'image/png') [optional]
photo_tan_data string In case that the bank server has instructed the user to scan a photo (or more generally speaking, any kind of QR-code-like data), then this field will contain the raw data of the photo as a BASE-64 string. [optional]
optical_data string In case that the bank server has instructed the user to scan a flicker code, then this field will contain the raw data for the flicker animation as a BASE-64 string. [optional]
optical_data_as_reiner_sct bool This field is only relevant when the field 'opticalData' is set. It depicts whether the optical data should be processed with the use of the Reiner SCT flicker algorithm. For more details, see: <a href='https://documentation.finapi.io/access/Flicker-Code-Template.2807824454.html&#39; target='_blank'>Flicker Code Template</a>

[Back to Model list] [Back to API list] [Back to README]