> ## Documentation Index > Fetch the complete documentation index at: https://docs.privue.ai/llms.txt > Use this file to discover all available pages before exploring further. # PAN verification > Verify a PAN and the holder details claimed for it against the income-tax registry. ## OpenAPI ````yaml /suite/api-reference/openapi.json post /pan/v1/verify.3 openapi: 3.1.0 info: title: Privue API Suite version: 1.0.0 description: >- Business, tax, registry, employment and identity verification against official Indian sources, a person's own documents read through DigiLocker with their consent, and an EPF member's passbook read with the OTP they receive. **Authentication.** Every request takes your API key as a bearer token: `Authorization: Bearer `. **One envelope.** Every check returns the reasons behind a refusal and the record the source held, and an empty `reasons` means the check passed. Branch on `reasons` rather than on the status code, because a call the source answered returns `200` whatever it concluded. **DigiLocker and EPFO passbook.** A DigiLocker endpoint returns `details` alone: what it read, as the source holds it. So do submitting an EPFO passbook OTP and reading the passbook; sending the OTP answers like a check. **Versioning.** Each endpoint is versioned on its own, directly in its path. A new version of one endpoint never moves another, so no release requires migrating every integration at once. servers: - url: https://api.privue.ai description: Production security: - bearerAuth: [] tags: - name: Checks description: One check on one subject, answered in the envelope every check shares. - name: DigiLocker description: >- A person's own documents, read through the consent they give at DigiLocker. - name: EPFO passbook description: >- A member's EPF passbook, read with the OTP sent to the mobile number on their account. - name: Orchestrated flows description: Every check on one business, asked and answered together in a single call. - name: Usage description: What you have called, and when. paths: /pan/v1/verify.3: post: tags: - Checks summary: PAN verification description: >- Verify a PAN and the holder details claimed for it against the income-tax registry. operationId: pan.verify.3 requestBody: content: application/json: schema: $ref: '#/components/schemas/PanVerifyRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PanVerifyResponse' examples: verified: summary: A PAN whose details match value: reasons: [] details: pan: ABCPE1234F category: Individual status: valid remarks: null name_as_per_pan_match: true date_of_birth_match: true aadhaar_seeded: true name_mismatch: summary: A name that does not match value: reasons: - code: pan-name-mismatch message: >- This name is not the one the income-tax registry holds for this PAN. details: pan: ABCPE1234F category: Individual status: valid remarks: null name_as_per_pan_match: false date_of_birth_match: true aadhaar_seeded: true date_of_birth_mismatch: summary: A date of birth that does not match value: reasons: - code: pan-date-of-birth-mismatch message: >- This date of birth is not the one the income-tax registry holds for this PAN. details: pan: ABCPE1234F category: Individual status: valid remarks: null name_as_per_pan_match: true date_of_birth_match: false aadhaar_seeded: true inactive: summary: A PAN the registry does not hold as valid value: reasons: - code: pan-inactive message: This PAN is not active in the income-tax registry. - code: pan-name-mismatch message: >- This name is not the one the income-tax registry holds for this PAN. - code: pan-date-of-birth-mismatch message: >- This date of birth is not the one the income-tax registry holds for this PAN. details: pan: ABCPE1234F category: Individual status: invalid remarks: Invalid PAN name_as_per_pan_match: false date_of_birth_match: false aadhaar_seeded: null '401': description: The API key is missing, malformed or not valid. content: application/json: schema: $ref: '#/components/schemas/SuiteError' '403': description: The key is valid but is not entitled to this feature. content: application/json: schema: $ref: '#/components/schemas/SuiteError' '422': description: >- The request failed validation, or the source would not accept the details in it. content: application/json: schema: $ref: '#/components/schemas/SuiteError' '429': description: >- The key is not cleared for this feature, or is sending too many requests. Nothing was called. content: application/json: schema: $ref: '#/components/schemas/SuiteError' '503': description: >- The source could not be reached, or authentication is temporarily unavailable. content: application/json: schema: $ref: '#/components/schemas/SuiteError' default: description: The request failed content: application/json: schema: $ref: '#/components/schemas/SuiteError' components: schemas: PanVerifyRequest: properties: pan: type: string pattern: ^[A-Z]{3}[ABCFGHJLPT][A-Z][0-9]{4}[A-Z]$ title: Pan description: Permanent Account Number to verify name: type: string minLength: 2 title: Name description: Full name exactly as printed on the PAN card date_of_birth: type: string format: date title: Date Of Birth description: Date of birth, or date of incorporation for a non-individual holder type: object required: - pan - name - date_of_birth title: PanVerifyRequest description: The PAN to verify, and the holder details to hold it to. PanVerifyResponse: properties: reasons: items: $ref: '#/components/schemas/Reason' type: array title: Reasons description: >- Why the check did not pass, worst first, each a stable code with the text for it. Empty when it passed details: $ref: '#/components/schemas/PanVerificationResult' description: The registry's record of the PAN type: object required: - details title: PanVerifyResponse description: >- What the income-tax registry holds for a PAN, and whether the claimed details matched. SuiteError: properties: code: type: integer title: Code description: HTTP status code of the response timestamp: type: integer title: Timestamp description: Unix millisecond timestamp of when the response was produced message: type: string title: Message description: What went wrong, in one sentence type: object required: - code - timestamp - message title: SuiteError description: Why a request failed. Reason: properties: code: $ref: '#/components/schemas/ReasonCode' description: Stable code to branch on message: type: string title: Message description: What the code means, in one sentence type: object required: - code - message title: Reason description: One machine-readable reason a check did not pass. PanVerificationResult: properties: pan: type: string title: Pan category: $ref: '#/components/schemas/PanType' status: $ref: '#/components/schemas/PanStatus' remarks: anyOf: - type: string - type: 'null' title: Remarks name_as_per_pan_match: type: boolean title: Name As Per Pan Match date_of_birth_match: type: boolean title: Date Of Birth Match aadhaar_seeded: anyOf: - type: boolean - type: 'null' title: Aadhaar Seeded type: object required: - pan - category - status - name_as_per_pan_match - date_of_birth_match - aadhaar_seeded title: PanVerificationResult description: >- Result of a Verify-PAN-Details call. The vendor's own transaction id is left in the raw payload rather than read onto this: it names a call of ours and says nothing about the PAN, and this shape is published to clients. ReasonCode: type: string enum: - cin-not-registered - gstin-not-registered - gstin-inactive - pan-inactive - pan-name-mismatch - pan-date-of-birth-mismatch - udyam-not-registered - udyam-not-registered-for-pan - udyam-cancelled - gst-not-registered-for-pan - company-not-registered-for-pan - epfo-member-not-found - uan-not-registered-for-pan - driving-licence-not-registered - driving-licence-details-mismatch - driving-licence-expired - uan-not-registered-for-mobile - passport-not-registered - passport-name-mismatch - source-unavailable - details-refused - bank-account-unverified - bank-account-unsettled title: ReasonCode description: >- Why a check did not pass, as the stable code a client branches on. Declared rather than written as strings so that every code a check can answer with reaches the published schema, and a client reads the whole set from the API reference. PanType: type: string enum: - Individual - Company - HUF - Firm - AOP - Trust - Body of Individuals - Local Authority - Artificial Juridical Person - Government - Unknown title: PanType description: Enumeration of possible PAN types. PanStatus: type: string enum: - valid - invalid title: PanStatus description: Whether official records hold the PAN as a live one. securitySchemes: bearerAuth: type: http scheme: bearer description: 'Your API key, sent as `Authorization: Bearer `.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.