---
title: "Cardholder Authentication API for 3DS"
method: POST
path: "/v2/lookup"
tags: ["V2"]
---

# Cardholder Authentication API for 3DS

`POST /v2/lookup`

The Cardholder Authentication API for 3DS authenticates the cardholder and leads to a challenge flow or a frictionless flow adhering to the Strong Customer Authentication (SCA) directive. For further details, refer to  <a target="_blank" style="color:blue;" href="https://verifone.cloud/docs/online-payments/api-integration/server-server-payments-3d-secure-setup-guide/server-server#step-11b__003a-__0028client__002dside__0029-pares__005fstatus-__003d-__201cc__201d-continue-to-the-authentication-step__202f">Server-to-Server Payments with 3D Secure</a>.

## Request body

- Model3
  - `code` number — A 3-digit code which uniquely identify an error.
  - `details` Details
  - `message` string — A description of the error.
  - `timestamp` integer — Error timestamp

## Response `200`

Successful

- Model4
  - `billing` Billing
    - `address_1` string — Customer's primary billing address information. <br /> Note:Required for 3DS. Please refer to the 3D Secure API specification for the format requirements.
    - `address_2` string — Customer's secondary billing address information.
    - `address_3` string — Customer's third billing address information.
    - `city` string — Customer's city on their billing address. <br /> Note:Required for 3DS. Please refer to the 3D Secure API specification for the format requirements.
    - `country_code` string — Customer's alpha 2 digit ISO 3166 country code. (e.g. United States = US) <br /> Note:Required for 3DS. Please refer to the 3D Secure API specification for the format requirements.
    - `first_name` string — Customer's first name. **Required** in case that companyName is not provided. <br /> Note:Required for 3DS. Please refer to the 3D Secure API specification for the format requirements.
    - `middle_name` string — Customer's middle name. <br />
    - `last_name` string — Customer's last name. **Required** in case that companyName is not provided. <br /> Note:Required for 3DS. Please refer to the 3D Secure API specification for the format requirements.
    - `phone` string — Customer's phone number for billing address.
    - `postal_code` string — Customer's postal code of their billing address. <br /> Note:Required for 3DS. Please refer to the 3D Secure API specification for the format requirements. Required unless market or regional mandate restricts sending this information.
    - `state` string — Customer's state or province of their billing address. (e,g. Ohio = OH, Texas = TX)
  - `company_name` string — Company of the customer. . **Required** in case that billing.firstName & billing.lastName are not provided.
  - `company_registration_number` string — Unique identifier of the company, recognised by the government. Known as CoC (Chamber of Commerce) number in some countries
  - `email_address` string — Consumer's email address.<br> Note: Required for 3DS. Please refer to the 3D Secure API specification for the format requirements.
  - `entity_id` string, required — Entity id on which the customer is created. Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)
  - `phone_number` string — Cardholder's phone number
  - `shipping` Shipping
    - `address_1` string — Consumer's primary shipping address information.</br> **Field required for**: Google Pay, Apple Pay
    - `address_2` string — Consumer's secondary shipping address information.
    - `address_3` string — Consumer's third shipping address information.
    - `city` string — Consumer's city on their shipping address.</br> **Field required for**: Google Pay, Apple Pay
    - `first_name` string — Consumer's first name.
    - `middle_name` string — Consumer's middle name.
    - `last_name` string — Consumer's last name.
    - `phone` string — Consumer's phone number.
    - `country_code` string — Consumer's alpha 2 digit ISO 3166 country code. (e.g. United States = US)</br> **Field required for**: Google Pay, Apple Pay
    - `postal_code` string — Consumer's postal code of their shipping address.</br> **Field required for**: Google Pay, Apple Pay
    - `state` string — Consumer's state or province of their shipping address. (e,g. Ohio = OH, Texas = TX)
  - `title` string — Title
  - `work_phone` string — Consumer's work phone number.
  - `tax` Tax
    - `identifier` string — An optional identifier of the document recipient:<br> Personal ID (for individuals) <br>Tax identification number (for business)
  - `language` string — Customer language preferences for the Invoice document. Read <a target="_blank" href="https://verifone.cloud/docs/online-payments/localisation">Localisation</a> for details.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error
- `504` — Gateway Time-out

---

[API](https://skmtc.dev/westpac/apis/checkout-api.md) · [All operations](https://skmtc.dev/westpac/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/westpac/checkout-api/revisions/97b34ca7df9a/schema)