> ## Documentation Index > Fetch the complete documentation index at: https://docs.deepxl.ai/llms.txt > Use this file to discover all available pages before exploring further. # Parse Document > Extract visible user information from a document or issued ID. **Available Models:** - `light` - Parsing light model. Data extraction is aimed at Driver License, State ID, Residency Permit, Social Security Card, Military ID - `performance` - Parsing performance model. Data extraction is aimed at Bank statements, US pay stubs **Tags Parameter:** Pass optional metadata as a JSON object to organize and filter your parsing results. **Recommended tag fields:** | Field | Description | Example | |-------|-------------|---------| | `customerId` | Your customer's unique identifier | `"9999"` | | `customerName` | Customer or account name | `"Acme Corp"` | | `documentId` | Your internal document reference | `"DOC-2024-001"` | | `companyName` | Company name | `"DeepXL"` | | `companyId` | Company identifier | `"COMP-001"` | **Example tags value:** `{"customerId":"9999","customerName":"Acme Corp","documentId":"DOC-2024-001","companyName":"DeepXL","companyId":"COMP-001"}` You can filter results by tags using the GET endpoint: `?tagFilter=customerId=9999` ## OpenAPI ````yaml /openapi.json post /v1/parse openapi: 3.1.0 info: title: DeepXL API description: >- Professional document analysis and verification API for fraud detection, identity verification, and data extraction. contact: name: DeepXL Support url: https://deepxl.ai/contact email: hello@deepxl.ai version: 1.1.0 servers: - url: https://api.deepxl.ai description: Production security: [] tags: - name: Fraud Detection description: Detect manipulated or AI-generated content in documents and images. - name: Document Parsing description: Extract structured data from IDs, bank statements, and pay stubs. - name: ID Verification description: Match an ID document against a selfie. - name: File Retrieval description: Fetch original uploads or generated heatmaps from a prior analysis. paths: /v1/parse: post: tags: - Document Parsing summary: Parse Document description: >- Extract visible user information from a document or issued ID. **Available Models:** - `light` - Parsing light model. Data extraction is aimed at Driver License, State ID, Residency Permit, Social Security Card, Military ID - `performance` - Parsing performance model. Data extraction is aimed at Bank statements, US pay stubs **Tags Parameter:** Pass optional metadata as a JSON object to organize and filter your parsing results. **Recommended tag fields:** | Field | Description | Example | |-------|-------------|---------| | `customerId` | Your customer's unique identifier | `"9999"` | | `customerName` | Customer or account name | `"Acme Corp"` | | `documentId` | Your internal document reference | `"DOC-2024-001"` | | `companyName` | Company name | `"DeepXL"` | | `companyId` | Company identifier | `"COMP-001"` | **Example tags value:** `{"customerId":"9999","customerName":"Acme Corp","documentId":"DOC-2024-001","companyName":"DeepXL","companyId":"COMP-001"}` You can filter results by tags using the GET endpoint: `?tagFilter=customerId=9999` operationId: parse_document_v1_parse_post requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/Body_parse_document_v1_parse_post' responses: '200': description: Document processed successfully with extracted parsed data. content: application/json: schema: $ref: '#/components/schemas/APIParseResponse' examples: successful_parse: summary: Successful document parse description: Document was recognized and data was extracted successfully value: result: parseId: 117 mediaType: image fileType: jpeg fileName: drivers_license.jpg fileSize: 231433 model: light country: us documentType: usa_driver_license parsedData: firstName: JOHN lastName: DOE dateOfBirth: '1990-05-15' licenseNumber: D1234567 expirationDate: '2028-05-15' address: 123 MAIN ST ANYTOWN, CA 90210 timestamp: 1725795600 timestampISO: '2024-09-08T10:00:00.000000' tags: - name: customerId value: '9999' - name: customerName value: Acme Corp - name: documentId value: DOC-2024-001 - name: companyName value: DeepXL - name: companyId value: COMP-001 files: - category: original_file fileName: drivers_license.jpg fileSize: 231433 contentType: image/jpeg timestamp: 1725795600 timestampISO: '2024-09-08T10:00:00.000000' url: >- https://api.deepxl.ai/v1/files/parse_117_drivers_license.jpg rejected_document: summary: Document rejected/not recognized description: Document type was not recognized or could not be parsed value: result: parseId: 116 mediaType: image fileType: png fileName: photo.png fileSize: 395856 model: light country: us documentType: other parsedData: {} timestamp: 1725795600 timestampISO: '2024-09-08T10:00:00.000000' tags: - name: customerId value: '9999' - name: customerName value: Acme Corp - name: documentId value: DOC-2024-002 - name: companyName value: DeepXL - name: companyId value: COMP-001 files: - category: original_file fileName: photo.png fileSize: 395856 contentType: image/png timestamp: 1725795600 timestampISO: '2024-09-08T10:00:00.000000' url: https://api.deepxl.ai/v1/files/parse_116_photo.png '400': description: Invalid model name or request parameters '401': description: Authentication required - API key or Clerk token missing/invalid '415': description: >- Unsupported media type - file type not compatible with selected model '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '500': description: Internal server error security: - API Key: [] components: schemas: Body_parse_document_v1_parse_post: properties: model: type: string title: Model description: >- AI model to use for parsing. 'light': Parsing light model (Driver License, State ID, Residency Permit, Social Security Card, Military ID). 'performance': Parsing performance model (Bank statements, US pay stubs). file: type: string contentMediaType: application/octet-stream title: File tags: anyOf: - type: string - type: 'null' title: Tags description: >- Optional JSON object with key-value pairs for organizing and querying results. Example: {"customerId":"9999","customerName":"Acme Corp","documentId":"DOC-2024-001","companyName":"DeepXL","companyId":"COMP-001"}. Common keys: customerId, customerName, documentId, companyName, companyId. default: '{}' country: anyOf: - type: string - type: 'null' title: Country description: >- Optional country hint. Supported values: us, mx, br. Defaults to us when omitted or invalid. type: object required: - model - file title: Body_parse_document_v1_parse_post APIParseResponse: properties: result: $ref: '#/components/schemas/APIParse' description: The document parse result type: object required: - result title: APIParseResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError APIParse: properties: parseId: type: integer title: Parseid description: Unique identifier for the parse record mediaType: type: string title: Mediatype description: Media type category (e.g. image, document) fileType: type: string title: Filetype description: File extension (e.g. jpeg, png, pdf) fileName: type: string title: Filename description: Original file name fileSize: type: integer title: Filesize description: File size in bytes timestamp: type: integer title: Timestamp description: Unix timestamp of when the parsing was performed timestampISO: type: string title: Timestampiso description: ISO 8601 timestamp of when the parsing was performed model: type: string title: Model description: Model used for parsing (light or performance) modelVersion: anyOf: - type: string - type: 'null' title: Modelversion description: Version of the model used (e.g. 1.2.0) country: anyOf: - type: string - type: 'null' title: Country description: Normalized country hint applied to this parse (us, mx, br) documentType: type: string title: Documenttype description: Detected document type (e.g. usa_driver_license, invoice, other) parsedData: additionalProperties: true type: object title: Parseddata description: Extracted key-value pairs from the document tags: items: $ref: '#/components/schemas/Tag' type: array title: Tags description: Metadata tags attached to this parse result default: [] files: items: $ref: '#/components/schemas/FileData' type: array title: Files description: Associated files (original upload) default: [] type: object required: - parseId - mediaType - fileType - fileName - fileSize - timestamp - timestampISO - model - documentType - parsedData title: APIParse ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError Tag: properties: name: type: string title: Name description: Tag key name value: type: string title: Value description: Tag value type: object required: - name - value title: Tag FileData: properties: category: anyOf: - type: string - type: 'null' title: Category description: File category (e.g. original_file, heatmap, id, face) fileName: type: string title: Filename description: Name of the file fileSize: type: integer title: Filesize description: File size in bytes contentType: type: string title: Contenttype description: MIME content type (e.g. image/jpeg, application/pdf) timestamp: type: integer title: Timestamp description: Unix timestamp of when the file was created timestampISO: type: string title: Timestampiso description: ISO 8601 timestamp of when the file was created url: anyOf: - type: string - type: 'null' title: Url description: URL to retrieve the file via GET /v1/files/{fileName} type: object required: - fileName - fileSize - contentType - timestamp - timestampISO title: FileData securitySchemes: API Key: type: apiKey description: API key created in the dashboard in: header name: x-api-key ````