Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Query Parameters

accountId
string
required

The ID of the account to work with.

Example:

"F50091"

personId
string<uuid>

The ID of the person to work with.

Maximum string length: 36
Example:

"775596ae-2624-40af-a9dc-9756110a4a04"

Body

application/json

Body

authenticationMethod
enum<string>
required

The method used to authenticate the cardholder.

Available options:
BIOMETRIC_FACE,
BIOMETRIC_FINGERPRINT,
VOICE_RECOGNITION,
IN_APP_LOGIN,
AUDIO_CALL,
VIDEO_CALL,
OTP_SMS,
OTP_EMAIL,
KNOWLEDGE_BASED,
OTHER
Example:

"BIOMETRIC_FACE"

authenticationResult
enum<string>
required

The result of the authentication performed.

Available options:
SUCCESS,
FAILED,
CANCELLED,
NOT_AUTHENTICATED
Example:

"SUCCESS"

acsTransactionId
string
required

The unique transaction identifier assigned by the ACS to identify a single transaction.

Maximum string length: 36
messageVersion
string
required

The 3DS protocol version used by the 3DS Requestor.

Maximum string length: 8

Response

200 - application/json

OK

success
boolean
required

Indicates the outcome of the operation.

Example:

true