Skip to main content
POST
Parse ID card images during signup

Body

application/json

Base64 image payload used by the signup ID-card scan flow.

Base64-encoded ID-card images captured or uploaded in the signup flow. frontImage is required; backImage and portraitImage are optional.

frontImage
string<byte>
required

Base64 image content for the front side of the Vietnamese ID card. Do not include the data URL prefix.

backImage
string<byte>

Optional base64 image content for the back side of the ID card.

portraitImage
string<byte>

Optional base64 portrait/selfie image.

Response

Parsed ID-card data and uploaded image URLs when available.

ID-card parsing response returned by the chat/ekyc route.

success
boolean

Whether parsing succeeded.

data
object

Parsed Vietnamese ID card fields.

imageUrls
object

Stored image URLs returned by the ID-card service.

error
string

Error message when parsing fails.