# Request object for simulating a 3DS authentication

## merchant

**object**  
**required**  
Merchant information for the simulated transaction

### merchant object

#### pan

**string**  
**required**  
length between 16 and 16  
Sixteen digit card number.

## transaction

**object**  
**required**  
Transaction details for the simulation

### transaction object

#### card_expiry_check

**string**  
**enum**  
When set will use the following values as part of the Simulated Authentication. When not set defaults to MATCH  
Allowed:  
`MATCH` `MISMATCH` `NOT_PRESENT`

# Responses

### `201      OK`
**object**  
#### token

**uuid**  
Globally unique identifier for the 3DS authentication.

### `400      A parameter in the query given in the request does not match the valid queries for the endpoint.`

### `401`  
|  |  |  |  
| --- | --- |  
| User has not been authenticated | Invalid or missing API key |  
| API key is not active | The API key used is no longer active |  
| Could not find API key | The API key provided is not associated with any user |  
| Please provide API key in Authorization header | The Authorization header is not in the request |  
| Please provide API key in the form Authorization: [api-key] | The Authorization header is not formatted properly |  
| Insufficient privileges. Issuing API key required | Write access requires an Issuing API key. Reach out at [lithic.com/contact](/content/contact/index.html) |  
| Insufficient privileges to create virtual cards. | Creating virtual cards requires an additional privilege |

### `422      Unprocessable entity.`

### `429      Client has exceeded the number of allowed requests in a given time period.`  
|  |  |  |  
| --- | --- |  
| Rate limited, too many requests per second | User has exceeded their per second rate limit |  
| Rate limited, reached daily limit | User has exceeded their daily rate limit |  
| Rate limited, too many keys tried | One IP has queried too many different API keys |

## Example Request  
```bash
curl --request POST \
     --url https://sandbox.lithic.com/v1/three_ds_authentication/simulate \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "merchant": {
    "country": "USA",
    "id": "OODKZAPJVN4YS7O",
    "mcc": "5812",
    "name": "COFFEE SHOP"
  },
  "pan": "4111111289144142",
  "transaction": {
    "amount": 0,
    "currency": "GBP"
  },
  "card_expiry_check": "MATCH"
}
'  
```

## Example Response  
```json
{
  "token": "fabd829d-7f7b-4432-a8f2-07ea4889aaac"
}
```