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

# Get verification document result

> Returns what was read from the identity document of the most relevant attempt,
normalised: dates as YYYY-MM-DD, countries as ISO 3166-1 alpha-2 (XK for Kosovo), and null for
anything the document did not yield or does not print. On identity (KYC)
workspaces `fields` carries eleven keys; on age verification workspaces only
`first_name`, `last_name`, `date_of_birth` and `document_number` are returned.
Each media item carries a `url` for the download endpoint, or null when the
media has been purged or has passed its retention window.



## OpenAPI

````yaml /openapi.json get /verifications/{verification}/document
openapi: 3.1.0
info:
  title: API Reference
  version: 1.0.0
  description: >-
    ProofAge is an identity verification and age estimation API. Use this API to
    create verification sessions, upload media (selfies and documents), and
    receive decisions via webhooks.
servers:
  - url: https://api.proofage.net/v1
    description: API
security:
  - apiKey: []
    hmacSignature: []
paths:
  /verifications/{verification}/document:
    get:
      tags:
        - Verification
      summary: Get verification document result
      description: >-
        Returns what was read from the identity document of the most relevant
        attempt,

        normalised: dates as YYYY-MM-DD, countries as ISO 3166-1 alpha-2 (XK for
        Kosovo), and null for

        anything the document did not yield or does not print. On identity (KYC)

        workspaces `fields` carries eleven keys; on age verification workspaces
        only

        `first_name`, `last_name`, `date_of_birth` and `document_number` are
        returned.

        Each media item carries a `url` for the download endpoint, or null when
        the

        media has been purged or has passed its retention window.
      operationId: getVerificationDocument
      parameters:
        - name: verification
          in: path
          required: true
          description: The verification ID
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: >-
            Verification document result. `type` and `gender` are open enums:
            handle values not listed here. `gender` is F, M or X, where X means
            the document states that the sex is unspecified. `other` in `type`
            is a readable document that is not an identity card, passport,
            driving licence or residence permit, such as a health insurance
            card. Countries are ISO 3166-1 alpha-2 (XK for Kosovo). A document
            that prints only the month or year of expiry reports the last day of
            that period; a partially printed birth or issue date is null. On a
            Mexican voter card or driving licence created before 20 August 2026
            17:00 UTC, `gender` is null. The German identity card prints no sex,
            so `gender` is null there. A permanent document (for example
            `PERMANENTE` or `INDEFINIDA`) reads as a null `expiry_date`. `type`
            `id` is the same value the upload endpoint takes. `issuing_country`
            and `nationality` can differ, for example on a residence permit.
            `issuing_subdivision` is the state or province that issued the
            document, as a bare code beside `issuing_country` (for example `FL`
            with `US`), or null; today it is filled for US driving licences and
            ID cards. `place_of_birth` is the printed text, not normalised.
            `address` is the printed text as read, not parsed and not
            normalised, and may contain line breaks.
          content:
            application/json:
              schema:
                type: object
                examples:
                  - document:
                      type: passport
                      issuing_country: DE
                      issuing_subdivision: null
                      fields:
                        first_name: JANE
                        middle_name: null
                        last_name: DOE
                        date_of_birth: '1990-04-12'
                        gender: F
                        nationality: DE
                        place_of_birth: BERLIN
                        address: null
                        document_number: C01X00T47
                        issue_date: '2020-04-14'
                        expiry_date: '2030-04-13'
                    media:
                      - id: 019de7a0-c11b-7373-9289-b0aa1ba08d13
                        type: selfie
                        url: >-
                          https://api.proofage.net/v1/verifications/019de7a0-c11b-7373-9289-b0aa1ba08d13/media/019de7a0-c11b-7373-9289-b0aa1ba08d13
                      - id: 019de7a0-c129-7259-8a08-bc10390ecbdb
                        type: document_front
                        url: >-
                          https://api.proofage.net/v1/verifications/019de7a0-c11b-7373-9289-b0aa1ba08d13/media/019de7a0-c129-7259-8a08-bc10390ecbdb
                    meta:
                      attempt_id: 019de7a2-0305-7269-9cff-1715c71b19ae
                  - document:
                      type: id
                      issuing_country: FR
                      issuing_subdivision: null
                      fields:
                        first_name: JEAN
                        last_name: MARTIN
                        date_of_birth: '1988-11-02'
                        document_number: X4RTBPFW4
                    media:
                      - id: 019de7a0-c129-7259-8a08-bc10390ecbdb
                        type: document_front
                        url: >-
                          https://api.proofage.net/v1/verifications/019de7a0-c11b-7373-9289-b0aa1ba08d13/media/019de7a0-c129-7259-8a08-bc10390ecbdb
                    meta:
                      attempt_id: 019de7a2-0305-7269-9cff-1715c71b19ae
                properties:
                  document:
                    type: object
                    properties:
                      type:
                        type:
                          - string
                          - 'null'
                        enum:
                          - passport
                          - id
                          - driver_license
                          - residence_permit
                          - other
                          - null
                      issuing_country:
                        type:
                          - string
                          - 'null'
                      issuing_subdivision:
                        type:
                          - string
                          - 'null'
                      fields:
                        type: object
                        properties:
                          first_name:
                            type:
                              - string
                              - 'null'
                          middle_name:
                            type:
                              - string
                              - 'null'
                          last_name:
                            type:
                              - string
                              - 'null'
                          date_of_birth:
                            type:
                              - string
                              - 'null'
                            format: date
                          gender:
                            type:
                              - string
                              - 'null'
                            enum:
                              - F
                              - M
                              - X
                              - null
                          nationality:
                            type:
                              - string
                              - 'null'
                          place_of_birth:
                            type:
                              - string
                              - 'null'
                          address:
                            type:
                              - string
                              - 'null'
                          document_number:
                            type:
                              - string
                              - 'null'
                          issue_date:
                            type:
                              - string
                              - 'null'
                            format: date
                          expiry_date:
                            type:
                              - string
                              - 'null'
                            format: date
                        required:
                          - first_name
                          - last_name
                          - date_of_birth
                          - document_number
                    required:
                      - type
                      - issuing_country
                      - issuing_subdivision
                      - fields
                  media:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                        url:
                          type:
                            - string
                            - 'null'
                      required:
                        - id
                        - type
                        - url
                  meta:
                    type: object
                    properties:
                      attempt_id:
                        type:
                          - string
                          - 'null'
                    required:
                      - attempt_id
                required:
                  - document
                  - media
                  - meta
        '404':
          $ref: '#/components/responses/ModelNotFoundException'
        '422':
          $ref: '#/components/responses/ValidationException'
components:
  responses:
    ModelNotFoundException:
      description: Not found
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    ValidationException:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Errors overview.
              errors:
                type: object
                description: A detailed description of each field that failed validation.
                additionalProperties:
                  type: array
                  items:
                    type: string
            required:
              - message
              - errors
  securitySchemes:
    apiKey:
      type: apiKey
      description: Your workspace public key (pk_test_… or pk_live_…).
      in: header
      name: X-API-Key
    hmacSignature:
      type: apiKey
      description: >-
        HMAC-SHA256 of the request, hex-encoded, keyed with the workspace secret
        key. See API authentication.
      in: header
      name: X-HMAC-Signature

````

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