CM.com · Schema

TransactionResult

CompanyCPaaSMessagingSMSVoicePaymentsVerificationTicketing

Properties

Name Type Description
id string
state object
tasks array
View JSON Schema on GitHub

JSON Schema

cm-com-transaction-result-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cm-com/main/json-schema/cm-com-transaction-result-schema.json",
  "title": "TransactionResult",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cm-com-verification-id-scan-v1-openapi.yml#/components/schemas/TransactionResult",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "readOnly": true
    },
    "state": {
      "$ref": "#/$defs/TransactionState",
      "readOnly": true
    },
    "tasks": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "$ref": "#/$defs/TaskResultDocumentScan"
          },
          {
            "$ref": "#/$defs/TaskResultFaceLiveness"
          },
          {
            "$ref": "#/$defs/TaskResultFaceMatch"
          }
        ]
      }
    }
  },
  "$defs": {
    "Attempts": {
      "type": "number",
      "description": "The number of attempts made for this task.",
      "readOnly": true,
      "minimum": 1
    },
    "AuthenticityScore": {
      "type": "number",
      "description": "Authenticity score for image pattern checks. Returns -1 if no authenticity checkmarks are found.",
      "format": "float",
      "minimum": 0,
      "maximum": 1
    },
    "ComparisonStatus": {
      "type": "string",
      "description": "The result of comparing MRZ, barcode and visual field values. If only one field value is available, the status will be `not_performed`.",
      "enum": [
        "match",
        "no_match",
        "not_performed"
      ]
    },
    "DocumentType": {
      "type": "string",
      "description": "The document type.",
      "enum": [
        "not_defined",
        "passport",
        "identity_card",
        "diplomatic_passport",
        "service_passport",
        "seamans_identity_document",
        "identity_card_for_residence",
        "travel_document",
        "other",
        "visa_id2",
        "visa_id3",
        "national_identity_card",
        "social_identity_card",
        "aliens_identity_card",
        "privileged_identity_card",
        "residence_permit_identity_card",
        "origin_card",
        "emergency_passport",
        "aliens_passport",
        "alternative_identity_card",
        "authorization_card",
        "beginner_permit",
        "border_crossing_card",
        "chauffeur_license",
        "chauffeur_license_under_18",
        "chauffeur_license_under_21",
        "commercial_driving_license",
        "commercial_driving_license_instructional_permit",
        "commercial_driving_license_under_18",
        "commercial_driving_license_under_21",
        "commercial_instruction_permit",
        "commercial_new_permit",
        "concealed_carry_license",
        "concealed_firearm_permit",
        "conditional_driving_license",
        "department_of_veterans_affairs_identity_card",
        "diplomatic_driving_license",
        "driving_license",
        "driving_license_instructional_permit",
        "driving_license_instructional_permit_under_18",
        "driving_license_instructional_permit_under_21",
        "driving_license_learners_permit",
        "driving_license_learners_permit_under_18",
        "driving_license_learners_permit_under_21",
        "driving_license_novice",
        "driving_license_novice_under_18",
        "driving_license_novice_under_21",
        "driving_license_registered_offender",
        "driving_license_restricted_under_18",
        "driving_license_restricted_under_21",
        "driving_license_temporary_visitor",
        "driving_license_temporary_visitor_under_18",
        "driving_license_temporary_visitor_under_21",
        "driving_license_under_18",
        "driving_license_under_21",
        "employment_driving_permit",
        "enhanced_chauffeur_license",
        "enhanced_chauffeur_license_under_18",
        "enhanced_chauffeur_license_under_21",
        "enhanced_commercial_driving_license",
        "enhanced_driving_license",
        "enhanced_driving_license_under_18",
        "enhanced_driving_license_under_21",
        "enhanced_identity_card",
        "enhanced_identity_card_under_18",
        "enhanced_identity_card_under_21",
        "enhanced_operators_license",
        "firearms_permit",
        "full_provisional_license",
        "full_provisional_license_under_18",
        "full_provisional_license_under_21",
        "geneva_conventions_identity_card",
        "graduated_driving_license_under_18",
        "graduated_driving_license_under_21",
        "graduated_instruction_permit_under_18",
        "graduated_instruction_permit_under_21",
        "graduated_license_under_18",
        "graduated_license_under_21",
        "handgun_carry_permit",
        "identity_and_privilege_card",
        "identity_card_mobility_impaired",
        "identity_card_registered_offender",
        "identity_card_temporary_visitor",
        "identity_card_temporary_visitor_under_18",
        "identity_card_temporary_visitor_under_21",
        "identity_card_under_18",
        "identity_card_under_21",
        "ignition_interlock_permit",
        "immigrant_visa",
        "instruction_permit",
        "instruction_permit_under_18",
        "instruction_permit_under_21",
        "interim_driving_license",
        "interim_identity_card",
        "intermediate_driving_license",
        "intermediate_driving_license_under_18",
        "intermediate_driving_license_under_21",
        "junior_driving_license",
        "learner_instructional_permit",
        "learner_license",
        "learner_license_under_18",
        "learner_license_under_21",
        "learner_permit",
        "learner_permit_under_18",
        "learner_permit_under_21",
        "limited_license",
        "limited_permit",
        "limited_term_driving_license",
        "limited_term_identity_card",
        "liquor_identity_card",
        "new_permit",
        "new_permit_under_18",
        "new_permit_under_21",
        "non_us_citizen_driving_license",
        "occupational_driving_license",
        "oneida_tribe_of_indians_identity_card",
        "operator_license",
        "operator_license_under_18",
        "operator_license_under_21",
        "permanent_driving_license",
        "permit_to_reenter",
        "probationary_auto_license",
        "probationary_driving_license_under_18",
        "probationary_driving_license_under_21",
        "probationary_vehicle_sales_person_license",
        "provisional_driving_license",
        "provisional_driving_license_under_18",
        "provisional_driving_license_under_21",
        "provisional_license",
        "provisional_license_under_18",
        "provisional_license_under_21",
        "public_passenger_chauffeur_license",
        "racing_and_gaming_comission_card",
        "refugee_travel_document",
        "renewal_permit",
        "restricted_commercial_driver_license",
        "restricted_driver_license",
        "restricted_permit",
        "seasonal_permit",
        "seasonal_resident_identity_card",
        "seasonal_citizen_identity_card",
        "sex_offender",
        "social_security_card",
        "temporary_driving_license",
        "temporary_driving_license_under_18",
        "temporary_driving_license_under_21",
        "temporary_identity_card",
        "temporary_instruction_permit_identity_card",
        "temporary_instruction_permit_identity_card_under_18",
        "temporary_instruction_permit_identity_card_under_21",
        "temporary_visitor_driving_license",
        "temporary_visitor_driving_license_under_18",
        "temporary_visitor_driving_license_under_21",
        "uniformed_services_identity_card",
        "vehicle_sales_person_license",
        "worker_identification_credential",
        "commercial_driving_license_novice",
        "commercial_driving_license_novice_under_18",
        "commercial_driving_license_novice_under_21",
        "passport_card",
        "passport_resident_card",
        "personal_identification_verification",
        "temporary_operator_license",
        "driving_license_under_19",
        "identity_card_under_19",
        "visa",
        "temporary_passport",
        "voting_card",
        "health_card",
        "certificate_of_citizenship",
        "address_card",
        "airport_immigration_card",
        "alien_registration_card",
        "apeh_card",
        "coupon_to_driving_license",
        "crew_member_certificate",
        "document_for_return",
        "e_card",
        "employment_card",
        "hksar_immigration_form",
        "immigrant_card",
        "labour_card",
        "laissez_passer",
        "lawyer_identity_certificate",
        "license_card",
        "passport_stateless",
        "passport_child",
        "passport_consular",
        "passport_diplomatic_service",
        "passport_official",
        "passport_provisional",
        "passport_special",
        "permission_to_the_local_border_traffic",
        "registration_certificate",
        "sedesol_card",
        "social_card",
        "tb_card",
        "vehicle_passport",
        "w_document",
        "diplomatic_identity_card",
        "consular_identity_card",
        "income_tax_card",
        "residence_permit",
        "document_of_identity",
        "border_crossing_permit",
        "passport_limited_validity",
        "sim_card",
        "tax_card",
        "company_card",
        "domestic_passport",
        "identity_certificate",
        "resident_id_card",
        "armed_forces_identity_card",
        "professional_card",
        "registration_stamp",
        "driver_card",
        "driver_training_certificate",
        "qualification_driving_license",
        "membership_card",
        "public_vehicle_driver_authority_card",
        "marine_license",
        "temporary_learner_license",
        "temporary_commercial_driving_license",
        "interim_instructional_permit",
        "certificate_of_competency",
        "certificate_of_proficiency",
        "trade_license",
        "passport_page"
      ]
    },
    "SourceType": {
      "type": "string",
      "enum": [
        "visual",
        "mrz",
        "barcode"
      ],
      "description": "The data is read from the visual inspection zone, barcode or from the machine readable zone (MRZ)."
    },
    "TaskResult": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "state": {
          "$ref": "#/$defs/TaskState",
          "readOnly": true
        },
        "attempts": {
          "$ref": "#/$defs/Attempts"
        },
        "score": {
          "type": "number",
          "description": "Average authenticity score for any side. Returns -1 if no authenticity checkmarks were found on any side of the document.",
          "format": "float",
          "minimum": 0,
          "maximum": 1
        }
      }
    },
    "TaskResultDocumentScan": {
      "allOf": [
        {
          "$ref": "#/$defs/TaskResult"
        }
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "document_scan"
          ]
        },
        "result": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "field": {
                "$ref": "#/$defs/TextField"
              },
              "validity": {
                "$ref": "#/$defs/ValidityStatus"
              },
              "comparison": {
                "$ref": "#/$defs/ComparisonStatus"
              },
              "locale": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "values": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "source": {
                      "$ref": "#/$defs/SourceType"
                    },
                    "value": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "files": {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "$ref": "#/$defs/TaskResultDocumentScanFileRawImage"
              },
              {
                "$ref": "#/$defs/TaskResultDocumentScanFileDocument"
              },
              {
                "$ref": "#/$defs/TaskResultDocumentScanFileImage"
              }
            ]
          }
        }
      }
    },
    "TaskResultDocumentScanFileDocument": {
      "allOf": [
        {
          "$ref": "#/$defs/TaskResultFile"
        }
      ],
      "properties": {
        "category": {
          "type": "string",
          "description": "The file category"
        },
        "type": {
          "$ref": "#/$defs/DocumentType"
        },
        "name": {
          "type": "string",
          "description": "The name of the document."
        },
        "score": {
          "$ref": "#/$defs/AuthenticityScore"
        }
      }
    },
    "TaskResultDocumentScanFileImage": {
      "allOf": [
        {
          "$ref": "#/$defs/TaskResultFile"
        }
      ],
      "properties": {
        "category": {
          "type": "string",
          "description": "The file category"
        },
        "type": {
          "type": "string",
          "description": "The type of image"
        }
      }
    },
    "TaskResultDocumentScanFileRawImage": {
      "allOf": [
        {
          "$ref": "#/$defs/TaskResultFile"
        }
      ],
      "properties": {
        "category": {
          "type": "string",
          "description": "The file category"
        },
        "type": {
          "type": "string",
          "description": "The type of image"
        }
      }
    },
    "TaskResultFaceLiveness": {
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "face_liveness"
          ]
        },
        "state": {
          "$ref": "#/$defs/TaskState"
        },
        "attempts": {
          "$ref": "#/$defs/Attempts"
        },
        "files": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/TaskResultFaceLivenessFile"
          }
        }
      }
    },
    "TaskResultFaceLivenessFile": {
      "allOf": [
        {
          "$ref": "#/$defs/TaskResultFile"
        }
      ],
      "properties": {
        "category": {
          "type": "string",
          "enum": [
            "image",
            "video"
          ],
          "description": "The file category"
        }
      }
    },
    "TaskResultFaceMatch": {
      "allOf": [
        {
          "$ref": "#/$defs/TaskResult"
        }
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "face_match"
          ]
        }
      }
    },
    "TaskResultFile": {
      "type": "object",
      "properties": {
        "url": {
          "type": [
            "string",
            "null"
          ],
          "description": "The url to download the image. This url also requires a valid JWT header."
        }
      }
    },
    "TaskState": {
      "type": "string",
      "enum": [
        "pending",
        "completed",
        "aborted",
        "maximum_attempts_exceeded"
      ]
    },
    "TextField": {
      "type": "string",
      "enum": [
        "academic_title",
        "accompanied_by",
        "address",
        "address_area",
        "address_block_number",
        "address_building",
        "address_building_type",
        "address_city",
        "address_city_sector",
        "address_city_type",
        "address_country",
        "address_county_type",
        "address_entrance",
        "address_flat",
        "address_floor_number",
        "address_house",
        "address_jurisdiction_code",
        "address_location",
        "address_municipality",
        "address_postal_code",
        "address_state",
        "address_street",
        "address_street_number",
        "address_street_type",
        "address_zip_code",
        "administrative_number",
        "age",
        "age_at_issue",
        "agy",
        "airline_code",
        "airline_designator_of_boarding_pass_issuer",
        "airline_name",
        "airline_name_frequent_flyer",
        "airline_numeric_code",
        "airport_from",
        "airport_to",
        "aka_date_of_birth",
        "aka_given_names",
        "aka_name_prefix",
        "aka_name_suffix",
        "aka_social_security_number",
        "aka_surname",
        "aka_surname_and_given_names",
        "allergies",
        "alt_code",
        "alt_date_of_expiry",
        "application_number",
        "artistic_name",
        "audit_information",
        "authority",
        "authority_code",
        "authority_rus",
        "authorization_number",
        "bank_card_number",
        "bank_card_valid_thru",
        "banknote_number",
        "bdb_type",
        "benefits_number",
        "binary_code",
        "biometric_format_owner",
        "biometric_format_type",
        "biometric_product_id",
        "biometric_subtype",
        "biometric_type",
        "blood_group",
        "booklet_number",
        "caliber",
        "card_access_number",
        "category",
        "ccw_until",
        "cdl_class",
        "century_date_of_birth",
        "chassis_number",
        "check_in_sequence_number",
        "children",
        "citizenship_of_first_person",
        "citizenship_of_second_person",
        "citizenship_status",
        "civil_status",
        "commercial_indicator",
        "commercial_vehicle_codes",
        "company_name",
        "compartment_code",
        "complexion",
        "compliance_type",
        "conditions",
        "configuration",
        "consul",
        "control_number",
        "copy",
        "court_code",
        "csc_code",
        "cty",
        "current_date",
        "custody_info",
        "cvv",
        "data_date_of_expiry",
        "data_discriminator",
        "date_first_renewal",
        "date_of_arrival",
        "date_of_birth",
        "date_of_birth_check_digit",
        "date_of_birth_checksum",
        "date_of_birth_of_husband",
        "date_of_birth_of_wife",
        "date_of_creation",
        "date_of_expiry",
        "date_of_expiry_check_digit",
        "date_of_expiry_checksum",
        "date_of_first_positive_test_result",
        "date_of_flight",
        "date_of_insurance_expiry",
        "date_of_issue",
        "date_of_issue_boarding_pass",
        "date_of_issue_check_digit",
        "date_of_issue_checksum",
        "date_of_personalization",
        "date_of_registration",
        "date_of_retirement",
        "date_of_specimen_collection",
        "date_second_renewal",
        "day",
        "department",
        "dept_number",
        "destination",
        "digital_travel_authorization_number",
        "discretionary_data",
        "dl_cdl_restriction_code",
        "dl_class",
        "dl_class_code_a1_from",
        "dl_class_code_a1_notes",
        "dl_class_code_a1_to",
        "dl_class_code_a2_from",
        "dl_class_code_a2_notes",
        "dl_class_code_a2_to",
        "dl_class_code_a3_from",
        "dl_class_code_a3_notes",
        "dl_class_code_a3_to",
        "dl_class_code_a_from",
        "dl_class_code_a_notes",
        "dl_class_code_a_to",
        "dl_class_code_am_from",
        "dl_class_code_am_notes",
        "dl_class_code_am_to",
        "dl_class_code_b1_from",
        "dl_class_code_b1_notes",
        "dl_class_code_b1_to",
        "dl_class_code_b2_from",
        "dl_class_code_b2_notes",
        "dl_class_code_b2_to",
        "dl_class_code_b2e_from",
        "dl_class_code_b2e_notes",
        "dl_class_code_b2e_to",
        "dl_class_code_b_from",
        "dl_class_code_b_notes",
        "dl_class_code_b_to",
        "dl_class_code_be_from",
        "dl_class_code_be_notes",
        "dl_class_code_be_to",
        "dl_class_code_btp_from",
        "dl_class_code_btp_notes",
        "dl_class_code_btp_to",
        "dl_class_code_c1_from",
        "dl_class_code_c1_notes",
        "dl_class_code_c1_to",
        "dl_class_code_c1e_from",
        "dl_class_code_c1e_notes",
        "dl_class_code_c1e_to",
        "dl_class_code_c2_from",
        "dl_class_code_c2_notes",
        "dl_class_code_c2_to",
        "dl_class_code_c3_from",
        "dl_class_code_c3_notes",
        "dl_class_code_c3_to",
        "dl_class_code_c_from",
        "dl_class_code_c_notes",
        "dl_class_code_c_to",
        "dl_class_code_ca_from",
        "dl_class_code_ca_notes",
        "dl_class_code_ca_to",
        "dl_class_code_cd_from",
        "dl_class_code_cd_notes",
        "dl_class_code_cd_to",
        "dl_class_code_ce_from",
        "dl_class_code_ce_notes",
        "dl_class_code_ce_to",
        "dl_class_code_d1_from",
        "dl_class_code_d1_notes",
        "dl_class_code_d1_to",
        "dl_class_code_d1e_from",
        "dl_class_code_d1e_notes",
        "dl_class_code_d1e_to",
        "dl_class_code_d2_from",
        "dl_class_code_d2_notes",
        "dl_class_code_d2_to",
        "dl_class_code_d3_from",
        "dl_class_code_d3_notes",
        "dl_class_code_d3_to",
        "dl_class_code_d_from",
        "dl_class_code_d_notes",
        "dl_class_code_d_to",
        "dl_class_code_de_from",
        "dl_class_code_de_notes",
        "dl_class_code_de_to",
        "dl_class_code_e_from",
        "dl_class_code_e_notes",
        "dl_class_code_e_to",
        "dl_class_code_eb_from",
        "dl_class_code_eb_notes",
        "dl_class_code_eb_to",
        "dl_class_code_ec1_from",
        "dl_class_code_ec1_notes",
        "dl_class_code_ec1_to",
        "dl_class_code_ec_from",
        "dl_class_code_ec_notes",
        "dl_class_code_ec_to",
        "dl_class_code_f_from",
        "dl_class_code_f_notes",
        "dl_class_code_f_to",
        "dl_class_code_fa1_from",
        "dl_class_code_fa1_notes",
        "dl_class_code_fa1_to",
        "dl_class_code_fa_from",
        "dl_class_code_fa_notes",
        "dl_class_code_fa_to",
        "dl_class_code_fb_from",
        "dl_class_code_fb_notes",
        "dl_class_code_fb_to",
        "dl_class_code_g1_from",
        "dl_class_code_g1_notes",
        "dl_class_code_g1_to",
        "dl_class_code_g_from",
        "dl_class_code_g_notes",
        "dl_class_code_g_to",
        "dl_class_code_h_from",
        "dl_class_code_h_notes",
        "dl_class_code_h_to",
        "dl_class_code_hc_from",
        "dl_class_code_hc_notes",
        "dl_class_code_hc_to",
        "dl_class_code_hr_from",
        "dl_class_code_hr_notes",
        "dl_class_code_hr_to",
        "dl_class_code_i_from",
        "dl_class_code_i_notes",
        "dl_class_code_i_to",
        "dl_class_code_j_from",
        "dl_class_code_j_notes",
        "dl_class_code_j_to",
        "dl_class_code_k_from",
        "dl_class_code_k_notes",
        "dl_class_code_k_to",
        "dl_class_code_l_from",
        "dl_class_code_l_notes",
        "dl_class_code_l_to",
        "dl_class_code_lc_from",
        "dl_class_code_lc_notes",
        "dl_class_code_lc_to",
        "dl_class_code_lk_from",
        "dl_class_code_lk_notes",
        "dl_class_code_lk_to",
        "dl_class_code_lr_from",
        "dl_class_code_lr_notes",
        "dl_class_code_lr_to",
        "dl_class_code_m_from",
        "dl_class_code_m_notes",
        "dl_class_code_m_to",
        "dl_class_code_mc_from",
        "dl_class_code_mc_notes",
        "dl_class_code_mc_to",
        "dl_class_code_mr_from",
        "dl_class_code_mr_notes",
        "dl_class_code_mr_to",
        "dl_class_code_n_from",
        "dl_class_code_n_notes",
        "dl_class_code_n_to",
        "dl_class_code_nt_from",
        "dl_class_code_nt_notes",
        "dl_class_code_nt_to",
        "dl_class_code_pw_from",
        "dl_class_code_pw_notes",
        "dl_class_code_pw_to",
        "dl_class_code_r_from",
        "dl_class_code_r_notes",
        "dl_class_code_r_to",
        "dl_class_code_re_from",
        "dl_class_code_re_notes",
        "dl_class_code_re_to",
        "dl_class_code_rm_from",
        "dl_class_code_rm_notes",
        "dl_class_code_rm_to",
        "dl_class_code_s_from",
        "dl_class_code_s_notes",
        "dl_class_code_s_to",
        "dl_class_code_t_from",
        "dl_class_code_t_notes",
        "dl_class_code_t_to",
        "dl_class_code_tb_from",
        "dl_class_code_tb_notes",
        "dl_class_code_tb_to",
        "dl_class_code_tm_from",
        "dl_class_code_tm_notes",
        "dl_class_code_tm_to",
        "dl_class_code_tn_from",
        "dl_class_code_tn_notes",
        "dl_class_code_tn_to",
        "dl_class_code_tr_from",
        "dl_class_code_tr_notes",
        "dl_class_code_tr_to",
        "dl_class_code_tv_from",
        "dl_class_code_tv_notes",
        "dl_class_code_tv_to",
        "dl_class_code_v_from",
        "dl_class_code_v_notes",
        "dl_class_code_v_to",
        "dl_class_code_w_from",
        "dl_class_code_w_notes",
        "dl_class_code_w_to",
        "dl_duplicate_date",
        "dl_endorsed",
        "dl_issue_type",
        "dl_record_created",
        "dl_restriction_code",
        "dl_under_18_date",
        "dl_under_19_date",
        "dl_under_21_date",
        "dni_number",
        "document_class_code",
        "document_class_name",
        "document_discriminator",
        "document_number",
        "document_number_check_digit",
        "document_number_checksum",
        "document_series",
        "document_status",
        "dod_number",
        "donor",
        "dossier_number",
        "ds_certificate_issuer",
        "ds_certificate_subject",
        "ds_certificate_valid_from",
        "ds_certificate_valid_to",
        "dtc_date_of_expiry",
        "dtc_id",
        "dtc_version",
        "duf_number",
        "duration_of_stay",
        "e_id_place_of_birth_city",
        "e_id_place_of_birth_country",
        "e_id_place_of_birth_state",
        "e_id_place_of_birth_street",
        "e_id_place_of_birth_zip_code",
        "e_id_residence_permit_1",
        "e_id_residence_permit_2",
        "ec_environmental_type",
        "ef_card_access",
        "electronic_ticket_indicator",
        "email",
        "endorsement_expiration_date",
        "engine_model",
        "engine_number",
        "engine_power",
        "engine_volume",
        "eqv_code",
        "exam_date",
        "except_in_tanks",
        "expiry_timestamp",
        "eyes_color",
        "faculty",
        "family_name",
        "family_name_truncation",
        "fast_track",
        "father_country_of_birth",
        "father_date_of_birth",
        "father_given_name",
        "father_personal_number",
        "father_place_of_birth",
        "father_surname",
        "fathers_name",
        "fathers_name_rus",
        "federal_elections",
        "fee",
        "field_from_mrz",
        "final_check_digit",
        "final_checksum",
        "first_issue_date",
        "first_issue_date_checkdigit",
        "first_issue_date_checksum",
        "first_name",
        "first_name_truncation",
        "first_surname",
        "flight_number",
        "folio_number",
        "form_of_education",
        "fourth_name",
        "free_baggage_allowance",
        "frequent_flyer_airline_designator",
        "frequent_flyer_number",
        "from_airport_code",
        "fuel_type",
        "given_names",
        "given_names_rus",
        "gnib_number",
        "grandfather_name",
        "grandfather_name_maternal",
        "hair_color",
        "health_number",
        "height",
        "identifier",
        "identity_card_number",
        "identity_card_number_check_digit",
        "identity_card_number_checksum",
        "in_tanks",
        "inventory_number",
        "invitation_number",
        "invitation_number_check_digit",
        "invitation_number_checksum",
        "invited_by",
        "iso_issuer_id_number",
        "issue_timestamp",
        "issuer_identification_number",
        "issuing_state_code",
        "issuing_state_code_alpha2",
        "issuing_state_code_numeric",
        "issuing_state_name",
        "jurisdiction_endorsement_code",
        "jurisdiction_restriction_code",
        "jurisdiction_specific_data",
        "jurisdiction_vehicle_class",
        "last_name",
        "license_number",
        "limited_duration_document_indicator",
        "line_1_check_digit",
        "line_1_checksum",
        "line_1_optional_data",
        "line_2_check_digit",
        "line_2_checksum",
        "line_2_optional_data",
        "line_3_check_digit",
        "line_3_checksum",
        "line_3_optional_data",
        "mailing_address_city",
        "mailing_address_jurisdiction_code",
        "mailing_address_postal_code",
        "mailing_address_street",
        "make",
        "marital_status",
        "max_mass_of_trailer_braked",
        "max_mass_of_trailer_unbraked",
        "max_speed",
        "mc_novice_date",
        "medical_indicator_codes",
        "method_of_testing",
        "middle_name",
        "middle_name_truncation",
        "military_book_number",
        "military_service_from",
        "military_service_to",
        "model",
        "month",
        "month_of_birth",
        "mortgage_by",
        "mother_country_of_birth",
        "mother_date_of_birth",
        "mother_given_name",
        "mother_personal_number",
        "mother_place_of_birth",
        "mother_surname",
        "mothers_name",
        "mrz_strings",
        "mrz_strings_icao_rfid",
        "mrz_strings_with_correct_check_sums",
        "mrz_type",
        "mvc_agency",
        "name_prefix",
        "name_suffix",
        "nationality",
        "nationality_code",
        "nationality_code_alpha2",
        "nationality_code_numeric",
        "non_domiciled_indicator",
        "non_resident_indicator",
        "number_of_axles",
        "number_of_card_issuance",
        "number_of_card_issuance_check_digit",
        "number_of_card_issuance_checksum",
        "number_of_cylinders",
        "number_of_duplicates",
        "number_of_entries",
        "number_of_seats",
        "number_of_standing_places",
        "observations",
        "ocr_number",
        "old_date_of_issue",
        "old_document_number",
        "old_place_of_issue",
        "optional_data",
        "optional_data_check_digit",
        "optional_data_checksum",
        "organization",
        "other",
        "other_name",
        "other_person_name",
        "other_valid_id",
        "owner",
        "parents_given_names",
        "passport_number",
        "passport_number_check_digit",
        "passport_number_checksum",
        "patron_header_version",
        "pay_grade",
        "payload_capacity",
        "payment_period_from",
        "payment_period_to",
        "pdf417_codec",
        "permissible_axle_load",
        "permit_date_of_expiry",
        "permit_date_of_issue",
        "permit_dl_class",
        "permit_endorsed",
        "permit_identifier",
        "permit_restriction_code",
        "person_to_notify_address",
        "person_to_notify_date_of_record",
        "person_to_notify_name",
        "person_to_notify_phone",
        "personal_number",
        "personal_number_check_digit",
        "personal_number_checksum",
        "personal_summary",
        "personalization_sn",
        "phone",
        "place_of_birth",
        "place_of_birth_area",
        "place_of_birth_city",
        "place_of_birth_rus",
        "place_of_birth_state_code",
        "place_of_examination",
        "place_of_issue",
        "place_of_registration",
        "pnr_code",
        "police_district",
        "power_weight_ratio",
        "precinct",
        "previous_type",
        "profession",
        "professional_id_number",
        "pseudo_code",
        "purpose_of_entry",
        "race_ethnicity",
        "rank",
        "reference_number",
        "reference_number_check_digit",
        "reference_number_checksum",
        "reg_cert_body_number",
        "reg_cert_body_type",
        "reg_cert_car_color",
        "reg_cert_car_mark",
        "reg_cert_car_model",
        "reg_cert_car_type",
        "reg_cert_max_weight",
        "reg_cert_reg_number",
        "reg_cert_reg_number_check_digit",
        "reg_cert_reg_number_checksum",
        "reg_cert_vehicle_its_code",
        "reg_cert_vin",
        "reg_cert_vin_check_digit",
        "reg_cert_vin_chec

# --- truncated at 32 KB (34 KB total) ---
# Full source: https://artifacts.apis.io/cm-com/json-schema/cm-com-transaction-result-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/cm-com-transaction-result"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.