> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eximpe.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Verify a PAN and Record Consent

> Verify a buyer's PAN and record their consent before you create a Hosted Checkout order, so the buyer skips the PAN page.

## How it works

1. Show the buyer the consent statement below and get their agreement.
2. Call this endpoint with the buyer's `pan` and `buyer_pan_consent: true`.
3. If `verified` is `true`, create the order within 24 hours on [Create Order](https://docs.eximpe.com/api-reference/v3/order/create.md#skip-the-pan-page). Send the same PAN as `buyer.pan_number`, with `business_model` and `purpose_code`.

If `verified` is `false`, no consent is recorded. The buyer enters their PAN on the PAN page in Hosted Checkout.

## Consent

Send `buyer_pan_consent: true` only after the buyer has agreed to the statement Hosted Checkout shows on its PAN page.

* **LRS payments:** "By continuing, I confirm that the PAN I entered belongs to the person paying for this purchase, that I have permission to share it, and that this payment is within their LRS limit for this financial year, and I agree to the Terms & Conditions and Privacy Policy."
* **Other consumer payments:** "By continuing, I confirm that the PAN I entered belongs to the person paying for this purchase, that I have permission to share it, and I agree to the Terms & Conditions and Privacy Policy."

The consent lasts 24 hours and covers every order created with that PAN in that time. After 24 hours the buyer sees the PAN page again; call this endpoint again to renew it. For an LRS order, the time of this call is recorded as the buyer's LRS declaration time.

## Reasons

| `reason` | Meaning |
| - | - |
| `INVALID_PAN` | The PAN does not exist. |
| `NON_INDIVIDUAL_PAN` | The PAN belongs to a company, firm or other non-individual. |
| `INOPERATIVE_PAN` | The PAN is inoperative. |
| `AADHAAR_NOT_LINKED` | The PAN is active but not linked to Aadhaar. |

## Errors

| Status | `error.code` | When |
| - | - | - |
| `400` | `40357` | `buyer_pan_consent` is missing or not `true`, or `pan` is missing or badly formed. `details` is keyed by the field. |
| `503` | `40356` | Verification is temporarily unavailable. No consent was recorded. Retry after the `Retry-After` header (60 seconds). |
| `500` | `40356` | Anything unexpected. No consent was recorded. |

```json Consent missing theme={null}
{
  "success": false,
  "error": {
    "code": 40357,
    "message": "Invalid PAN verification request.",
    "details": {
      "buyer_pan_consent": ["This field is required."]
    }
  }
}
```


## OpenAPI

````yaml POST /pg/pan/consent/
openapi: 3.0.0
info:
  title: Eximpe Payment Gateway API
  description: >-
    API for payment processing and order management through Eximpe payment
    gateway. This specification is for v3 API version.
  license:
    name: Proprietary
  version: 3.0.0
servers:
  - url: https://api-pacb-uat.eximpe.com
    description: Payment Gateway Sandbox URL
security:
  - clientAuth: []
    clientSecretAuth: []
tags:
  - name: Card Tokens
  - name: Merchants
  - name: Orders
  - name: Payment Links
  - name: Payments
  - name: Refunds
  - name: Settlements
  - name: Subscriptions
  - name: Virtual Bank Accounts
    description: Create and manage virtual bank accounts and read collected payments.
  - name: B2B Verification
    description: Verification and post-settlement compliance for B2B payments.
paths:
  /pg/pan/consent/:
    post:
      tags:
        - LRS
      summary: Verify a PAN and record consent
      description: >-
        Verify a buyer's PAN and record their consent before you create the
        order. When the PAN passes, create the order on [Create
        Order](/api-reference/v3/order/create#skip-the-pan-page) with the same
        PAN in `buyer.pan_number` within 24 hours, and the buyer skips the PAN
        page in Hosted Checkout. The PAN passes when it is valid, belongs to an
        individual, is active and is linked to Aadhaar.


        Send `buyer_pan_consent: true` only after the buyer has agreed to the
        statement Hosted Checkout shows on the PAN page:


        - LRS payments: "By continuing, I confirm that the PAN I entered belongs
        to the person paying for this purchase, that I have permission to share
        it, and that this payment is within their LRS limit for this financial
        year, and I agree to the Terms & Conditions and Privacy Policy."

        - Other consumer payments: "By continuing, I confirm that the PAN I
        entered belongs to the person paying for this purchase, that I have
        permission to share it, and I agree to the Terms & Conditions and
        Privacy Policy."


        The consent lasts 24 hours. A PAN that fails returns `verified: false`
        and a `reason`, and no consent is recorded.
      operationId: v3_post_pg_pan_consent_
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - pan
                - buyer_pan_consent
              properties:
                pan:
                  type: string
                  description: >-
                    Buyer PAN (AAAAA9999A format). Spaces around it are trimmed
                    and letters are upper-cased.
                  example: ABCPK1234F
                buyer_pan_consent:
                  type: boolean
                  description: >-
                    `true` when the buyer has agreed to the consent statement
                    above. Any other value is refused.
                  example: true
            example:
              pan: ABCPK1234F
              buyer_pan_consent: true
      responses:
        '200':
          description: PAN checked. Read `verified`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: PAN verified.
                  data:
                    type: object
                    properties:
                      verified:
                        type: boolean
                        example: true
                      reason:
                        type: string
                        nullable: true
                        enum:
                          - INVALID_PAN
                          - NON_INDIVIDUAL_PAN
                          - INOPERATIVE_PAN
                          - AADHAAR_NOT_LINKED
                        description: Why the PAN did not pass. `null` when it passed.
                        example: null
              examples:
                verified:
                  summary: Verified
                  value:
                    success: true
                    message: PAN verified.
                    data:
                      verified: true
                      reason: null
                not_verified:
                  summary: Not linked to Aadhaar
                  value:
                    success: true
                    message: PAN could not be verified.
                    data:
                      verified: false
                      reason: AADHAAR_NOT_LINKED
        '400':
          description: >-
            Invalid request: `buyer_pan_consent` missing or not `true`, or a
            missing or badly formed PAN. Error code `40357`; `details` is keyed
            by the field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3_ErrorResponse'
        '500':
          description: Unexpected error. No consent was recorded. Error code `40356`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3_ErrorResponse'
        '503':
          description: >-
            PAN verification is temporarily unavailable, so no consent was
            recorded. Retry after the number of seconds in the `Retry-After`
            header (60). Error code `40356`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3_ErrorResponse'
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
                example: 60
      security:
        - clientAuth: []
          clientSecretAuth: []
          merchantAuth: []
          apiVersionHeader: []
components:
  schemas:
    v3_ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          description: Indicates if the request was successful
        error:
          $ref: '#/components/schemas/v3_ErrorDetails'
    v3_ErrorDetails:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Error code (e.g., ERR_ORDER_002)
        message:
          type: string
          description: Error message
        details:
          type: object
          description: Detailed validation error information with field-specific errors
          additionalProperties:
            type: string
            description: Error message for the specific field
  securitySchemes:
    clientAuth:
      type: apiKey
      name: X-Client-ID
      in: header
      description: >-
        **Client Application ID** - Your unique application identifier used to
        authenticate API requests. You can find your Client ID in the Developer
        Settings section of the merchant dashboard.
      x-displayName: Client ID
      x-example: your-client-id
    clientSecretAuth:
      type: apiKey
      name: X-Client-Secret
      in: header
      description: >-
        **Client Secret Key** - Your secret key used alongside the Client ID for
        secure authentication. Keep this confidential and never expose it in
        client-side code. Available in the Developer Settings section of the
        merchant dashboard.
      x-displayName: Client Secret
      x-example: your-client-secret
    merchantAuth:
      type: apiKey
      name: X-Merchant-ID
      in: header
      description: >-
        **Merchant Identifier** - The unique ID for the merchant account. This
        is required for PSP (Payment Service Provider) merchants who manage
        multiple merchant accounts. You can find merchant IDs in the Merchant
        Management section of the dashboard.
      x-displayName: Merchant ID
      x-example: your-merchant-id

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.