Authentication - POST Eligibility Check

post/authentication/{authentication_id}/eligibility-check

Request

The document declares no server URL.
Auth
API key in header api-key
TypeScript
https://skmtc.dev/hyperswitch/apis/dynamic-routing-openapi-3-0/docs/authentication/:authentication_id/eligibility-check/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

client_secretstring nullable

Optional secret value used to identify and authorize the client making the request. This can help ensure that the payment session is secure and valid.

Example request

{
  "eligibility_check_data": {
    "click_to_pay": {
      "visa": {
        "customData": {
          "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8"
        }
      }
    }
  }
}

Response

Eligibility Performed for the Authentication

authentication_idstring required

The unique identifier for this authentication.

Example response

{
  "authentication_id": "auth_mbabizu24mvu3mela5njyhpit4"
}

Changes

No recorded changes to this operation across all 1 revision of this API.