openapi: 3.0.0
servers:
  - url: https://kyc-demo.vultsecurity.com
    description: Demo Environment
  - url: https://kyc.vultsecurity.com
    description: Production Environment
info:
  version: 2.10.15
  title: KYC API
  description: KYC API
components:
  schemas: {}
  parameters: {}
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        password:
          tokenUrl: https://auth-demo.vultsecurity.com/token
          scopes:
            kyc: kyc
        clientCredentials:
          tokenUrl: https://auth-dev.vultpayments.dev/token
          scopes: {}
paths:
  /:
    get:
      summary: Root endpoint
      description: Returns service information and documentation links.
      responses:
        '200':
          description: Service info
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                  description:
                    type: string
                  version:
                    type: string
                  environment:
                    type: string
                  timestamp:
                    type: string
                    format: date-time
                  documentation:
                    type: string
                  health:
                    type: string
                  status:
                    type: string
      tags:
        - Utility
  /ping:
    get:
      summary: Ping
      description: Basic connectivity test.
      responses:
        '200':
          description: Pong
          content:
            application/json:
              schema:
                type: object
                properties:
                  pong:
                    type: boolean
                  timestamp:
                    type: string
                    format: date-time
      tags:
        - Utility
  /status:
    get:
      summary: API status
      description: Returns API status and available endpoints.
      responses:
        '200':
          description: Status
          content:
            application/json:
              schema:
                type: object
                properties:
                  service:
                    type: string
                  version:
                    type: string
                  environment:
                    type: string
                  timestamp:
                    type: string
                    format: date-time
                  uptime:
                    type: number
                  endpoints:
                    type: object
                    properties:
                      health:
                        type: string
                      ready:
                        type: string
                      live:
                        type: string
                      metrics:
                        type: string
                      docs:
                        type: string
                      api_spec:
                        type: string
      tags:
        - Utility
  /metrics:
    get:
      summary: System metrics
      description: Returns system and environment metrics.
      responses:
        '200':
          description: Metrics
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                  system:
                    type: object
                    properties:
                      uptime:
                        type: number
                      memory:
                        type: object
                        properties:
                          used:
                            type: number
                          total:
                            type: number
                          external:
                            type: number
                          rss:
                            type: number
                      cpu:
                        type: object
                      pid:
                        type: number
                      node_version:
                        type: string
                      platform:
                        type: string
                  environment:
                    type: object
                    properties:
                      node_env:
                        type: string
                      version:
                        type: string
      tags:
        - Utility
  /live:
    get:
      summary: Liveness probe
      description: Checks if the service is alive.
      responses:
        '200':
          description: Alive
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  timestamp:
                    type: string
                    format: date-time
                  uptime:
                    type: number
      tags:
        - Utility
  /ready:
    get:
      summary: Readiness probe
      description: Checks if the service is ready to receive traffic.
      responses:
        '200':
          description: Ready
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  timestamp:
                    type: string
                    format: date-time
                  checks:
                    type: object
                    properties:
                      database:
                        type: boolean
                      cache:
                        type: boolean
                      storage:
                        type: boolean
        '503':
          description: Not ready
      tags:
        - Utility
  /health/simple:
    get:
      summary: Simple health check
      description: Returns a simple health status for load balancers.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  timestamp:
                    type: string
                    format: date-time
      tags:
        - Utility
  /health:
    get:
      summary: Health check
      description: Returns health status of the service and dependencies.
      responses:
        '200':
          description: Healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  timestamp:
                    type: string
                    format: date-time
                  uptime:
                    type: number
                  version:
                    type: string
                  environment:
                    type: string
                  checks:
                    type: object
                    properties:
                      database:
                        type: string
                      cache:
                        type: string
                      storage:
                        type: string
                      external_services:
                        type: object
                  details:
                    type: object
                    properties:
                      database:
                        type: object
                      cache:
                        type: object
                      storage:
                        type: object
                      external_services:
                        type: object
                  error:
                    type: string
        '503':
          description: Unhealthy
      tags:
        - Utility
  /api/version:
    get:
      summary: Get API version
      description: Returns the current version of the API.
      responses:
        '200':
          description: API version
          content:
            application/json:
              schema:
                type: object
                properties:
                  version:
                    type: string
                required:
                  - version
      tags:
        - Utility
  /api/v1/idv/sdk/metadata/update:
    put:
      tags:
        - IDV SDK
      summary: sdk metadata update
      description: SDK metadata update.
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: X-Client-Id
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                sdk_metadata:
                  type: object
                  additionalProperties: {}
              required:
                - session_id
                - sdk_metadata
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/sdk/selfie/session/generate:
    post:
      tags:
        - IDV SDK
      summary: sdk liveness session generate
      description: SDK access to generate a liveness session
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: X-Client-Id
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                latitude:
                  type: number
                longitude:
                  type: number
              required:
                - session_id
                - latitude
                - longitude
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
                required:
                  - token
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/sdk/selfie/session/process:
    post:
      tags:
        - IDV SDK
      summary: sdk liveness session process
      description: SDK access to process a liveness session
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: X-Client-Id
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                latitude:
                  type: number
                longitude:
                  type: number
                images:
                  type: array
                  items:
                    type: string
              required:
                - session_id
                - latitude
                - longitude
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
                required:
                  - token
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/sdk/session/read:
    post:
      tags:
        - IDV SDK
      summary: sdk session read
      description: SDK access to read the session information
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: X-Client-Id
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
              required:
                - session_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  session_id:
                    type: string
                  client_id:
                    type: string
                  document_type_e:
                    type: string
                  consented:
                    type: boolean
                  document_front_given:
                    type: boolean
                  document_back_given:
                    type: boolean
                  liveness_detected:
                    type: boolean
                  selfie_given:
                    type: boolean
                  liveness_provider_e:
                    type: string
                    enum:
                      - azure
                      - vult
                  sdk_metadata:
                    type: object
                    additionalProperties: {}
                  settings:
                    type: object
                    properties:
                      perform_image_manipulation_test:
                        type: boolean
                      perform_aamva_test:
                        type: boolean
                      perform_ofac_test:
                        type: boolean
                      perform_age_test:
                        type: boolean
                      perform_gender_test:
                        type: boolean
                      perform_liveness_test:
                        type: boolean
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/sdk/consent/add:
    post:
      tags:
        - IDV SDK
      summary: sdk add identity consent
      description: >-
        Add identity consent. This must be done after session. All other
        endpoints will fail if this is not added to the system.
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: X-Client-Id
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                consented:
                  type: boolean
              required:
                - session_id
                - consented
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/sdk/document/type/update:
    put:
      tags:
        - IDV SDK
      summary: sdk document type update
      description: SDK document type update.
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: X-Client-Id
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                document_type_e:
                  type: string
                  enum:
                    - unknown
                    - driver_license
                    - identification_card
                    - passport
                    - passport_card
              required:
                - session_id
                - document_type_e
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/sdk/document/front/image/add:
    post:
      tags:
        - IDV SDK
      summary: sdk document front image add
      description: SDK document front image add.
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: X-Client-Id
          in: header
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                latitude:
                  type: string
                  minLength: 1
                longitude:
                  type: string
                  minLength: 1
                image:
                  type: string
                  format: binary
              required:
                - session_id
                - latitude
                - longitude
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/sdk/document/back/image/add:
    post:
      tags:
        - IDV SDK
      summary: sdk document back image add
      description: SDK document back image add.
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: X-Client-Id
          in: header
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                latitude:
                  type: string
                  minLength: 1
                longitude:
                  type: string
                  minLength: 1
                image:
                  type: string
                  format: binary
              required:
                - session_id
                - latitude
                - longitude
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/sdk/finalize:
    post:
      tags:
        - IDV SDK
      summary: sdk idv finalization
      description: Finalizes the identity verification process for the SDK.
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: X-Client-Id
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                settings:
                  type: object
                  properties:
                    doc_front_suspicious_words_fail:
                      type: boolean
                    doc_front_image_manipulation_fail:
                      type: boolean
                    doc_front_online_duplication_fail:
                      type: boolean
                    doc_front_is_identity_document_fail:
                      type: boolean
                    doc_back_suspicious_words_fail:
                      type: boolean
                    doc_back_image_manipulation_fail:
                      type: boolean
                    doc_back_online_duplication_fail:
                      type: boolean
                    doc_back_is_identity_document_fail:
                      type: boolean
                    ocr_name_match_fail:
                      type: boolean
                    ocr_address_match_fail:
                      type: boolean
                    ocr_document_number_match_fail:
                      type: boolean
                    aamva_test_scenario:
                      type: string
                      enum:
                        - DLDVSTRUCTUREDTEST11
                        - DLDVSTRUCTUREDTEST12
                        - DLDVSTRUCTUREDTEST22
                        - DLDVLONGESTNAME123
                        - DLDVLONGESTNAME456
                        - PERMITCARD123
                        - PERMITCARD456
                        - STATECARD123
                        - STATECARD456
                        - NOMATCH123
                        - REPORTEDDECEASED1234
                        - INCOMPLETEDATA123
                        - DLDVFUZZYLOGICTEST11
                        - DLDVSTRUCTUREDTEST13
                        - DLDVSTRUCTUREDTEST14
                        - DLDVSTRUCTUREDTEST16
                        - DLDVSTRUCTUREDTEST786
              required:
                - session_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  verified:
                    type: boolean
                  on_sanction_list:
                    type: boolean
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/session/location:
    post:
      tags:
        - IDV
      summary: idv session location read response
      description: IDV Session Location read response
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                location_capture_type_e:
                  type: string
                  enum:
                    - unknown
                    - front_doc_image_capture
                    - back_doc_image_capture
                    - selfie_image_capture
              required:
                - session_id
                - location_capture_type_e
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  ip_address:
                    type: string
                  ip_latitude:
                    type: number
                  ip_longitude:
                    type: number
                  ip_country:
                    type: string
                  ip_region:
                    type: string
                  ip_city:
                    type: string
                  device_location:
                    type: string
                  device_latitude:
                    type: number
                  device_longitude:
                    type: number
                  device_country_name:
                    type: string
                  device_country_code:
                    type: string
                  device_admin_area:
                    type: string
                  device_sub_admin_area:
                    type: string
                  device_locality:
                    type: string
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/session/anonymize:
    post:
      tags:
        - IDV
      summary: session anonymize
      description: Session anonymize for identity verification.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
              required:
                - session_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/session/delete:
    delete:
      tags:
        - IDV
      summary: session delete
      description: Session delete for identity verification.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
              required:
                - session_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/session/create:
    post:
      tags:
        - IDV
      summary: session create
      description: Session create for identity verification.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  type: object
                  additionalProperties:
                    anyOf:
                      - type: string
                      - type: number
                liveness_mode:
                  type: string
                  enum:
                    - passive
                    - passive_active
                webhook_url:
                  type: string
                settings:
                  type: object
                  properties:
                    perform_image_manipulation_test:
                      type: boolean
                    perform_aamva_test:
                      type: boolean
                    perform_ofac_test:
                      type: boolean
                    collect_ip_data:
                      type: boolean
                    collect_location_data:
                      type: boolean
                    aamva_retry_e:
                      type: string
                      enum:
                        - skip
                        - block
                        - allow_and_retry
                        - block_and_retry
                    perform_age_test:
                      type: boolean
                    perform_gender_test:
                      type: boolean
                    perform_liveness_test:
                      type: boolean
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  session_id:
                    type: string
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/session/list:
    post:
      tags:
        - IDV
      summary: session list
      description: Session list for identity verification.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                take:
                  type: number
                skip:
                  type: number
                search_term:
                  type: string
                start_date:
                  type:
                    - string
                    - 'null'
                end_date:
                  type:
                    - string
                    - 'null'
                metadata:
                  type: object
                  additionalProperties:
                    anyOf:
                      - type: string
                      - type: number
                      - type: array
                        items:
                          anyOf:
                            - type: string
                            - type: number
                identity_id:
                  anyOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                status:
                  type: string
                  enum:
                    - unknown
                    - in_progress
                    - complete
                    - temporarily_blocked
                    - temporarily_complete
                    - expired
                client_id:
                  anyOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                user_id:
                  anyOf:
                    - type: string
                    - type: array
                      items:
                        type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessions:
                    type: array
                    items:
                      type: object
                      properties:
                        session_id:
                          type: string
                        user_id:
                          type: string
                        client_id:
                          type: string
                        idv_weights_id:
                          type: string
                        status_e:
                          type: string
                          enum:
                            - unknown
                            - in_progress
                            - complete
                            - temporarily_blocked
                            - temporarily_complete
                            - expired
                        document_type_e:
                          type: string
                          enum:
                            - unknown
                            - driver_license
                            - identification_card
                            - passport
                            - passport_card
                        created_at:
                          type:
                            - string
                            - 'null'
                        completed_at:
                          type:
                            - string
                            - 'null'
                        first_name:
                          type: string
                        middle_name:
                          type: string
                        last_name:
                          type: string
                        suffix_name:
                          type: string
                        gender_e:
                          type: string
                          enum:
                            - unknown
                            - female
                            - male
                        birth_date:
                          type:
                            - string
                            - 'null'
                        consented:
                          type: boolean
                        consented_at:
                          type:
                            - string
                            - 'null'
                        document_front_given:
                          type: boolean
                        document_front_given_at:
                          type:
                            - string
                            - 'null'
                        document_back_given:
                          type: boolean
                        document_back_given_at:
                          type:
                            - string
                            - 'null'
                        liveness_detected:
                          type: boolean
                        liveness_detected_at:
                          type:
                            - string
                            - 'null'
                        selfie_given:
                          type: boolean
                        selfie_given_at:
                          type:
                            - string
                            - 'null'
                        ofac_status_e:
                          type: string
                          enum:
                            - unknown
                            - initiated
                            - passed
                            - failed
                            - skipped
                        ofac_detected_at:
                          type:
                            - string
                            - 'null'
                        dmv_status_e:
                          type: string
                          enum:
                            - unknown
                            - initiated
                            - passed
                            - failed
                            - skipped
                            - pending
                        dmv_detected_at:
                          type:
                            - string
                            - 'null'
                        verified:
                          type: boolean
                        verified_at:
                          type:
                            - string
                            - 'null'
                        score:
                          type: number
                        identity_id:
                          type: string
                        metadata:
                          type: object
                          additionalProperties:
                            anyOf:
                              - type: string
                              - type: number
                      required:
                        - status_e
                        - created_at
                        - completed_at
                        - birth_date
                        - consented_at
                        - document_front_given_at
                        - document_back_given_at
                        - liveness_detected_at
                        - selfie_given_at
                        - ofac_status_e
                        - ofac_detected_at
                        - dmv_status_e
                        - dmv_detected_at
                        - verified_at
                  meta_counts:
                    type: object
                    properties:
                      take:
                        type: number
                      skip:
                        type: number
                      response:
                        type: number
                      total:
                        type: number
                required:
                  - sessions
                  - meta_counts
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/session/read:
    post:
      tags:
        - IDV
      summary: session read
      description: Session read for identity verification.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
              required:
                - session_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  session_id:
                    type: string
                  user_id:
                    type: string
                  client_id:
                    type: string
                  idv_weights_id:
                    type: string
                  status_e:
                    type: string
                    enum:
                      - unknown
                      - in_progress
                      - complete
                      - temporarily_blocked
                      - temporarily_complete
                      - expired
                  document_type_e:
                    type: string
                    enum:
                      - unknown
                      - driver_license
                      - identification_card
                      - passport
                      - passport_card
                  created_at:
                    type:
                      - string
                      - 'null'
                  completed_at:
                    type:
                      - string
                      - 'null'
                  first_name:
                    type: string
                  middle_name:
                    type: string
                  last_name:
                    type: string
                  suffix_name:
                    type: string
                  gender_e:
                    type: string
                    enum:
                      - unknown
                      - female
                      - male
                  birth_date:
                    type:
                      - string
                      - 'null'
                  consented:
                    type: boolean
                  consented_at:
                    type:
                      - string
                      - 'null'
                  document_front_given:
                    type: boolean
                  document_front_given_at:
                    type:
                      - string
                      - 'null'
                  document_back_given:
                    type: boolean
                  document_back_given_at:
                    type:
                      - string
                      - 'null'
                  liveness_detected:
                    type: boolean
                  liveness_detected_at:
                    type:
                      - string
                      - 'null'
                  selfie_given:
                    type: boolean
                  selfie_given_at:
                    type:
                      - string
                      - 'null'
                  dmv_status_e:
                    type: string
                    enum:
                      - unknown
                      - initiated
                      - passed
                      - failed
                      - skipped
                      - pending
                  dmv_detected_at:
                    type:
                      - string
                      - 'null'
                  ofac_status_e:
                    type: string
                    enum:
                      - unknown
                      - initiated
                      - passed
                      - failed
                      - skipped
                  ofac_detected_at:
                    type:
                      - string
                      - 'null'
                  verified:
                    type: boolean
                  verified_at:
                    type:
                      - string
                      - 'null'
                  score:
                    type: number
                  identity_id:
                    type: string
                  metadata:
                    type: object
                    additionalProperties:
                      anyOf:
                        - type: string
                        - type: number
                  webhook_url:
                    type: string
                  settings:
                    type: object
                    properties:
                      perform_image_manipulation_test:
                        type: boolean
                      perform_aamva_test:
                        type: boolean
                      perform_ofac_test:
                        type: boolean
                      collect_ip_data:
                        type: boolean
                      collect_location_data:
                        type: boolean
                      aamva_retry_e:
                        type: string
                        enum:
                          - skip
                          - block
                          - allow_and_retry
                          - block_and_retry
                      perform_age_test:
                        type: boolean
                      perform_gender_test:
                        type: boolean
                      perform_liveness_test:
                        type: boolean
                  history:
                    type: array
                    items:
                      type: object
                      properties:
                        event:
                          anyOf:
                            - type: string
                              enum:
                                - created
                                - consent_add
                                - session_read
                                - document_type_update
                                - document_front_image_add
                                - document_back_image_add
                                - liveness_session_created
                                - liveness_session_processed
                                - selfie_add
                                - session_finalize
                                - metadata_update
                                - websocket_connection_established
                            - type: string
                              enum:
                                - websocket_connection_established
                                - buffer_filled
                                - no_faces_detected
                                - emotion_detected
                                - face_mismatch
                                - direction_detected
                                - wearing_glasses
                                - liveness_detection_error
                                - liveness_verified
                                - passive_liveness_verified
                                - active_liveness_verified
                                - face_match
                                - preprocess_failed
                                - emotion_failed
                                - liveness_failed
                                - direction_failed
                                - active_liveness_failed
                        endpoint:
                          type: string
                      required:
                        - event
                        - endpoint
                required:
                  - status_e
                  - created_at
                  - completed_at
                  - birth_date
                  - consented_at
                  - document_front_given_at
                  - document_back_given_at
                  - liveness_detected_at
                  - selfie_given_at
                  - dmv_status_e
                  - dmv_detected_at
                  - ofac_status_e
                  - ofac_detected_at
                  - verified_at
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/document/read:
    post:
      tags:
        - IDV
      summary: document read
      description: Document read for identity verification.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
              required:
                - session_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  session_id:
                    type: string
                  document_id:
                    type: string
                  type_e:
                    type: string
                    enum:
                      - unknown
                      - driver_license
                      - identification_card
                      - passport
                      - passport_card
                  data_source_e:
                    type: string
                    enum:
                      - unknown
                      - pdf417
                      - mrz
                      - ocr
                  document_number:
                    type: string
                  ref_number:
                    type: string
                  issued_at:
                    type:
                      - string
                      - 'null'
                  expires_at:
                    type:
                      - string
                      - 'null'
                  issuing_country:
                    type: string
                  issuing_state:
                    type: string
                  first_name:
                    type: string
                  middle_name:
                    type: string
                  last_name:
                    type: string
                  name_suffix:
                    type: string
                  street:
                    type: string
                  city:
                    type: string
                  state:
                    type: string
                  postal_code:
                    type: string
                  birth_date:
                    type:
                      - string
                      - 'null'
                  gender_e:
                    type: string
                    enum:
                      - unknown
                      - female
                      - male
                  height:
                    type: string
                  weight:
                    type: string
                  eye_color:
                    type: string
                  hair_color:
                    type: string
                  class:
                    type: string
                  restrictions:
                    type: string
                required:
                  - issued_at
                  - expires_at
                  - birth_date
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/document/list:
    post:
      tags:
        - IDV
      summary: document list
      description: Document list for identity verification.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                take:
                  type: number
                skip:
                  type: number
                session_id:
                  type: string
              required:
                - session_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  documents:
                    type: array
                    items:
                      type: object
                      properties:
                        document_id:
                          type: string
                        type_e:
                          type: string
                          enum:
                            - unknown
                            - driver_license
                            - identification_card
                            - passport
                            - passport_card
                        data_source_e:
                          type: string
                          enum:
                            - unknown
                            - pdf417
                            - mrz
                            - ocr
                        document_number:
                          type: string
                        ref_number:
                          type: string
                        issued_at:
                          type:
                            - string
                            - 'null'
                        expires_at:
                          type:
                            - string
                            - 'null'
                        issuing_country:
                          type: string
                        issuing_state:
                          type: string
                        first_name:
                          type: string
                        middle_name:
                          type: string
                        last_name:
                          type: string
                        name_suffix:
                          type: string
                        street:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        postal_code:
                          type: string
                        birth_date:
                          type:
                            - string
                            - 'null'
                        gender_e:
                          type: string
                          enum:
                            - unknown
                            - female
                            - male
                        height:
                          type: string
                        weight:
                          type: string
                        eye_color:
                          type: string
                        hair_color:
                          type: string
                        class:
                          type: string
                        restrictions:
                          type: string
                      required:
                        - issued_at
                        - expires_at
                        - birth_date
                  meta_counts:
                    type: object
                    properties:
                      take:
                        type: number
                      skip:
                        type: number
                      response:
                        type: number
                      total:
                        type: number
                required:
                  - documents
                  - meta_counts
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/document/download:
    post:
      tags:
        - IDV
      summary: document download
      description: Document download for identity verification.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                storage_file_type_e:
                  type: string
                  enum:
                    - unknown
                    - driver_license_front
                    - driver_license_back
                    - state_id_card_front
                    - state_id_card_back
                    - passport_front
                    - passport_card_front
                    - passport_card_back
                    - selfie
                    - liveness_passive
                    - liveness_active_step_1
                    - liveness_active_step_2
                    - liveness_active_step_3
                    - liveness_active_step_4
              required:
                - session_id
                - storage_file_type_e
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/session/test/read:
    post:
      tags:
        - IDV
      summary: session test read
      description: Session test read for identity verification.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
              required:
                - session_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  doc_front_image_manipulation:
                    type: string
                  doc_front_is_identity_document:
                    type: string
                  doc_front_online_duplication:
                    type: string
                  doc_front_suspicious_words:
                    type: string
                  doc_back_image_manipulation:
                    type: string
                  doc_back_is_identity_document:
                    type: string
                  doc_back_online_duplication:
                    type: string
                  doc_back_suspicious_words:
                    type: string
                  dmv_document_number_match:
                    type: boolean
                  dmv_document_expiration_match:
                    type: boolean
                  dmv_document_issue_match:
                    type: boolean
                  dmv_document_category_match:
                    type: boolean
                  dmv_birth_date_match:
                    type: boolean
                  dmv_sex_match:
                    type: boolean
                  dmv_eye_color_match:
                    type: boolean
                  dmv_height_match:
                    type: boolean
                  dmv_weight_match:
                    type: boolean
                  dmv_first_name_match:
                    type: boolean
                  dmv_middle_name_match:
                    type: boolean
                  dmv_last_name_match:
                    type: boolean
                  dmv_suffix_name_match:
                    type: boolean
                  dmv_street_match:
                    type: boolean
                  dmv_city_match:
                    type: boolean
                  dmv_state_match:
                    type: boolean
                  dmv_postal_code_match:
                    type: boolean
                  document_number_crosscheck:
                    type: boolean
                  name_crosscheck:
                    type: boolean
                  address_crosscheck:
                    type: boolean
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/requirements:
    get:
      tags:
        - IDV
      summary: get requirements
      description: Get the requirements for the given type and data source.
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: false
          name: client_id
          in: query
        - schema:
            type: string
          required: false
          name: user_id
          in: query
        - schema:
            type: string
            enum:
              - unknown
              - driver_license
              - identification_card
              - passport
              - passport_card
          required: false
          name: type_e
          in: query
        - schema:
            type: string
          required: false
          name: data_source_e
          in: query
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  requirements:
                    type: array
                    items:
                      type: object
                      properties:
                        type_e:
                          type: string
                          enum:
                            - unknown
                            - driver_license
                            - identification_card
                            - passport
                            - passport_card
                        data_source_e:
                          type: string
                        document_number_required:
                          type: boolean
                        ref_number_required:
                          type: boolean
                        issue_at_required:
                          type: boolean
                        expires_at_required:
                          type: boolean
                        issuing_country_required:
                          type: boolean
                        issuing_state_required:
                          type: boolean
                        first_name_required:
                          type: boolean
                        middle_name_required:
                          type: boolean
                        last_name_required:
                          type: boolean
                        name_suffix_required:
                          type: boolean
                        street_required:
                          type: boolean
                        city_required:
                          type: boolean
                        state_required:
                          type: boolean
                        postal_code_required:
                          type: boolean
                        birth_date_required:
                          type: boolean
                        gender_required:
                          type: boolean
                        height_required:
                          type: boolean
                        weight_required:
                          type: boolean
                        eye_color_required:
                          type: boolean
                        hair_color_required:
                          type: boolean
                        class_required:
                          type: boolean
                        mentions_required:
                          type: boolean
                        restrictions_required:
                          type: boolean
                        raw_barcode_required:
                          type: boolean
                        face_encoding_required:
                          type: boolean
                      required:
                        - type_e
                        - data_source_e
                        - document_number_required
                        - ref_number_required
                        - issue_at_required
                        - expires_at_required
                        - issuing_country_required
                        - issuing_state_required
                        - first_name_required
                        - middle_name_required
                        - last_name_required
                        - name_suffix_required
                        - street_required
                        - city_required
                        - state_required
                        - postal_code_required
                        - birth_date_required
                        - gender_required
                        - height_required
                        - weight_required
                        - eye_color_required
                        - hair_color_required
                        - class_required
                        - mentions_required
                        - restrictions_required
                        - raw_barcode_required
                        - face_encoding_required
                required:
                  - requirements
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
    put:
      tags:
        - IDV
      summary: update requirements
      description: Update the requirements for the given type and data source.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client_id:
                  type: string
                user_id:
                  type: string
                type_e:
                  type: string
                  enum:
                    - unknown
                    - driver_license
                    - identification_card
                    - passport
                    - passport_card
                data_source_e:
                  type: string
                document_number_required:
                  type: boolean
                ref_number_required:
                  type: boolean
                issue_at_required:
                  type: boolean
                expires_at_required:
                  type: boolean
                issuing_country_required:
                  type: boolean
                issuing_state_required:
                  type: boolean
                first_name_required:
                  type: boolean
                middle_name_required:
                  type: boolean
                last_name_required:
                  type: boolean
                name_suffix_required:
                  type: boolean
                street_required:
                  type: boolean
                city_required:
                  type: boolean
                state_required:
                  type: boolean
                postal_code_required:
                  type: boolean
                birth_date_required:
                  type: boolean
                gender_required:
                  type: boolean
                height_required:
                  type: boolean
                weight_required:
                  type: boolean
                eye_color_required:
                  type: boolean
                hair_color_required:
                  type: boolean
                class_required:
                  type: boolean
                mentions_required:
                  type: boolean
                restrictions_required:
                  type: boolean
                raw_barcode_required:
                  type: boolean
                face_encoding_required:
                  type: boolean
              required:
                - type_e
                - data_source_e
                - document_number_required
                - ref_number_required
                - issue_at_required
                - expires_at_required
                - issuing_country_required
                - issuing_state_required
                - first_name_required
                - middle_name_required
                - last_name_required
                - name_suffix_required
                - street_required
                - city_required
                - state_required
                - postal_code_required
                - birth_date_required
                - gender_required
                - height_required
                - weight_required
                - eye_color_required
                - hair_color_required
                - class_required
                - mentions_required
                - restrictions_required
                - raw_barcode_required
                - face_encoding_required
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/weights:
    get:
      tags:
        - IDV
      summary: get weights
      description: Get the weights for the IDV system.
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: false
          name: client_id
          in: query
        - schema:
            type: string
          required: false
          name: user_id
          in: query
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  client_id:
                    type: string
                  user_id:
                    type: string
                  onboarding_face_encoding_tolerance:
                    type: number
                  verified_account_face_encoding_tolerance:
                    type: number
                  driver_license_fuzzy_match_tolerance:
                    type: number
                  driver_license_fuzzy_match_weight:
                    type: number
                  state_id_fuzzy_match_tolerance:
                    type: number
                  state_id_fuzzy_match_weight:
                    type: number
                  passport_fuzzy_match_tolerance:
                    type: number
                  passport_fuzzy_match_weight:
                    type: number
                  passport_card_fuzzy_match_tolerance:
                    type: number
                  passport_card_fuzzy_match_weight:
                    type: number
                  ofac_fuzzy_match_tolerance:
                    type: number
                  ofac_fuzzy_match_weight:
                    type: number
                  suspicious_words_weight:
                    type: number
                  image_manipulation_weight:
                    type: number
                  online_duplication_weight:
                    type: number
                  is_identity_document_weight:
                    type: number
                  aamva_match_tolerance:
                    type: number
                  aamva_match_weight:
                    type: number
                  idv_session_tolerance:
                    type: number
                  minimum_liveness_tolerance:
                    type: number
                  passive_active_skip_tolerance:
                    type: number
                  gender_probability_tolerance:
                    type: number
                  gender_weight:
                    type: number
                  expression_tolerance:
                    type: number
                  age_tolerance:
                    type: number
                  age_weight:
                    type: number
                  direction_tolerance:
                    type: number
                required:
                  - onboarding_face_encoding_tolerance
                  - verified_account_face_encoding_tolerance
                  - driver_license_fuzzy_match_tolerance
                  - driver_license_fuzzy_match_weight
                  - state_id_fuzzy_match_tolerance
                  - state_id_fuzzy_match_weight
                  - passport_fuzzy_match_tolerance
                  - passport_fuzzy_match_weight
                  - passport_card_fuzzy_match_tolerance
                  - passport_card_fuzzy_match_weight
                  - ofac_fuzzy_match_tolerance
                  - ofac_fuzzy_match_weight
                  - suspicious_words_weight
                  - image_manipulation_weight
                  - online_duplication_weight
                  - is_identity_document_weight
                  - aamva_match_tolerance
                  - aamva_match_weight
                  - idv_session_tolerance
                  - minimum_liveness_tolerance
                  - passive_active_skip_tolerance
                  - gender_probability_tolerance
                  - gender_weight
                  - expression_tolerance
                  - age_tolerance
                  - age_weight
                  - direction_tolerance
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
    put:
      tags:
        - IDV
      summary: update weights
      description: Update the weights for the IDV system.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client_id:
                  type: string
                user_id:
                  type: string
                onboarding_face_encoding_tolerance:
                  type: number
                verified_account_face_encoding_tolerance:
                  type: number
                driver_license_fuzzy_match_tolerance:
                  type: number
                driver_license_fuzzy_match_weight:
                  type: number
                state_id_fuzzy_match_tolerance:
                  type: number
                state_id_fuzzy_match_weight:
                  type: number
                passport_fuzzy_match_tolerance:
                  type: number
                passport_fuzzy_match_weight:
                  type: number
                passport_card_fuzzy_match_tolerance:
                  type: number
                passport_card_fuzzy_match_weight:
                  type: number
                ofac_fuzzy_match_tolerance:
                  type: number
                ofac_fuzzy_match_weight:
                  type: number
                suspicious_words_weight:
                  type: number
                image_manipulation_weight:
                  type: number
                online_duplication_weight:
                  type: number
                is_identity_document_weight:
                  type: number
                aamva_match_tolerance:
                  type: number
                aamva_match_weight:
                  type: number
                idv_session_tolerance:
                  type: number
                minimum_liveness_tolerance:
                  type: number
                passive_active_skip_tolerance:
                  type: number
                gender_probability_tolerance:
                  type: number
                gender_weight:
                  type: number
                expression_tolerance:
                  type: number
                age_tolerance:
                  type: number
                age_weight:
                  type: number
                direction_tolerance:
                  type: number
              required:
                - onboarding_face_encoding_tolerance
                - verified_account_face_encoding_tolerance
                - driver_license_fuzzy_match_tolerance
                - driver_license_fuzzy_match_weight
                - state_id_fuzzy_match_tolerance
                - state_id_fuzzy_match_weight
                - passport_fuzzy_match_tolerance
                - passport_fuzzy_match_weight
                - passport_card_fuzzy_match_tolerance
                - passport_card_fuzzy_match_weight
                - ofac_fuzzy_match_tolerance
                - ofac_fuzzy_match_weight
                - suspicious_words_weight
                - image_manipulation_weight
                - online_duplication_weight
                - is_identity_document_weight
                - aamva_match_tolerance
                - aamva_match_weight
                - idv_session_tolerance
                - minimum_liveness_tolerance
                - passive_active_skip_tolerance
                - gender_probability_tolerance
                - gender_weight
                - expression_tolerance
                - age_tolerance
                - age_weight
                - direction_tolerance
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/idv/weights/{id}:
    get:
      tags:
        - IDV
      summary: get weights by id
      description: Get weights by ID for historical lookup.
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  client_id:
                    type: string
                  user_id:
                    type: string
                  onboarding_face_encoding_tolerance:
                    type: number
                  verified_account_face_encoding_tolerance:
                    type: number
                  driver_license_fuzzy_match_tolerance:
                    type: number
                  driver_license_fuzzy_match_weight:
                    type: number
                  state_id_fuzzy_match_tolerance:
                    type: number
                  state_id_fuzzy_match_weight:
                    type: number
                  passport_fuzzy_match_tolerance:
                    type: number
                  passport_fuzzy_match_weight:
                    type: number
                  passport_card_fuzzy_match_tolerance:
                    type: number
                  passport_card_fuzzy_match_weight:
                    type: number
                  ofac_fuzzy_match_tolerance:
                    type: number
                  ofac_fuzzy_match_weight:
                    type: number
                  suspicious_words_weight:
                    type: number
                  image_manipulation_weight:
                    type: number
                  online_duplication_weight:
                    type: number
                  is_identity_document_weight:
                    type: number
                  aamva_match_tolerance:
                    type: number
                  aamva_match_weight:
                    type: number
                  idv_session_tolerance:
                    type: number
                  minimum_liveness_tolerance:
                    type: number
                  passive_active_skip_tolerance:
                    type: number
                  gender_probability_tolerance:
                    type: number
                  gender_weight:
                    type: number
                  expression_tolerance:
                    type: number
                  age_tolerance:
                    type: number
                  age_weight:
                    type: number
                  direction_tolerance:
                    type: number
                required:
                  - onboarding_face_encoding_tolerance
                  - verified_account_face_encoding_tolerance
                  - driver_license_fuzzy_match_tolerance
                  - driver_license_fuzzy_match_weight
                  - state_id_fuzzy_match_tolerance
                  - state_id_fuzzy_match_weight
                  - passport_fuzzy_match_tolerance
                  - passport_fuzzy_match_weight
                  - passport_card_fuzzy_match_tolerance
                  - passport_card_fuzzy_match_weight
                  - ofac_fuzzy_match_tolerance
                  - ofac_fuzzy_match_weight
                  - suspicious_words_weight
                  - image_manipulation_weight
                  - online_duplication_weight
                  - is_identity_document_weight
                  - aamva_match_tolerance
                  - aamva_match_weight
                  - idv_session_tolerance
                  - minimum_liveness_tolerance
                  - passive_active_skip_tolerance
                  - gender_probability_tolerance
                  - gender_weight
                  - expression_tolerance
                  - age_tolerance
                  - age_weight
                  - direction_tolerance
                description: '200'
        '404':
          description: The item you requested could not be found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: The item you requested could not be found
  /api/v1/ida/session/location:
    post:
      tags:
        - IDA
      summary: ida session location read response
      description: IDA Session Location read response
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                location_capture_type_e:
                  type: string
                  enum:
                    - unknown
                    - front_doc_image_capture
                    - back_doc_image_capture
                    - selfie_image_capture
              required:
                - session_id
                - location_capture_type_e
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  ip_address:
                    type: string
                  ip_latitude:
                    type: number
                  ip_longitude:
                    type: number
                  ip_country:
                    type: string
                  ip_region:
                    type: string
                  ip_city:
                    type: string
                  device_location:
                    type: string
                  device_latitude:
                    type: number
                  device_longitude:
                    type: number
                  device_country_name:
                    type: string
                  device_country_code:
                    type: string
                  device_admin_area:
                    type: string
                  device_sub_admin_area:
                    type: string
                  device_locality:
                    type: string
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/ida/session/delete:
    delete:
      tags:
        - IDA
      summary: session delete
      description: Session delete for identity authentication.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
              required:
                - session_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/ida/session/create:
    post:
      tags:
        - IDA
      summary: identity authentication session create
      description: Identity Authentication session create
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                identity_id:
                  type: string
                webhook_url:
                  type: string
                liveness_mode:
                  type: string
                  enum:
                    - passive
                    - passive_active
                metadata:
                  type: object
                  additionalProperties:
                    anyOf:
                      - type: string
                      - type: number
                settings:
                  type: object
                  properties:
                    perform_age_test:
                      type: boolean
                    perform_gender_test:
                      type: boolean
              required:
                - identity_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  session_id:
                    type: string
                required:
                  - session_id
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/ida/session/list:
    post:
      tags:
        - IDA
      summary: session list
      description: Session list for identity authentication.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                take:
                  type: number
                skip:
                  type: number
                identity_id:
                  anyOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                client_id:
                  anyOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                user_id:
                  anyOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                search_term:
                  type: string
                verified:
                  type: boolean
                status:
                  type: string
                  enum:
                    - unknown
                    - in_progress
                    - complete
                    - temporarily_blocked
                    - temporarily_complete
                    - expired
                start_date:
                  type:
                    - string
                    - 'null'
                end_date:
                  type:
                    - string
                    - 'null'
                metadata:
                  type: object
                  additionalProperties:
                    anyOf:
                      - type: string
                      - type: number
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessions:
                    type: array
                    items:
                      type: object
                      properties:
                        user_id:
                          type: string
                        client_id:
                          type: string
                        created_at:
                          type:
                            - string
                            - 'null'
                        completed_at:
                          type:
                            - string
                            - 'null'
                        identity_id:
                          type: string
                        session_id:
                          type: string
                        idv_weights_id:
                          type: string
                        status_e:
                          type: string
                          enum:
                            - unknown
                            - in_progress
                            - complete
                            - temporarily_blocked
                            - temporarily_complete
                            - expired
                        first_name:
                          type: string
                        middle_name:
                          type: string
                        last_name:
                          type: string
                        suffix_name:
                          type: string
                        liveness_detected:
                          type: boolean
                        liveness_detected_at:
                          type:
                            - string
                            - 'null'
                        selfie_given:
                          type: boolean
                        selfie_given_at:
                          type:
                            - string
                            - 'null'
                        authenticated:
                          type: boolean
                        metadata:
                          type: object
                          additionalProperties:
                            anyOf:
                              - type: string
                              - type: number
                      required:
                        - created_at
                        - completed_at
                        - status_e
                        - liveness_detected_at
                        - selfie_given_at
                  meta_counts:
                    type: object
                    properties:
                      take:
                        type: number
                      skip:
                        type: number
                      response:
                        type: number
                      total:
                        type: number
                required:
                  - sessions
                  - meta_counts
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/ida/session/read:
    post:
      tags:
        - IDA
      summary: session read
      description: Session read for identity authentication.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
              required:
                - session_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  session_id:
                    type: string
                  user_id:
                    type: string
                  client_id:
                    type: string
                  idv_weights_id:
                    type: string
                  status_e:
                    type: string
                    enum:
                      - unknown
                      - in_progress
                      - complete
                      - temporarily_blocked
                      - temporarily_complete
                      - expired
                  created_at:
                    type:
                      - string
                      - 'null'
                  completed_at:
                    type:
                      - string
                      - 'null'
                  identity_id:
                    type: string
                  first_name:
                    type: string
                  middle_name:
                    type: string
                  last_name:
                    type: string
                  suffix_name:
                    type: string
                  liveness_detected:
                    type: boolean
                  liveness_detected_at:
                    type:
                      - string
                      - 'null'
                  selfie_given:
                    type: boolean
                  selfie_given_at:
                    type:
                      - string
                      - 'null'
                  authenticated:
                    type: boolean
                  metadata:
                    type: object
                    additionalProperties:
                      anyOf:
                        - type: string
                        - type: number
                  webhook_url:
                    type: string
                  settings:
                    type: object
                    properties:
                      perform_age_test:
                        type: boolean
                      perform_gender_test:
                        type: boolean
                  history:
                    type: array
                    items:
                      type: object
                      properties:
                        event:
                          anyOf:
                            - type: string
                              enum:
                                - created
                                - session_read
                                - liveness_session_created
                                - liveness_session_processed
                                - selfie_add
                                - session_finalize
                                - metadata_update
                                - websocket_connection_established
                            - type: string
                              enum:
                                - websocket_connection_established
                                - buffer_filled
                                - no_faces_detected
                                - emotion_detected
                                - face_mismatch
                                - direction_detected
                                - wearing_glasses
                                - liveness_detection_error
                                - liveness_verified
                                - passive_liveness_verified
                                - active_liveness_verified
                                - face_match
                                - preprocess_failed
                                - emotion_failed
                                - liveness_failed
                                - direction_failed
                                - active_liveness_failed
                        endpoint:
                          type: string
                      required:
                        - event
                        - endpoint
                required:
                  - status_e
                  - created_at
                  - completed_at
                  - liveness_detected_at
                  - selfie_given_at
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/ida/session/download:
    post:
      tags:
        - IDA
      summary: download ida document
      description: Download ida document.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
              required:
                - session_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/ida/sdk/metadata/update:
    put:
      tags:
        - IDA SDK
      summary: sdk metadata update
      description: SDK metadata update.
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: X-Client-Id
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                sdk_metadata:
                  type: object
                  additionalProperties: {}
              required:
                - session_id
                - sdk_metadata
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/ida/sdk/selfie/session/generate:
    post:
      tags:
        - IDA SDK
      summary: sdk liveness session generate
      description: SDK access to generate a liveness session
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: X-Client-Id
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                latitude:
                  type: number
                longitude:
                  type: number
              required:
                - session_id
                - latitude
                - longitude
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
                required:
                  - token
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/ida/sdk/selfie/session/process:
    post:
      tags:
        - IDA SDK
      summary: sdk liveness session process
      description: SDK access to process a liveness session
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: X-Client-Id
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                latitude:
                  type: number
                longitude:
                  type: number
                images:
                  type: array
                  items:
                    type: string
              required:
                - session_id
                - latitude
                - longitude
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
                required:
                  - token
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/ida/sdk/finalize:
    post:
      tags:
        - IDA SDK
      summary: identity authentication finalize
      description: Identity Authentication finalize
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: X-Client-Id
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
              required:
                - session_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/ida/sdk/session/read:
    post:
      tags:
        - IDA
      summary: session read
      description: Session read for identity authentication.
      security:
        - oauth2:
            - kyc
      parameters:
        - schema:
            type: string
          required: true
          name: X-Client-Id
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
              required:
                - session_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  session_id:
                    type: string
                  identity_id:
                    type: string
                  user_id:
                    type: string
                  client_id:
                    type: string
                  status_e:
                    type: string
                    enum:
                      - unknown
                      - in_progress
                      - complete
                      - temporarily_blocked
                      - temporarily_complete
                      - expired
                  first_name:
                    type: string
                  middle_name:
                    type: string
                  last_name:
                    type: string
                  suffix_name:
                    type: string
                  liveness_detected:
                    type: boolean
                  liveness_detected_at:
                    type:
                      - string
                      - 'null'
                  selfie_given:
                    type: boolean
                  selfie_given_at:
                    type:
                      - string
                      - 'null'
                  authenticated:
                    type: boolean
                  liveness_provider_e:
                    type: string
                    enum:
                      - azure
                      - vult
                  sdk_metadata:
                    type: object
                    additionalProperties: {}
                required:
                  - status_e
                  - liveness_detected_at
                  - selfie_given_at
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/identity/list:
    post:
      tags:
        - Identity
      summary: list identities
      description: List identities.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client_id:
                  anyOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                user_id:
                  anyOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                search_term:
                  type: string
                take:
                  type: number
                skip:
                  type: number
                start_date:
                  type: string
                  format: date-time
                end_date:
                  type: string
                  format: date-time
                metadata:
                  type: object
                  additionalProperties:
                    anyOf:
                      - type: string
                      - type: number
                      - type: array
                        items:
                          anyOf:
                            - type: string
                            - type: number
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  identities:
                    type: array
                    items:
                      type: object
                      properties:
                        identity_id:
                          type: string
                        created_at:
                          type: string
                        external_id:
                          type: string
                        first_name:
                          type: string
                        middle_name:
                          type: string
                        last_name:
                          type: string
                        name_suffix:
                          type: string
                        birth_date:
                          type: string
                        email:
                          type: string
                        phone:
                          type: string
                        completed_at:
                          type: string
                        document_front_given:
                          type: boolean
                        document_front_given_at:
                          type:
                            - string
                            - 'null'
                        liveness_detected:
                          type: boolean
                        liveness_detected_at:
                          type:
                            - string
                            - 'null'
                        ofac_status_e:
                          type: string
                          enum:
                            - unknown
                            - initiated
                            - passed
                            - failed
                            - skipped
                        ofac_detected_at:
                          type: string
                        dmv_status_e:
                          type: string
                          enum:
                            - unknown
                            - initiated
                            - passed
                            - failed
                            - skipped
                            - pending
                        dmv_detected_at:
                          type: string
                        verified:
                          type: boolean
                        verified_at:
                          type:
                            - string
                            - 'null'
                        last_verified:
                          type: string
                        identity_score:
                          type: number
                      required:
                        - document_front_given_at
                        - liveness_detected_at
                        - verified_at
                  meta_counts:
                    type: object
                    properties:
                      take:
                        type: number
                      skip:
                        type: number
                      response:
                        type: number
                      total:
                        type: number
                required:
                  - identities
                  - meta_counts
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/identity/anonymize:
    post:
      tags:
        - Identity
      summary: anonymize identity
      description: Anonymize identity.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                identity_id:
                  type: string
              required:
                - identity_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/identity/read:
    post:
      tags:
        - Identity
      summary: read identities
      description: Read identities.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                identity_id:
                  anyOf:
                    - type: string
                    - type: array
                      items:
                        type: string
                identity_ids:
                  type: array
                  items:
                    type: string
                metadata:
                  type: object
                  additionalProperties:
                    anyOf:
                      - type: string
                      - type: number
                      - type: array
                        items:
                          anyOf:
                            - type: string
                            - type: number
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  identities:
                    type: array
                    items:
                      type: object
                      properties:
                        identity_id:
                          type: string
                        created_at:
                          type: string
                        first_name:
                          type: string
                        middle_name:
                          type: string
                        last_name:
                          type: string
                        suffix_name:
                          type: string
                        birth_date:
                          type: string
                        gender_e:
                          type: string
                          enum:
                            - unknown
                            - female
                            - male
                        street:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        postal_code:
                          type: string
                        document_front_given:
                          type: boolean
                        document_front_given_at:
                          type: string
                        verified:
                          type: boolean
                        verified_at:
                          type: string
                        liveness_detected:
                          type: boolean
                        liveness_detected_at:
                          type: string
                        ofac_status_e:
                          type: string
                          enum:
                            - unknown
                            - initiated
                            - passed
                            - failed
                            - skipped
                        ofac_detected_at:
                          type: string
                        dmv_status_e:
                          type: string
                          enum:
                            - unknown
                            - initiated
                            - passed
                            - failed
                            - skipped
                            - pending
                        dmv_detected_at:
                          type: string
                        score:
                          type: number
                  identity_id:
                    type: string
                  created_at:
                    type: string
                  first_name:
                    type: string
                  middle_name:
                    type: string
                  last_name:
                    type: string
                  suffix_name:
                    type: string
                  birth_date:
                    type: string
                  gender_e:
                    type: string
                    enum:
                      - unknown
                      - female
                      - male
                  street:
                    type: string
                  city:
                    type: string
                  state:
                    type: string
                  postal_code:
                    type: string
                  document_front_given:
                    type: boolean
                  document_front_given_at:
                    type: string
                  verified:
                    type: boolean
                  verified_at:
                    type: string
                  liveness_detected:
                    type: boolean
                  liveness_detected_at:
                    type: string
                  ofac_status_e:
                    type: string
                    enum:
                      - unknown
                      - initiated
                      - passed
                      - failed
                      - skipped
                  ofac_detected_at:
                    type: string
                  dmv_status_e:
                    type: string
                    enum:
                      - unknown
                      - initiated
                      - passed
                      - failed
                      - skipped
                      - pending
                  dmv_detected_at:
                    type: string
                  score:
                    type: number
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/identity/status/read:
    post:
      tags:
        - Identity
      summary: get identity status for sdk
      description: Gets the identity status for a identity for sdk use.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                identity_id:
                  type: string
              required:
                - identity_id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  verified:
                    type: boolean
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/identity/document/read:
    post:
      tags:
        - Identity
      summary: read completed identity document
      description: Read completed identity document.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                identity_id:
                  type: string
                document_type_e:
                  type: string
                  enum:
                    - unknown
                    - driver_license
                    - identification_card
                    - passport
                    - passport_card
              required:
                - identity_id
                - document_type_e
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  document_id:
                    type: string
                  document_type_e:
                    type: string
                    enum:
                      - unknown
                      - driver_license
                      - identification_card
                      - passport
                      - passport_card
                  document_data_source_e:
                    type: string
                    enum:
                      - unknown
                      - pdf417
                      - mrz
                      - ocr
                  document_number:
                    type: string
                  issue_date:
                    type: string
                  expiration_date:
                    type: string
                  ref_number:
                    type: string
                  issuing_country:
                    type: string
                  issuing_state:
                    type: string
                  birth_date:
                    type: string
                  gender_e:
                    type: string
                    enum:
                      - unknown
                      - female
                      - male
                  first_name:
                    type: string
                  middle_name:
                    type: string
                  last_name:
                    type: string
                  suffix_name:
                    type: string
                  street:
                    type: string
                  city:
                    type: string
                  state:
                    type: string
                  postal_code:
                    type: string
                  height:
                    type: string
                  weight:
                    type: string
                  eye_color:
                    type: string
                  hair_color:
                    type: string
                required:
                  - document_type_e
                  - document_data_source_e
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/identity/image/read:
    post:
      tags:
        - Identity
      summary: read identity image
      description: Read identity image.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                identity_id:
                  type: string
                storage_file_type_e:
                  type: string
                  enum:
                    - unknown
                    - driver_license_front
                    - driver_license_back
                    - state_id_card_front
                    - state_id_card_back
                    - passport_front
                    - passport_card_front
                    - passport_card_back
                    - selfie
                    - liveness_passive
                    - liveness_active_step_1
                    - liveness_active_step_2
                    - liveness_active_step_3
                    - liveness_active_step_4
              required:
                - identity_id
                - storage_file_type_e
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/webhook/create:
    post:
      tags:
        - Webhook
      summary: webhook create
      description: Webhook create.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client_id:
                  type: string
                name:
                  type: string
                url:
                  type: string
              required:
                - name
                - url
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/webhook/list:
    post:
      tags:
        - Webhook
      summary: webhook list
      description: Webhook list.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                client_id:
                  type: string
                take:
                  type: number
                skip:
                  type: number
                search_term:
                  type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhooks:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        client_id:
                          type: string
                        name:
                          type: string
                        url:
                          type: string
                  statistics:
                    type: object
                    properties:
                      total_rows:
                        type: number
                      current_page:
                        type: number
                      total_pages:
                        type: number
                required:
                  - webhooks
                  - statistics
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
  /api/v1/webhook/delete:
    post:
      tags:
        - Webhook
      summary: webhook delete
      description: Webhook delete.
      security:
        - oauth2:
            - kyc
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
              required:
                - id
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: '200'
        '400':
          description: >-
            The request payload or query string parameter you passed was not
            valid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: A 400 error
webhooks: {}
