output-registration

  • appointments
    Type: array object[] · output-appointment[]
    required
    • appointment_id
      Type: string
      required
    • end_date
      Type: string
      required
    • external_id
      Type: string
      required
    • keysafe_id
      Type: string
      required
    • location_id
      Type: string
      required
    • location_name
      Type: string
      required
    • registration_id
      Type: string
      required
    • start_date
      Type: string
      required
    • status
      Type: string
      required
    • type
      Type: string
      required
  • balance
    Type: number Format: int32
    required
  • business_accounts
    Type: array object[] · output-registration-businessaccount[]
    required
    • company_name
      Type: string
      required
    • id
      Type: string
      required
    • role
      Type: string
      required
    • status
      Type: string
      required
    • user_id
      Type: string
      required
  • cards
    Type: array object[] · output-card[]
    required
    • active
      Type: string
      required
    • id
      Type: string
      required
    • serial_number
      Type: string
      required
  • check_executions
    Type: array object[] · output-checkexecution[]
    required
    • cases
      Type: array object[] · output-blacklist-caseidentifier[]
      required
    • extra_fields
      Type: array object[] · output-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
  • check_process
    Type: string
    required
  • comments
    Type: array object[] · output-comment[]
    required
    • comment
      Type: string
      required
    • date
      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

    • type
      Type: string enum
      required
      values
      • customer_comment
      • organisation_comment
      • system
      • unknown
      • manual
  • 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

  • created_by
    Type: string
    required
  • created_by_email
    Type: string
    required
  • created_by_first_name
    Type: string
    required
  • created_by_last_name
    Type: string
    required
  • created_by_last_name_prefix
    Type: string
    required
  • device_id
    Type: string
    required
  • external_id
    Type: string
    required
  • financial_transactions
    Type: array object[] · output-transaction[]
    required
    • amount
      Type: number Format: int32
      required
    • attachments
      Type: array object[] · output-attachment[]
      required
    • description
      Type: string
      required
    • id
      Type: string
      required
    • payment_method
      Type: string
      required
    • status
      Type: string
      required
    • status_history
      Type: array object[] · output-transactionstatus[]
      required
  • id
    Type: string
    required
  • invite_token
    Type: string
    required
  • keysafe_identifier
    Type: string
    required
  • lessee
    Type: object · output-lessee
    required
    • bank_account_holder
      Type: string
      required
    • city
      Type: string
      required
    • country
      Type: string
      required
    • date_of_birth
      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

    • documents
      Type: array object[] · output-document-api[]
      required
    • email_address
      Type: string
      required
    • financial_data
      Type: object · output-financial-data
      required
    • first_name
      Type: string
      required
    • gender
      Type: string
      required
    • house_number
      Type: string
      required
    • house_number_extension
      Type: string
      required
    • iban
      Type: string
      required
    • id
      Type: string
      required
    • id_documents
      Type: array object[] · output-iddocument[]
      required
    • initials
      Type: string
      required
    • institutional_data
      Type: array object[] · output-institutional-data-reduced[]
      required
    • last_name
      Type: string
      required
    • last_name_prefix
      Type: string
      required
    • mobile_phone_number
      Type: string
      required
    • nationality
      Type: string
      required
    • password
      Type: string
      required
    • phone_number
      Type: string
      required
    • place_of_birth
      Type: string
      required
    • postal_code
      Type: string
      required
    • social_security_number
      Type: string
      required
    • street_name
      Type: string
      required
    • zip_code
      Type: string
      required
  • lessor
    Type: object · output-lessor
    required
    • id
      Type: number Format: int32
      required
    • name
      Type: string
      required
  • lock
    Type: object · output-registration-lock
    required
    • keysafe_identifier
      Type: string
      required
    • keysafe_name
      Type: string
      required
    • number
      Type: string
      required
  • minimum_balance
    Type: number Format: int32
    required
  • paid_registration_fee
    Type: boolean
    required
  • source
    Type: object · output-check-v1-source
    required
    • location
      Type: string
      required
    • location_id
      Type: string
      required
    • organisation_name
      Type: string
      required
    • organization_coc_registration_number
      Type: string
      required
    • source
      Type: string
      required
    • sourceid
      Type: string
      required
    • userid
      Type: number Format: int32
      required
    • username
      Type: string
      required
  • status
    Type: string
    required
  • token
    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

  • validations
    Type: array object[] · output-validation[]
    required
    • status
      Type: string
      required
    • type
      Type: string
      required
  • webhooks
    Type: array object[] · output-webhook[]
    required
    • purpose
      Type: string
      required
    • url
      Type: string
      required