Skip to main content

ID Card

The ID Card Answer is used to submit ID card document information for identity verification.

Fields

FieldTypeRequiredDescription
fieldTypeIdstringYesMust be set to "IdCard" (from FieldTypeEnum)
idCardFrontIdstringYesID of the previously uploaded ID card front document
idCardBackIdstringNoID of the previously uploaded ID card back document (if applicable)

Example Usage

{
"fqName": "PersonalInfo_Identity_IdCard",
"answer": {
"fieldTypeId": "IdCard",
"idCardFrontId": "d8f72bae-5c9a-4f8e-b8e7-19d8fcd7e34b",
"idCardBackId": "e9f83cbf-6d0a-5f9f-c9f8-20e9gde8f45c"
}
}

Notes

  • The documentId must reference a document previously uploaded using the Documents Upload API.
  • When ID card documents are uploaded, the system may automatically perform OCR to extract information.