Skip to main content
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

AreaOperationPurpose
SignupPOST /api/v2/chat/api/id-cardParse ID-card images during the signup process.

ID-card parsing

Request body, examples, response schema, and error formats.

OpenAPI source

Filtered OpenAPI file containing the documented API v2 operation.

​
Versioning guidance

TopicGuidance
Path versionKeep the documented /api/v2 path exactly as shown.
Base URLUse the server URL defined by the OpenAPI operation or generated API playground.
AuthenticationFollow each endpoint’s documented security requirements. The signup ID-card parsing endpoint does not require authentication.
Payload formatSend JSON fields exactly as documented. For image parsing, send base64 image content without the data: URL prefix.

​
Signup ID-card parsing flow

1

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.
2

Send the API v2 request

Call POST /api/v2/chat/api/id-card with the base64 image payload.
3

Validate parsed fields

Use the response to populate signup fields, then require user review and correction before submission.