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

# API v2

> VOS API v2 contract for signup ID-card parsing

VOS API v2 documents the signup ID-card parsing contract used by Vero OMS.
Use the OpenAPI reference as the source of truth for paths, request schemas, response schemas, and authentication requirements.

## Current coverage

| Area   | Operation                       | Purpose                                         |
| ------ | ------------------------------- | ----------------------------------------------- |
| Signup | `POST /api/v2/chat/api/id-card` | Parse ID-card images during the signup process. |

<CardGroup cols={2}>
  <Card title="ID-card parsing" icon="id-card" href="/en/apis/api-v2/parse-id-card">
    Request body, examples, response schema, and error formats.
  </Card>

  <Card title="OpenAPI source" icon="file-code" href="/openapi.v2.en.json">
    Filtered OpenAPI file containing the documented API v2 operation.
  </Card>
</CardGroup>

## Versioning guidance

| Topic          | Guidance                                                                                                                      |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| Path version   | Keep the documented `/api/v2` path exactly as shown.                                                                          |
| Base URL       | Use the server URL defined by the OpenAPI operation or generated API playground.                                              |
| Authentication | Follow each endpoint's documented security requirements. The signup ID-card parsing endpoint does not require authentication. |
| Payload format | Send JSON fields exactly as documented. For image parsing, send base64 image content without the `data:` URL prefix.          |

## Signup ID-card parsing flow

<Steps>
  <Step title="Collect image input">
    Capture or upload the front ID-card image. Include the back image or portrait image only when required by the signup process.
  </Step>

  <Step title="Send the API v2 request">
    Call `POST /api/v2/chat/api/id-card` with the base64 image payload.
  </Step>

  <Step title="Validate parsed fields">
    Use the response to populate signup fields, then require user review and correction before submission.
  </Step>
</Steps>