Improve authentication performance
Last updated: July 19, 2023
Issuers use the information you provide in your authentication requests to perform risk analysis and determine the authentication outcome.
To improve your authentication acceptance rates, you can include additional optional fields in your requests, which gives issuers more information to base their decision on.
Checkout.com supports the inclusion of the optional fields shown in the following tables. For more information on the fields, see our API documentation.
Although these fields within the source
object are optional, Checkout.com strongly recommends that you include as many of them as possible in your authentication request. These fields provide information about the address and contact information that the customer holds with the merchant.
Field | Example |
---|---|
string |
|
string |
|
string |
|
string |
|
string |
|
string |
|
string |
|
boolean |
|
string |
|
string |
|
string |
|
string |
|
string |
|
string |
|
string |
|
string |
|
string |
|
string |
|
string |
|
string |
|
string |
|
1{2"source": {3"email": "[email protected]",4"name": "John Smith",5"billing_address": {6"address_line1": "123 Anywhere St.",7"address_line2": "Apt. 456",8"address_line3": "A",9"city": "Anytown",10"state": "AL",11"zip": "123456",12"country": "US"13},14"home_phone": {15"country_code": "1",16"number": "555 123 4567"17},18"mobile_phone": {19"country_code": "1",20"number": "555 765 4321"21},22"work_phone": {23"country_code": "1",24"number": "555 111 2222"25}26},27"shipping_address": {28"address_line1": "123 Anywhere St.",29"address_line2": "Apt. 456",30"address_line3": "A",31"city": "Anytown",32"state": "AL",33"zip": "123456",34"country": "US"35},36"shipping_address_matches_billing": true37}
Information
The example contents are not valid calls to the endpoint. They only show the optional fields, not everything you would need to include in a call.
Although these fields within the account_info
object are optional, Checkout.com strongly recommends that you include most of them in your authentication request. These fields provide information about the account that the customer holds with the merchant.
You can also include the account_id
field and the three_ds_requestor_authentication_info
object, although these are lower priority.
Field | Example | |
---|---|---|
string |
| |
string |
| |
string |
| |
string |
| |
string |
| |
boolean |
| |
string |
| |
string |
| |
string |
| |
string |
| |
string |
| |
string |
| |
string |
| |
string |
| |
string |
| |
string |
| |
boolean |
| |
string |
| |
string |
| |
string |
| |
string |
| |
string |
|
1{2"account_info": {3"account_age": "created_during_transaction",4"account_change": "2019-08-24T14:15:22Z",5"account_change_indicator": "less_than_thirty_days",6"account_date": "2019-08-24T14:15:22Z",7"account_id": "CKO123456",8"account_name_matches_shipping_name": true,9"account_password_change": "2019-08-24T14:15:22Z",10"account_password_change_indicator": "no_change",11"account_type": "credit",12"add_card_attempts": 2,13"authentication_method": "own_credentials",14"cardholder_account_age_indicator": "thirty_to_sixty_days",15"payment_account_age": "2019-08-24T14:15:22Z",16"purchase_count": 1,17"shipping_address_age": "less_than_thirty_days",18"shipping_address_usage": "2019-08-24T14:15:22Z",19"suspicious_account_activity": false,20"transactions_per_year": 10,21"transactions_today": 2,22"three_ds_requestor_authentication_info": {23"three_ds_req_auth_data": "dsTransactionId:cfa2beeb-74f4-47ba-89ac-4b0332cc47c2",24"three_ds_req_auth_method": "third_party_authentication",25"three_ds_req_auth_timestamp": "2019-08-24T14:15:22Z"26}27}28}
Information
The example contents are not valid calls to the endpoint. They only show the optional fields, not everything you would need to include in a call.
Although these fields within the merchant_risk_info
object are optional, Checkout.com recommends that you consider including them in your authentication request. These fields provide additional information about the cardholder's purchase.
Field | Example | |
---|---|---|
string | ||
string |
| |
string |
| |
string |
| |
string |
| |
boolean |
| |
boolean |
| |
string |
| |
string |
| |
string |
| |
string |
|
1{2"merchant_risk_info": {3"delivery_email": "[email protected]",4"delivery_timeframe": "two_days_or_more",5"gift_card_amount": "135",6"gift_card_count": 1,7"gift_card_currency": "USD",8"is_preorder": false,9"is_reorder": true,10"pre_order_date": "2019-08-24T14:15:22Z",11"pre_order_purchase_indicator": "merchandise_available",12"reorder_items_indicator": "first_time_ordered",13"shipping_indicator": "billing_address"14}15}
Information
The example contents are not valid calls to the endpoint. They only show the optional fields, not everything you would need to include in a call.
Although these fields within the initial_transaction
or previous_transaction
object are optional, Checkout.com recommends that you consider including them in your authentication request. These fields provide information about previous transactions.
Field | Example | |
---|---|---|
string |
| |
string |
| |
string |
| |
string |
|
1{2"initial_transaction": {3"acs_transaction_id": "ef35a82d-66bc-4b0e-b59c-39ed3129d868",4"authentication_data": "dsTransactionId:cfa2beeb-74f4-47ba-89ac-4b0332cc47c2",5"authentication_method": "challenge_occurred",6"authentication_timestamp": "2023-02-06T15:00:00.000Z"7}8}
Information
The example contents are not valid calls to the endpoint. They only show the optional fields, not everything you would need to include in a call.