---
title: "Send pre-authentication for evaluation"
method: POST
path: "/customer_evaluation_provided_url"
tags: ["HST"]
---

# Send pre-authentication for evaluation

`POST /customer_evaluation_provided_url`

Send pre authentication information to customer to evaluate the authentication.

## Headers

- `account_id` integer, required
- `card_id` integer, required

## Request body

- Evaluate
  - `id` string, required — Pismo-generated unique authentication ID
  - `external_id` string, required — Provider-generated unique ID for client monitoring and tracking
  - `provider` 'HST', required — Third-party provider name
  - `type` 'authentication' | 'challenge-request', required — Evaluation intention
  - `card` Card, required
    - `id` integer — Enrolled card ID
    - `mode_id` integer — Card mode ID
    - `type` 'PLASTIC' | 'VIRTUAL' | 'RECURRING' | 'TEMPORARY' — Card type
    - `hash` string — Encrypted PAN using 2048 rsa key and base64 encoded. Pismo provides the encrypt/decrypt keys for this field.
    - `bin` string — Card BIN (Bank Identification Number)
    - `last_four_digits` string — Card last four PAN digits
  - `account` Account, required
    - `id` integer — Account ID
    - `document_number` string — Cardholder government document number. This can be from any document that identifies the cardholder such as a Tax ID, State ID, or driver's license.
    - `postal_code` string — Cardholder postal code
  - `program` Program, required
    - `id` integer — Program ID
  - `customer` Customer, required
    - `id` integer — Pismo customer ID.
  - `raw_provider` RawProvider, required — All non-PCI information received from provider. Check provider documentation for details.

## Response `200`

OK

- EvaluateResponse
  - `decision` 'approve' | 'reject' | 'request_challenge', required — Client's anti-fraud evaluated decision
  - `challenge_info` ChallengeInfo — Customer challenge information including cardholder data
    - `cardholder_name` string — Cardholder name
    - `method` 'OTP' | 'OOB' — Method to be used to challenge the cardholder. Possible values: - OTP - OOB
    - `cardholder_phone` object — Cardholder phone number details
      - `country_code` string — Country code
      - `area_code` string — Area code
      - `number` string — Phone number without area code
  - `subissuer_id` string — Client's subissuer override, we will use this one to override the issuerSpecificData.subissuerID, if empty, we will use the org_id value.
  - `product_id` string — Client's product override, we will use this one to override the issuerSpecificData.productID, if empty, we will use the program_id value.
  - `metadata` string — Any data object with key/value pairs. No limit on length. **Note**: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to [Get started with Pismo APIs](https://developers.pismo.io/pismo-docs/reference/get-started-with-pismo-apis#metadata).

---

[API](https://skmtc.net/pismo/apis/platform-authentication.md) · [All operations](https://skmtc.net/pismo/apis/platform-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pismo/platform-authentication/revisions/935b62e16de4/schema)