Authentication - POST Eligibility Check

POST /authentication/{authentication_id}/eligibility-check

Description: Perform an eligibility check for an authentication.

Endpoint (sandbox): https://sandbox.hyperswitch.io/authentication/{authentication_id}/eligibility-check

Authentication: Provide api-key in header (publishable keys allowed)

  • Header: api-key: <api-key>

  • Content-Type: application/json

cURL
curl --request POST \
  --url https://sandbox.hyperswitch.io/authentication/{authentication_id}/eligibility-check \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "eligibility_check_data": {
    "click_to_pay": {
      "visa": {
        "consumerPresent": true,
        "consumerStatus": "<string>",
        "customData": {
          "color_depth": 1,
          "java_enabled": true,
          "java_script_enabled": true,
          "language": "<string>",
          "screen_height": 1,
          "screen_width": 1,
          "time_zone": 123,
          "ip_address": "<string>",
          "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
          "user_agent": "<string>",
          "os_type": "<string>",
          "os_version": "<string>",
          "device_model": "<string>",
          "accept_language": "<string>",
          "referer": "<string>"
        }
      },
      "mastercard": {
        "consumerPresent": true,
        "idLookupSessionId": "<string>",
        "lastUsedCardTimestamp": "<string>"
      }
    }
  },
  "client_secret": "<string>"
}
'

Request body (application/json)

  • eligibility_check_data (object) — required

    • click_to_pay (object)

      • visa (object)

        • consumerPresent (boolean)

        • consumerStatus (string)

        • customData (object)

          • color_depth (number)

          • java_enabled (boolean)

          • java_script_enabled (boolean)

          • language (string)

          • screen_height (number)

          • screen_width (number)

          • time_zone (number)

          • ip_address (string)

          • accept_header (string)

          • user_agent (string)

          • os_type (string)

          • os_version (string)

          • device_model (string)

          • accept_language (string)

          • referer (string)

      • mastercard (object)

        • consumerPresent (boolean)

        • idLookupSessionId (string)

        • lastUsedCardTimestamp (string)

  • client_secret (string | null) — optional. Optional secret value used to identify and authorize the client making the request.

Response (200 application/json)

Response fields

  • authentication_id (string) — required The unique identifier for this authentication. Example: "auth_mbabizu24mvu3mela5njyhpit4"

  • sdk_next_action — required The next action for the SDK. Available option shown in example: await_merchant_callback

Authorizations

  • api-key (string) — header — required

Try it / Related

  • Documentation: https://api-reference.hyperswitch.io/introduction

  • Locker API Reference: https://api-reference.hyperswitch.io/locker-api-reference/overview

  • Intelligent Router API Reference: https://api-reference.hyperswitch.io/intelligent-router-api-reference/overview

Edit or raise an issue

  • Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/authentication/authentication--post-eligibility-check.mdx

  • Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/authentication/authentication--post-eligibility-check

PreviousauthenticationNextAuthentication - Create