Skip to content

Get 3DS pre-initiate authentication details

Request

Retrieves the details of a specific 3DS pre-initiate authentication using the authenticationId provided in the path. Note: This endpoint is intended for use with the Components SDKs.

Path
authenticationIdstringrequired

The authentication ID.

curl -i -X GET \
  'https://developer.pxp.io/_mock/apis/three-d-secure-authentication/threedsecure/integrated/authentications/{authenticationId}/assessment'

Responses

OK

Bodyapplication/json
authenticationIdstring or null

A unique reference provided by PXP for the authentication request, represented as a GUID.

Example:"550e8400-e29b-41d4-a716-446655440000"
statestring or null

The current state of the authentication request. For pre-initiation, this can only be PendingClientData or null (if the card isn't enrolled for 3DS).

Value:"PendingClientData"
scaMandatedboolean

Whether Strong Customer Authentication (SCA) is mandated for this transaction.

Example:true
applicableExemptionsstring or null

Specifies any exemptions that apply to the transaction from SCA requirements.

Enum:"LVP""TRA"
threeDSecureVersionstring or null

The version of the 3D Secure protocol being used for the authentication.

Example:"2.1.0"
threeDSecureFingerprintUrlstring or null

The URL to which the 3D Secure method data should be sent.

Example:"https://example.com/3ds-method"
threeDSecureFingerprintDatastring or null

Data required for the 3D Secure method, typically a base64 encoded string.

Example:"eyJ0aHJlZURTU2VjdXJlTWV0aG9kRGF0YSI6IlhYWiJ9"
threeDSecureSupportedboolean

Whether 3D Secure authentication is supported for this transaction.

Example:true
recommendedChallengeIndicatorstring or null

The recommended challenge indicator.

Response
{ "authenticationId": "550e8400-e29b-41d4-a716-446655440000", "state": "PendingClientData", "scaMandated": true, "applicableExemptions": "LVP", "threeDSecureVersion": "2.1.0", "threeDSecureFingerprintUrl": "https://example.com/3ds-method", "threeDSecureFingerprintData": "eyJ0aHJlZURTU2VjdXJlTWV0aG9kRGF0YSI6IlhYWiJ9", "threeDSecureSupported": true, "recommendedChallengeIndicator": "string" }