input-document-api

  • age
    Type: number Format: int32
    required
  • check_executions
    Type: array object[] · input-document-checkexecution[]
    required
    • cases
      Type: array object[] · input-blacklist-caseidentifier[]
      required
    • extra_fields
      Type: array object[] · input-checkexecution-field[]
      required
    • html_report_url
      Type: string
      required
    • id
      Type: string
      required
    • message
      Type: string
      required
    • pdf_report_url
      Type: string
      required
    • performed_at
      Type: string
      required
    • status
      Type: string
      required
    • type
      Type: string
      required
  • checkdigit_date_of_birth
    Type: number Format: int32
    required
  • checkdigit_expire_date
    Type: number Format: int32
    required
  • checkdigit_final
    Type: number Format: int32
    required
  • checkdigit_number
    Type: number Format: int32
    required
  • country
    Type: string
    required
  • created_at
    Type: string Format: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • date_of_birth
    Type: string
    required
  • expiration_date
    Type: string
    required
  • fields
    Type: object · input-document-fields-api
    required
    • age
      Type: number Format: int32
      required
    • checkdigit_date_of_birth
      Type: number Format: int32
      required
    • checkdigit_expire_date
      Type: number Format: int32
      required
    • checkdigit_final
      Type: number Format: int32
      required
    • checkdigit_number
      Type: number Format: int32
      required
    • country
      Type: string
      required
    • date_of_birth
      Type: string
      required
    • drivers_license_a_from
      Type: string
      required
    • drivers_license_a_to
      Type: string
      required
    • drivers_license_a1_from
      Type: string
      required
    • drivers_license_a1_to
      Type: string
      required
    • drivers_license_a2_from
      Type: string
      required
    • drivers_license_a2_to
      Type: string
      required
    • drivers_license_am_from
      Type: string
      required
    • drivers_license_am_to
      Type: string
      required
    • drivers_license_b_from
      Type: string
      required
    • drivers_license_b_to
      Type: string
      required
    • drivers_license_b1_from
      Type: string
      required
    • drivers_license_b1_to
      Type: string
      required
    • drivers_license_be_from
      Type: string
      required
    • drivers_license_be_to
      Type: string
      required
    • drivers_license_c_from
      Type: string
      required
    • drivers_license_c_to
      Type: string
      required
    • drivers_license_c1_from
      Type: string
      required
    • drivers_license_c1_to
      Type: string
      required
    • drivers_license_c1e_from
      Type: string
      required
    • drivers_license_c1e_to
      Type: string
      required
    • drivers_license_ce_from
      Type: string
      required
    • drivers_license_ce_to
      Type: string
      required
    • drivers_license_d_from
      Type: string
      required
    • drivers_license_d_to
      Type: string
      required
    • drivers_license_d1_from
      Type: string
      required
    • drivers_license_d1_to
      Type: string
      required
    • drivers_license_d1e_from
      Type: string
      required
    • drivers_license_d1e_to
      Type: string
      required
    • drivers_license_de_from
      Type: string
      required
    • drivers_license_de_to
      Type: string
      required
    • drivers_license_l_from
      Type: string
      required
    • drivers_license_l_to
      Type: string
      required
    • drivers_license_m_from
      Type: string
      required
    • drivers_license_m_to
      Type: string
      required
    • drivers_license_t_from
      Type: string
      required
    • drivers_license_t_to
      Type: string
      required
    • expiration_date
      Type: string
      required
    • first_name
      Type: string
      required
    • full_name
      Type: string
      required
    • gender
      Type: string enum
      required
      values
      • male
      • female
      • unknown
    • height
      Type: string
      required
    • issue_date
      Type: string
      required
    • issue_state
      Type: string
      required
    • issuing_authority
      Type: string
      required
    • last_name
      Type: string
      required
    • mrz_string
      Type: string
      required
    • mrz_string_correct
      Type: string
      required
    • nationality
      Type: string
      required
    • number
      Type: string
      required
    • place_of_birth
      Type: string
      required
    • remainder_term
      Type: number Format: int32
      required
    • social_security_number
      Type: string
      required
    • type
      Type: string enum
      required
      values
      • D
      • I
      • P
      • S
      • C
  • finished
    Type: boolean
    required
  • first_name
    Type: string
    required
  • full_name
    Type: string
    required
  • gender
    Type: string enum
    required
    values
    • male
    • female
    • unknown
  • height
    Type: string
    required
  • id
    Type: string
    required
  • identification
    Type: object · input-document-identification
    required
    • back
      Type: object · input-document-identification-side
      required
    • front
      Type: object · input-document-identification-side
      required
  • images
    Type: array object[] · input-document-image[]
    required
    • apply_watermark
      Type: boolean
      required
    • content
      Type: string
      required
    • created_at
      Type: string Format: date-time
      required

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • dtype
      Type: string
      required
    • field_coordinates
      Type: array object[] · input-document-coordinates[]
      required
    • id
      Type: string
      required
    • light_type
      Type: string
      required
    • manipulated
      Type: boolean
      required
    • original_filename
      Type: string
      required
    • passed_security_checks
      Type: boolean
      required
    • side
      Type: string
      required
    • size
      Type: string
      required
    • updated_at
      Type: string Format: date-time
      required

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • url
      Type: string
      required
  • issue_date
    Type: string
    required
  • issue_state
    Type: string
    required
  • issuing_authority
    Type: string
    required
  • last_name
    Type: string
    required
  • mrz_fields
    Type: object · input-document-fields-api
    required
    • age
      Type: number Format: int32
      required
    • checkdigit_date_of_birth
      Type: number Format: int32
      required
    • checkdigit_expire_date
      Type: number Format: int32
      required
    • checkdigit_final
      Type: number Format: int32
      required
    • checkdigit_number
      Type: number Format: int32
      required
    • country
      Type: string
      required
    • date_of_birth
      Type: string
      required
    • drivers_license_a_from
      Type: string
      required
    • drivers_license_a_to
      Type: string
      required
    • drivers_license_a1_from
      Type: string
      required
    • drivers_license_a1_to
      Type: string
      required
    • drivers_license_a2_from
      Type: string
      required
    • drivers_license_a2_to
      Type: string
      required
    • drivers_license_am_from
      Type: string
      required
    • drivers_license_am_to
      Type: string
      required
    • drivers_license_b_from
      Type: string
      required
    • drivers_license_b_to
      Type: string
      required
    • drivers_license_b1_from
      Type: string
      required
    • drivers_license_b1_to
      Type: string
      required
    • drivers_license_be_from
      Type: string
      required
    • drivers_license_be_to
      Type: string
      required
    • drivers_license_c_from
      Type: string
      required
    • drivers_license_c_to
      Type: string
      required
    • drivers_license_c1_from
      Type: string
      required
    • drivers_license_c1_to
      Type: string
      required
    • drivers_license_c1e_from
      Type: string
      required
    • drivers_license_c1e_to
      Type: string
      required
    • drivers_license_ce_from
      Type: string
      required
    • drivers_license_ce_to
      Type: string
      required
    • drivers_license_d_from
      Type: string
      required
    • drivers_license_d_to
      Type: string
      required
    • drivers_license_d1_from
      Type: string
      required
    • drivers_license_d1_to
      Type: string
      required
    • drivers_license_d1e_from
      Type: string
      required
    • drivers_license_d1e_to
      Type: string
      required
    • drivers_license_de_from
      Type: string
      required
    • drivers_license_de_to
      Type: string
      required
    • drivers_license_l_from
      Type: string
      required
    • drivers_license_l_to
      Type: string
      required
    • drivers_license_m_from
      Type: string
      required
    • drivers_license_m_to
      Type: string
      required
    • drivers_license_t_from
      Type: string
      required
    • drivers_license_t_to
      Type: string
      required
    • expiration_date
      Type: string
      required
    • first_name
      Type: string
      required
    • full_name
      Type: string
      required
    • gender
      Type: string enum
      required
      values
      • male
      • female
      • unknown
    • height
      Type: string
      required
    • issue_date
      Type: string
      required
    • issue_state
      Type: string
      required
    • issuing_authority
      Type: string
      required
    • last_name
      Type: string
      required
    • mrz_string
      Type: string
      required
    • mrz_string_correct
      Type: string
      required
    • nationality
      Type: string
      required
    • number
      Type: string
      required
    • place_of_birth
      Type: string
      required
    • remainder_term
      Type: number Format: int32
      required
    • social_security_number
      Type: string
      required
    • type
      Type: string enum
      required
      values
      • D
      • I
      • P
      • S
      • C
  • mrz_string
    Type: string
    required
  • mrz_string_correct
    Type: string
    required
  • nationality
    Type: string
    required
  • number
    Type: string
    required
  • ocr_fields
    Type: object · input-document-fields-api
    required
    • age
      Type: number Format: int32
      required
    • checkdigit_date_of_birth
      Type: number Format: int32
      required
    • checkdigit_expire_date
      Type: number Format: int32
      required
    • checkdigit_final
      Type: number Format: int32
      required
    • checkdigit_number
      Type: number Format: int32
      required
    • country
      Type: string
      required
    • date_of_birth
      Type: string
      required
    • drivers_license_a_from
      Type: string
      required
    • drivers_license_a_to
      Type: string
      required
    • drivers_license_a1_from
      Type: string
      required
    • drivers_license_a1_to
      Type: string
      required
    • drivers_license_a2_from
      Type: string
      required
    • drivers_license_a2_to
      Type: string
      required
    • drivers_license_am_from
      Type: string
      required
    • drivers_license_am_to
      Type: string
      required
    • drivers_license_b_from
      Type: string
      required
    • drivers_license_b_to
      Type: string
      required
    • drivers_license_b1_from
      Type: string
      required
    • drivers_license_b1_to
      Type: string
      required
    • drivers_license_be_from
      Type: string
      required
    • drivers_license_be_to
      Type: string
      required
    • drivers_license_c_from
      Type: string
      required
    • drivers_license_c_to
      Type: string
      required
    • drivers_license_c1_from
      Type: string
      required
    • drivers_license_c1_to
      Type: string
      required
    • drivers_license_c1e_from
      Type: string
      required
    • drivers_license_c1e_to
      Type: string
      required
    • drivers_license_ce_from
      Type: string
      required
    • drivers_license_ce_to
      Type: string
      required
    • drivers_license_d_from
      Type: string
      required
    • drivers_license_d_to
      Type: string
      required
    • drivers_license_d1_from
      Type: string
      required
    • drivers_license_d1_to
      Type: string
      required
    • drivers_license_d1e_from
      Type: string
      required
    • drivers_license_d1e_to
      Type: string
      required
    • drivers_license_de_from
      Type: string
      required
    • drivers_license_de_to
      Type: string
      required
    • drivers_license_l_from
      Type: string
      required
    • drivers_license_l_to
      Type: string
      required
    • drivers_license_m_from
      Type: string
      required
    • drivers_license_m_to
      Type: string
      required
    • drivers_license_t_from
      Type: string
      required
    • drivers_license_t_to
      Type: string
      required
    • expiration_date
      Type: string
      required
    • first_name
      Type: string
      required
    • full_name
      Type: string
      required
    • gender
      Type: string enum
      required
      values
      • male
      • female
      • unknown
    • height
      Type: string
      required
    • issue_date
      Type: string
      required
    • issue_state
      Type: string
      required
    • issuing_authority
      Type: string
      required
    • last_name
      Type: string
      required
    • mrz_string
      Type: string
      required
    • mrz_string_correct
      Type: string
      required
    • nationality
      Type: string
      required
    • number
      Type: string
      required
    • place_of_birth
      Type: string
      required
    • remainder_term
      Type: number Format: int32
      required
    • social_security_number
      Type: string
      required
    • type
      Type: string enum
      required
      values
      • D
      • I
      • P
      • S
      • C
  • passed_security_checks
    Type: boolean
    required
  • place_of_birth
    Type: string
    required
  • pr_document_type
    Type: number Format: int32
    required
  • remainder_term
    Type: number Format: int32
    required
  • result
    Type: string
    required
  • rfid_fields
    Type: object · input-document-fields-api
    required
    • age
      Type: number Format: int32
      required
    • checkdigit_date_of_birth
      Type: number Format: int32
      required
    • checkdigit_expire_date
      Type: number Format: int32
      required
    • checkdigit_final
      Type: number Format: int32
      required
    • checkdigit_number
      Type: number Format: int32
      required
    • country
      Type: string
      required
    • date_of_birth
      Type: string
      required
    • drivers_license_a_from
      Type: string
      required
    • drivers_license_a_to
      Type: string
      required
    • drivers_license_a1_from
      Type: string
      required
    • drivers_license_a1_to
      Type: string
      required
    • drivers_license_a2_from
      Type: string
      required
    • drivers_license_a2_to
      Type: string
      required
    • drivers_license_am_from
      Type: string
      required
    • drivers_license_am_to
      Type: string
      required
    • drivers_license_b_from
      Type: string
      required
    • drivers_license_b_to
      Type: string
      required
    • drivers_license_b1_from
      Type: string
      required
    • drivers_license_b1_to
      Type: string
      required
    • drivers_license_be_from
      Type: string
      required
    • drivers_license_be_to
      Type: string
      required
    • drivers_license_c_from
      Type: string
      required
    • drivers_license_c_to
      Type: string
      required
    • drivers_license_c1_from
      Type: string
      required
    • drivers_license_c1_to
      Type: string
      required
    • drivers_license_c1e_from
      Type: string
      required
    • drivers_license_c1e_to
      Type: string
      required
    • drivers_license_ce_from
      Type: string
      required
    • drivers_license_ce_to
      Type: string
      required
    • drivers_license_d_from
      Type: string
      required
    • drivers_license_d_to
      Type: string
      required
    • drivers_license_d1_from
      Type: string
      required
    • drivers_license_d1_to
      Type: string
      required
    • drivers_license_d1e_from
      Type: string
      required
    • drivers_license_d1e_to
      Type: string
      required
    • drivers_license_de_from
      Type: string
      required
    • drivers_license_de_to
      Type: string
      required
    • drivers_license_l_from
      Type: string
      required
    • drivers_license_l_to
      Type: string
      required
    • drivers_license_m_from
      Type: string
      required
    • drivers_license_m_to
      Type: string
      required
    • drivers_license_t_from
      Type: string
      required
    • drivers_license_t_to
      Type: string
      required
    • expiration_date
      Type: string
      required
    • first_name
      Type: string
      required
    • full_name
      Type: string
      required
    • gender
      Type: string enum
      required
      values
      • male
      • female
      • unknown
    • height
      Type: string
      required
    • issue_date
      Type: string
      required
    • issue_state
      Type: string
      required
    • issuing_authority
      Type: string
      required
    • last_name
      Type: string
      required
    • mrz_string
      Type: string
      required
    • mrz_string_correct
      Type: string
      required
    • nationality
      Type: string
      required
    • number
      Type: string
      required
    • place_of_birth
      Type: string
      required
    • remainder_term
      Type: number Format: int32
      required
    • social_security_number
      Type: string
      required
    • type
      Type: string enum
      required
      values
      • D
      • I
      • P
      • S
      • C
  • social_security_number
    Type: string
    required
  • source
    Type: string
    required
  • source_identifier
    Type: string
    required
  • status
    Type: string enum
    required
    values
    • unknown
    • accepted
    • rejected
    • not_applicable
    • not_complete
    • failed
    • pending
  • status_errors
    Type: array string[]
    required
  • type
    Type: string enum
    required
    values
    • D
    • I
    • P
    • S
    • C