Basis Theory API Documentation
Three DS.Authenticate Session
POST {{baseUrl}}/3ds/sessions/:sessionId/authenticate
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status OK
| {
"pan_token_id": "<string>",
"threeds_version": "<string>",
"acs_transaction_id": "7e00A5Cd-848d-3CbB-D1de-28fa8CCC4E2A",
"ds_transaction_id": "5A8eC0d3-5F0e-304F-BdcB-4f8aFf9839aA",
"sdk_transaction_id": "aBfa7B4c-AF53-7B66-E9c6-cbcebDFf77c1",
"acs_reference_number": "<string>",
"ds_reference_number": "<string>",
"authentication_value": "<string>",
"authentication_status": "<string>",
"authentication_status_code": "<string>",
"authentication_status_reason": "<string>",
"eci": "<string>",
"acs_challenge_mandated": "<string>",
"acs_decoupled_authentication": "<string>",
"authentication_challenge_type": "<string>",
"acs_rendering_type": {
"acsInterface": "<string>",
"acsUiTemplate": "<string>"
},
"acs_signed_content": "<string>",
"acs_challenge_url": "<string>",
"challenge_attempts": "<string>",
"challenge_cancel_reason": "<string>",
"cardholder_info": "<string>",
"whitelist_status": "<string>",
"whitelist_status_source": "<string>",
"message_extensions": [
{
"id": "<string>",
"name": "<string>",
"critical": "<boolean>",
"data": {
"nullable": true
}
},
{
"id": "<string>",
"name": "<string>",
"critical": "<boolean>",
"data": {
"nullable": true
}
}
]
} |
Curl
curl -X POST 'https://api.basistheory.com/3ds/sessions/:sessionId/authenticate' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"authentication_category":"\u003cstring\u003e","authentication_type":"\u003cstring\u003e","requestor_info":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","url":"\u003cstring\u003e"},"challenge_preference":"\u003cstring\u003e","purchase_info":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e","exponent":"\u003cstring\u003e","date":"\u003cstring\u003e","transaction_type":"\u003cstring\u003e","installment_count":"\u003cstring\u003e","recurring_expiration":"\u003cstring\u003e","recurring_frequency":"\u003cstring\u003e"},"merchant_info":{"mid":"\u003cstring\u003e","acquirer_bin":"\u003cstring\u003e","name":"\u003cstring\u003e","country_code":"\u003cstring\u003e","category_code":"\u003cstring\u003e","risk_info":{"delivery_email":"\u003cstring\u003e","delivery_time_frame":"\u003cstring\u003e","gift_card_amount":"\u003cstring\u003e","gift_card_count":"\u003cstring\u003e","gift_card_currency":"\u003cstring\u003e","pre_order_purchase":"\u003cboolean\u003e","pre_order_date":"\u003cstring\u003e","reordered_purchase":"\u003cboolean\u003e","shipping_method":"\u003cstring\u003e"}},"cardholder_info":{"account_id":"\u003cstring\u003e","account_type":"\u003cstring\u003e","account_info":{"account_age":"\u003cstring\u003e","account_last_changed":"\u003cstring\u003e","account_change_date":"\u003cstring\u003e","account_created_date":"\u003cstring\u003e","account_pwd_last_changed":"\u003cstring\u003e","account_pwd_change_date":"\u003cstring\u003e","purchase_count_half_year":"\u003cstring\u003e","transaction_count_day":"\u003cstring\u003e","payment_account_age":"\u003cstring\u003e","transaction_count_year":"\u003cstring\u003e","payment_account_created":"\u003cstring\u003e","shipping_address_first_used":"\u003cstring\u003e","shipping_address_usage_date":"\u003cstring\u003e","shipping_account_name_match":"\u003cboolean\u003e","suspicious_activity_observed":"\u003cboolean\u003e"},"authentication_info":{"method":"\u003cstring\u003e","timestamp":"\u003cstring\u003e","data":"\u003cstring\u003e"},"prior_authentication_info":{"method":"\u003cstring\u003e","timestamp":"\u003cstring\u003e","reference_id":"\u003cstring\u003e","data":"\u003cstring\u003e"},"name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone_number":{"country_code":"\u003cstring\u003e","number":"\u003cstring\u003e"},"mobile_phone_number":{"country_code":"\u003cstring\u003e","number":"\u003cstring\u003e"},"work_phone_number":{"country_code":"\u003cstring\u003e","number":"\u003cstring\u003e"},"billing_shipping_address_match":"\u003cstring\u003e","billing_address":{"line1":"\u003cstring\u003e","line2":"\u003cstring\u003e","line3":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","city":"\u003cstring\u003e","state_code":"\u003cstring\u003e","country_code":"\u003cstring\u003e"},"shipping_address":{"line1":"\u003cstring\u003e","line2":"\u003cstring\u003e","line3":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","city":"\u003cstring\u003e","state_code":"\u003cstring\u003e","country_code":"\u003cstring\u003e"}},"broadcast_info":{"nullable":true},"message_extensions":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","critical":"\u003cboolean\u003e","data":{"nullable":true}},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","critical":"\u003cboolean\u003e","data":{"nullable":true}}]}'
ENDPOINTS