Start Card Authentication Simulation
Path Parameters
Program code identifier
Body Parameters
Card hash ID as per MM system
Denotes the challenge method configured for the card type of the given card hash ID
otpoobDenotes the delivery channel configured for the card type of the given card hash ID.
If challenge_method is otp, then this field is mandatory.
If challenge_method is oob, then this field is optional and its value is not considered by the system.
smsemailResponse
Authentication challenge started successfully
Response Attributes
Message that denotes the successful operation of Start authentication
Transaction Authentication ID to be used in subsequent calls
Bad Request
Possible error codes :
validation_error : Validation errors — Card_id is required
validation_error : Validation errors — challenge_method is required
validation_error : challenge_method_not_configured — challenge_method 'otp' with type 'email' is not configured for card type '{card_type_code}'
validation_error : challenge_method_not_configured — challenge_method 'oob' is not configured for card type '{card_type_code}'
parameter_card_id_invalid : Parameter Card ID Invalid — card_id is invalid
simulation_error : card_not_found — card not found
simulation_error : card_disabled — card disabled
validation_error : validation_error — type must be one of: sms, email (for otp challenge_method)
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Unauthorized Request
Possible error codes :
access_denied : access_denied — access denied
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Resource not found
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Internal Server Error
Possible error codes :
generic_error : Generic Error — General application error
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API