2025-03-21

Paths

• Create an ID Document check (POST /v1/checks/id_document)
  • ✨ [Added] property vendor to settings in request body: "veriff","idnow"
  • ✨ [Added] required property vendor to data.settings in response body: "veriff","idnow"
  • ✨ [Added] possible values of data.vendor.name in response body: "idnow"
  • ⚠️ [Added] deprecated status to data.detailed_results in response body: true
  • ✨ [Added] possible values of data.information.document_type in response body: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"
  • ✨ [Added] required property maiden_name to data.information in response body
• Retrieve an ID Document check (GET /v1/checks/id_document/{id}), Add files (POST /v1/checks/id_document/{id}/add_files), Review an ID Document check (PATCH /v1/checks/id_document/{id}/review)
  • ✨ [Added] required property vendor to data.settings in response body: "veriff","idnow"
  • ✨ [Added] possible values of data.vendor.name in response body: "idnow"
  • ⚠️ [Added] deprecated status to data.detailed_results in response body: true
  • ✨ [Added] possible values of data.information.document_type in response body: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"
  • ✨ [Added] required property maiden_name to data.information in response body
• Create an ID Verification check (POST /v1/checks/id_verification), Retrieve an ID Verification check (GET /v1/checks/id_verification/{id}), Review an ID Verification check (PATCH /v1/checks/id_verification/{id}/review), Refresh an ID Verification check url (POST /v1/checks/id_verification/{id}/refresh_url)
  • ⚠️ [Added] deprecated status to data.detailed_results in response body: true
  • ✨ [Added] possible values of data.information.document_type in response body: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"
• Create a Document check (POST /v1/checks/document), Add files (POST /v1/checks/document/{id}/add_files), Retrieve a Document check (GET /v1/checks/document/{id}), Force review (POST /v1/checks/document/{id}/force_review), Review a Document check (PATCH /v1/checks/document/{id}/review)
  • ⚠️ [Added] deprecated status to data.detailed_results in response body: true

Components schemas

• DocumentCheckWebhook
  • ⚠️ [Added] deprecated status to check.data.detailed_results: true
• IdVerificationCheckWebhook
  • ⚠️ [Added] deprecated status to check.data.detailed_results: true
  • ✨ [Added] possible values of check.data.information.document_type: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"
• IdDocumentCheckWebhook
  • ✨ [Added] required property vendor to check.data.settings: "veriff","idnow"
  • ⚠️ [Added] deprecated status to check.data.detailed_results: true
  • ✨ [Added] possible values of check.data.information.document_type: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"
  • ✨ [Added] required property maiden_name to check.data.information