{
  "openapi": "3.1.0",
  "info": {
    "title": "Incode Omni API",
    "description": "Incode Omni\n\nServed by Incode Developer Hub at https://developer.incode.com/openapi.json.\n\nThis is the published Omni API specification, annotated with a link from each of its 214 operations to the page documenting it (`externalDocs`, plus `x-incode-markdown` for the Markdown twin).\n\n9 operation(s) have no page on this site yet and are marked `x-incode-status: undocumented`.\n\nSchemas are the API's own — nothing here is re-derived from the documentation.",
    "termsOfService": "http://swagger.io/terms/",
    "license": {
      "name": "Apache 2.0",
      "url": "http://springdoc.org"
    },
    "version": "0.0.1-SNAPSHOT",
    "contact": {
      "name": "Incode Developer Hub",
      "url": "https://developer.incode.com/"
    }
  },
  "servers": [
    {
      "url": "https://demo-api.incodesmile.com",
      "description": "Incode demo environment"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": [],
      "IncodeHardwareIdAuth": []
    }
  ],
  "tags": [
    {
      "name": "Dashboard",
      "description": "Dashboard notification operations"
    },
    {
      "name": "API Keys",
      "description": "Following endpoints facilitate API key rotation, for security reasons - current key gets stolen, user access needs\nto be revoked, organization expires, etc. It is good practice to rotate them every once in a while, regardless\n(e.g. every three months).\n\n**Migration**\nThere used to be only one API key per organization, created and registered on API Gateway at the time of organization\ncreation. Each organization has a user defined `name`, on which 3 random digits are added to generate `clientId`,\non which sha1 was applied to generate `apiKey`. Field `clientId` was also used as organization identifier, while\n`apiKey` also served as organization reference.\n\nWith the rotatable approach, API key management is delegated to a separate collection, which would contain `clientId`\nand `value` for each record. This also enables having multiple API keys per organization. Fields `clientId`/`apiKey`\non organization entity will keep their identifier/reference function, to maintain referential integrity between entities.\n\nIn order to facilitate the new approach and ensure backwards compatibility, a migration process is established.\nThrough it, API key related fields are copied from Organization to RotatableApiKey collection, so that in the end\neach organization would have a corresponding rotatable key created. Key validity is checked on API Gateway directly\n(if applicable, otherwise set to `true`). All subsequent API key management would affect new collection only.\n"
    },
    {
      "name": "Dashboard",
      "description": "Manage global regional retention policies for compliance"
    },
    {
      "name": "Payments",
      "description": "Payment-instrument (card) verification endpoints"
    },
    {
      "name": "API validations",
      "description": "Standalone API validations that are not related to any interview or onboarding process. This helps with various\nidentity verifications specific to certain countries such as CURP and INE in Mexico or SSN in USA.\n"
    }
  ],
  "paths": {
    "/omni/api-key": {
      "get": {
        "tags": [
          "API Keys"
        ],
        "summary": "Fetch",
        "description": "Fetch all API keys of current user's organization. If user is super admin, parameter apiKey can be provided to specify\norganization for which the keys should be fetched (ignored otherwise).\n",
        "operationId": "getApiKeys",
        "parameters": [
          {
            "name": "apiKey",
            "in": "query",
            "description": "Organization reference.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RotatableApiKeyDto"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-key/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-key.md"
      },
      "put": {
        "tags": [
          "API Keys"
        ],
        "summary": "Update",
        "description": "Validate/invalidate API key for current user's organization. If user is super admin, parameter apiKey can be provided\nto specify organization for which the key should be adjusted (ignored otherwise). User is not allowed to invalidate last\nvalid key of the belonging organization. Super admin user can invalidate last valid keys of other organizations\n(effectively revoking their access to the application).\n",
        "operationId": "updateApiKey",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateApiKeyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RotatableApiKeyDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-key-put/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-key-put.md"
      },
      "post": {
        "tags": [
          "API Keys"
        ],
        "summary": "Create",
        "description": "Create new API key for current user's organization. If user is super admin, parameter apiKey can be provided to specify\norganization for which the key should be created (ignored otherwise).\n",
        "operationId": "addApiKey",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddApiKeyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RotatableApiKeyDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-key-post/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-key-post.md"
      }
    },
    "/omni/update/editable-ocr-data-second-id": {
      "put": {
        "tags": [
          "Id capture"
        ],
        "summary": "Update editable OCR data in interview for the second Id",
        "description": "Update some of the crucial interview OCR data if needed.\n",
        "operationId": "updateeditableocrdatasecondid",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomerEditableOcrDataRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/update-editable-ocr-data-second-id/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/update-editable-ocr-data-second-id.md"
      }
    },
    "/omni/update/editable-ocr-data": {
      "put": {
        "tags": [
          "Id capture"
        ],
        "summary": "Update editable OCR data in interview",
        "description": "Update some of the crucial interview OCR data if needed.\n",
        "operationId": "updateeditableocrdata",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomerEditableOcrDataRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/update-editable-ocr-data/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/update-editable-ocr-data.md"
      }
    },
    "/omni/update": {
      "put": {
        "tags": [
          "Interview"
        ],
        "summary": "Update interview",
        "description": "If upload of front, back side of id or selfie, was not successful after retries,\nuse this endpoint to specify that additional manual check is needed.\n",
        "operationId": "updateinterview",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Id of onboarding for which data will be updated. If not present, it will be extracted from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/update/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/update.md"
      }
    },
    "/omni/queue/conference/add": {
      "put": {
        "tags": [
          "Video conference"
        ],
        "summary": "Add user to queue",
        "description": "When data collection is over, users can be added to the queue for joining conference calls with an executive. The average\ntime for before user joins to conference is given in response.\n",
        "operationId": "addToQueue",
        "parameters": [
          {
            "name": "queueName",
            "in": "query",
            "description": "The name of the queue, user is entering in case a conference call will be used. If not set, default queue will be used.\nPossible values: aristotle, buddha, confucius, diogenes. Same value for queueName needs to be used across all requests\nin one onboarding session.\n",
            "required": false,
            "schema": {
              "type": "string",
              "default": ""
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VerifyInterviewRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddToQueueResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error status:\n- 4014: Invalid interview code\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/queue-conference-add/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/queue-conference-add.md"
      }
    },
    "/omni/manual-review": {
      "put": {
        "tags": [
          "Interview"
        ],
        "summary": "Update manual review",
        "description": "Can be used to set an interview as 'needs manual review', 'approved by manual review' or 'rejected by manual review'.\nIn case manualReviewStatus field in request is set to APPROVED or REJECTED, notification to client side is sent\nfor onboarding status change - see [notify-status-changed] for more details\n",
        "operationId": "updatemanualreview",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "description": "Id of onboarding for which data will be updated. If not present, it will be extracted from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateManualReviewRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/updatemanualreview/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/updatemanualreview.md"
      }
    },
    "/omni/finish": {
      "put": {
        "tags": [
          "Video conference"
        ],
        "summary": "Finish interview",
        "description": "Finish the interview and remove customer from the queue.",
        "operationId": "finishInterview",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FinishInterviewRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FinishInterviewResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/finish/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/finish.md"
      }
    },
    "/omni/stateless-authentications/provide/reference-selfie": {
      "post": {
        "tags": [
          "Onboarding authentication"
        ],
        "summary": "Provide selfie for stateless authentication",
        "description": "A method to provide a reference selfie for stateless authentication.\n(A selfie of the original onboarding that was approved but later removed from Incode storage).\nThis selfie will be used in authentication process if it's configured to be stateless.\n",
        "operationId": "authenticate",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StatelessAuthenticationSelfieRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StatelessAuthenticationSelfieResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/stateless-authentications-provide-reference-selfie/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/stateless-authentications-provide-reference-selfie.md"
      }
    },
    "/omni/oneToN/v2/identify": {
      "post": {
        "tags": [
          "Login"
        ],
        "summary": "Face Authentication 1:N",
        "description": "Identify user by face. Parameter base64Image is optional if template is present. If there is more than one user that has\nrecognition confidence above threshold, secondFactor will be true and [/omni/oneToN/mfa](#/Login/oneToNMfa) must be called.\n",
        "operationId": "oneToNIdentify",
        "parameters": [
          {
            "name": "correlationId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "returnIPDeviceLocation",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OneToNRequestV2"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "- customerId: String. ID of recognized customer. (only if single customer was recognized)\n- token: String. Token bound to the customerId of recognized customer. (only if single customer was recognized)\n- interviewId: String. ID of the session where recognized customer got approved. (only if single customer was recognized)\n- interviewToken: String. Token bound to the session identified with interviewId (only if single customer was recognized)\n- transactionId: String. Authentication attempt identifier.\n- faceMatch: Boolean. True only if single customer was recognized.\n- spoofAttempt: Boolean. Flag indicating if this was spoof attempt.\n- secondFactor: Boolean. True in case multiple possible candidates were recognized, in which case additional verification is needed using [/omni/oneToN/mfa](#/Login/oneToNMfa).\n- overallScore: Float. Overall score search, value form 0 to 100.\n- overallStatus: String. Overall status search PASS or FAIL.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuthenticationAttemptResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "x-incode-status": "undocumented"
      }
    },
    "/omni/oneToN/mfa": {
      "post": {
        "tags": [
          "Login"
        ],
        "summary": "Perform MFA",
        "description": "This method is used for confirming user identity by sending last four digits of his phone number. transactionId which\nwas received in [/omni/oneToN/identify](#/Login/oneToNIdentify) response should be used.\n",
        "operationId": "oneToNMfa",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OneToNMfaRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuthenticationAttemptResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error status:\n- 4004: Couldn't find record with verificationCode and transactionId\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/oneton-mfa/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/oneton-mfa.md"
      }
    },
    "/omni/oneToN/identify": {
      "post": {
        "tags": [
          "Login"
        ],
        "summary": "Face Authentication 1:N",
        "description": "Identify user by face. Parameter base64Image is optional if template is present. If there is more than one user that has\nrecognition confidence above threshold, secondFactor will be true and [/omni/oneToN/mfa](#/Login/oneToNMfa) must be called.\n",
        "operationId": "oneToNIdentify_1",
        "parameters": [
          {
            "name": "correlationId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "returnIPDeviceLocation",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OneToNRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "- customerId: String. ID of recognized customer. (only if single customer was recognized)\n- token: String. Token bound to the customerId of recognized customer. (only if single customer was recognized)\n- interviewId: String. ID of the session where recognized customer got approved. (only if single customer was recognized)\n- interviewToken: String. Token bound to the session identified with interviewId (only if single customer was recognized)\n- transactionId: String. Authentication attempt identifier.\n- faceMatch: Boolean. True only if single customer was recognized.\n- spoofAttempt: Boolean. Flag indicating if this was spoof attempt.\n- secondFactor: Boolean. True in case multiple possible candidates were recognized, in which case additional verification is needed using [/omni/oneToN/mfa](#/Login/oneToNMfa).\n- overallScore: Float. Overall score search, value form 0 to 100.\n- overallStatus: String. Overall status search PASS or FAIL.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuthenticationAttemptResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "x-incode-status": "undocumented"
      }
    },
    "/omni/frame-analysis/analyze": {
      "post": {
        "tags": [
          "Frame analysis"
        ],
        "summary": "Analysis of all faces from selfie image",
        "description": "Authenticate users by comparing base64 image from request and user's existing face templates.\nEach face from the image is analyzed, and relevant attributes are extracted. In case of failure, error description is returned.\n",
        "operationId": "authenticate_1",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FrameAnalysisRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FrameAnalysisResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/frame-analysis-analyze/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/frame-analysis-analyze.md"
      }
    },
    "/omni/frame-analysis/analyze/third-party": {
      "post": {
        "tags": [
          "Frame analysis"
        ],
        "summary": "Analysis of all faces from selfie image",
        "description": "Authenticate users by comparing base64 image from request and user's existing face templates.\nEach face from the image is analyzed, and relevant attributes are extracted. In case of failure, error description is returned.\n",
        "operationId": "authenticate_2",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FrameAnalysisRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FrameAnalysisResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/frame-analysis-analyze-third-party/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/frame-analysis-analyze-third-party.md"
      }
    },
    "/omni/executive-events/find": {
      "post": {
        "tags": [
          "Organization"
        ],
        "summary": "Fetch audit logs",
        "description": "Use this API to retrieve records of activities performed within your organization. These logs include key events such as changes to organization settings, executive actions, updates to flows, workflows and user identities, as well as changes made to organization’s watchlist.\nNote: Requires admin login token.\n",
        "operationId": "auditLogs",
        "parameters": [
          {
            "name": "avoidCounting",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "pageable",
            "in": "query",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Pageable"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExecutiveEventFilter"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExecutiveEventResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/executive-events-find/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/executive-events-find.md"
      }
    },
    "/omni/b2b/v1/watchlist/integrator/batch": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Add custom watchlist entries for child organizations",
        "description": "Imports custom watchlist entries from a CSV file and assigns each row to the child organization identified by clientId.",
        "operationId": "b2bIntegratorBatchWatchlistRecord",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary",
                    "description": "CSV file with integrator watchlist rows."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKeyAuth": [],
            "BearerAuth": []
          }
        ],
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/b2b-v1-watchlist-integrator-batch/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/b2b-v1-watchlist-integrator-batch.md"
      }
    },
    "/omni/b2b/v1/sessions/continue": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Continue onboarding session",
        "description": "Issues a new token for an ACTIVE existing onboarding session.\nThe session is located by exactly one of: its sessionId, or its externalId\n(the value supplied as externalId on /omni/start).\nProviding zero or both identifiers is rejected with 400.\n\nNotes:\n- Continuations count against the same per-session limits as end-user continuations.\n  The organization's maxSessionContinuationAttempts admin setting, when set, replaces\n  the default max number of continuations for this endpoint only.\nWorks with <Glossary>Admin Token</Glossary>.",
        "operationId": "b2bContinueSession",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SessionContinueRequestDto"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SessionContinueResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error statuses:\n- 4086: Current session continuation period is expired.\n- 4087: Max number of session continuations reached\n- 4088: Session is not active\n- 4089: Zero or both of sessionId / externalId provided\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "404": {
            "description": "Session not found for the given sessionId or externalId within the api key's organization",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SessionContinueResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKeyAuth": [],
            "BearerAuth": []
          }
        ],
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/b2b-v1-sessions-continue/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/b2b-v1-sessions-continue.md"
      }
    },
    "/omni/b2b/v1/authentications/add-selfie-to-identity": {
      "post": {
        "tags": [
          "Onboarding authentication"
        ],
        "summary": "Add selfie to identity template",
        "description": "Adds the selfie from the specified or latest authentication attempt to the user's identity template set.",
        "operationId": "addSelfieToIdentityTemplate",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddSelfieToIdentityRequestDto"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/b2b-v1-authentications-add-selfie-to-identity/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/b2b-v1-authentications-add-selfie-to-identity.md"
      }
    },
    "/omni/b2b/onboarding/request-new": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Request new onboarding for integrations",
        "description": "This endpoint starts new onboarding session for integration and generates onboarding link.\n",
        "operationId": "requestNewOnboarding",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewOnboardingB2BRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NewOnboardingResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error statuses:\n- 4300: Integration not found by id\n- 4301: Employee by login factor cannot be found\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/b2b-onboarding-request-new/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/b2b-onboarding-request-new.md"
      }
    },
    "/omni/authentications/external/search": {
      "post": {
        "tags": [
          "Authentications"
        ],
        "summary": "Fetch authentication attempts",
        "description": "This API allows for searching through stored authentication records, providing insight into both 1:1 (one to one) and 1:N (one to many) authentication modes. It includes data for successful and failed login attempts, enabling an overview of authentication activity within the organization. \nWorks with <Glossary>Admin Token</Glossary>.",
        "operationId": "authenticationAttempts",
        "parameters": [
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 30
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": {
                  "type": "object"
                },
                "description": "Provides filter for authentications"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerAuthenticationsExternalResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/authentications-external-search/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/authentications-external-search.md"
      }
    },
    "/executive/log-in": {
      "post": {
        "tags": [
          "Organization"
        ],
        "summary": "Login admin token",
        "description": "Logs in an user and provides a token with high-privileges",
        "operationId": "adminLogin",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExecutiveCognitoLoginRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExecutiveLoginResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/executive-log-in/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/executive-log-in.md"
      }
    },
    "/api/validate/vin": {
      "post": {
        "tags": [
          "API validations"
        ],
        "summary": "Vehicle Identification Number Validation",
        "description": "Validate a VIN number and obtain data related to reports about crashes, theft, etc.",
        "operationId": "validateVin",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VinRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "- id: String.\n- vin: String.\n- attributes: Object with following fields.\n    - vin: String.\n    - year: String.\n    - make: String.\n    - model: String.\n    - type: String.\n    - made_In: String.\n    - style: String.\n    - engine: String.\n- success: Boolean.\n- error: String.\n- base64PDF: String.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-validate-vin/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-validate-vin.md"
      }
    },
    "/api/validate/ssn": {
      "post": {
        "tags": [
          "API validations"
        ],
        "summary": "SSN Validation",
        "description": "Validate a social security number and the person associated with it.",
        "operationId": "validateSsn",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ValidateSsnRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "- requestId: Int. Response's status, check catalog.\n- ssnValid: Boolean. Indicates if ssn information sent is valid.\n- deceasedPerson: Boolean. Indicates if information sent corresponds to a deceased person.\n- errorCode: String. Error code in case something goes wrong.\n- errorCodeDescription: String. Error description in case something goes wrong or if ssn is not valid.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-validate-ssn/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-validate-ssn.md"
      }
    },
    "/api/validate/rfc": {
      "post": {
        "tags": [
          "API validations"
        ],
        "summary": "RFC validation",
        "description": "Check for valid RFC. If RFC is not found then validRFC field will be false.\n\n`rfcMessageCode` gives the machine-readable reason for the outcome. `RFC_VALID` is the only value for which `validRFC` is true. `RFC_PROVIDER_UNAVAILABLE` means the RFC could NOT be checked — the provider failed — and must not be treated as a negative verdict on the RFC. The full catalog is `RFC_VALID`, `RFC_VALID_NOT_INVOICEABLE`, `RFC_NOT_FOUND`, `RFC_FORMAT_INVALID`, `RFC_PROVIDER_UNAVAILABLE`, `RFC_UNKNOWN`.\n\nA malformed RFC supplied by the caller is rejected with HTTP 400 before any provider call, so `RFC_FORMAT_INVALID` is not returned on this endpoint — see the 400 example below.\n\n`status`, `message` and `errorMessage` are unchanged; `rfcMessageCode`, and `messageCode`/`rfcType` on the error path, are additive.",
        "operationId": "validaterfc",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RFCRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "RFC validation result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RfcValidationResponse"
                },
                "examples": {
                  "Valid RFC": {
                    "description": "Valid RFC",
                    "value": {
                      "validRFC": true,
                      "status": "OK",
                      "message": "RFC Valido",
                      "rfcType": "F",
                      "messageCode": "0",
                      "rfcMessageCode": "RFC_VALID"
                    }
                  },
                  "RFC not found in SAT": {
                    "description": "RFC not found in SAT",
                    "value": {
                      "validRFC": false,
                      "status": "ERROR",
                      "errorMessage": "El RFC ingresado no se encuentra en la lista de RFC no cancelados",
                      "rfcType": "F",
                      "messageCode": "1",
                      "rfcMessageCode": "RFC_NOT_FOUND"
                    }
                  },
                  "RFC valid but not able to receive invoices": {
                    "description": "Same status, same errorMessage and same messageCode as the previous example — rfcMessageCode is what separates them.",
                    "value": {
                      "validRFC": false,
                      "status": "ERROR",
                      "errorMessage": "El RFC ingresado no se encuentra en la lista de RFC no cancelados",
                      "rfcType": "F",
                      "messageCode": "1",
                      "rfcMessageCode": "RFC_VALID_NOT_INVOICEABLE"
                    }
                  },
                  "Provider unavailable": {
                    "description": "The RFC could not be checked. Not a verdict on the RFC.",
                    "value": {
                      "validRFC": false,
                      "status": "ERROR",
                      "errorMessage": "Falló la validación de RFC",
                      "rfcMessageCode": "RFC_PROVIDER_UNAVAILABLE"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid RFC format",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                },
                "examples": {
                  "Invalid RFC Format": {
                    "description": "Invalid RFC Format",
                    "value": {
                      "timestamp": 1622548800000,
                      "status": 400,
                      "error": "Bad Request",
                      "message": "BadRequestException: Invalid curp",
                      "path": "/api/validate/rfc"
                    }
                  },
                  "Missing RFC": {
                    "description": "Missing RFC",
                    "value": {
                      "timestamp": 1622548800000,
                      "status": 400,
                      "error": "Bad Request",
                      "message": "must not be blank",
                      "path": "/api/validate/rfc"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error during validation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                },
                "examples": {
                  "Service Unavailable": {
                    "description": "Service Unavailable",
                    "value": {
                      "timestamp": 1622548800000,
                      "status": 500,
                      "error": "Internal Server Error",
                      "path": "/api/validate/rfc"
                    }
                  }
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-validate-rfc/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-validate-rfc.md"
      }
    },
    "/api/validate/rfc-by-curp/v2": {
      "post": {
        "tags": [
          "API validations"
        ],
        "summary": "RFC validation by CURP v2",
        "description": "Check for valid CURP, use obtained data to calculate RFC and then validate the RFC.\nIf CURP is not found then renapo_valid field will be false.\n\n`rfcMessageCode` gives the machine-readable reason for the RFC outcome:\n\n| Code | Meaning |\n|---|---|\n| `RFC_VALID` | RFC exists in SAT and can receive invoices. The only code with `validRFC: true`. |\n| `RFC_VALID_NOT_INVOICEABLE` | RFC exists and is valid, but is not able to receive invoices. A cancelled or suspended RFC is reported here. |\n| `RFC_NOT_FOUND` | RFC is not registered in SAT's padrón de contribuyentes. |\n| `RFC_FORMAT_INVALID` | The calculated RFC is malformed. |\n| `RFC_PROVIDER_UNAVAILABLE` | The RFC could NOT be checked because the provider failed. This is not a verdict on the RFC — do not reject the user on this code alone. |\n| `CURP_PROVIDER_UNAVAILABLE` | The CURP provider failed or is in maintenance, so no RFC could be calculated. This is not a verdict on the CURP or the RFC. |\n| `CURP_NOT_FOUND` | The CURP is not registered in RENAPO, so no RFC could be calculated. |\n| `CURP_INVALID` | RENAPO rejected the CURP (deactivated, malformed, multiple matches or invalid format), so no RFC could be calculated. |\n| `CURP_DATA_INSUFFICIENT` | The CURP resolved but carried too little data to build an RFC. |\n| `RFC_UNKNOWN` | The provider answered with something not yet in this catalog. |\n\nThis endpoint falls back to a secondary provider when the primary one is unreachable. The fallback can confirm `RFC_VALID`, `RFC_NOT_FOUND` and `RFC_FORMAT_INVALID`; it cannot currently distinguish a cancelled RFC, which is reported as `RFC_PROVIDER_UNAVAILABLE` rather than guessed at.\n\n`rfcStatus`, `rfcValidationMessage` and `rfcErrorMessage` keep their existing values; `rfcMessageCode` is additive.\n",
        "operationId": "validaterfcbycurpv2",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CurpRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Respuesta con validación de CURP",
            "content": {
              "application/json": {
                "examples": {
                  "Successful CURP Validation": {
                    "summary": "Successful CURP Validation",
                    "description": "Successful CURP Validation",
                    "value": {
                      "success": true,
                      "curp": "XXXX820814HDFABC01",
                      "sex": "MUJER",
                      "nationality": "MEX",
                      "result": "success",
                      "requestData": {
                        "name": "JUANA",
                        "firstLastName": "PEREZ",
                        "secondLastName": "LOPEZ",
                        "gender": "M",
                        "birthDate": "14/08/1982",
                        "state": "DF"
                      },
                      "transactionId": "transaction1234567890",
                      "renapo_valid": true,
                      "names": "JUANA",
                      "paternal_surname": "PEREZ",
                      "mothers_maiden_name": "LOPEZ",
                      "birthdate": "14/08/1982",
                      "entity_birth": "DF",
                      "probation_document": "1",
                      "probation_document_data": {
                        "foja": "",
                        "numEntidadReg": "09",
                        "libro": "",
                        "NumRegExtranjeros": "",
                        "cveEntidadNac": "DF",
                        "numActa": "00001",
                        "CRIP": "",
                        "tomo": "",
                        "cveEntidadEmisora": "",
                        "anioReg": "1982",
                        "cveMunicipioReg": "001",
                        "FolioCarta": ""
                      },
                      "status_curp": "RCN",
                      "deceasedStatus": "ALIVE"
                    }
                  },
                  "CURP not found": {
                    "summary": "CURP not found",
                    "description": "CURP not found",
                    "value": {
                      "success": false,
                      "error": {
                        "codigoError": "06",
                        "resultCURPS": {
                          "numEntidadReg": "",
                          "apellidoPaterno": "",
                          "libro": "",
                          "statusCurp": "",
                          "cveEntidadNac": "",
                          "numActa": "",
                          "CRIP": "",
                          "tomo": "",
                          "cveEntidadEmisora": "",
                          "FolioCertificado": "",
                          "anioReg": "",
                          "cveMunicipioReg": "",
                          "FolioCarta": "",
                          "CURP": "",
                          "apellidoMaterno": "",
                          "nombres": "",
                          "nacionalidad": "",
                          "foja": "",
                          "NumRegExtranjeros": "",
                          "fechNac": "",
                          "sexo": "",
                          "docProbatorio": ""
                        },
                        "statusOper": "NO EXITOSO",
                        "tipoError": "01",
                        "sessionID": "xF1hOzrjnJU36wDsPl83KlkDpE-eb7tM1Oe2bjI0jrbPJv-mU3IF!1562844632!1749682961123",
                        "message": "La CURP no se encuentra en la base de datos"
                      },
                      "result": "Not valid request: La CURP no se encuentra en la base de datos code: 06",
                      "transactionId": "xF1hOzrjnJU36wDsPl83KlkDpE-eb7tM1Oe2bjI0jrbPJv-mU3IF!1562844632!1749682961123",
                      "renapo_valid": false
                    }
                  },
                  "Daily Rate Limit Exceeded": {
                    "summary": "Daily Rate Limit Exceeded",
                    "description": "Daily Rate Limit Exceeded",
                    "value": {
                      "success": false,
                      "error": {
                        "codigoError": "02",
                        "tipoError": "99",
                        "message": "SE HA ALCANZADO EL LIMITE DE TRANSACCIONES PERMITIDAS POR DIA"
                      },
                      "result": "SE HA ALCANZADO EL LIMITE DE TRANSACCIONES PERMITIDAS POR DIA",
                      "renapo_valid": false
                    }
                  },
                  "Curp status not acceptable": {
                    "summary": "Curp status not acceptable",
                    "description": "Curp status not acceptable",
                    "value": {
                      "success": false,
                      "sessionStatus": "Alive",
                      "error": {
                        "codigoError": "02",
                        "tipoError": "99",
                        "message": "Curp status is not acceptable."
                      },
                      "result": "Error: STATUS CURP not acceptable.",
                      "renapo_valid": false
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal error during CURP validation."
          },
          "504": {
            "description": "The request to validate the CURP exceeded the allowed time limit"
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-validate-rfc-by-curp-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-validate-rfc-by-curp-v2.md"
      }
    },
    "/api/validate/registraduria": {
      "post": {
        "tags": [
          "API validations"
        ],
        "summary": "Registraduria validation - Colombian id",
        "description": "Check for valid Colombian ID and return corresponding values of that person.\nOptionally, you can set isForeign flag to true to check for foreign people living in Colombia.\nAn example could be a Mexican person with a Colombian ID.\n",
        "operationId": "validateRegistraduria",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RegistraduriaRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Response:\n- data: Object with following fields.\n    - anio_resolucion: Integer.\n    - codigo_error_datos_cedula: Integer.\n    - codigo_respuesta: Integer.\n    - date: String.\n    - departamento_expedicion: String.\n    - descripcion_estado: String.\n    - estado_cedula: Integer.\n    - fecha_expedicion: String.\n    - informacion_adicional: String.\n    - municipio_expedicion: String.\n    - nombre_completo: String.\n    - nuip: Integer.\n    - numero_resolucion: Integer.\n    - particula: String.\n    - primer_apellido: String.\n    - primer_nombre: String.\n    - segundo_apellido: String.\n    - segundo_nombre: String.\n- error: String.\n- findings: String [].\n- status: Boolean.\n\nA response example for foreigners is:\n\n```\n{\n    \"data\": {\n        \"ce\": \"456123\",\n        \"estado\": \"VIGENTE\",\n        \"fecha_expedicion\": \"02/10/2019\",\n        \"fecha_nacimiento\": \"05/03/1956\",\n        \"fecha_vencimiento\": \"01/10/2024\",\n        \"nacionalidad\": \"CHILENA\",\n        \"nombre_completo\": \"JUAN ALEJANDRO PEREZ LOPEZ\"\n    },\n    \"error\": \"\",\n    \"findings\": [],\n    \"status\": true }\n```\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-validate-registraduria/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-validate-registraduria.md"
      }
    },
    "/api/validate/registraduria-ppt": {
      "post": {
        "tags": [
          "API validations"
        ],
        "summary": "Colombia - Temporary Residency / PPT Validation",
        "description": "Check for a valid Colombian temporary residency ID and return the corresponding values of that person.",
        "operationId": "validateRegistraduriaPPT",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RegistraduriaRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "- data: Object with following fields.\n    - estado: String.\n    - fecha_entrega: String.\n    - identidad_venezolana: String.\n    - lugar_entrega: String.\n    - nombre_completo: String.\n    - ppt: String.\n    - tipo_documento: String.\n- error: String.\n- findings: String [].\n- status: Boolean.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-validate-registraduria-ppt/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-validate-registraduria-ppt.md"
      }
    },
    "/api/validate/ine": {
      "post": {
        "tags": [
          "API validations"
        ],
        "summary": "INE scraping validation",
        "description": "Check for valid INE directly with an automated search in [https://listanominal.ine.mx/scpln/](https://listanominal.ine.mx/scpln/)\nand return corresponding values of that ID.\n\nScraping service will start working asynchronously and this service will return a resultsId to fetch the results in\n[/api/fetch/ine](#/API%20Validations/fetchIne). The recommended wait time is 20 sec.\n\nPossible parameters are ocr, cic, claveElector and numeroEmision but the parameters sent depend on the model of the INE/IFE\nto be consulted.\n\nModel C: IFE with emission year from 2008 to 2013, should send claveElector, numeroEmision and ocr from the back of ID.\n\nModel D: INE with emission year from 2013, should send cic from back of ID (9 characters) and OCR from the back of the ID (13 characters).\n\nModel E,F,G,H: INE with emission year from 2014 onwards, should send CIC from the back of the ID (9 characters) and\ncitizen id (ocr) from the back of the ID (9 characters).\n\nAdditional indications and information on the models of the credentials can be found in [https://listanominal.ine.mx/scpln/](https://listanominal.ine.mx/scpln/)\n",
        "operationId": "validateIne",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/IneScraperRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "idResults: String",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-validate-ine/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-validate-ine.md"
      }
    },
    "/api/validate/curp/v4": {
      "post": {
        "tags": [
          "Curp validation"
        ],
        "summary": "CURP validation v4",
        "description": "Check for valid CURP and return corresponding values of that person.\n\nIf CURP is not found then renapo_valid field will be false.\n\nif CURP has invalid format or is not found an error object with details will be returned, for example:\n\n```\n{\n\n    \"error\": { \"codigoError\": \"06\", \"message\": \"La CURP no se encuentra en la base de datos\" },\n\n    \"result\": \"Not valid request: La CURP no se encuentra en la base de datos code: 06\",\n\n}\n```\n",
        "operationId": "validatecurp4",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CurpRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Respuesta con validación de CURP",
            "content": {
              "application/json": {
                "examples": {
                  "Successful CURP Validation": {
                    "summary": "Successful CURP Validation",
                    "description": "Successful CURP Validation",
                    "value": {
                      "success": true,
                      "curp": "XXXX820814HDFABC01",
                      "sex": "MUJER",
                      "nationality": "MEX",
                      "result": "success",
                      "requestData": {
                        "name": "JUANA",
                        "firstLastName": "PEREZ",
                        "secondLastName": "LOPEZ",
                        "gender": "M",
                        "birthDate": "14/08/1982",
                        "state": "DF"
                      },
                      "transactionId": "transaction1234567890",
                      "renapo_valid": true,
                      "names": "JUANA",
                      "paternal_surname": "PEREZ",
                      "mothers_maiden_name": "LOPEZ",
                      "birthdate": "14/08/1982",
                      "entity_birth": "DF",
                      "probation_document": "1",
                      "probation_document_data": {
                        "foja": "",
                        "numEntidadReg": "09",
                        "libro": "",
                        "NumRegExtranjeros": "",
                        "cveEntidadNac": "DF",
                        "numActa": "00001",
                        "CRIP": "",
                        "tomo": "",
                        "cveEntidadEmisora": "",
                        "anioReg": "1982",
                        "cveMunicipioReg": "001",
                        "FolioCarta": ""
                      },
                      "status_curp": "RCN",
                      "deceasedStatus": "ALIVE"
                    }
                  },
                  "CURP not found": {
                    "summary": "CURP not found",
                    "description": "CURP not found",
                    "value": {
                      "success": false,
                      "error": {
                        "codigoError": "06",
                        "resultCURPS": {
                          "numEntidadReg": "",
                          "apellidoPaterno": "",
                          "libro": "",
                          "statusCurp": "",
                          "cveEntidadNac": "",
                          "numActa": "",
                          "CRIP": "",
                          "tomo": "",
                          "cveEntidadEmisora": "",
                          "FolioCertificado": "",
                          "anioReg": "",
                          "cveMunicipioReg": "",
                          "FolioCarta": "",
                          "CURP": "",
                          "apellidoMaterno": "",
                          "nombres": "",
                          "nacionalidad": "",
                          "foja": "",
                          "NumRegExtranjeros": "",
                          "fechNac": "",
                          "sexo": "",
                          "docProbatorio": ""
                        },
                        "statusOper": "NO EXITOSO",
                        "tipoError": "01",
                        "sessionID": "xF1hOzrjnJU36wDsPl83KlkDpE-eb7tM1Oe2bjI0jrbPJv-mU3IF!1562844632!1749682961123",
                        "message": "La CURP no se encuentra en la base de datos"
                      },
                      "result": "Not valid request: La CURP no se encuentra en la base de datos code: 06",
                      "transactionId": "xF1hOzrjnJU36wDsPl83KlkDpE-eb7tM1Oe2bjI0jrbPJv-mU3IF!1562844632!1749682961123",
                      "renapo_valid": false
                    }
                  },
                  "Daily Rate Limit Exceeded": {
                    "summary": "Daily Rate Limit Exceeded",
                    "description": "Daily Rate Limit Exceeded",
                    "value": {
                      "success": false,
                      "error": {
                        "codigoError": "02",
                        "tipoError": "99",
                        "message": "SE HA ALCANZADO EL LIMITE DE TRANSACCIONES PERMITIDAS POR DIA"
                      },
                      "result": "SE HA ALCANZADO EL LIMITE DE TRANSACCIONES PERMITIDAS POR DIA",
                      "renapo_valid": false
                    }
                  },
                  "Curp status not acceptable": {
                    "summary": "Curp status not acceptable",
                    "description": "Curp status not acceptable",
                    "value": {
                      "success": false,
                      "sessionStatus": "Alive",
                      "error": {
                        "codigoError": "02",
                        "tipoError": "99",
                        "message": "Curp status is not acceptable."
                      },
                      "result": "Error: STATUS CURP not acceptable.",
                      "renapo_valid": false
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal error during CURP validation."
          },
          "504": {
            "description": "The request to validate the CURP exceeded the allowed time limit"
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-validate-curp-v4/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-validate-curp-v4.md"
      }
    },
    "/api/validate/curp/v3": {
      "post": {
        "tags": [
          "API validations"
        ],
        "summary": "CURP scraping validation",
        "description": "Check for valid CURP directly with an automated search in [https://www.gob.mx/curp/](https://www.gob.mx/curp/) and return\ncorresponding values of that person. Parameter must be \"curp\".\n\nScraping service will start working asynchronously and this service will return a resultsId to fetch the results in\n[/api/fetch/curp/v3](#/API%20Validations/fetchCurp3). The recommended wait time is 25 sec.\n",
        "operationId": "validateCurp3",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CurpRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "idResults: String",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid curp: a 400 error will be thrown if the curp provided does not match the correct pattern.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-validate-curp-v3/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-validate-curp-v3.md"
      }
    },
    "/api/validate/curp-by-data/v4": {
      "post": {
        "tags": [
          "Curp validation"
        ],
        "summary": "CURP by data validation v4",
        "description": "Check for valid CURP based on a person data and return corresponding values of that person including the CURP.\n",
        "operationId": "validatecurpbydata4",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CurpDataRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "If data doesn't match any CURP then the field renapo_valid will be false.\n\nIf there is an error with the request data an error object is returned with the details, example:\"\n```\n{ \"error\": { \"descripcionRespuesta\": \"DATOS INCORRECTOS: [El campo no cumple con el formato.]\", \"codigoRespuesta\": \"02\", } }\n```\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CurpResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-validate-curp-by-data-v4/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-validate-curp-by-data-v4.md"
      }
    },
    "/api/validate/curp-by-data/v3": {
      "post": {
        "tags": [
          "API validations"
        ],
        "summary": "CURP scraping validation by data",
        "description": "Check for valid CURP directly with an automated search in [https://www.gob.mx/curp/](https://www.gob.mx/curp/) and return\ncorresponding curp of that person. Parameters are the person's details.\n\nScraping service will start working asynchronously and this service will return a resultsId to fetch the results in\n[/api/fetch/curp/v3](#/API%20Validations/fetchCurp3). The recommended wait time is 25 sec.\n\nValid values for state are the ones listed by renapo in this link: [https://es.wikipedia.org/wiki/Plantilla:Abreviaciones_de_los_estados_de_México](https://es.wikipedia.org/wiki/Plantilla:Abreviaciones_de_los_estados_de_México)\n",
        "operationId": "validateCurpByData3",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CurpDataRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "idResults: String.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-validate-curp-by-data-v3/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-validate-curp-by-data-v3.md"
      }
    },
    "/api/validate/bank-statement": {
      "post": {
        "tags": [
          "API validations"
        ],
        "summary": "Validate bank statement",
        "description": "This endpoint is used to validate and get the information from a bank statement.",
        "operationId": "validateAccountStatement",
        "parameters": [
          {
            "name": "dummy",
            "in": "query",
            "description": "Enables sending any pdf and will return a dummy response.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "pdf (bank-statement pdf)",
          "content": {
            "application/json": {
              "schema": {
                "type": "string",
                "format": "byte"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "fields are optional, based on the bank statement format\n- name: String.\n- account_num: String.\n- clabe: String.\n- summary: String.\n- bank: String.\n- rfc: String.\n- starting_balance: Float.\n- ending_balance: Float.\n- pdf_quality: Number.\n- summary: Object. Object with detailed information on balance, deposits, withdrawals and fees.\n- txs: Array of transactions.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-validate-bank-statement/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-validate-bank-statement.md"
      }
    },
    "/api/validate/bank-statement/v2": {
      "post": {
        "tags": [
          "API validations"
        ],
        "summary": "Validate bank statement v2",
        "description": "This endpoint is used to validate and get the information from a bank statement.",
        "operationId": "validateAccountStatementv2",
        "parameters": [
          {
            "name": "dummy",
            "in": "query",
            "description": "Enables sending any pdf and will return a dummy response.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Base64AccountStatementMxRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Fields are optional, based on the bank statement format\n- name: String.\n- account_num: String.\n- clabe: String.\n- summary: String.\n- bank: String.\n- rfc: String.\n- starting_balance: Float.\n- ending_balance: Float.\n- pdf_quality: Number.\n- summary: Object. Object with detailed information on balance, deposits, withdrawals and fees.\n- txs: Array of transactions.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-validate-bank-statement-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-validate-bank-statement-v2.md"
      }
    },
    "/api/calculate/rfc": {
      "post": {
        "tags": [
          "API validations"
        ],
        "summary": "Calculate RFC",
        "description": "Calculate and return the RFC based on a person data.\n\nOnce you obtain the calculated RFC it doesn't necessarily mean it's a valid one. You could use the validate RFC method to check if it exists.\n",
        "operationId": "generaterfc",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CalculateRFCRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successfully calculated RFC",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RFCResponse"
                },
                "examples": {
                  "Success Response": {
                    "description": "Success Response",
                    "value": {
                      "calculatedRFC": "PEPJ870918ABC"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid input data",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                },
                "examples": {
                  "Invalid Date Format": {
                    "description": "Invalid Date Format",
                    "value": {
                      "timestamp": 1622548800000,
                      "status": 400,
                      "error": "Bad Request",
                      "message": "Date is not in valid format",
                      "path": "/api/calculate/rfc",
                      "details": {
                        "error": {
                          "birthDate": [
                            "Birth date must be in format dd/mm/yyyy"
                          ]
                        }
                      }
                    }
                  },
                  "Missing Required Field": {
                    "description": "Missing Required Field",
                    "value": {
                      "timestamp": 1622548800000,
                      "status": 400,
                      "error": "Bad Request",
                      "message": "Required field missing",
                      "path": "/api/calculate/rfc",
                      "details": {
                        "error": {
                          "name": [
                            "must not be blank"
                          ]
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error during calculation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                },
                "examples": {
                  "Internal Server Error": {
                    "description": "Internal Server Error",
                    "value": {
                      "timestamp": 1622548800000,
                      "status": 500,
                      "error": "Internal Server Error",
                      "message": "Error calculating RFC",
                      "path": "/api/calculate/rfc"
                    }
                  }
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-calculate-rfc/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-calculate-rfc.md"
      }
    },
    "/omni/watchlist-result": {
      "post": {
        "tags": [
          "Global watchlist"
        ],
        "summary": "Global Watchlist result",
        "description": "This endpoint calls the global watchlist api (currently only Tier 2), and gets the latest gathered result.",
        "operationId": "getWatchlistResult",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WatchlistRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WatchlistSearchResultResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/watchlist-result/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/watchlist-result.md"
      }
    },
    "/omni/videoselfie/hash": {
      "post": {
        "tags": [
          "Videoselfie"
        ],
        "summary": "Get videoselfie hash",
        "description": "Obtain a hash of the video file of the videoselfie. The hash and hashImage fields in the response will be null if the video file is not yet ready.",
        "operationId": "getvideoselfiehash",
        "parameters": [
          {
            "name": "withImage",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VideoSelfieHashResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/videoselfie-hash/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/videoselfie-hash.md"
      }
    },
    "/omni/videoselfie/compare-ocr/v2": {
      "post": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Compare OCR from videoselfie against OCR from ID v2",
        "description": "This endpoint is used to compare OCR from videoselfie frame against OCR from ID.",
        "operationId": "videoSelfieCompareOcrV2",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "Frame extracted from videoselfie",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Base64ImageRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error statuses:\n- 5003: Unsatisfied image size\n- 5004: Document alignment failed\n- 5005: Document not found\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/videoselfie-compare-ocr-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/videoselfie-compare-ocr-v2.md"
      }
    },
    "/omni/video-selfie/upload/part": {
      "post": {
        "tags": [
          "Videoselfie"
        ],
        "summary": "Upload a video selfie chunk",
        "description": "Upload a single chunk of the video selfie. Chunks must be between 5MB and 10MB, except for the last chunk which can be smaller.",
        "operationId": "uploadVideoSelfiePart",
        "parameters": [
          {
            "name": "uploadId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "partNumber",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "string",
                "format": "byte"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UploadVideoPartResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/video-selfie-upload-part/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/video-selfie-upload-part.md"
      }
    },
    "/omni/video-selfie/upload/initiate": {
      "post": {
        "tags": [
          "Videoselfie"
        ],
        "summary": "Initiate multipart video selfie upload",
        "description": "Start a chunked video upload session. Returns an uploadId for subsequent part uploads and completion.\nThe entire upload (all parts + complete) must finish within the configured video selfie timeout (default 240 seconds), otherwise the session will receive a fail score for the video selfie module.",
        "operationId": "initiateVideoSelfieUpload",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InitiateVideoUploadResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/video-selfie-upload-initiate/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/video-selfie-upload-initiate.md"
      }
    },
    "/omni/video-selfie/upload/complete": {
      "post": {
        "tags": [
          "Videoselfie"
        ],
        "summary": "Complete multipart video selfie upload",
        "description": "Signal that all chunks have been uploaded.",
        "operationId": "completeVideoSelfieUpload",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CompleteVideoUploadRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VideoUploadStatusResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/video-selfie-upload-complete/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/video-selfie-upload-complete.md"
      }
    },
    "/omni/verifyFace": {
      "post": {
        "tags": [
          "Video conference"
        ],
        "summary": "Verify face",
        "description": "A bank executive can ask the customer to additionally capture his face during an interview and do face recognition.\nA face can be captured from selfie or ID that a customer places in front of camera.\n",
        "operationId": "recognize",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MatchRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebappRecognizeResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error statuses:\n- 4019: Face not found\n- 1003: Face cropping failure\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/verifyface/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/verifyface.md"
      }
    },
    "/omni/trust-graph/report": {
      "post": {
        "tags": [
          "Trust graph"
        ],
        "summary": "Add fraud candidate to the trust graph",
        "description": "Adds a new fraud candidate to the trust graph based on the provided request data, including details such as the source entity, reason, and associated information.",
        "operationId": "addFraudCandidate",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FraudCandidateRequestDto"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "x-incode-status": "undocumented"
      }
    },
    "/omni/trust-graph/defraud": {
      "post": {
        "tags": [
          "Trust graph"
        ],
        "summary": "Defraud multiple interviews in trust graph",
        "description": "Marks multiple interviews as defrauded in the trust graph based on the provided list of interview IDs.",
        "operationId": "defraudInterviewBatch",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DefraudInterviewBatchRequestDto"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "x-incode-status": "undocumented"
      }
    },
    "/omni/start": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Start onboarding",
        "description": "This endpoint is mandatory to start any onboarding session in Incode Omni and session can be monitored on the Incode Dashboard.\nAnd it generates token which should be used for the authentication of future subsequent calls.\n",
        "operationId": "startInterview",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StartRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StartResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error statuses:\n- 4026: Invalid uuid parameter\n- 4027: Invalid configurationId\n- 4028: Flow is not activated\n- 4081: Invalid parameters for validation\n- 4082: Start endpoint version forbidden in flow/workflow\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/start/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/start.md"
      }
    },
    "/omni/sna/initiate": {
      "post": {
        "tags": [
          "Phone number input"
        ],
        "summary": "Initiate Silent Network Authentication (SNA)",
        "description": "Silent Network Authentication verifies that the device making the request owns the phone number,\nwithout sending an SMS code. It is available when the organization has SNA enabled and the flow's\nPhone module has `snaVerification` set in `GET /omni/onboarding/flow`.\n\n**Phone number resolution.** Send `phoneNumber` to verify the number the user just typed. When the\nbody is empty or absent, the number is resolved from the session in this order: the phone already\nstored on the session, the `phone`/`phoneNumber` custom field, the most recent PHONE form answer,\nthe OAuth `loginHint`. The resolved number is stored on the session and echoed back in\n`phoneNumber`, with `phoneSource` telling where it came from. A client can therefore call this\nendpoint before showing the phone capture screen and skip the screen when the response carries a\n`phoneNumber` (`success: true`, or `success: false` with `fallbackReason`). A response with\n`errorCode` carries no phone number: show the capture screen on `PHONE_REQUIRED`, and handle the\nother codes as errors.\n\n**Outcomes.** The endpoint always answers HTTP 200; branch on the body:\n- `success: true` - SNA started. Open `checkUrl` from the device over its mobile data connection\n  (not Wi-Fi), capture the `code` returned by the redirect and send it to `POST /omni/sna/complete`.\n- `success: false` with `fallbackReason` - SNA is not possible for this number (organization or flow\n  has SNA disabled, network not covered, SIM swapped in the last 7 days, provider error). The number\n  is still saved on the session. Continue with SMS OTP: `GET /omni/send/otp` then\n  `GET /omni/compare/otp?code={code}` (both accept the same LIMITED token and default to SMS).\n- `success: false` with `errorCode` - the request itself failed, see `errorCode`.\n",
        "operationId": "snaInitiate",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "Optional. Omit the body, or send `{}`, to use the phone number already known for the session.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SnaInitiateRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SnaInitiateResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/sna-initiate/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/sna-initiate.md"
      }
    },
    "/omni/sna/complete": {
      "post": {
        "tags": [
          "Phone number input"
        ],
        "summary": "Complete Silent Network Authentication (SNA)",
        "description": "Finishes the check started by `POST /omni/sna/initiate`. Send the `checkId` from the initiate\nresponse together with the `code` obtained when the device followed `checkUrl`.\n\nThe endpoint always answers HTTP 200. When `match` is `true` the phone number is marked as verified\non the session, the same as a successful SMS OTP. When `success` is `false` the check did not\nconfirm the number and `shouldFallbackToOtp` is `true`: either let the user try another phone number\n(when the flow has `snaRetryWithNewPhone` enabled) or continue with `GET /omni/send/otp` and\n`GET /omni/compare/otp?code={code}` for the same number (both accept the same LIMITED token and\ndefault to SMS).\n",
        "operationId": "snaComplete",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SnaCompleteRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SnaCompleteResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/sna-complete/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/sna-complete.md"
      }
    },
    "/omni/sign-string/nom151": {
      "post": {
        "tags": [
          "Nom151"
        ],
        "summary": "Sign String with NOM 151",
        "description": "Sign any String with NOM 151.",
        "operationId": "signStringNom151",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SignNom151StringRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Response:\n- signedString: String. NOM 151 constancia (digital evidence)\n- reference: String. Reference folio (unique confirmation id)\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/sign-string-nom151/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/sign-string-nom151.md"
      }
    },
    "/omni/sign-hash/nom151": {
      "post": {
        "tags": [
          "Nom151"
        ],
        "summary": "Sign hash with NOM 151",
        "description": "Sign any SHA-256 hash (64-hex) with NOM 151.",
        "operationId": "signHashNom151",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SignNom151HashRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Response:\n- signedString: String. NOM 151 constancia (digital evidence)\n- reference: String. Reference folio (unique confirmation id)\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/sign-hash-nom151/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/sign-hash-nom151.md"
      }
    },
    "/omni/sign-document/nom151": {
      "post": {
        "tags": [
          "Nom151"
        ],
        "summary": "Sign document with NOM 151",
        "description": "Sign any base64-encoded document with NOM 151.",
        "operationId": "signDocumentNom151",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SignNom151DocumentRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Response:\n- signedString: String. NOM 151 constancia (digital evidence)\n- reference: String. Reference folio (unique confirmation id)\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/sign-document-nom151/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/sign-document-nom151.md"
      }
    },
    "/omni/sign-combined-consent": {
      "post": {
        "tags": [
          "Shared consent"
        ],
        "summary": "Sign combined consents with checkboxes.",
        "description": "Receives information about which checkboxes user signed.",
        "operationId": "signcombinedconsent",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SignCombinedConsentRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/sign-combined-consent/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/sign-combined-consent.md"
      }
    },
    "/omni/session/status/set": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Set session status",
        "description": "Set the status of current session. Possible actions to set the status to are: Alive, Closed or Deleted. Closed status\ndisables all of the \"/add/...\" calls so they can no longer make any changes to the system. Deleted status deletes\nthe important data stored in the session.\n",
        "operationId": "setSessionStatus",
        "parameters": [
          {
            "name": "action",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "Alive",
                "Closed",
                "Deleted"
              ]
            }
          },
          {
            "name": "id",
            "in": "query",
            "description": "id of the session, optional, if not sent obtained from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetStatusResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/session-status-set/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/session-status-set.md"
      }
    },
    "/omni/session/downloadpdf/v2": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Generates single session PDF report",
        "description": "This endpoint is used to generate a PDF report for a single session",
        "operationId": "downloadPdfV2",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SessionDownloadRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/session-downloadpdf-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/session-downloadpdf-v2.md"
      }
    },
    "/omni/recordings/import/third-party": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Import base64Video and return recordingId",
        "operationId": "importRecording",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreVideoRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ImportSessionRecordingResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/recordings-import-third-party/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/recordings-import-third-party.md"
      }
    },
    "/omni/recordings/import": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Import base64Video and return recordingId",
        "operationId": "importRecording_1",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StoreVideoRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ImportSessionRecordingResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/recordings-import/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/recordings-import.md"
      }
    },
    "/omni/record-stop": {
      "post": {
        "tags": [
          "Video conference"
        ],
        "summary": "Stop recording",
        "description": "Stop recording the interview.",
        "operationId": "interviewStopRecord",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InterviewStopRecordRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/record-stop/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/record-stop.md"
      }
    },
    "/omni/record-start": {
      "post": {
        "tags": [
          "Video conference"
        ],
        "summary": "Start recording",
        "description": "Start recording of the interview.",
        "operationId": "interviewStartRecord",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InterviewStartRecordRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InterviewStartRecordResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/record-start/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/record-start.md"
      }
    },
    "/omni/queue/conference/disconnect": {
      "post": {
        "tags": [
          "Video conference"
        ],
        "summary": "Disconnect user from the queue",
        "description": "Users can disconnect themselves while waiting in the queue at any time.",
        "operationId": "customerDisconnect",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "success: flag indicating if user was successfully removed from the queue. False in the case the user not found in the queue, true otherwise\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/queue-conference-disconnect/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/queue-conference-disconnect.md"
      }
    },
    "/omni/qr/validate": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Validate QR code uuid",
        "description": "Check if provided UUID value is still valid for Interview ID.\nIf valid, response will contain UUID that is stored on Onboarding cache and have default TTL of 15min\nIf not valid, response will contain error details\n",
        "operationId": "validateqrcodeuuid",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/QrValidationRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QrRefreshResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error statuses:\n- 4026: Invalid uuid parameter\n- 4081: Invalid parameters for validation\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/qr-validate/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/qr-validate.md"
      }
    },
    "/omni/qr/refresh": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Refresh QR code value",
        "description": "Refresh UUID for already started onboarding with /omni/onboarding-url.\nReturns null if not started before this call or if start expired.\nReturned UUID is short lived (15sec) and should be refreshed in constant periods (5sec).\n",
        "operationId": "refreshqrcodevalue",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/QrRefreshRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QrRefreshResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error statuses:\n- 4026: Invalid uuid parameter\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/qr-refresh/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/qr-refresh.md"
      }
    },
    "/omni/process/watchlist": {
      "post": {
        "tags": [
          "Custom watchlist"
        ],
        "summary": "Process custom watchlist",
        "description": "This endpoint fetches data (photo, email, phone, document number) from onboarding session and tries to find a match in custom\nwatchlist database. If a match on the watchlist is found, then the score influence is calculated based on the number of matched fields.\n",
        "operationId": "processincodewatchlistrecord",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Id of onboarding session. If not present, it will be extracted from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProcessWatchlistResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/process-watchlist/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/process-watchlist.md"
      }
    },
    "/omni/process/second-id": {
      "post": {
        "tags": [
          "Id capture"
        ],
        "summary": "Process Second Id",
        "description": "**Note**: This endpoint should be called only after the upload of [front-side-secondId](#/Onboarding/addFrontSecondIdV2) and\n[back-side-secondId](#/Onboarding/addBackSecondIdV2) is over. And in case of passports or only front sided documents, only\n[front-side-secondId](#/Onboarding/addFrontSecondIdV2) should be over.\n\nIncode validations and ocr parsing are processed during this endpoint. To fetch ocr data call\n[Fetch-SecondId_OCR](#/Onboarding/getOcrDataSecondId). Parameter queueName is needed so it can be determined in which queue\ninterview should go. Once this is called, user is no longer able to upload ID (front or back side).\n",
        "operationId": "processSecondId",
        "parameters": [
          {
            "name": "queueName",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The name of the queue, user is entering in case conference call will be used. If not set, default queue will be used.\n",
              "enum": [
                "aristotle",
                "buddha",
                "confucius",
                "diogenes"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProcessIdResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/process-second-id/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/process-second-id.md"
      }
    },
    "/omni/process/payment-proof": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Process payment proof",
        "description": "**Note**: This endpoint should be called once the Qr-code is executed.\n\nIt will fetch info from add qr code text call and validate payment proof fields rfc issuer, rfc receiver and fiscal invoice and return response.\n\nIt will also call the configured [Payment Proof Webhook](doc:payment-proof-webhook).\n",
        "operationId": "obtainLaborHistoryCallback",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProcessPaymentProofResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/process-payment-proof/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/process-payment-proof.md"
      }
    },
    "/omni/process/imss": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Process IMSS",
        "description": "Trigger fetching of work history for curp. This will notify the results to the configured [Work History Webhook](doc:work-history-webhook).\n",
        "operationId": "processImss",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProcessImssRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/process-imss/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/process-imss.md"
      }
    },
    "/omni/process/id": {
      "post": {
        "tags": [
          "Id capture"
        ],
        "summary": "Process Id",
        "description": "**Note**:This endpoint should be called only after the [front-side](#/Onboarding/addFrontIdV2)\nand [back-side](#/Onboarding/addBackIdV2) is over.\nAnd in case of passports or only front sided documents, only [front-side](#/Onboarding/addFrontIdV2) should be over.\n\nIncode validations and ocr parsing are processed during this endpoint. To fetch ocr data call [Fetch-OCR](#/Onboarding/getOcrData).\n\nOnce this is called, user is no longer able to upload ID (front or back side).\n",
        "operationId": "processId",
        "parameters": [
          {
            "name": "queueName",
            "in": "query",
            "description": "The name of the queue, user is entering in case conference call will be used. If not set, default queue will be used",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "aristotle",
                "buddha",
                "confucius",
                "diogenes"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProcessIdResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Custom error statuses:\n- 4085: ID image is too small. The message contains the received dimensions and the required minimum (the smallest image side must be at least 200 px).\n- 6000: Processing error (generic failure during ID processing)\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/process-id/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/process-id.md"
      }
    },
    "/omni/process/government-validation": {
      "post": {
        "tags": [
          "Government validation"
        ],
        "summary": "Process government validation",
        "description": "This endpoint reads the country code from the interview which can be set at the moment of calling the start endpoint or\nis updated based on the processed id. Request body can optionally contain data from id in JSON. If omitted, data from\nscanned ID is read.\n\n**Country codes**:\n\n**MEX**: Mexico - INE Validation. When government face validation is enabled this method compares the user's selfie against\nthe image in the INE database. The method should be called after [add-face](#/Onboarding/addFaceByThirdParty) is over and\none of ([process-id](#/Onboarding/processId) or [document-id](#/Onboarding/addDocumentId)) is over.\n\nRequest parameters:\n- fallbackEnabled: Boolean, optional. If it is not sent, it will default to false.\n- scrapingMethod: Boolean, optional. If it is not sent, it will default to false.\n\nIf parameter fallbackEnabled is true and there's some connection or infrastructure error with the INE service, validation by\nscraping will start. If parameter scrapingMethod is true, then direct connection to INE service won't be attempted and\nthe scraping approach will be used instead.\n\nRequest Body is optional - if not sent, data will be taken from the session:\n- ocr: String, mandatory for INE and IFE.\n- cic: String, mandatory for INE.\n- nombre: String, optional.\n- apellidoPaterno: String, optional.\n- apellidoMaterno: String, optional.\n- anioRegistro: String, optional.\n- anioEmision: String, optional.\n- numeroEmisionCredencial: String, mandatory for ife.\n- claveElector: String, mandatory for ife.\n- curp: String, optional.\n\n**COL**: Colombia - Registraduría Validation. Currently there's no option for face validation. Can validate registraduría or\nextranjería (foreign citizens living in colombia). **Note**: Government Validations for Colombia acquired via TusDatos\n\nRequest Body is optional - if not sent data will be taken from the session:\n- idNumber: String, mandatory.\n- fechaEmision: String, mandatory when Nationality is not Columbia. Format dd/mm/yyyy\n- nombre: String, optional.\n- apellidoPaterno: String, optional.\n- apellidoMaterno: String, optional.\n\n**ARG**: Argentina - Renaper Validation. Currently there's no option for face validation.\n\nRequest Body:\n- idNumber: String, mandatory.\n\n**PER**: Peru - Reniec Validation. Currently there's no option for face validation. Can validate Reniec. **Note**: Government\nValidations for Peru obtained by checking against TOC, a risk database. ID must include DNI in order to validate.\nRequest Body is optional - if not sent data will be taken from the session.\n- idNumber: String, mandatory (corresponds to DNI number)\n- nombre: String, optional - if not provided ocrValidation for FistName will be UNKNOWN\n- apellidoPaterno: String, optional - if not provided ocrValidation for PaternalLastName will be UNKNOWN\n- apellidoMaterno: String, optional - if not provided ocrValidation for MaternalLastName will be UNKNOWN\n- birthDate: String, optional - if not provided ocrValidation for BirthDate will be UNKNOWN\n- gender: String, optional - if not provided ocrValidation for Gender will be UNKNOWN\n\n**CHL**: Chile - Sinacofi Validation. Currently there's no option for face validation. Can validate Sinacofi. **Note**:\nGovernment Validations for Chile obtained by checking against TOC, a risk database. ID must include DNI in order to validate.\nRequest Body is optional - if not sent data will be taken from the session:\n- idNumber: String, mandatory (corresponds Serie)\n- personalNumber: String, mandatory (corresponds RUT/RUN)\n\n**AUS**: Australia - Government Validation for Passport and Driver License.\nRequest Body is optional - if not sent data will be taken from the OCR.\n\nFor Passport validation:\n- firstName: String, mandatory.\n- middleName: String, optional.\n- paternalLastName: String, mandatory.\n- cic: String, mandatory (corresponds to Passport number).\n- documentType: String, mandatory (\"Passport\").\n- birthDate: String, mandatory. Format yyyy/MM/dd.\n- address: String, optional.\n\nFor Driver License validation:\n- firstName: String, mandatory.\n- middleName: String, optional.\n- paternalLastName: String, mandatory.\n- documentType: String, mandatory ( com\"DriversLicense\").\n- birthDate: String, mandatory. Format yyyy/MM/dd.\n- refNumber: String, mandatory (corresponds to Card number).\n- cic: String, mandatory (corresponds to License number).\n- issuerState: String, mandatory (e.g., \"NSW\").\n- address: String, optional.\n",
        "operationId": "processgovernmentvalidation",
        "parameters": [
          {
            "name": "fallbackEnabled",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "scrapingMethod",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "scrapingV2",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "scrapingV3",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "interviewId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "countryCode",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GovernmentValidationDataRequest"
              },
              "examples": {
                "Default Request": {
                  "summary": "Default Validation Request",
                  "description": "Default Request",
                  "value": {
                    "ocr": "string",
                    "cic": "string",
                    "nombre": "string",
                    "apellidoPaterno": "string",
                    "apellidoMaterno": "string",
                    "anioRegistro": "string",
                    "anioEmision": "string",
                    "numeroEmisionCredencial": "string",
                    "claveElector": "string",
                    "curp": "string",
                    "base64Image": "string",
                    "idNumber": "string",
                    "fechaEmision": "string",
                    "personalNumber": "string",
                    "birthDate": "string",
                    "gender": "string",
                    "birthPlace": "string",
                    "address": "string",
                    "latitude": "string",
                    "longitude": "string",
                    "macAddress": "string",
                    "ip": "string",
                    "osVersion": "string",
                    "applicationName": "string",
                    "sufix": "string",
                    "firstName": "string",
                    "givenName": "string",
                    "middleName": "string",
                    "paternalLastName": "string",
                    "documentType": "Unknown",
                    "refNumber": "string",
                    "issuerState": "string",
                    "documentTypeId": 0,
                    "issuedAt": "string",
                    "documentNumber": "string",
                    "expireAt": "string",
                    "eyeColor": "string",
                    "height": "string",
                    "weight": "string",
                    "city": "string",
                    "postalCode": "string"
                  }
                },
                "It takes data from OCR document data (session data)": {
                  "summary": "Document OCR Validation Request",
                  "description": "It takes data from OCR document data (session data)",
                  "value": {}
                },
                "Brazil - CPF Request": {
                  "summary": "Brazil - CPF Request",
                  "description": "Brazil - CPF Request",
                  "value": {
                    "idNumber": "88291306800"
                  }
                },
                "AUS_Passport_Request": {
                  "summary": "Australia Passport Validation Request",
                  "description": "Example request for validating an Australian passport",
                  "value": {
                    "firstName": "VINCE",
                    "middleName": "",
                    "paternalLastName": "CITIZEN",
                    "cic": "PA0001317",
                    "documentType": "Passport",
                    "birthDate": "2013/03/01"
                  }
                },
                "AUS_DriverLicense_Request": {
                  "summary": "Australia Driver License Validation Request",
                  "description": "Example request for validating an Australian driver license",
                  "value": {
                    "firstName": "TIM",
                    "middleName": "",
                    "paternalLastName": "CITIZEN",
                    "documentType": "DriversLicense",
                    "birthDate": "1970/02/21",
                    "refNumber": "A968754",
                    "cic": "1948573847",
                    "issuerState": "NSW"
                  }
                },
                "COL_Cedula_Request": {
                  "summary": "Colombia ANI Compliance Validation Request",
                  "description": "Example request for validating a Colombian Cedula",
                  "value": {
                    "documentNumber": "12345678",
                    "issuerState": "VALLE",
                    "issuedAt": "1990-03-15",
                    "issuingAuthority": "CALI",
                    "firstName": "JUAN",
                    "middleName": "CARLOS",
                    "paternalLastName": "PEREZ",
                    "maternalLastName": "GOMEZ"
                  }
                },
                "Peru_ResidenceDocument_Request": {
                  "summary": "Peru Residence Document Validation Request",
                  "description": "Example request for validating a Residence Document",
                  "value": {
                    "documentType": "ResidenceDocument",
                    "documentNumber": "012345678",
                    "birthDate": "1990-01-01",
                    "fullName": "ANA MARIA PEREZ GONZALEZ"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Responses:\n**MEX**:\n- statusCode: Integer. Possible values:\n    - OK (0, \"ok\"),\n    - VALIDATION_ERROR (1, \"validationError\"),\n    - INE_CONNECTION_ERROR (2, \"ineConnectionError\"),\n    - INE_INFRASTRUCTURE_ERROR (3, \"ineInfrastructureError\"),\n    - MODULE_NOT_SUPPORTED (4, \"moduleNotSupported\"),\n    - MISSING_DOCUMENT_ID (5, \"missingDocumentId\"),\n    - MISSING_SELFIE (6, \"missingSelfie\"),\n    - USER_NOT_FOUND (7, \"userNotFound\");\n    - USER_NOT_FOUND_IN_INE_DB (8, \"userNotFoundInIneDb\"),\n    - NOT_ENOUGH_DATA (9, \"notEnoughData\"),\n    - LIVENESS_FAIL (10, \"livenessFail\")\n    - INE_NOT_CURRENT (11, \"ineNotCurrent\")\n    - INE_REPORTED_LOST (12, \"ineReportedLost\")\n    - INE_REPORTED_STOLEN (13, \"ineReportedStolen\")\n    - INE_SIGNATURE_ERROR (14, \"ineSignaturError\")\n    - INE_NOT_VALID (15, \"ineNotValid\")\n    - PROVIDER_UNAVAILABLE (98, \"providerUnavailable\"). Also returned for an INE-side service degradation (codigoRespuesta=0 with similitud1=null): the face comparison never produced a score, so recognitionConfidence stays null — distinct from a real face mismatch. In that case errorDescription identifies the cause.\n    - COUNTRY_NOT_SUPPORTED (99, \"countryNotSupported\")\n    - PROCESSING_INE (-1, \"processingIne\"). It only applies for Listas Nominales (INE Scraping).\n    - PROCESSING (-4, \"processing\")\n    - CONNECTION_ERROR (17, \"connectionError\")\n    - INFRASTRUCTURE_ERROR (18, \"infrastructureError\")\n    - TRANSACTION_LIMIT_REACHED (205, \"transactionLimitReached\")\n- valid: Boolean. Flag stating if request processed successfully.\n- registralSituation: Structure with following fields:\n    - tipoSituacionRegistral: String. Possible values: [ VIGENTE, NO_VIGENTE, DATOS_NO_ENCONTRADOS ]\n    - tipoReporteRoboExtravio: String, optional. Possible values: [ null, REPORTE_DE_EXTRAVIO, REPORTE_DE_ROBO, REPORTE_DE_ROBO_TEMPORAL, REPORTE_DE_EXTRAVIO_TEMPORAL ]\n- governmentValidation: Structure with following fields:\n    - validationStatus: Structure with following fields:\n        - value: Look statusCode\n        - status: Look statusCode\n        - key:\n            - ok: when value OK\n            - error: when value VALIDATION_ERROR, INE_INFRASTRUCTURE_ERROR, USER_NOT_FOUND_IN_INE_DB, INE_NOT_CURRENT, INE_REPORTED_LOST, INE_REPORTED_STOLEN, USER_NOT_FOUND, TRANSACTION_LIMIT_REACHED\n            - unknown: otherwise\n    - ocrValidation: Array of structure with following fields:\n        - value: Possible values - true false empty\n        - status: Possible values - OK FAIL UNKNOWN\n        - key: Possible values - issueDate firstName maternalLastName paternalLastName ocr personalId electorsKey emissionNumber registrationDate\n    - ocrValidationOverall: Structure with following fields:\n        - value: Calculated value based on Ocr Validation between 0 and 100\n        - status: OK or FAIL based on calculation\n    - overall: Same as ocrValidationOverall\n- ocrData: Look at fetch-OCR\n- deviceInfo: Look at fetch-deviceInfo\n- ineTransactionId: String\n\n**COL**:\n- statusCode: 0 - OK, other not OK*\n- governmentValidation - consists of the following fields:\n    - validationStatus - following values:\n        - OK (0, \"ok\"),\n        - VALIDATION_ERROR (1, \"validationError\"),\n        - CONNECTION_ERROR (17, \"connectionError\"),\n        - USER_NOT_FOUND (7, \"userNotFound\"),\n        - NOT_ENOUGH_DATA (9, \"notEnoughData\")\n    - ocrValidation: Array of structure with following fields:\n        - value: Possible values - true false empty\n        - status: Possible values - OK FAIL UNKNOWN\n        - key: Possible values - firstName maternalLastName paternalLastName ocr birthDate gender\n- governmentValidationResponse (DEPRECATED):\n    - COL1:\n        \"governmentValidationResponse\": {\n            \"codError\": \"0\",\n            \"contract_id\": 111,\n            \"departamentoExpedicion\": \"ATLANTICO\",\n            \"descripcionEstado\": \"VIGENTE\",\n            \"estadoCedula\": \"0\",\n            \"fechaExpedicion\": \"31/12/1990\",\n            \"fechaHoraConsulta\": \"2025-03-12 20:32:29\",\n            \"municipioExpedicion\": \"BARRANQUILLA\",\n            \"nuip\": \"000000000\",\n            \"particula\": \"DE\",\n            \"primerApellido\": \"Perez\",\n            \"primerNombre\": \"Jose\",\n            \"segundoApellido\": \"Perez\",\n            \"segundoNombre\": \"Juan\"\n        }\n    - COL2:\n        \"governmentValidationResponse\": {\n            \"data\": {\n                \"anio_resolucion\": 0,\n                \"codigo_error_datos_cedula\": 0,\n                \"codigo_respuesta\": \"\",\n                \"departamento_expedicion\": \"ATLANTICO\",\n                \"descripcion_estado\": \"Vigente\",\n                \"estado_cedula\": 0,\n                \"fecha_expedicion\": \"Mon, 31 Dec 1990 00:00:00 GMT\",\n                \"informacion_adicional\": \"\",\n                \"municipio_expedicion\": \"BARRANQUILLA\",\n                \"nombre_completo\": \"Jose Juan Perez Perez\",\n                \"nuip\": 000000000,\n                \"numero_resolucion\": 0,\n                \"particula\": \"DE\",\n                \"primer_apellido\": \"Perez\",\n                \"primer_nombre\": \"Jose\",\n                \"segundo_apellido\": \"Perez\",\n                \"segundo_nombre\": \"Juan\"\n            }\n        }\n\n- ocrValidationOverall:\n    - ocrValidationOverall: 100 - 15 each fail or unknown ocrValidation\n    - status: ocrValidationOverall > 55 => OK, else FAIL\n- overall: same as ocrValidationOverall\n\n**ARG**:\n- statusCode: Integer. Value 0 means verification Ok.\n- governmentValidation - consists of following fieds:\n    - validationStatus - following values:\n        - OK (0, \"ok\")\n        - FACE_COMPARISON_FAILED (207, \"faceComparisonFailed\")\n        - PROCESSING (-4, \"processing\")\n        - PROVIDER_NOT_CONFIGURED (96, \"providerNotConfigured\")\n        - PROVIDER_UNAVAILABLE (98, \"providerUnavailable\")\n        - USER_NOT_FOUND (7, \"userNotFound\")\n        - VALIDATION_ERROR (1, \"validationError\")\n        - NO_INFORMATION (204, \"noInformation\")\n\n**PER**:\n- statusCode: 0 - OK, other not OK\n- governmentValidation - consists of following fieds:\n    - validationStatus - following values:\n        - OK (0, \"ok\"),\n        - VALIDATION_ERROR (1, \"validationError\"),\n        - INE_CONNECTION_ERROR (2, \"ineConnectionError\"),\n        - USER_NOT_FOUND (7, \"userNotFound\"),\n        - NOT_ENOUGH_DATA (9, \"notEnoughData\")\n- ocrValidation: Array of structure with following fields:\n    - value: Possible values - true false empty\n    - status: Possible values - OK FAIL UNKNOWN\n    - key: Possible values - documentNumber firstName maternalLastName paternalLastName ocr birthDate gender\n- governmentValidationResponse: Response received from external source (see example)\n- ocrValidationOverall:\n    - ocrValidationOverall: 100 - 15*each fail or unknown ocrValidation\n    - status: ocrValidationOverall > 55 => OK, else FAIL\n- overall: same as ocrValidationOverall\n\n**CHL**:\n- statusCode: 0 - OK, other not OK\n- governmentValidation - consists of following fieds:\n    - validationStatus - following values:\n        - OK (0, \"ok\"),\n        - VALIDATION_ERROR (1, \"validationError\"),\n        - INE_CONNECTION_ERROR (2, \"ineConnectionError\"),\n        - USER_NOT_FOUND (7, \"userNotFound\"),\n        - NOT_ENOUGH_DATA (9, \"notEnoughData\")\n    - ocrValidation: Array of structure with following fields:\n        - value: Possible values - true false empty\n        - status: Possible values - OK FAIL UNKNOWN\n        - key: Possible values - documentNumber firstName maternalLastName paternalLastName ocr birthDate gender\n    - governmentValidationResponse: Response received from external source (see example)\n    - ocrValidationOverall:\n        - ocrValidationOverall: 100 - 15*each fail or unknown ocrValidation\n        - status: ocrValidationOverall > 55 => OK, else FAIL\n    - overall: same as ocrValidationOverall\n\n**AUS**:\n- statusCode: 0 - OK, other not OK\n- valid: Boolean. Flag stating if request processed successfully.\n- governmentValidation - consists of following fields:\n    - validationStatus - following values:\n        - OK (0, \"ok\"),\n        - USER_NOT_FOUND (7, \"userNotFound\"),\n        - NOT_ENOUGH_DATA (9, \"notEnoughData\"),\n        - CONNECTION_ERROR (17, \"connectionError\")\n    - ocrValidation: Array of structure with following fields:\n        - value: Possible values - true false\n        - status: Possible values - OK FAIL\n        - key: Possible values - documentNumber firstName paternalLastName birthDate expirationDate issueDate\n    - ocrValidationOverall:\n        - value: Calculated value between 0 and 100\n        - status: OK or FAIL based on calculation\n    - overall: Same as ocrValidationOverall\n- errorDescription: String. Present only in error responses with values like \"userNotFound\", \"notEnoughData\", \"connectionError\"\n\n**BRA**:\n- statusCode: 0 - OK, other not OK. Always mirrors validationStatus and is independent of the overall score.\n- valid: Boolean. True when validationStatus is OK (statusCode 0), i.e. CPF found. Note this tracks\n    validationStatus, NOT the overall score: an OCR-field mismatch or a SERPRO_FACE face mismatch\n    can leave valid=true while overall is FAIL.\n- governmentValidation - consists of following fields:\n    - validationStatus - following values:\n        - OK (0, \"ok\"): CPF found, data and/or face matched\n        - VALIDATION_ERROR (1, \"validationError\")\n        - MODULE_NOT_SUPPORTED (4, \"moduleNotSupported\")\n        - MISSING_SELFIE (6, \"missingSelfie\"): required for SERPRO_FACE\n        - USER_NOT_FOUND (7, \"userNotFound\"): CPF not found, or face not matched\n        - CPF_NUMBER_INVALID_OR_MISSING (16, \"cpfNumberInvalidOrMissing\")\n        - CONNECTION_ERROR (17, \"connectionError\")\n        - PROVIDER_NOT_CONFIGURED (96, \"providerNotConfigured\")\n        - PROVIDER_UNAVAILABLE (98, \"providerUnavailable\")\n        - GEOGRAPHIC_REGION_NOT_SUPPORTED (99, \"geographicRegionNotSupported\")\n    - recognitionConfidence: Present when government face validation is attempted (e.g. SERPRO_FACE).\n        - value: \"100.0\" when face matched, \"0.0\" when no match or face not in SERPRO DB\n        - status: OK when matched, FAIL otherwise\n    - ocrValidation: Array of structure with following fields (present for both SERPRO and SERPRO_FACE when validationStatus is OK):\n        - value: Possible values - true false\n        - status: Possible values - OK FAIL UNKNOWN\n        - key: Possible values - documentNumber fullName birthDate\n        Note: fullName is derived from firstName, paternalLastName, and maternalLastName,\n        which all map to the same SERPRO nome field and always share the same status.\n    - ocrValidationOverall:\n        - value: Calculated value between 0 and 100\n        - status: OK or FAIL based on calculation\n    - overall: Equals ocrValidationOverall for SERPRO. For SERPRO_FACE the face recognitionConfidence\n        can override it (e.g. face not in DB / not matched drives overall to 0.0 FAIL even when ocrValidationOverall is OK).\n- errorDescription: String. Present only in error responses\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GovermentValidationResponseObject"
                },
                "examples": {
                  "Default response": {
                    "description": "Default response",
                    "value": {
                      "valid": true,
                      "statusCode": 0,
                      "registralSituation": {
                        "tipoSituacionRegistral": "string",
                        "tipoReporteRoboExtravio": "string"
                      },
                      "governmentValidation": {
                        "recognitionConfidence": {
                          "value": "string",
                          "status": "OK"
                        },
                        "validationStatus": {
                          "value": "string",
                          "status": "OK",
                          "key": "string"
                        },
                        "ocrValidation": [
                          {
                            "value": "string",
                            "status": "OK",
                            "key": "string"
                          }
                        ],
                        "ocrValidationOverall": {
                          "value": "string",
                          "status": "OK"
                        },
                        "overall": {
                          "value": "string",
                          "status": "OK"
                        }
                      },
                      "curpCecobanValidation": {
                        "returnCode": "string",
                        "description": "string",
                        "uniquePopulationRegistrationKeyMatch": true
                      },
                      "customFields": {
                        "additionalProp": "string"
                      },
                      "ocrData": {
                        "name": {
                          "fullName": "string",
                          "fullNameNativeScript": "string",
                          "machineReadableFullName": "string",
                          "firstName": "string",
                          "middleName": "string",
                          "givenName": "string",
                          "givenNameMrz": "string",
                          "nameSuffix": "string",
                          "paternalLastName": "string",
                          "maternalLastName": "string",
                          "lastNameMrz": "string"
                        },
                        "address": "string",
                        "addressFields": {
                          "street": "string",
                          "colony": "string",
                          "postalCode": "string",
                          "city": "string",
                          "state": "string",
                          "stateName": "string",
                          "district": "string",
                          "stateCode": "string",
                          "addressCountryCode": "string",
                          "label": "string"
                        },
                        "fullAddress": true,
                        "invalidAddress": true,
                        "checkedAddress": "string",
                        "checkedAddressBean": {
                          "street": "string",
                          "colony": "string",
                          "postalCode": "string",
                          "city": "string",
                          "state": "string",
                          "stateName": "string",
                          "district": "string",
                          "stateCode": "string",
                          "addressCountryCode": "string",
                          "label": "string"
                        },
                        "exteriorNumber": "string",
                        "interiorNumber": "string",
                        "addressFromStatement": "string",
                        "addressFieldsFromStatement": {
                          "street": "string",
                          "colony": "string",
                          "postalCode": "string",
                          "city": "string",
                          "state": "string",
                          "stateName": "string",
                          "district": "string",
                          "stateCode": "string",
                          "addressCountryCode": "string",
                          "label": "string"
                        },
                        "invalidAddressFromStatement": true,
                        "addressStatementEmissionDate": 0,
                        "documentType": "a1",
                        "addressStatementTimestamps": [
                          {
                            "dateType": "string",
                            "addressStatementTimestamp": 0
                          }
                        ],
                        "poaName": "string",
                        "typeOfId": "string",
                        "documentFrontSubtype": "string",
                        "documentBackSubtype": "string",
                        "birthDate": 0,
                        "gender": "M",
                        "claveDeElector": "string",
                        "curp": "string",
                        "numeroEmisionCredencial": "string",
                        "cic": "string",
                        "ocr": "string",
                        "documentNumber": "string",
                        "documentNumberSource": "FORM",
                        "personalNumber": "string",
                        "nationalNumber": "string",
                        "refNumber": "string",
                        "taxIdNumber": "string",
                        "nue": "string",
                        "externalId": "string",
                        "issuedAt": "string",
                        "expireAt": "string",
                        "expirationDate": 0,
                        "issueDate": 0,
                        "registrationDate": 0,
                        "dlClassDetails": [
                          {
                            "dlClass": "string",
                            "validFromDate": 0,
                            "validToDate": 0,
                            "additionalCodes": "string"
                          }
                        ],
                        "issuingCountry": "string",
                        "issuingState": "string",
                        "birthPlace": "string",
                        "issuingAuthority": "string",
                        "height": "string",
                        "weight": "string",
                        "eyeColor": "string",
                        "hairColor": "string",
                        "bloodType": "string",
                        "maritalStatus": "string",
                        "nationality": "string",
                        "race": "string",
                        "nationalityMrz": "string",
                        "nationalityAlpha3": "string",
                        "governmentComparisonResults": {
                          "paternalLastNameValid": true,
                          "maternalLastNameValid": true,
                          "firstNameValid": true,
                          "curpValid": true,
                          "ocrValid": true,
                          "claveDeElectorValid": true,
                          "numeroEmisionCredencialValid": true,
                          "registrationDateValid": true,
                          "issueDateValid": true
                        },
                        "notExtracted": 0,
                        "notExtractedDetails": [
                          "string"
                        ],
                        "classes": "string",
                        "cond": "string",
                        "mentions": "string",
                        "restrictions": "string",
                        "mrz1": "string",
                        "mrz2": "string",
                        "mrz3": "string",
                        "fullNameMrz": "string",
                        "documentNumberCheckDigit": "string",
                        "dateOfBirthCheckDigit": "string",
                        "expirationDateCheckDigit": "string",
                        "barcodeRawData": "string",
                        "fathersName": "string",
                        "mothersName": "string",
                        "spouseName": "string",
                        "federalRevenueNumber": "string",
                        "originDocumentId": "string",
                        "driversLicenseCategory": "string",
                        "controlNumber": "string",
                        "renach": "string",
                        "additionalAttrs": [
                          "DOCUMENTO_INFANTIL"
                        ],
                        "ocrDataConfidence": {
                          "birthDateConfidence": 0,
                          "nameConfidence": 0,
                          "nameNativeScriptConfidence": 0,
                          "givenNameConfidence": 0,
                          "firstNameConfidence": 0,
                          "middleNameConfidence": 0,
                          "nameSuffixConfidence": 0,
                          "mothersSurnameConfidence": 0,
                          "fathersSurnameConfidence": 0,
                          "nickNameConfidence": 0,
                          "fullNameMrzConfidence": 0,
                          "mothersNameConfidence": 0,
                          "fathersNameConfidence": 0,
                          "spouseNameConfidence": 0,
                          "addressConfidence": 0,
                          "streetConfidence": 0,
                          "colonyConfidence": 0,
                          "postalCodeConfidence": 0,
                          "cityConfidence": 0,
                          "stateConfidence": 0,
                          "districtConfidence": 0,
                          "stateCodeConfidence": 0,
                          "countryCodeConfidence": 0,
                          "genderConfidence": 0,
                          "issueDateConfidence": 0,
                          "expirationDateConfidence": 0,
                          "issuedAtConfidence": 0,
                          "expireAtConfidence": 0,
                          "issuingAuthorityConfidence": 0,
                          "mrz1Confidence": 0,
                          "mrz2Confidence": 0,
                          "mrz3Confidence": 0,
                          "mrzFullConfidence": 0,
                          "documentNumberConfidence": 0,
                          "backNumberConfidence": 0,
                          "personalNumberConfidence": 0,
                          "nationalNumberConfidence": 0,
                          "claveDeElectorConfidence": 0,
                          "numeroEmisionCredencialConfidence": 0,
                          "curpConfidence": 0,
                          "nueConfidence": 0,
                          "registrationDateConfidence": 0,
                          "heightConfidence": 0,
                          "birthPlaceConfidence": 0,
                          "bloodTypeConfidence": 0,
                          "eyeColorConfidence": 0,
                          "classesConfidence": 0,
                          "condConfidence": 0,
                          "mentionsConfidence": 0,
                          "refNumberConfidence": 0,
                          "weightConfidence": 0,
                          "hairConfidence": 0,
                          "restrictionsConfidence": 0,
                          "nationalityConfidence": 0,
                          "nationalityMrzConfidence": 0,
                          "maritalStatusConfidence": 0,
                          "raceConfidence": 0,
                          "taxIdNumberConfidence": 0,
                          "jurisdictionCodeConfidence": 0
                        },
                        "additionalDocumentAttempts": [
                          {
                            "status": "SUCCESS",
                            "attemptTimestamp": 0,
                            "documentType": "string",
                            "firstName": "string",
                            "lastName": "string",
                            "countryOfOrigin": "string",
                            "dateOfBirth": 0,
                            "expiryDate": 0,
                            "issueDate": 0,
                            "gender": "MALE",
                            "nationality": "string",
                            "placeOfIssue": "string",
                            "referenceNumber": "string",
                            "residentialAddressLines": [
                              "string"
                            ]
                          },
                          {
                            "status": "SUCCESS",
                            "attemptTimestamp": 0,
                            "documentType": "string",
                            "fullName": "string",
                            "address": "string",
                            "accountNumber": "string",
                            "bankName": "string",
                            "documentDate": "string"
                          },
                          {
                            "status": "SUCCESS",
                            "attemptTimestamp": 0,
                            "documentType": "string",
                            "fullName": "string",
                            "curpNumber": "string",
                            "registrationDate": 0,
                            "registrationEntity": "string",
                            "idNumber": "string"
                          },
                          {
                            "status": "SUCCESS",
                            "attemptTimestamp": 0,
                            "documentType": "string",
                            "fullName": "string",
                            "address": "string",
                            "issueDate": 0
                          },
                          {
                            "status": "SUCCESS",
                            "attemptTimestamp": 0,
                            "documentType": "string",
                            "rfcNumber": "string",
                            "corporateName": "string",
                            "fullName": "string",
                            "declarationType": "string",
                            "fiscalYear": 0,
                            "submissionDate": 0,
                            "hasIncomeStatement": true,
                            "hasFinancialPositionStatement": true,
                            "totalIncome": 0,
                            "capitalFromContributions": 0,
                            "capitalFromCapitalization": 0,
                            "accumulatedLosses": 0,
                            "currentYearLosses": 0,
                            "accumulatedProfits": 0,
                            "currentYearProfits": 0,
                            "amountToPay": 0,
                            "amountDue": 0,
                            "operationNumber": "string"
                          },
                          {
                            "status": "SUCCESS",
                            "attemptTimestamp": 0,
                            "documentType": "string",
                            "issueDate": 0,
                            "rfcNumber": "string",
                            "corporateName": "string",
                            "fullName": "string",
                            "registryStatus": "string",
                            "addressComponents": {
                              "street": "string",
                              "colony": "string",
                              "postalCode": "string",
                              "city": "string",
                              "state": "string",
                              "stateName": "string",
                              "district": "string",
                              "stateCode": "string",
                              "addressCountryCode": "string",
                              "label": "string"
                            },
                            "economicActivities": [
                              {
                                "title": "string",
                                "percentage": 0,
                                "startDate": 0,
                                "endDate": 0
                              }
                            ],
                            "regimes": [
                              {
                                "title": "string",
                                "startDate": 0,
                                "endDate": 0
                              }
                            ],
                            "barcodes": [
                              {
                                "format": "string",
                                "contentType": "string",
                                "text": "string",
                                "error": "string"
                              }
                            ]
                          },
                          {
                            "status": "SUCCESS",
                            "attemptTimestamp": 0,
                            "documentType": "string",
                            "name": "string",
                            "address": "string",
                            "timestamp": 0,
                            "addressStatementTimestamps": [
                              {
                                "dateType": "string",
                                "addressStatementTimestamp": 0
                              }
                            ],
                            "issuer": "a1",
                            "addressComponents": {
                              "street": "string",
                              "colony": "string",
                              "postalCode": "string",
                              "city": "string",
                              "state": "string",
                              "stateName": "string",
                              "district": "string",
                              "stateCode": "string",
                              "addressCountryCode": "string",
                              "label": "string"
                            }
                          },
                          {
                            "status": "SUCCESS",
                            "attemptTimestamp": 0,
                            "documentType": "string",
                            "firstNames": "string",
                            "lastName": "string",
                            "gender": "MALE",
                            "countryOfBirth": "string",
                            "dateOfBirth": 0,
                            "nationality": "string",
                            "maritalStatus": "string",
                            "issueDate": 0,
                            "expiryDate": 0,
                            "idNumber": "string"
                          },
                          {
                            "status": "SUCCESS",
                            "attemptTimestamp": 0,
                            "documentType": "string",
                            "fullName": "string",
                            "gender": "MALE",
                            "dateOfBirth": 0,
                            "issueDate": 0,
                            "countryOfBirth": "string",
                            "nationality": "string",
                            "maritalStatus": "string",
                            "documentNumber": "string"
                          },
                          {
                            "status": "SUCCESS",
                            "attemptTimestamp": 0,
                            "documentType": "string",
                            "fullName": "string",
                            "rfcNumber": "string",
                            "idCIF": "string"
                          },
                          {
                            "status": "SUCCESS",
                            "attemptTimestamp": 0,
                            "documentType": "string"
                          },
                          {
                            "status": "SUCCESS",
                            "attemptTimestamp": 0,
                            "documentType": "string",
                            "fullName": "string",
                            "address": "string",
                            "addressList": [
                              "string"
                            ],
                            "registrationNumber": "string",
                            "v5cNumber": "string",
                            "referenceNumber": "string"
                          }
                        ]
                      },
                      "deviceInfo": {
                        "ipAddress": "string",
                        "hash": "string",
                        "deviceType": "IOS",
                        "osVersion": "string",
                        "deviceModel": "string",
                        "sdkVersion": "string",
                        "browser": "string",
                        "hasLiedBrowser": true,
                        "longitude": 0,
                        "latitude": 0,
                        "location": "string",
                        "getmAdminArea": "CA",
                        "getmSubAdminArea": "Santa Clara",
                        "getmLocality": "string",
                        "getmSubLocality": "Mission District",
                        "getmThoroughfare": "string",
                        "getmSubThoroughfare": "string",
                        "getmPostalCode": 95014,
                        "getmCountryCode": "US",
                        "getmCountryName": "United States",
                        "hostingApp": "Onboarding"
                      },
                      "ineTransactionId": "string",
                      "errorDescription": "string",
                      "fallbackCalled": true
                    }
                  },
                  "AUS_Passport_Success": {
                    "summary": "Australia Validation - Success",
                    "description": "Example of successful government validation for an Australian passport",
                    "value": {
                      "valid": true,
                      "statusCode": 0,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "0",
                          "status": "OK",
                          "key": "ok"
                        },
                        "ocrValidation": [
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "documentNumber"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "paternalLastName"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "firstName"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "birthDate"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "expirationDate"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "issueDate"
                          }
                        ],
                        "ocrValidationOverall": {
                          "value": "100.0",
                          "status": "OK"
                        },
                        "overall": {
                          "value": "100.0",
                          "status": "OK"
                        }
                      }
                    }
                  },
                  "AUS_UserNotFound": {
                    "summary": "Australia Validation - User Not Found (NO MATCH)",
                    "description": "Example of user not found during Australian government validation",
                    "value": {
                      "valid": false,
                      "statusCode": 7,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "7",
                          "status": "FAIL",
                          "key": "userNotFound"
                        },
                        "overall": {
                          "status": "FAIL"
                        }
                      },
                      "errorDescription": "userNotFound"
                    }
                  },
                  "AUS_ConnectionError": {
                    "summary": "Australia Validation - Connection Error",
                    "description": "Example of connection error during Australian government validation",
                    "value": {
                      "valid": false,
                      "statusCode": 7,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "17",
                          "status": "CONNECTION_ERROR",
                          "key": "connectionError"
                        },
                        "overall": {
                          "status": "FAIL"
                        }
                      },
                      "errorDescription": "connectionError"
                    }
                  },
                  "AUS_NotEnoughData": {
                    "summary": "Australia Validation - Incomplete Data",
                    "description": "Example of incomplete data during Australian government validation",
                    "value": {
                      "valid": false,
                      "statusCode": 7,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "9",
                          "status": "NOT_ENOUGH_DATA",
                          "key": "notEnoughData"
                        },
                        "overall": {
                          "status": "FAIL"
                        }
                      },
                      "errorDescription": "notEnoughData"
                    }
                  },
                  "Brazil Validation - Success": {
                    "summary": "SERPRO data-only - all OCR fields matched",
                    "description": "Brazil Validation - Success",
                    "value": {
                      "valid": true,
                      "statusCode": 0,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "0",
                          "status": "OK",
                          "key": "ok"
                        },
                        "ocrValidation": [
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "documentNumber"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "fullName"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "birthDate"
                          }
                        ],
                        "ocrValidationOverall": {
                          "value": "100.0",
                          "status": "OK"
                        },
                        "overall": {
                          "value": "100.0",
                          "status": "OK"
                        }
                      }
                    }
                  },
                  "Brazil Validation - Partial match": {
                    "summary": "SERPRO data-only - CPF found (validationStatus OK, valid=true) but an OCR field mismatched, so overall FAILs",
                    "description": "Brazil Validation - Partial match",
                    "value": {
                      "valid": true,
                      "statusCode": 0,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "0",
                          "status": "OK",
                          "key": "ok"
                        },
                        "ocrValidation": [
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "documentNumber"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "fullName"
                          },
                          {
                            "value": "false",
                            "status": "FAIL",
                            "key": "birthDate"
                          }
                        ],
                        "ocrValidationOverall": {
                          "value": "55.0",
                          "status": "FAIL"
                        },
                        "overall": {
                          "value": "55.0",
                          "status": "FAIL"
                        }
                      }
                    }
                  },
                  "Brazil Validation - No match": {
                    "description": "Brazil Validation - No match",
                    "value": {
                      "valid": false,
                      "statusCode": 7,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "7",
                          "status": "FAIL",
                          "key": "userNotFound"
                        },
                        "overall": {
                          "value": "0.0",
                          "status": "FAIL"
                        }
                      },
                      "errorDescription": "userNotFound"
                    }
                  },
                  "Brazil Validation - Invalid CPF": {
                    "description": "Brazil Validation - Invalid CPF",
                    "value": {
                      "valid": false,
                      "statusCode": 16,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "16",
                          "status": "UNKNOWN",
                          "key": "cpfNumberInvalidOrMissing"
                        },
                        "overall": {
                          "status": "FAIL"
                        }
                      },
                      "errorDescription": "cpfNumberInvalidOrMissing"
                    }
                  },
                  "Brazil SERPRO_FACE - Face matched": {
                    "summary": "SERPRO_FACE - Face+data validation success",
                    "description": "Brazil SERPRO_FACE - Face matched",
                    "value": {
                      "valid": true,
                      "statusCode": 0,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "0",
                          "status": "OK",
                          "key": "ok"
                        },
                        "ocrValidation": [
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "documentNumber"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "fullName"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "birthDate"
                          }
                        ],
                        "ocrValidationOverall": {
                          "value": "100.0",
                          "status": "OK"
                        },
                        "recognitionConfidence": {
                          "value": "100.0",
                          "status": "OK"
                        },
                        "overall": {
                          "value": "100.0",
                          "status": "OK"
                        }
                      }
                    }
                  },
                  "Brazil SERPRO_FACE - Face not matched": {
                    "summary": "SERPRO_FACE - Face not matched or CPF not found",
                    "description": "Brazil SERPRO_FACE - Face not matched",
                    "value": {
                      "valid": false,
                      "statusCode": 7,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "7",
                          "status": "FAIL",
                          "key": "userNotFound"
                        },
                        "overall": {
                          "value": "0.0",
                          "status": "FAIL"
                        }
                      },
                      "errorDescription": "userNotFound"
                    }
                  },
                  "Brazil SERPRO_FACE - Face not in DB": {
                    "summary": "SERPRO_FACE - Face not in SERPRO DB (non-DriversLicense): data matches so validationStatus OK and valid=true, but recognitionConfidence FAILs and overrides overall to FAIL",
                    "description": "Brazil SERPRO_FACE - Face not in DB",
                    "value": {
                      "valid": true,
                      "statusCode": 0,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "0",
                          "status": "OK",
                          "key": "ok"
                        },
                        "ocrValidation": [
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "documentNumber"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "fullName"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "birthDate"
                          }
                        ],
                        "ocrValidationOverall": {
                          "value": "100.0",
                          "status": "OK"
                        },
                        "recognitionConfidence": {
                          "value": "0.0",
                          "status": "FAIL"
                        },
                        "overall": {
                          "value": "0.0",
                          "status": "FAIL"
                        }
                      }
                    }
                  },
                  "Brazil SERPRO_FACE - Missing selfie": {
                    "summary": "SERPRO_FACE - selfie required but not provided",
                    "description": "Brazil SERPRO_FACE - Missing selfie",
                    "value": {
                      "valid": false,
                      "statusCode": 6,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "6",
                          "status": "UNKNOWN",
                          "key": "missingSelfie"
                        },
                        "overall": {
                          "status": "FAIL"
                        }
                      },
                      "errorDescription": "missingSelfie"
                    }
                  },
                  "COL_Cedula_Success": {
                    "summary": "Colombia ANI Compliance Validation - Success",
                    "description": "Example of successful government validation",
                    "value": {
                      "valid": true,
                      "statusCode": 0,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "0",
                          "status": "OK",
                          "key": "ok"
                        },
                        "ocrValidation": [
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "documentNumber"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "firstName"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "paternalLastName"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "maternalLastName"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "issueDate"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "ocr"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "middleName"
                          }
                        ],
                        "ocrValidationOverall": {
                          "value": "100.0",
                          "status": "OK"
                        },
                        "overall": {
                          "value": "100.0",
                          "status": "OK"
                        }
                      }
                    }
                  },
                  "COL_Cedula_Success_Legacy": {
                    "summary": "Colombia BD ANI Validation - Success",
                    "description": "Example of successful government validation",
                    "value": {
                      "valid": true,
                      "statusCode": 0,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "0",
                          "status": "OK",
                          "key": "ok"
                        },
                        "ocrValidation": [
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "documentNumber"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "firstName"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "paternalLastName"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "maternalLastName"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "issueDate"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "ocr"
                          }
                        ],
                        "governmentValidationResponse": {
                          "codError": "0",
                          "contract_id": 133,
                          "departamentoExpedicion": "ATLANTICO",
                          "descripcionEstado": "VIGENTE",
                          "estadoCedula": "0",
                          "fechaExpedicion": "15/08/1995",
                          "fechaHoraConsulta": "2025-07-21 19:20:08",
                          "municipioExpedicion": "BARRANQUILLA",
                          "nuip": "99999999",
                          "particula": " ",
                          "primerApellido": "PEREZ",
                          "primerNombre": "JUAN",
                          "segundoApellido": "GOMEZ",
                          "segundoNombre": "CARLOS"
                        },
                        "ocrValidationOverall": {
                          "value": "100.0",
                          "status": "OK"
                        },
                        "overall": {
                          "value": "100.0",
                          "status": "OK"
                        }
                      }
                    }
                  },
                  "Peru_ResidenceDocument_Success": {
                    "summary": "Peru ResidenceDocument - Success",
                    "description": "Example of successful government validation",
                    "value": {
                      "valid": true,
                      "statusCode": 0,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "0",
                          "status": "OK",
                          "key": "ok"
                        },
                        "ocrValidation": [
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "documentNumber"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "firstName"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "paternalLastName"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "maternalLastName"
                          },
                          {
                            "value": "true",
                            "status": "OK",
                            "key": "birthDate"
                          }
                        ],
                        "governmentValidationResponse": {
                          "code": 1,
                          "message": "OK",
                          "data": {
                            "nombres_apellidos": "PEREZ GONZALEZ, ANA MARIA",
                            "nacionalidad": "VENEZOLANA",
                            "fecha_nacimiento": "21-11-1992",
                            "calidad_migratoria": "RESIDENTE",
                            "vencim_residencia": "31/12/2030",
                            "caducidad_carne": "01/01/2035",
                            "emision_ultimo": "01/01/2025"
                          }
                        },
                        "ocrValidationOverall": {
                          "value": "100.0",
                          "status": "OK"
                        },
                        "overall": {
                          "value": "100.0",
                          "status": "OK"
                        }
                      }
                    }
                  },
                  "Peru_ResidenceDocument_NoMatch": {
                    "summary": "Peru ResidenceDocument - No Match",
                    "description": "Example of no match government validation",
                    "value": {
                      "valid": false,
                      "statusCode": 7,
                      "governmentValidation": {
                        "validationStatus": {
                          "value": "7",
                          "status": "FAIL",
                          "key": "userNotFound"
                        },
                        "governmentValidationResponse": {
                          "code": 0,
                          "message": "No se encontró datos para la búsqueda."
                        },
                        "overall": {
                          "status": "FAIL"
                        }
                      },
                      "errorDescription": "userNotFound"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "409": {
            "description": "Another government-validation request is already in progress for this interview. Wait for it to finish instead of retrying immediately.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/process-government-validation/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/process-government-validation.md"
      }
    },
    "/omni/process/global-watchlist": {
      "post": {
        "tags": [
          "Global watchlist"
        ],
        "summary": "Process global watchlist",
        "description": "This endpoint processes a global watchlist search for an individual using the watchlist configuration defined in the flow (including settings for subscription to ongoing monitoring).\nIt performs a comprehensive screening against global watchlists (sanctions, PEPs, adverse media) and saves the results for further processing.\nThe endpoint returns a basic success/failure response.\n",
        "operationId": "processGlobalWatchlist",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WatchlistRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/process-global-watchlist/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/process-global-watchlist.md"
      }
    },
    "/omni/process/face-vs-second-id": {
      "post": {
        "tags": [
          "Face capture"
        ],
        "summary": "Process face vs second id",
        "description": "**Note**: This endpoint should be called only after [selfie](#/Onboarding/addFaceByThirdParty) and\n[front-second-id](#/Onboarding/addFrontSecondIdV2) both are over.\n\nIt is validating user's selfie against photo from ID (1:1 recognition). Also, this call validates if user already exists\nin the system (1:N recognition).\n\nIt is highly recommended that before calling this process-face endpoint, one should first finish following endpoints:\n[add-front-secondId](#/Onboarding/addFrontSecondIdV2), [add-back-secondId](#/Onboarding/addBackSecondIdV2) (not required in\ncase of passports), [process-secondId](#/Onboarding/processSecondId) and [add-selfie](#/Onboarding/addFaceByThirdParty) in order\nto get complete result view based on id verification, face recognition and liveness.\n",
        "operationId": "processfacevssecondid",
        "parameters": [
          {
            "name": "imageType",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "selfie",
                "videoSelfie"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProcessFaceResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/process-face-vs-second-id/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/process-face-vs-second-id.md"
      }
    },
    "/omni/process/face": {
      "post": {
        "tags": [
          "Face capture"
        ],
        "summary": "Process face",
        "description": "**Note: This endpoint should be called only after [selfie](#/Onboarding/addFaceByThirdParty)\nand [front-id](#/Onboarding/addFrontIdV2) both are over.**\n\nIt is validating user's selfie against photo from ID (1:1 recognition).\nAlso, this call validates if user already exists in the system (1:N recognition).\n\n**It is highly recommended that before calling this process-face endpoint, one should first finish following endpoints:\n[add-front](#/Onboarding/addFrontIdV2), [add-back](#/Onboarding/addBackIdV2)(not required in case of passports),\n[process-id](#/Onboarding/processId) and [add-selfie](#/Onboarding/addFaceByThirdParty) in order to get complete result view\nbased on id verification, face recognition and liveness.**\n",
        "operationId": "processface",
        "parameters": [
          {
            "name": "imageType",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "selfie",
                "videoSelfie"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProcessFaceResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/process-face/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/process-face.md"
      }
    },
    "/omni/process/approve": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Approve customer",
        "description": "Approve customer for omnichannel program. Body is optional and used for auto approve when only specific features\nshould be approved. It is not possible to approve twice the same user (e.g. with the same phone number).\n",
        "operationId": "approve",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "description": "Session id for which approval is requested.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApproveRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApproveOnboardingResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error status:\n- 4006: User with given phone already exists\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/process-approve/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/process-approve.md"
      }
    },
    "/omni/phone": {
      "get": {
        "tags": [
          "Phone number input"
        ],
        "summary": "Get phone",
        "description": "Get the phone previously added to the interview.",
        "operationId": "getgetphone",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/phone/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/phone.md"
      },
      "post": {
        "tags": [
          "Phone number input"
        ],
        "summary": "Add phone",
        "description": "Add phone to interview",
        "operationId": "postaddphone",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PhoneRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddPhoneResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/phone-post/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/phone-post.md"
      }
    },
    "/omni/onboarding-authentications/authenticate/third-party": {
      "post": {
        "tags": [
          "Onboarding authentication"
        ],
        "summary": "Authentication with face/selfie image",
        "description": "Authenticate user by comparing base64 image from request and user's existing face template.\nIn case of One to one authentication, user is first found in DB by hint from request. At least one of criteria parameter must be sent in request.\nIn case of One to N authentication, hint is not used.\nIn case face doesn't match error response is returned.\n",
        "operationId": "authenticate_3",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OnboardingAuthenticationRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnboardingAuthenticationResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/onboarding-authentications-authenticate-third-party/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/onboarding-authentications-authenticate-third-party.md"
      }
    },
    "/omni/onboarding-authentications/authenticate": {
      "post": {
        "tags": [
          "Onboarding authentication"
        ],
        "summary": "Authentication with face/selfie image",
        "description": "Authenticate user by comparing base64 image from request and user's existing face template.\nIn case of One to one authentication, user is first found in DB by hint from request. At least one of criteria parameter must be sent in request.\nIn case of One to N authentication, hint is not used.\nIn case face doesn't match error response is returned.\n",
        "operationId": "authenticate_4",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OnboardingAuthenticationRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OnboardingAuthenticationResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/onboarding-authentications-authenticate/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/onboarding-authentications-authenticate.md"
      }
    },
    "/omni/kyb": {
      "post": {
        "tags": [
          "Ekyb"
        ],
        "summary": "KYB Modular Business Verification",
        "description": "Verifies a business against official registries and other sources. The caller picks the\nmodules to run:\n\n- `identity`: tax ID and business name match\n- `address`: registered address match\n- `statusEntityType`: registration status and legal form\n- `personAssociation`: people associated with the business (officers and directors; outside the US also\n  shareholders, which can be companies, and persons with significant control), and a\n  match for each name in `personNames`\n- `webPresence`: social profiles, websites, phone numbers and emails\n- `websiteAnalysis`: domain age and TLS certificate of the website\n- `industryInfo`: industry classification and risk level\n- `financialIntelligence`: liens, litigation, bankruptcy and credit information\n- `groupStructure`: parent, subsidiary and affiliated companies\n\nModule availability depends on the country and on how the organization is configured.\nEvery requested module appears in the response. The supported modules run normally. A\nmodule that is not supported for the country returns an `error` object with status\n`notSupported` in place of its data, and the request still succeeds. A module that ran\nbut could not produce a result also returns an `error` object in place of its data.\n\nIn an onboarding session, `GET /omni/kyb/form` returns a ready-to-render form for this request,\nwith the fields each country needs.\n\nMatch fields use these values: `verified` (exact or near-exact match),\n`approximateMatch` (close match), `unverified` (did not match, or could not be checked) and `notFound` (no\nrecord found). A module `error` can also have the status `notSupported`.\n\nEvery response carries a `referenceId`. Some modules (`webPresence`, `websiteAnalysis`,\n`industryInfo`, `financialIntelligence`) may not finish before the response is returned.\nWhen that happens they are listed in `pendingModules`. Every run ends with exactly one\n`KYB_RESULT` webhook, carrying `referenceId` and the final `result`. The final result is\nalso available from `GET /omni/verification/async/{referenceId}`.\n",
        "operationId": "kyb",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/KybRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "KYB result. Modules listed in `pendingModules` are still running, and their results arrive in the `KYB_RESULT` webhook",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/KybResult"
                }
              }
            }
          },
          "400": {
            "description": "Missing `country`, empty `modules`, an unknown value in `modules`, or no KYB provider configured for the country in this organization. In the United States, also missing inputs required by the requested modules or an invalid `taxId`. Outside the United States a request without a `taxId` is not rejected: it returns 200 with a `notFound` error in every requested module. `message` carries the reason, though for a missing `country` or empty `modules` it does not name the field",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing, invalid or expired session token, or a token from a different organization than the `x-api-key`. The response has no body"
          },
          "403": {
            "description": "Forbidden - the caller is authenticated but below the required access level",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "406": {
            "description": "Malformed request body",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/kyb/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/kyb.md"
      }
    },
    "/omni/interview-events": {
      "get": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch interview events",
        "description": "Returns the list of all events for given interview",
        "operationId": "getEvents",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 100
            }
          },
          {
            "name": "codes",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "default": [],
              "items": {
                "type": "string"
              },
              "uniqueItems": true
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetInterviewEventsResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/getevents/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/getevents.md"
      }
    },
    "/omni/identity-reuse/submit": {
      "post": {
        "tags": [
          "Identity reuse"
        ],
        "summary": "Submit identity reuse decision",
        "description": "Accepts or declines reuse of a previously verified identity, on another organization.",
        "operationId": "submitidentityreuse",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/IdentityReuseRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/identity-reuse-submit/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/identity-reuse-submit.md"
      }
    },
    "/omni/identity-crosscheck": {
      "post": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Identity cross-check comparing account creation data with IDV data",
        "description": "Cross-checks name and date of birth from account creation against data extracted during IDV.\nCompares the provided data with OCR-extracted data and returns validation score with risk assessment.\n",
        "operationId": "identityCrosscheck",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "Identity cross-check request containing name and DOB (session ID from JWT)",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/IdentityCrosscheckRequest"
              },
              "example": {
                "name": "John Doe",
                "dateOfBirth": "1990-01-15"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IdentityCrosscheckResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "404": {
            "description": "Session or IDV data not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/identity-crosscheck/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/identity-crosscheck.md"
      }
    },
    "/omni/get/images/v2": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch image links",
        "description": "Returns images temporary links for requested images. Links are valid for one hour",
        "operationId": "getimageslinks",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Id of onboarding for which images are requested. If not present, it will be extracted from token",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "Image types that are requested",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ImagesRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "For each requested image type, response contains line in format:\n\n{imageType}: String (base64).\n\nBase64 representation of image. Additionally, if signature image is requested, response will contain an array of all signatures.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-images-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-images-v2.md"
      }
    },
    "/omni/get/images-second-id/v2": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch image links for second id",
        "description": "Returns seconnd id images temporary links for requested images. Links are valid for one hour",
        "operationId": "getimageslinksforsecondid",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ImagesRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "For each requested image type, response contains line in format:\n\n{imageType}: String (base64).\n\nBase64 representation of image. Additionally, if signature image is requested, response will contain an array of all signatures.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-images-second-id-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-images-second-id-v2.md"
      }
    },
    "/omni/get/images-second-id": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch images second id",
        "description": "Returns images for second id of user",
        "operationId": "getimagessecondid",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Id of onboarding for which images are requested. If not present, it will be extracted from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "Image types that are requested. It is strongly advised to fetch one image at the time, as response payload can be potentially big",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ImagesRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "For each requested image type, response contains line in format:\n\n{imageType}: String (base64)\n\nBase64 representation of image. Additionally, if signature image is requested, response will contain an array of all signatures.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-images-second-id/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-images-second-id.md"
      }
    },
    "/omni/get/images": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch images",
        "description": "Returns images for user",
        "operationId": "getimages",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Id of onboarding for which images are requested. If not present, it will be extracted from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "Image types that are requested. It is strongly advised to fetch one image at the time, as response payload can be potentially big",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ImagesRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "For each requested image type, response contains line in format:\n\n{imageType}: String (base64)\n\nBase64 representation of image. Additionally, if signature image is requested, response will contain an array of all signatures.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-images/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-images.md"
      }
    },
    "/omni/get/concatenated-images": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch concatenated images",
        "description": "Concatenates requested images from user. Resulting image keep the largest width of the requested images and preserves the order.",
        "operationId": "getconcatenatedimages",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Id of onboarding for which images are requested. If not present, it will be extracted from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "Image types that are requested. Requested images are limited to crops only, because full frames can potentially lead to big payload in response",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ImagesRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "For each requested image type, response contains line in format:\n\n{imageType}: String (base64)\n\nBase64 representation of image. Additionally, if signature image is requested, response will contain an array of all signatures.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-concatenated-images/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-concatenated-images.md"
      }
    },
    "/omni/finish-status": {
      "get": {
        "tags": [
          "Interview"
        ],
        "summary": "Mark onboarding complete",
        "description": "    Mark onboarding done.\n    NOTE: This call is **deprecated**, use [POST /finish-status](#/Onboarding/finishSessionPost) instead.\n",
        "operationId": "finishsession",
        "parameters": [
          {
            "name": "flowId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "interviewId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "Response:\n- redirectionUrl: String. Url to be redirected when onboarding is done\n- action: String. Possible values: none, approved, manualReview, rejected. Refers to the action performed based on\nthe flow score configurations if applicable.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FinishSessionResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "deprecated": true,
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/finish-status/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/finish-status.md"
      },
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Mark onboarding complete",
        "description": "Mark onboarding done",
        "operationId": "finishsession_1",
        "parameters": [
          {
            "name": "flowId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "interviewId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "Response:\n- redirectionUrl: String. Url to be redirected when onboarding is done\n- action: String. Possible values: none, approved, manualReview, rejected. Refers to the action performed based on\nthe flow score configurations if applicable.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FinishSessionResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/finish-status-post/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/finish-status-post.md"
      }
    },
    "/omni/finalize/document": {
      "post": {
        "tags": [
          "Proof of address capture"
        ],
        "summary": "Finalize document processing",
        "description": "Finalize document processing for multi-page documents with optional page capture",
        "operationId": "finalizeDocument",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FinalizeDocumentRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddDocumentResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/finalize-document/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/finalize-document.md"
      }
    },
    "/omni/externalVerification/income": {
      "post": {
        "tags": [
          "Ekyc"
        ],
        "summary": "eKYC Income verification",
        "description": "This endpoint performs an eKYC income check",
        "operationId": "externalverificationincome",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "**Example**\n\nCheck income:\n```\n{\n  \"country\": \"br\",\n  \"taxId\": \"32757350803\" // cpf 76433943853. 32757350803\n}\n```\n",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EkycIncomeVerificationRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Example:\n```\n{\n    \"income\": [\n        {\n            \"key\": \"employment_type\",\n            \"status\": \"success\",\n            \"sub_label\": \"Type\",\n            \"message\": \"ENTREPRENEUR | BUSINESS OWNER\"\n        },\n        {\n            \"key\": \"employment_sector\",\n            \"status\": \"success\",\n            \"sub_label\": \"Sector\",\n            \"message\": \"PRIVATE - 4639701 - COMERCIO ATACADISTA DE PRODUTOS ALIMENTICIOS EM GERAL\"\n        },\n        {\n            \"key\": \"income_range\",\n            \"status\": \"success\",\n            \"sub_label\": \"Estimated Income Range\",\n            \"message\": \"9240-13200\"\n        }\n    ]\n}\n```\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EkycVerificationResponse"
                }
              }
            }
          },
          "400": {
            "description": "Example:\n```\n{\n    \"timestamp\": 1722948860110,\n    \"status\": 400,\n    \"error\": \"Both country and taxId are mandatory fields must be submitted for successful request\",\n    \"message\": \"Both country and taxId are mandatory fields must be submitted for successful request\",\n    \"path\": \"/omni/externalVerification/income\"\n}\n```\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/externalverification-income/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/externalverification-income.md"
      }
    },
    "/omni/externalVerification/ekyc/unified": {
      "post": {
        "tags": [
          "Ekyc"
        ],
        "summary": "Unified start + eKYC + finish (low-latency)",
        "description": "Runs session start and eKYC verification in parallel and fires finish-status asynchronously,\nreturning once both the start and eKYC legs have resolved.\n",
        "operationId": "unifiedEkyc",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UnifiedEkycRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnifiedEkycResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/externalverification-ekyc-unified/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/externalverification-ekyc-unified.md"
      }
    },
    "/omni/externalVerification/ekyc": {
      "post": {
        "tags": [
          "Ekyc"
        ],
        "summary": "External Verification (eKYC)",
        "description": "This endpoint verifies phone, email, address, date of birth and tax numbers, specifically social security number (ssn).\nWhen making a request use \"kyc\" in the plugins array. To have the API return specific risk scores for phone, email, ssn (taxId)\nand address, see examples below.\n",
        "operationId": "externalverificationekyc",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "**Note**: When fields are provided they will override field values derived from a document scan.\n\n**Examples**\n\nCheck address:\n```\n{\n    \"plugins\": [\"kyc\"],\n    \"firstName\": \"Jon\",\n    \"surName\": \"Hasselhoff\",\n    \"street\": \"101 Beach Highway\",\n    \"postalCode\": \"90210\",\n    \"state\": \"CA\",\n    \"city\": \"Beverly Hills\",\n    \"countryCode\": \"US\"\n}\n```\n\n\nCheck email:\n```\n{\n    \"plugins\": [\"kyc\"],\n    \"firstName\": \"Jon\",\n    \"surName\": \"Hasselhoff\",\n    \"email\": \"david.hasselhoff@email.com\"\n}\n```\n\nCheck phone:\n```\n{\n    \"plugins\": [\"kyc\"],\n    \"firstName\": \"Jon\",\n    \"surName\": \"Hasselhoff\",\n    \"phone\": \"+16504463444\"\n    \"street\": \"101 Beach Highway\",\n    \"postalCode\": \"90210\",\n    \"state\": \"CA\",\n    \"city\": \"Beverly Hills\",\n    \"countryCode\": \"US\"\n}\n```\n\nCheck SSN (taxId):\n```\n{\n    \"plugins\": [\"kyc\"],\n    \"firstName\": \"Jon\",\n    \"surName\": \"Hasselhoff\",\n    \"street\": \"101 Beach Highway\",\n    \"postalCode\": \"90210\",\n    \"state\": \"CA\",\n    \"city\": \"Beverly Hills\",\n    \"countryCode\": \"US\",\n    \"taxId\": \"123456789\",\n    \"dateOfBirth\": \"1980-06-01\"\n}\n```\n\nFull eKYC check:\n```\n{\n    \"plugins\": [\"kyc\"],\n    \"firstName\": \"Jon\",\n    \"middleName\": \"Michael\",\n    \"surName\": \"Hasselhoff\",\n    \"street\": \"101 Beach Highway\",\n    \"postalCode\": \"90210\",\n    \"state\": \"CA\",\n    \"city\": \"Beverly Hills\",\n    \"countryCode\": \"US\",\n    \"phone\": \"+16504463444\",\n    \"email\": \"david.hasselhoff@email.com\"\n    \"taxId\": \"123456789\",\n    \"dateOfBirth\": \"1980-06-01\"\n}\n```\n",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EkycVerificationRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EkycVerificationResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/externalverification-ekyc/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/externalverification-ekyc.md"
      }
    },
    "/omni/externalVerification/ekyb": {
      "post": {
        "tags": [
          "Ekyb"
        ],
        "summary": "eKYB",
        "description": "This endpoint performs an eKYB check for the business specified",
        "operationId": "externalverificationekyb",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BusinessVerificationRequestDto"
              },
              "examples": {
                "US": {
                  "description": "US",
                  "value": {
                    "plugins": [
                      "ekyb"
                    ],
                    "businessName": "Incode Technologies, Inc.",
                    "addressLine1": "575 Market St",
                    "addressLine2": "Fl 4",
                    "city": "San Francisco",
                    "state": "CA",
                    "postalCode": "94105"
                  }
                },
                "BR": {
                  "description": "BR",
                  "value": {
                    "plugins": [
                      "ekyb"
                    ],
                    "businessName": "RENATA DISTR. DE SUPLEMENTOS LTDA",
                    "street": "Rua Curupaiti",
                    "houseNo": "225",
                    "addressLine2": "",
                    "city": "Rio De Janeiro",
                    "state": "RJ",
                    "postalCode": "20735320",
                    "country": "BR",
                    "taxId": "41111051548164",
                    "uboNames": [
                      "MICHEL RODRIGUES",
                      "ERIC SANTOS",
                      "MICHELLE MUNHOZ"
                    ]
                  }
                },
                "CA": {
                  "description": "CA",
                  "value": {
                    "plugins": [
                      "ekyb"
                    ],
                    "country": "CA",
                    "taxId": "4261607",
                    "businessName": "Shopify Inc",
                    "street": "151 O'Connor Street",
                    "city": "Ottawa",
                    "state": "Ontario",
                    "postalCode": "K2P 2L8"
                  }
                },
                "AE": {
                  "description": "AE",
                  "value": {
                    "plugins": [
                      "ekyb"
                    ],
                    "country": "AE",
                    "taxId": "CN-1000000",
                    "businessName": "Sample Trading LLC",
                    "street": "Sample Business Park",
                    "city": "Abu Dhabi",
                    "directors": [
                      "Sample Director"
                    ],
                    "uboNames": [
                      "Sample Holding Company"
                    ]
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "The `kyb` array carries one entry per check that ran. Which keys appear depends on the\ncountry and the provider behind it, and on which fields the request supplied, so read\nthe array by key rather than by position and treat an absent key as \"not checked\".\n\n`sub_label` holds the outcome of the check. `status` and `message` are populated by\nsome providers only and are absent elsewhere.\n\nOn most providers the \"directors_name_match\" and \"ubo_name_match\" keys repeat once\nper name supplied in `directors` and `uboNames`, and each entry names the value it\nreports on in `directorsName_input` or `uboName_input`. Match entries on that field\nrather than keeping one entry per key. In the United States there is at most one\n\"ubo_name_match\" entry. It reports on the first name in `uboNames` only and carries\nno `uboName_input`.\n\nOutcomes for a name or address check:\n- sub_label: Verified, the submitted value matched\n- sub_label: Approximate Match, a close but inexact match\n- sub_label: Unverified, the submitted value did not match. Most providers also\n  return it when no company matched or they hold no value to compare\n- sub_label: Unknown, nothing was compared. Some providers return it when no\n  company matched the request, when the registry holds no value for that field, or\n  when the check does not apply to that country or to the fields supplied\n\nThe `registrationStatus` key reports Active, Inactive or Unknown, and the\n`entityType` key carries the legal entity type in its own `entityType` object rather\nthan in `sub_label`.\n\nThe \"address_property_type\" and \"address_deliverability\" keys are returned for the\nUnited States only, and carry both a status and a message:\n- sub_label: Commercial, message: Submitted Office Address is a Commercial property\n- sub_label: Residential, message: Submitted Office Address is a Residential property\n- sub_label: Deliverable, message: The USPS is able to deliver mail to the submitted Office Address\n- sub_label: Undeliverable, message: The USPS is unable to deliver mail to the submitted Office Address\n\nExample:\n```\n{\n    \"kyb\": [\n        {\n            \"key\": \"name\",\n            \"status\": \"success\",\n            \"sub_label\": \"Verified\",\n            \"message\": \"Match identified to the submitted Business Name\"\n        },\n        {\n            \"key\": \"address_verification\",\n            \"status\": \"success\",\n            \"sub_label\": \"Verified\",\n            \"message\": \"Match identified to the submitted Office Address\"\n        },\n        {\n            \"key\": \"address_deliverability\",\n            \"status\": \"success\",\n            \"sub_label\": \"Deliverable\",\n            \"message\": \"The USPS is able to deliver mail to the submitted Office Address\"\n        },\n        {\n            \"key\": \"address_property_type\",\n            \"status\": \"success\",\n            \"sub_label\": \"Commercial\",\n            \"message\": \"Submitted Office Address is a Commercial property\"\n        }\n    ]\n}\n```\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EkybVerificationResponse"
                }
              }
            }
          },
          "202": {
            "description": "Async verification is enabled for the organization; the request is processed in the background and the result is delivered via the EKYB_VERIFICATION_RESULT webhook. Body carries only referenceId and status=PENDING.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EkybVerificationResponse"
                }
              }
            }
          },
          "400": {
            "description": "Validation failures and provider failures both answer 400. The body's `status`\nfield carries the classification: 400 when the request was rejected because a\nfield the country requires is missing or blank, 503 when the provider did not\nreturn a complete result in time and the request can be retried later,\n502 when the provider answered the search but not the company profile.\n`message` carries the reason.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/externalverification-ekyb/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/externalverification-ekyb.md"
      }
    },
    "/omni/external/send-sms": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Send SMS with the link for onboarding",
        "description": "Used by Admins or Executives to send SMS containing generated onboarding link.",
        "operationId": "sendsmsexternal",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Id of onboarding session for which link is being generated.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SendExternalSmsRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error status:\n- 4004: Could not find user\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/external-send-sms/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/external-send-sms.md"
      }
    },
    "/omni/expire/interviews": {
      "post": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Expire onboarding sessions by interviewIds.",
        "description": "Expire onboarding sessions given by interviewIds array, and cleanerConfiguration parameter.\n",
        "operationId": "expireOnboardingSessionsByIds",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExpireInterviewDto"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/expire-interviews/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/expire-interviews.md"
      }
    },
    "/omni/device/stats": {
      "post": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Update device stats",
        "description": "Sends information about collected capture frame statistics",
        "operationId": "updateBehavioralStats",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BehavioralStatsRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/device-stats/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/device-stats.md"
      }
    },
    "/omni/delete/watchlist/single-record": {
      "post": {
        "tags": [
          "Custom watchlist"
        ],
        "summary": "Delete custom watchlist entry",
        "description": "Works with <Glossary>Admin Token</Glossary>.",
        "operationId": "deleteincodewatchlistrecord",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DeleteWatchlistRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/delete-watchlist-single-record/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/delete-watchlist-single-record.md"
      }
    },
    "/omni/delete/interviews": {
      "post": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Delete Multiple onboarding sessions with multiple options.",
        "description": "Delete all onboarding sessions by given array of interview ids. The endpoint is executed asynchronously.\nNote:\nRequires admin login token reference - /executive/log-in\nPlease, bear in mind that usage of this API endpoint for deletion of Customer Data will mean that Incode will no longer have access to it nor will be able to review or analyze any issue related to deleted Customer Data. After deletion, as Incode will not be able to retrieve the deleted Customer Data, any potential claims related to such data will be waived by Customer.\nFinally, for clarity purposes, Incode may continue to process information derived from Customer Data that has been deidentified, anonymized, and/or aggregated such that the data is no longer considered Personal Data under applicable Data Protection Laws and in a manner that does not identify individuals or Customer to improve its services and defend its legitimate interests.\n",
        "operationId": "cleanOnboardingSessionsByIds",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InterviewCleanupRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncDeletionTaskResponse"
                }
              }
            }
          }
        },
        "deprecated": true,
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/delete-interviews/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/delete-interviews.md"
      }
    },
    "/omni/credentials/mdl": {
      "post": {
        "tags": [],
        "summary": "Issue a device-bound mDL for the current interview",
        "description": "Builds credential claims from the interview identified by the access token and issues a device-bound ISO/IEC 18013-5 mDL bound to the supplied device public key.",
        "operationId": "issuemdl",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MdlIssuanceRequestDto"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MdlIssuanceResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/credentials-mdl/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/credentials-mdl.md"
      }
    },
    "/omni/conference/report-issue": {
      "post": {
        "tags": [
          "Video conference"
        ],
        "summary": "Report conference issue",
        "description": "An executive can report any issue by this call.",
        "operationId": "reportIssue",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReportIssueRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/conference-report-issue/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/conference-report-issue.md"
      }
    },
    "/omni/conference/photo": {
      "post": {
        "tags": [
          "Video conference"
        ],
        "summary": "Store conference photos",
        "description": "A bank executive can ask the customer to additionally capture his face or document. These will be stored in DB.",
        "operationId": "storePhotos",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ConfStoreRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/conference-photo/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/conference-photo.md"
      }
    },
    "/omni/conference/add/event": {
      "post": {
        "tags": [
          "Video conference"
        ],
        "summary": "Add conference event",
        "description": "Send (OpenTok) conference event. Any connection issue caught by webapp could be reported using this call.",
        "operationId": "addConferenceEvent",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ConferenceEvent"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/conference-add-event/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/conference-add-event.md"
      }
    },
    "/omni/code/verify": {
      "post": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Verify interview code",
        "description": "Verify interview code before connecting to video conference.",
        "operationId": "verifyInterviewCode",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VerifyInterviewCodeRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Custom error status:\n- 4014: Invalid interview code\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/code-verify/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/code-verify.md"
      }
    },
    "/omni/chat": {
      "post": {
        "tags": [
          "Video conference"
        ],
        "summary": "Send conference chat",
        "description": "Store conference chat. The executive should send the whole chat at the end of conference call (just before finish is called).\n",
        "operationId": "saveChat",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChatRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/chat/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/chat.md"
      }
    },
    "/omni/calculate-contract-nom151-signature": {
      "post": {
        "tags": [
          "Nom151"
        ],
        "summary": "Calculate contract Nom151 signature",
        "description": "This api endpoint calculates the Nom151 signature of an already signed contract and returns the signature.",
        "operationId": "calculateNom151Signature",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CalculateContractNom151SignatureRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtendedResponse"
                },
                "example": {
                  "success": true,
                  "sessionStatus": "Alive",
                  "additionalInformation": {
                    "signedDocumentNom151": "nom151 signature",
                    "signedDocumentBase64": "base64 of signed document",
                    "signedDocumentWithNomSignatureBase64": "base64 of signed contract with attached nom151 signature"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/calculate-contract-nom151-signature/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/calculate-contract-nom151-signature.md"
      }
    },
    "/omni/batch/auth-stats": {
      "post": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Insert authentications in batch",
        "description": "Inserts face authentications in batch.",
        "operationId": "batchAuthStats",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BatchAuthStatsRequest"
              },
              "example": {
                "data": [
                  {
                    "id": "6231ec685a378c0013e72641",
                    "photo": "base64 of photo",
                    "confidence": 100,
                    "timestamp": 1647444546006,
                    "sourceId": "identifier"
                  },
                  {
                    "id": "6231ec685a378c0013e72641",
                    "photo": "base64 of photo",
                    "confidence": 100,
                    "timestamp": 1647444546006,
                    "sourceId": "identifier"
                  }
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/batch-auth-stats/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/batch-auth-stats.md"
      }
    },
    "/omni/b2b/trust-graph/report": {
      "post": {
        "tags": [
          "Trust graph"
        ],
        "summary": "Add fraud candidate to the trust graph (B2B)",
        "description": "Adds a new fraud candidate to the trust graph for B2B based on the provided request data.",
        "operationId": "addFraudCandidateB2B",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FraudCandidateRequestB2BDto"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "x-incode-status": "undocumented"
      }
    },
    "/omni/authentication/verify": {
      "post": {
        "tags": [
          "Authentications"
        ],
        "summary": "Verify authentication attempt",
        "description": "Verify the authenticity of an authentication attempt.\nWorks with <Glossary>Admin Token</Glossary>.",
        "operationId": "verifyauthattempt",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AuthVerificationRequestDTO"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuthVerificationResponseDTO"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/authentication-verify/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/authentication-verify.md"
      }
    },
    "/omni/attach-stamp-on-annotation": {
      "post": {
        "tags": [
          "Document capture"
        ],
        "summary": "Attach stamp on annotation",
        "description": "Substitute stamps from interview to previously uploaded PDF contracts at all places with pdf text annotations. Annotations\nmust contain text with preselected values. Preselected values are:\n- NAME (NAME_STAMP),\n- ADDRESS (ADDRESS_STAMP),\n- DATE #ZoneId# #Format#,\n- AGE,\n- SEX,\n- DOB #Format#,\n- COUNTRY,\n- STATE,\n- PHONE,\n- TIME #ZoneId# #Format#,\n- SECOND_NAME*\n\nReplace parameter ZoneId with full size zone using time zones used in Java8 TimeDate API Replace parameter Format with format\nyou wish to display the time and date\n\nStamps are added in Helvetica, size 13. Endpoint is intended to be used as fluent api. One call to the api gives in\nresponses id of the signed document which can then be used in the subsequent call to continuously add another signature on a different annotation.\n",
        "operationId": "addStampToPdfOnAnnotation",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AttachStampOnAnnotationRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtendedResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/attach-stamp-on-annotation/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/attach-stamp-on-annotation.md"
      }
    },
    "/omni/attach-signature-to-pdf/v2": {
      "post": {
        "tags": [
          "Electronic signature"
        ],
        "summary": "Attach signature to multiple pdf documents",
        "description": "Attach signature from interview to previously uploaded PDF contracts at (x, y) coordinates with desired height to\ndesired page on pdf. Coordinates are relative to left bottom corner of page. Every document id can have multiple signature\nattached to it, hence the array of signature positions for every document.\n\nWhen the session is linked to an identity (successful face authentication, or an approved session) the DEFAULT\nsignature stored on that identity is used. The signature captured in the session itself is used only when the\nsession has no linked identity, or that identity has no stored signature.\n",
        "operationId": "addsignaturetopdffilev2",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AttachSignatureV2Request"
              },
              "example": {
                "includeSignedDocumentInResponse": true,
                "includeNom151SignatureInResponse": true,
                "includeSignedDocumentWithNom151InResponse": true,
                "includeCertificateDetailsInResponse": true,
                "signaturePositionsOnContracts": {
                  "e81cd044-98fd-47b0-b0c5-937b22b69977#contract1": [
                    {
                      "x": 10,
                      "y": 10,
                      "height": 10,
                      "pageNumber": 2,
                      "orientation": "ORIENTATION_NORMAL"
                    },
                    {
                      "x": 20,
                      "y": 30,
                      "height": 10,
                      "pageNumber": 1,
                      "orientation": "ORIENTATION_90_DEGREE"
                    }
                  ],
                  "1ffcd128-153f-40d4-a881-7c3362e58806#contract2": [
                    {
                      "x": 10,
                      "y": 10,
                      "height": 20,
                      "pageNumber": 2
                    },
                    {
                      "x": 20,
                      "y": 30,
                      "height": 20,
                      "pageNumber": 1
                    }
                  ],
                  "074355ff-81f5-4b9f-a6c6-eb41bdcaf9f1#contract3": [
                    {
                      "x": 10,
                      "y": 10,
                      "height": 30,
                      "pageNumber": 2
                    },
                    {
                      "x": 20,
                      "y": 30,
                      "height": 30,
                      "pageNumber": 1
                    }
                  ]
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtendedResponse"
                },
                "example": {
                  "success": true,
                  "sessionStatus": "Alive",
                  "additionalInformation": {
                    "signingDetails": {
                      "providedBy": "Advantage Security, S. de R.L. de C.V.",
                      "requestedBy": "Incode Technologies Inc.",
                      "policyValue": "2.16.484.101.10.316.2.1.1.2.",
                      "signingHash": "AHm8P/i2AnvdM8vKfVLWe5xCovA2v/7l3zmWc1+N4HE=",
                      "certificateSerial": "2C",
                      "signingTimestamp": "1651076647389"
                    },
                    "signedDocumentBase64": "base64 of pdf document",
                    "signedDocumentWithNomSignatureBase64": "base64 of pdf document with nom151"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/attach-signature-to-pdf-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/attach-signature-to-pdf-v2.md"
      }
    },
    "/omni/attach-signature-to-pdf": {
      "post": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Attach signature to pdf document",
        "description": "Attach signature from interview to supplied pdf at (x, y) coordinates with desired height to desired page on pdf.\nCoordinates are relative to left bottom corner of page.\n",
        "operationId": "addSignatureToPdfFile",
        "parameters": [
          {
            "name": "x",
            "in": "query",
            "description": "The x axis where to place the signature image (from the left bottom corner of page)",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "y",
            "in": "query",
            "description": "The y axis where to place the signature image (from the left bottom corner of page)",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "height",
            "in": "query",
            "description": "Height of the image when placed in the pdf, keeps aspect ratio.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "pageNumber",
            "in": "query",
            "description": "number of page on which to put the signature image (pages numbering start from 1, default value is 1)",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "Document to add signature to",
          "content": {
            "application/json": {
              "schema": {
                "type": "string",
                "format": "byte"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Stream of new pdf document file",
            "content": {
              "application/pdf": {}
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/pdf": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/attach-signature-to-pdf/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/attach-signature-to-pdf.md"
      }
    },
    "/omni/attach-signature-on-annotation": {
      "post": {
        "tags": [
          "Electronic signature"
        ],
        "summary": "Attach signature on annotation",
        "description": "Attach signature from interview to previously uploaded PDF contracts at all places annotated with text from request,\nwith desired height on pdf. Annotations must contain text with either preselected values, or alternative can be supplied.\nIf user wishes to use signature supplied during onboarding, DEFAULT signature type should be used.\n\nPreselected values are: DEFAULT, INITIALS, PATIENTS_SIGNATURE, NON_MEDICAL_SIGNATURE_1, NON_MEDICAL_SIGNATURE_2,\nMEDICAL_SIGNATURE_1, MEDICAL_SIGNATURE_2\n\nEndpoint is intended to be used as fluent api. One call to the api gives in responses id of the signed document which\ncan then be used in the subsequent call to continuously add another signature on a different annotation.\n\nFor the DEFAULT signature type, when the session is linked to an identity (successful face authentication,\nor an approved session) the DEFAULT signature stored on that identity is used. The signature captured in\nthe session itself is used only when the session has no linked identity, or that identity has no stored\nsignature. Any other signature type is always taken from the session.\n",
        "operationId": "addsignaturetopdfonannotation",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AttachSignatureOnAnnotationRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtendedResponse"
                },
                "example": {
                  "success": true,
                  "signedDocumentId": "new signed document ID",
                  "signedDocumentURL": "temporary URL to new signed document"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/attach-signature-on-annotation/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/attach-signature-on-annotation.md"
      }
    },
    "/omni/add/watchlist/single-record": {
      "post": {
        "tags": [
          "Custom watchlist"
        ],
        "summary": "Add custom watchlist entry",
        "description": "Works with <Glossary>Admin Token</Glossary>.",
        "operationId": "insertincodewatchlistrecord",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "Values of `idNumber`, `email`, `phone`,`imageBase64` must be unique. These fields are used to perform search\nin watchlist database. At least one of these must be supplied.\n",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InsertWatchlistRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddSingleWatchlistResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-watchlist-single-record/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-watchlist-single-record.md"
      }
    },
    "/omni/add/watchlist/session": {
      "post": {
        "tags": [
          "Custom watchlist"
        ],
        "summary": "Add custom watchlist entry from session",
        "description": "Works with <Glossary>Admin Token</Glossary>.",
        "operationId": "insertwatchlistrecordfromsession",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InsertSessionToWatchlistRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-watchlist-session/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-watchlist-session.md"
      }
    },
    "/omni/add/watchlist/identity": {
      "post": {
        "tags": [
          "Custom watchlist"
        ],
        "summary": "Add custom watchlist entry from identity",
        "description": "Works with <Glossary>Admin Token</Glossary>.",
        "operationId": "insertwatchlistrecordfromidentity",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InsertIdentityToWatchlistRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-watchlist-identity/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-watchlist-identity.md"
      }
    },
    "/omni/add/user-consent": {
      "post": {
        "tags": [
          "User consent"
        ],
        "summary": "Add user consent",
        "description": "Add user consent with title, content and status to session.",
        "operationId": "adduserconsent",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UserConsentRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-user-consent/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-user-consent.md"
      }
    },
    "/omni/add/qr-code-text": {
      "post": {
        "tags": [
          "Interview"
        ],
        "summary": "Add QR code raw text",
        "description": "Add QR code raw text to interview. It will be saved in customFields named 'qrCodeText', this fields needs to be present\nin organization's custom fields schema.\n",
        "operationId": "addqrcodetext",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddQrCodeTextRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-qr-code-text/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-qr-code-text.md"
      }
    },
    "/omni/add/phone": {
      "post": {
        "tags": [
          "Phone number input"
        ],
        "summary": "Add phone",
        "description": "Add phone to interview. Deprecated, use POST /phone instead.",
        "operationId": "addphone",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PhoneRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddPhoneResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "deprecated": true,
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-phone/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-phone.md"
      }
    },
    "/omni/add/name": {
      "post": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Add name",
        "description": "This endpoint is used for adding user's name for current onboarding session.",
        "operationId": "addName",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NameRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-name/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-name.md"
      }
    },
    "/omni/add/geolocation": {
      "post": {
        "tags": [
          "Geolocation"
        ],
        "summary": "Add geolocation",
        "description": "Send location to store in database, or send coordinates and fetch location and store it",
        "operationId": "addGeolocation",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReverseGeolocationRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-geolocation/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-geolocation.md"
      }
    },
    "/omni/add/front-second-id/v2": {
      "post": {
        "tags": [
          "Id capture"
        ],
        "summary": "Add front side of Second ID",
        "description": "This endpoint is used for storing front side of second id for further processing",
        "operationId": "addFrontSecondIdV2",
        "parameters": [
          {
            "name": "onlyFront",
            "in": "query",
            "description": "Flag stating if document is one-sided (like Passport). Default value is false, in case it is not sent.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/IdCaptureV2Request"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddIdResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error statuses:\n- 4019: Face not found\n- 1003: Face cropping failure\n- 4092: Image format is unsupported or the image is unreadable\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "503": {
            "description": "Image conversion temporarily unavailable; retry after the Retry-After header",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-front-second-id-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-front-second-id-v2.md"
      }
    },
    "/omni/add/front-id/v2": {
      "post": {
        "tags": [
          "Id capture"
        ],
        "summary": "Add front side of ID",
        "description": "This endpoint is used for storing front side of id for further processing. Image quality check is performed during that call.\nNumber of retries is not limited.\n\nOnce [process-id](#/Onboarding/processId) is finished, this endpoint cannot be called for retries.\n\n**Note: Front side of id should be uploaded before [back-side](#/Onboarding/addBackIdV2)**\n\n**Image requirements**: the smallest side of the image must be at least 200 px.\nA smaller image can pass this capture step, but [process-id](#/Onboarding/processId) rejects it with error status 4085 (\"ID image is too small.\").\nImages larger than 2048 px on the longest side are scaled down automatically.\n",
        "operationId": "addFrontIdV2",
        "parameters": [
          {
            "name": "onlyFront",
            "in": "query",
            "description": "Flag stating if document is one-sided (like Passport)",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "extractIdFace",
            "in": "query",
            "description": "When false, skips biometric face extraction and template creation from the front ID. Default true.",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": true
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "Front side of id. In case of passport, this should be page with all data about user.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/IdCaptureV2Request"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "In case there's some issue when calling the endpoint due to classification failed, an issue such as bad quality,\nor any of the fail reasons the response will always have the field:\n- classification\n- failReason\n- sharpness\n- glare\n- horizontalResolution\n\nWe recommend considering the call as failed if there's a failReason in the response or if the classification is false.\nPossible values for fail reason:\n- UNKNOWN_DOCUMENT_TYPE: document classification failed\n- WRONG_DOCUMENT_SIDE: can happen when uploading back side of id when front id is required or the other way around\n- WRONG_ONE_SIDED_DOCUMENT: uploading wrong document with only one side\n- WRONG_UNFOLDED_DOCUMENT: uploading unfolded document with unrecognizable sides\n- UNFOLDED_DOCUMENT_PAGE_MISMATCH: uploading unfolded document with mismatching sides\n- DOCUMENT_NOT_READABLE: document couldn't be read, probably due to image quality\n- UNABLE_TO_ALIGN_DOCUMENT: alignment failed\n- ID_TYPE_UNACCEPTABLE: invalid type of id\n- UNEXPECTED_ERROR_OCCURRED: unexpected error\n\nWhenever the classification is done successfully the fields that will always be present are:\n- classification\n- sharpness\n- glare\n- horizontalResolution\n- readability\n- typeOfId\n- sessionStatus\n\nThe remaining fields could be optional depending on the specific type of id and country of origin.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddIdResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error statuses:\n- 1003: Face cropping failure\n- 4004: Could not find user\n- 4019: Face not found\n- 4092: Image format is unsupported or the image is unreadable\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "503": {
            "description": "Image conversion temporarily unavailable; retry after the Retry-After header",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-front-id-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-front-id-v2.md"
      }
    },
    "/omni/add/fiscal-qr-url-image": {
      "post": {
        "tags": [
          "Fiscal qr url"
        ],
        "summary": "Add fiscal qr image",
        "description": "Upload a fiscal qr image as base64 to session. The data available in the url embedded in the qr will be available via the [Get fiscal qr url response](ref:getfiscalqrurlresponse) endpoint.\n(México only)\n",
        "operationId": "addfiscalqrimage",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Base64ImageOrImgUrlRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddFiscalQrUrlResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-fiscal-qr-url-image/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-fiscal-qr-url-image.md"
      }
    },
    "/omni/add/fiscal-qr-url": {
      "post": {
        "tags": [
          "Fiscal qr url"
        ],
        "summary": "Add fiscal qr url",
        "description": "Upload the url extracted from a fiscal qr code. Data from the given url will be available via the [Get fiscal qr url response](ref:getfiscalqrurlresponse) endpoint.\n(México only)\n",
        "operationId": "addfiscalqrurl",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddFiscalQrUrlRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddFiscalQrUrlResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-fiscal-qr-url/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-fiscal-qr-url.md"
      }
    },
    "/omni/add/fingerprints": {
      "post": {
        "tags": [],
        "summary": "Add fingerprints",
        "description": "Add fingerprints blobs and metadata to interview.",
        "operationId": "addFingerprints",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FingerprintsData"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Respuesta con validación de CURP",
            "content": {
              "application/json": {
                "examples": {
                  "Successful CURP Validation": {
                    "summary": "Successful CURP Validation",
                    "description": "Successful CURP Validation",
                    "value": {
                      "success": true,
                      "curp": "XXXX820814HDFABC01",
                      "sex": "MUJER",
                      "nationality": "MEX",
                      "result": "success",
                      "requestData": {
                        "name": "JUANA",
                        "firstLastName": "PEREZ",
                        "secondLastName": "LOPEZ",
                        "gender": "M",
                        "birthDate": "14/08/1982",
                        "state": "DF"
                      },
                      "transactionId": "transaction1234567890",
                      "renapo_valid": true,
                      "names": "JUANA",
                      "paternal_surname": "PEREZ",
                      "mothers_maiden_name": "LOPEZ",
                      "birthdate": "14/08/1982",
                      "entity_birth": "DF",
                      "probation_document": "1",
                      "probation_document_data": {
                        "foja": "",
                        "numEntidadReg": "09",
                        "libro": "",
                        "NumRegExtranjeros": "",
                        "cveEntidadNac": "DF",
                        "numActa": "00001",
                        "CRIP": "",
                        "tomo": "",
                        "cveEntidadEmisora": "",
                        "anioReg": "1982",
                        "cveMunicipioReg": "001",
                        "FolioCarta": ""
                      },
                      "status_curp": "RCN",
                      "deceasedStatus": "ALIVE"
                    }
                  },
                  "CURP not found": {
                    "summary": "CURP not found",
                    "description": "CURP not found",
                    "value": {
                      "success": false,
                      "error": {
                        "codigoError": "06",
                        "resultCURPS": {
                          "numEntidadReg": "",
                          "apellidoPaterno": "",
                          "libro": "",
                          "statusCurp": "",
                          "cveEntidadNac": "",
                          "numActa": "",
                          "CRIP": "",
                          "tomo": "",
                          "cveEntidadEmisora": "",
                          "FolioCertificado": "",
                          "anioReg": "",
                          "cveMunicipioReg": "",
                          "FolioCarta": "",
                          "CURP": "",
                          "apellidoMaterno": "",
                          "nombres": "",
                          "nacionalidad": "",
                          "foja": "",
                          "NumRegExtranjeros": "",
                          "fechNac": "",
                          "sexo": "",
                          "docProbatorio": ""
                        },
                        "statusOper": "NO EXITOSO",
                        "tipoError": "01",
                        "sessionID": "xF1hOzrjnJU36wDsPl83KlkDpE-eb7tM1Oe2bjI0jrbPJv-mU3IF!1562844632!1749682961123",
                        "message": "La CURP no se encuentra en la base de datos"
                      },
                      "result": "Not valid request: La CURP no se encuentra en la base de datos code: 06",
                      "transactionId": "xF1hOzrjnJU36wDsPl83KlkDpE-eb7tM1Oe2bjI0jrbPJv-mU3IF!1562844632!1749682961123",
                      "renapo_valid": false
                    }
                  },
                  "Daily Rate Limit Exceeded": {
                    "summary": "Daily Rate Limit Exceeded",
                    "description": "Daily Rate Limit Exceeded",
                    "value": {
                      "success": false,
                      "error": {
                        "codigoError": "02",
                        "tipoError": "99",
                        "message": "SE HA ALCANZADO EL LIMITE DE TRANSACCIONES PERMITIDAS POR DIA"
                      },
                      "result": "SE HA ALCANZADO EL LIMITE DE TRANSACCIONES PERMITIDAS POR DIA",
                      "renapo_valid": false
                    }
                  },
                  "Curp status not acceptable": {
                    "summary": "Curp status not acceptable",
                    "description": "Curp status not acceptable",
                    "value": {
                      "success": false,
                      "sessionStatus": "Alive",
                      "error": {
                        "codigoError": "02",
                        "tipoError": "99",
                        "message": "Curp status is not acceptable."
                      },
                      "result": "Error: STATUS CURP not acceptable.",
                      "renapo_valid": false
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal error during CURP validation."
          },
          "504": {
            "description": "The request to validate the CURP exceeded the allowed time limit"
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-fingerprints/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-fingerprints.md"
      }
    },
    "/omni/add/face/third-party": {
      "post": {
        "tags": [
          "Face capture"
        ],
        "summary": "Add face/Selfie image",
        "description": "Uploads selfie image for onboarding session. Response will contain data regarding liveness — if that is the photo of a real person.\nNumber of retries is not limited.\n\n**Note**: After selfie and front-id are uploaded, endpoint for comparing faces process-face on those two images can be called.\n\nIt is required that person is alone on the photo.\n",
        "operationId": "addFaceByThirdParty",
        "parameters": [
          {
            "name": "imageType",
            "in": "query",
            "description": "Image type. Default is selfie",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "selfie",
                "videoSelfie",
                "id",
                "nfc"
              ]
            }
          },
          {
            "name": "captureType",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "AUTO",
                "MANUAL",
                "NATIVE",
                "UPLOAD"
              ]
            }
          },
          {
            "name": "externalCaptureId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "recordingId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddFaceRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddFaceResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error statuses:\n- 4010: More than one face detected\n- 4019: Face not found\n- 4077: Selfie image has low quality\n- 4078: Selfie face is occluded or partially covered\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-face-third-party/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-face-third-party.md"
      }
    },
    "/omni/add/email": {
      "post": {
        "tags": [
          "Email input"
        ],
        "summary": "Add email",
        "description": "Add email to interview.",
        "operationId": "addemail",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EmailRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-email/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-email.md"
      }
    },
    "/omni/add/document/v3": {
      "post": {
        "tags": [
          "Document capture"
        ],
        "summary": "Add document V3",
        "description": "Upload document image gathered and store data.",
        "operationId": "adddocumentv3",
        "parameters": [
          {
            "name": "type",
            "in": "query",
            "description": "- **signature**: Upload user's digital signature. This can be later fetched in get images endpoint.\n- **document**: Upload user's proof of address document. This can be later fetched in get images endpoint.\n- **addressStatement**: (Legacy) Upload user's proof of address document. Used for backward compatibility. Use type 'document' instead.\n- **contract**: Upload contract image.\n- **v5cMultiPageLogbook**: Upload single page (image) of V5C logbook multi page document.\n- **carInvoice**: Upload single page (image) of two pages car invoice document.\n- **financeSettlement**: Upload single page (image) of two pages finance settlement letter.\n- **w8Ben**: Upload IRS W-8BEN form as a single page image or a PDF.\n- **w8BenE**: Upload one page (image) of the multi page IRS W-8BEN-E form, or the complete form as a PDF. Finish with the finalize document endpoint.\n",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "signature",
                "document",
                "contract",
                "v5cMultiPageLogbook",
                "carInvoice",
                "financeSettlement",
                "w8Ben",
                "w8BenE"
              ]
            }
          },
          {
            "name": "title",
            "in": "query",
            "description": "Only if type is contract. Title of contract.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "format",
            "in": "query",
            "description": "Only if type is document. Possible values are image (jpg and png supported) or pdf. Default is image.",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "image",
                "pdf"
              ]
            }
          },
          {
            "name": "processingMethod",
            "in": "query",
            "description": "Only applicable for some documents. Possible values are sync and async. Default is sync.",
            "required": false,
            "schema": {
              "type": "string",
              "default": "sync",
              "enum": [
                "sync",
                "async"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddDocumentRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddDocumentResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-document-v3/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-document-v3.md"
      }
    },
    "/omni/add/document/v2": {
      "post": {
        "tags": [
          "Document capture"
        ],
        "summary": "Add document V2",
        "description": "Upload document image and store data.",
        "operationId": "adddocumentv2",
        "parameters": [
          {
            "name": "type",
            "in": "query",
            "description": "- **signature**: Upload user's digital signature. This can be later fetched in get images endpoint.\n- **document**: Upload user's proof of address document. This can be later fetched in get images endpoint.\n- **addressStatement**: (Legacy) Upload user's proof of address document. Used for backward compatibility. Use type 'document' instead.\n- **contract**: Upload contract image.\n",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "signature",
                "document",
                "contract"
              ]
            }
          },
          {
            "name": "title",
            "in": "query",
            "description": "Only if type is contract. Title of contract.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "format",
            "in": "query",
            "description": "Only if type is document. Possible values are image (jpg and png supported) or pdf. Default is image.",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "image",
                "pdf"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Base64ImageOrImgUrlRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-document-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-document-v2.md"
      }
    },
    "/omni/add/document/async": {
      "post": {
        "tags": [
          "Document capture"
        ],
        "summary": "Add document asynchronously",
        "description": "Upload document image and store data asynchronously.",
        "operationId": "adddocumentasync",
        "parameters": [
          {
            "name": "type",
            "in": "query",
            "description": "- **signature**: Upload user's digital signature. This can be later fetched in get images endpoint.\n- **document**: Upload user's proof of address document. This can be later fetched in get images endpoint.\n- **addressStatement**: (Legacy) Upload user's proof of address document. Used for backward compatibility. Use type 'document' instead.\n- **contract**: Upload contract image.\n",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "signature",
                "document",
                "contract"
              ]
            }
          },
          {
            "name": "title",
            "in": "query",
            "description": "Only if type is contract. Title of contract.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "format",
            "in": "query",
            "description": "Only if type is document. Possible values are image (jpg and png supported) or pdf. Default is image.",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "image",
                "pdf"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Base64ImageOrImgUrlRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-document-async/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-document-async.md"
      }
    },
    "/omni/add/document-id": {
      "post": {
        "tags": [
          "Id capture"
        ],
        "summary": "Add document id",
        "description": "Upload document identifier. For Mexican id it is cic from the back of id.",
        "operationId": "addDocumentId",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DocumentIdentifierRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-document-id/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-document-id.md"
      }
    },
    "/omni/add/document": {
      "post": {
        "tags": [
          "Document capture"
        ],
        "summary": "Add document",
        "description": "Upload document image and store data.\n\n**Note**: Make sure to put the 'Content-Type' header as 'Content-Type: image/jpeg' or 'Content-Type: image/png'.\n",
        "operationId": "addDocument",
        "parameters": [
          {
            "name": "type",
            "in": "query",
            "description": "- **signature**: Upload user's digital signature. This can be later fetched in get images endpoint.\n- **document**: Upload user's proof of address document. This can be later fetched in get images endpoint.\n- **addressStatement**: (Legacy) Upload user's proof of address document. Used for backward compatibility. Use type 'document' instead.\n- **contract**: Upload contract image.\n",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "signature",
                "document",
                "contract"
              ]
            }
          },
          {
            "name": "title",
            "in": "query",
            "description": "Only if type is contract. Title of contract.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "format",
            "in": "query",
            "description": "Only if type is document. Possible values are image (jpg and png supported) or pdf. Default is image.",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "image",
                "pdf"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "Binary Image.",
          "content": {
            "application/json": {
              "schema": {
                "type": "string",
                "format": "byte"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-document/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-document.md"
      }
    },
    "/omni/add/diagnostics-data": {
      "post": {
        "tags": [],
        "summary": "Forward diagnostics data",
        "description": "Accepts an encrypted TrueSight diagnostics envelope from the SDK, enriches it with server-resolved clientId and environment, and forwards it to TrueSight.",
        "operationId": "addDiagnosticsData",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DiagnosticsEnvelopeRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DiagnosticsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-diagnostics-data/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-diagnostics-data.md"
      }
    },
    "/omni/add/device-fingerprint-signals": {
      "post": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Add device fingerprint signals",
        "description": "Records signals (device, network, behaviour, or PID) captured during an interview event.\nFor a PID signal with deviceHashRequested set, the response returns the device hash with its\nalgorithm name and version.",
        "operationId": "addDeviceFingerprintSignals",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DeviceFingerprintSignalsRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeviceFingerprintSignalsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-device-fingerprint-signals/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-device-fingerprint-signals.md"
      }
    },
    "/omni/add/device-fingerprint": {
      "post": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Add device fingerprint",
        "description": "Sends information about device from which endpoint is called",
        "operationId": "addDeviceFingerprint",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DeviceFingerprintRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddDeviceFingerprintResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-device-fingerprint/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-device-fingerprint.md"
      }
    },
    "/omni/add/custom-fields": {
      "post": {
        "tags": [
          "Custom fields"
        ],
        "summary": "Add custom fields",
        "description": "This endpoint is used for adding custom fields to current onboarding session.\nThe key must match one of the keys that are defined for the Organization, and the value must be of the type\nthat is defined for the corresponding key.\n",
        "operationId": "addcustomfields",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomFieldsRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-custom-fields/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-custom-fields.md"
      }
    },
    "/omni/add/curp/v2": {
      "post": {
        "tags": [
          "Curp validation"
        ],
        "summary": "Add curp v2",
        "description": "Add CURP and validation result based on a person data.\n",
        "operationId": "addcurp2",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "Valid values for state are the ones listed by renapo in this link:\n[https://es.wikipedia.org/wiki/Plantilla:Abreviaciones_de_los_estados_de_México](https://es.wikipedia.org/wiki/Plantilla:Abreviaciones_de_los_estados_de_México)\n",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CurpDataRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Respuesta con validación de CURP",
            "content": {
              "application/json": {
                "examples": {
                  "Successful CURP Validation": {
                    "summary": "Successful CURP Validation",
                    "description": "Successful CURP Validation",
                    "value": {
                      "success": true,
                      "curp": "XXXX820814HDFABC01",
                      "sex": "MUJER",
                      "nationality": "MEX",
                      "result": "success",
                      "requestData": {
                        "name": "JUANA",
                        "firstLastName": "PEREZ",
                        "secondLastName": "LOPEZ",
                        "gender": "M",
                        "birthDate": "14/08/1982",
                        "state": "DF"
                      },
                      "transactionId": "transaction1234567890",
                      "renapo_valid": true,
                      "names": "JUANA",
                      "paternal_surname": "PEREZ",
                      "mothers_maiden_name": "LOPEZ",
                      "birthdate": "14/08/1982",
                      "entity_birth": "DF",
                      "probation_document": "1",
                      "probation_document_data": {
                        "foja": "",
                        "numEntidadReg": "09",
                        "libro": "",
                        "NumRegExtranjeros": "",
                        "cveEntidadNac": "DF",
                        "numActa": "00001",
                        "CRIP": "",
                        "tomo": "",
                        "cveEntidadEmisora": "",
                        "anioReg": "1982",
                        "cveMunicipioReg": "001",
                        "FolioCarta": ""
                      },
                      "status_curp": "RCN",
                      "deceasedStatus": "ALIVE"
                    }
                  },
                  "CURP not found": {
                    "summary": "CURP not found",
                    "description": "CURP not found",
                    "value": {
                      "success": false,
                      "error": {
                        "codigoError": "06",
                        "resultCURPS": {
                          "numEntidadReg": "",
                          "apellidoPaterno": "",
                          "libro": "",
                          "statusCurp": "",
                          "cveEntidadNac": "",
                          "numActa": "",
                          "CRIP": "",
                          "tomo": "",
                          "cveEntidadEmisora": "",
                          "FolioCertificado": "",
                          "anioReg": "",
                          "cveMunicipioReg": "",
                          "FolioCarta": "",
                          "CURP": "",
                          "apellidoMaterno": "",
                          "nombres": "",
                          "nacionalidad": "",
                          "foja": "",
                          "NumRegExtranjeros": "",
                          "fechNac": "",
                          "sexo": "",
                          "docProbatorio": ""
                        },
                        "statusOper": "NO EXITOSO",
                        "tipoError": "01",
                        "sessionID": "xF1hOzrjnJU36wDsPl83KlkDpE-eb7tM1Oe2bjI0jrbPJv-mU3IF!1562844632!1749682961123",
                        "message": "La CURP no se encuentra en la base de datos"
                      },
                      "result": "Not valid request: La CURP no se encuentra en la base de datos code: 06",
                      "transactionId": "xF1hOzrjnJU36wDsPl83KlkDpE-eb7tM1Oe2bjI0jrbPJv-mU3IF!1562844632!1749682961123",
                      "renapo_valid": false
                    }
                  },
                  "Daily Rate Limit Exceeded": {
                    "summary": "Daily Rate Limit Exceeded",
                    "description": "Daily Rate Limit Exceeded",
                    "value": {
                      "success": false,
                      "error": {
                        "codigoError": "02",
                        "tipoError": "99",
                        "message": "SE HA ALCANZADO EL LIMITE DE TRANSACCIONES PERMITIDAS POR DIA"
                      },
                      "result": "SE HA ALCANZADO EL LIMITE DE TRANSACCIONES PERMITIDAS POR DIA",
                      "renapo_valid": false
                    }
                  },
                  "Curp status not acceptable": {
                    "summary": "Curp status not acceptable",
                    "description": "Curp status not acceptable",
                    "value": {
                      "success": false,
                      "sessionStatus": "Alive",
                      "error": {
                        "codigoError": "02",
                        "tipoError": "99",
                        "message": "Curp status is not acceptable."
                      },
                      "result": "Error: STATUS CURP not acceptable.",
                      "renapo_valid": false
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal error during CURP validation."
          },
          "504": {
            "description": "The request to validate the CURP exceeded the allowed time limit"
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-curp-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-curp-v2.md"
      }
    },
    "/omni/add/curp": {
      "post": {
        "tags": [
          "Curp validation"
        ],
        "summary": "Add curp",
        "description": "Add curp and the validation process result to interview.",
        "operationId": "addcurp",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddCurpRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Respuesta con validación de CURP",
            "content": {
              "application/json": {
                "examples": {
                  "Successful CURP Validation": {
                    "summary": "Successful CURP Validation",
                    "description": "Successful CURP Validation",
                    "value": {
                      "success": true,
                      "curp": "XXXX820814HDFABC01",
                      "sex": "MUJER",
                      "nationality": "MEX",
                      "result": "success",
                      "requestData": {
                        "name": "JUANA",
                        "firstLastName": "PEREZ",
                        "secondLastName": "LOPEZ",
                        "gender": "M",
                        "birthDate": "14/08/1982",
                        "state": "DF"
                      },
                      "transactionId": "transaction1234567890",
                      "renapo_valid": true,
                      "names": "JUANA",
                      "paternal_surname": "PEREZ",
                      "mothers_maiden_name": "LOPEZ",
                      "birthdate": "14/08/1982",
                      "entity_birth": "DF",
                      "probation_document": "1",
                      "probation_document_data": {
                        "foja": "",
                        "numEntidadReg": "09",
                        "libro": "",
                        "NumRegExtranjeros": "",
                        "cveEntidadNac": "DF",
                        "numActa": "00001",
                        "CRIP": "",
                        "tomo": "",
                        "cveEntidadEmisora": "",
                        "anioReg": "1982",
                        "cveMunicipioReg": "001",
                        "FolioCarta": ""
                      },
                      "status_curp": "RCN",
                      "deceasedStatus": "ALIVE"
                    }
                  },
                  "CURP not found": {
                    "summary": "CURP not found",
                    "description": "CURP not found",
                    "value": {
                      "success": false,
                      "error": {
                        "codigoError": "06",
                        "resultCURPS": {
                          "numEntidadReg": "",
                          "apellidoPaterno": "",
                          "libro": "",
                          "statusCurp": "",
                          "cveEntidadNac": "",
                          "numActa": "",
                          "CRIP": "",
                          "tomo": "",
                          "cveEntidadEmisora": "",
                          "FolioCertificado": "",
                          "anioReg": "",
                          "cveMunicipioReg": "",
                          "FolioCarta": "",
                          "CURP": "",
                          "apellidoMaterno": "",
                          "nombres": "",
                          "nacionalidad": "",
                          "foja": "",
                          "NumRegExtranjeros": "",
                          "fechNac": "",
                          "sexo": "",
                          "docProbatorio": ""
                        },
                        "statusOper": "NO EXITOSO",
                        "tipoError": "01",
                        "sessionID": "xF1hOzrjnJU36wDsPl83KlkDpE-eb7tM1Oe2bjI0jrbPJv-mU3IF!1562844632!1749682961123",
                        "message": "La CURP no se encuentra en la base de datos"
                      },
                      "result": "Not valid request: La CURP no se encuentra en la base de datos code: 06",
                      "transactionId": "xF1hOzrjnJU36wDsPl83KlkDpE-eb7tM1Oe2bjI0jrbPJv-mU3IF!1562844632!1749682961123",
                      "renapo_valid": false
                    }
                  },
                  "Daily Rate Limit Exceeded": {
                    "summary": "Daily Rate Limit Exceeded",
                    "description": "Daily Rate Limit Exceeded",
                    "value": {
                      "success": false,
                      "error": {
                        "codigoError": "02",
                        "tipoError": "99",
                        "message": "SE HA ALCANZADO EL LIMITE DE TRANSACCIONES PERMITIDAS POR DIA"
                      },
                      "result": "SE HA ALCANZADO EL LIMITE DE TRANSACCIONES PERMITIDAS POR DIA",
                      "renapo_valid": false
                    }
                  },
                  "Curp status not acceptable": {
                    "summary": "Curp status not acceptable",
                    "description": "Curp status not acceptable",
                    "value": {
                      "success": false,
                      "sessionStatus": "Alive",
                      "error": {
                        "codigoError": "02",
                        "tipoError": "99",
                        "message": "Curp status is not acceptable."
                      },
                      "result": "Error: STATUS CURP not acceptable.",
                      "renapo_valid": false
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal error during CURP validation."
          },
          "504": {
            "description": "The request to validate the CURP exceeded the allowed time limit"
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/curp-validation-error-codes/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/curp-validation-error-codes.md"
      }
    },
    "/omni/add/conference/notes": {
      "post": {
        "tags": [
          "Video conference"
        ],
        "summary": "Add notes",
        "description": "This endpoint is used for adding notes for interview/session.",
        "operationId": "addNotes",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddNotesRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-conference-notes/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-conference-notes.md"
      }
    },
    "/omni/add/notes": {
      "post": {
        "tags": [
          "Video conference"
        ],
        "summary": "Add notes",
        "description": "This endpoint is used for adding notes for interview/session.",
        "operationId": "addNotes_1",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddNotesRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-notes/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-notes.md"
      }
    },
    "/omni/add/conference/feedback": {
      "post": {
        "tags": [
          "Video conference"
        ],
        "summary": "Add conference feedback",
        "description": "This endpoint is used for adding conference feedback for the interview/session.",
        "operationId": "addConferenceFeedback",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddConferenceFeedback"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-conference-feedback/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-conference-feedback.md"
      }
    },
    "/omni/add/conference-module": {
      "post": {
        "tags": [
          "Video conference"
        ],
        "summary": "Add conference module",
        "description": "Add conference module with name, url and icon (base64).",
        "operationId": "addConferenceModule",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddConferenceModuleRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-conference-module/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-conference-module.md"
      }
    },
    "/omni/add/conference-consent": {
      "post": {
        "tags": [
          "Video conference"
        ],
        "summary": "Save user consent",
        "description": "Save information indicating that user has accepted terms and conditions and other checks on conference.",
        "operationId": "addConferenceConsent",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "description": "ID of interview for which consent needs to be given.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ConferenceConsentRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-conference-consent/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-conference-consent.md"
      }
    },
    "/omni/add/barcode/v3": {
      "post": {
        "tags": [
          "Id capture"
        ],
        "summary": "Add Base64 Barcode",
        "description": "Add Base64 barcode and parse it to interview.",
        "operationId": "addbarcodev3",
        "parameters": [
          {
            "name": "processId",
            "in": "query",
            "description": "Flag stating if id validation should be automatically performed",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "Barcode V2 request.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BarcodeV2Request"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Response:\n- forceFrontIdCapture: Boolean. Flag that signals if front id capture must be executed after barcode being added.\n- sessionStatus: SessionStatus. Session status\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddBarcodeResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-barcode-v3/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-barcode-v3.md"
      }
    },
    "/omni/add/barcode/v2": {
      "post": {
        "tags": [
          "Id capture"
        ],
        "summary": "Add Base64 Barcode",
        "description": "Add Base64 barcode and parse it to interview.",
        "operationId": "addbarcodev2",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BarcodeV2Request"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-barcode-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-barcode-v2.md"
      }
    },
    "/omni/add/barcode": {
      "post": {
        "tags": [
          "Id capture"
        ],
        "summary": "Add Barcode",
        "description": "Add raw barcode and parse it to interview.",
        "operationId": "addbarcode",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BarcodeRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-barcode/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-barcode.md"
      }
    },
    "/omni/add/back-second-id/v2": {
      "post": {
        "tags": [
          "Id capture"
        ],
        "summary": "Add back side of Second ID",
        "description": "Image quality check is performed during that call. Number of retries is not limited. Once id processing is finished,\nthis endpoint cannot be called for retries. Front side of id should be uploaded before back side. In case of passport,\nthis endpoint should not be called.\n",
        "operationId": "addBackSecondIdV2",
        "parameters": [
          {
            "name": "captureType",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "AUTO",
                "MANUAL",
                "NATIVE",
                "UPLOAD"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/IdCaptureV2Request"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddIdResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error statuses:\n- 4092: Image format is unsupported or the image is unreadable\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "503": {
            "description": "Image conversion temporarily unavailable; retry after the Retry-After header",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-back-second-id-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-back-second-id-v2.md"
      }
    },
    "/omni/add/back-id/v2": {
      "post": {
        "tags": [
          "Id capture"
        ],
        "summary": "Add back side of ID",
        "description": "This endpoint is used for storing back side of id for further processing. Image quality check is performed during that call.\nNumber of retries is not limited.\n\nOnce [process-id](#/Onboarding/processId) is finished, this endpoint cannot be called for retries.\n\n**Note**: Front-side of id should be uploaded before back side.\n\nIn case of passport or only front sided documents, this endpoint should not be called.\n",
        "operationId": "addBackIdV2",
        "parameters": [
          {
            "name": "retry",
            "in": "query",
            "description": "Flag stating that this is retry attempt for add/back-id",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "description": "Back side of id",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/IdCaptureV2Request"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "In case there's some issue when calling the endpoint due to classification failed, an issue such as bad quality,\nor any of the fail reasons the response will always have the field:\n- classification\n- failReason\n- sharpness\n- glare\n- horizontalResolution\n\nWe recommend considering the call as failed if there's a failReason in the response or if the classification is false.\nPossible values for fail reason:\n- UNKNOWN_DOCUMENT_TYPE: document classification failed\n- WRONG_DOCUMENT_SIDE: can happen when uploading back side of id when front id is required or the other way around\n- WRONG_ONE_SIDED_DOCUMENT: uploading wrong document with only one side\n- WRONG_UNFOLDED_DOCUMENT: uploading unfolded document with unrecognizable sides\n- UNFOLDED_DOCUMENT_PAGE_MISMATCH: uploading unfolded document with mismatching sides\n- DOCUMENT_NOT_READABLE: document couldn't be read, probably due to image quality\n- UNABLE_TO_ALIGN_DOCUMENT: alignment failed\n- ID_TYPE_UNACCEPTABLE: invalid type of id\n- UNEXPECTED_ERROR_OCCURRED: unexpected error\n\nWhenever the classification is done successfully the fields that will always be present are:\n- classification\n- sharpness\n- glare\n- horizontalResolution\n- readibility\n- typeOfId\n- sessionStatus\n\nThe remaining fields could be optional depending on the specific type of id and country of origin.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AddIdResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error statuses:\n- 4004: Could not find user\n- 5003: Unsatisfied image size\n- 4092: Image format is unsupported or the image is unreadable\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "503": {
            "description": "Image conversion temporarily unavailable; retry after the Retry-After header",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-back-id-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-back-id-v2.md"
      }
    },
    "/omni/add/address-statement/v2": {
      "post": {
        "tags": [
          "Proof of address capture"
        ],
        "summary": "Add proof of address v2",
        "description": "Add a proof of address statement as a base64 string. OCR data from statement will be automatically extracted",
        "operationId": "addproofofaddressv2",
        "parameters": [
          {
            "name": "format",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "image",
                "pdf"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Base64ImageRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-address-statement-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-address-statement-v2.md"
      }
    },
    "/omni/add/address-statement": {
      "post": {
        "tags": [
          "Proof of address capture"
        ],
        "summary": "Add proof of address",
        "description": "Add a proof of address statement as a blob. OCR data from statement will be automatically extracted",
        "operationId": "addproofofaddress",
        "parameters": [
          {
            "name": "format",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "image",
                "pdf"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "string",
                "format": "byte"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/add-address-statement/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/add-address-statement.md"
      }
    },
    "/omni/1to1/v2/identify": {
      "post": {
        "tags": [
          "Login"
        ],
        "summary": "Face Authentication 1:1",
        "description": "Authenticate existing user, by comparing base64 image from request and user's existing face template. User is first found\nin DB by any of criteria from request: uuid, externalId, deviceFingerprintHash, phone or email (in that order). At least one of\ncriteria parameter must be sent in request. In case face doesn't match error response is returned with custom error code and message.\n",
        "operationId": "oneToOneIdentify",
        "parameters": [
          {
            "name": "returnIPDeviceLocation",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OneToOneIdentifyCustomerRequestV2"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "- customerId: String. Id of authenticated user.\n- token: String. Token bound to the customerId of authenticated user.\n- interviewId: String. Id of the session where authenticated user got approved.\n- interviewToken: String. Token bound to the session identified with interviewId.\n- transactionId: String. Authentication attempt identifier.\n- faceMatch: Boolean. Flag indicating if user's face matched.\n- spoofAttempt: Boolean. Flag indicating if this was spoof attempt.\n- secondFactor: Boolean. Always false for 1:1.\n- overallScore: Float. Overall score search, value form 0 to 100.\n- overallStatus: String. Overall status search PASS or FAIL.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuthenticationAttemptResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error status:\n- 4004: Non existing customer.\n- 4005: Spoof attempt detected.\n- 4015: User is not recognized.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "x-incode-status": "undocumented"
      }
    },
    "/omni/1to1/identify": {
      "post": {
        "tags": [
          "Login"
        ],
        "summary": "Face Authentication 1:1",
        "description": "Authenticate existing user, by comparing base64 image from request and user's existing face template. User is first found\nin DB by any of criteria from request: uuid, externalId, deviceFingerprintHash, phone or email (in that order). At least one of\ncriteria parameter must be sent in request. In case face doesn't match error response is returned with custom error code and message.\n",
        "operationId": "oneToOneIdentify_1",
        "parameters": [
          {
            "name": "returnIPDeviceLocation",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OneToOneIdentifyCustomerRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "- customerId: String. Id of authenticated user.\n- token: String. Token bound to the customerId of authenticated user.\n- interviewId: String. Id of the session where authenticated user got approved.\n- interviewToken: String. Token bound to the session identified with interviewId.\n- transactionId: String. Authentication attempt identifier.\n- faceMatch: Boolean. Flag indicating if user's face matched.\n- spoofAttempt: Boolean. Flag indicating if this was spoof attempt.\n- secondFactor: Boolean. Always false for 1:1.\n- overallScore: Float. Overall score search, value form 0 to 100.\n- overallStatus: String. Overall status search PASS or FAIL.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuthenticationAttemptResponse"
                }
              }
            }
          },
          "400": {
            "description": "Custom error status:\n- 4004: Non existing customer.\n- 4005: Spoof attempt detected.\n- 4015: User is not recognized.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "x-incode-status": "undocumented"
      }
    },
    "/omni/identity/{customerId}/sessions": {
      "get": {
        "tags": [
          "Organization"
        ],
        "summary": "Fetch all passed onboardings for the same person",
        "description": "Get all passed onboardings for the same person",
        "operationId": "getcustomersessions",
        "parameters": [
          {
            "name": "customerId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Interview"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/identity-sessions/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/identity-sessions.md"
      }
    },
    "/omni/identity/{customerId}/sessionIds": {
      "get": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Fetch all passed onboardings ids for the same person",
        "description": "Get all passed onboardings ids for the same person",
        "operationId": "getCustomerSessionIds",
        "parameters": [
          {
            "name": "customerId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerSessionIdsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/identity-sessionids/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/identity-sessionids.md"
      }
    },
    "/omni/b2b/v1/sessions/listing": {
      "get": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch session listing",
        "description": "Fetch onboarding sessions listing.",
        "operationId": "b2bSessionListing",
        "parameters": [
          {
            "name": "loginHint",
            "in": "query",
            "description": "Login hint to search onboarding sessions by (e.g. email).",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1
            }
          },
          {
            "name": "maxItems",
            "in": "query",
            "description": "Maximum number of items to retrieve (has to be positive). Optional, defaults to 10.",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 10
            }
          },
          {
            "name": "sessionScore",
            "in": "query",
            "description": "Filter by session score: PASS matches OK and MANUAL_OK, FAIL matches FAIL and MANUAL_FAIL. Optional.",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "PASS",
                "FAIL"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SessionListingDto"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKeyAuth": [],
            "BearerAuth": []
          }
        ],
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/b2b-v1-sessions-listing/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/b2b-v1-sessions-listing.md"
      }
    },
    "/omni/b2b/v1/identities/{id}": {
      "get": {
        "tags": [
          "Identities"
        ],
        "summary": "Fetch Identity data",
        "description": "Fetches data associated with identity, which was gathered in onboarding.\nWorks with <Glossary>Admin Token</Glossary>.",
        "operationId": "identitydata",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FetchIdentityDataResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/b2b-v1-identities/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/b2b-v1-identities.md"
      }
    },
    "/omni/b2b/v1/devices/info": {
      "get": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch device info list",
        "description": "Fetch all device information entries associated with the given onboarding Session.",
        "operationId": "b2bDeviceInfo",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Represents Session id for which device data are requested.",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/DeviceInfoResponse"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKeyAuth": [],
            "BearerAuth": []
          }
        ],
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/b2b-v1-devices-info/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/b2b-v1-devices-info.md"
      }
    },
    "/api/fetch/ine": {
      "get": {
        "tags": [
          "API validations"
        ],
        "summary": "Fetch INE scraping results",
        "description": "Fetch the results from [/api/validate/ine](#/API%20Validations/validateIne). The recommended wait time is 20 sec and retrying every 5 sec after that.\n",
        "operationId": "fetchIne",
        "parameters": [
          {
            "name": "idResults",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "scrapingStatus possible values are:\n- IN_PROGRESS: service hasn't finished and should retry in 5 seconds.\n- FINISHED: scrapping service finished and we got either a successful response or an error such as curp not found.\n- ERROR: scrapping service had an unhandled error, another attempt should be sent to validate curp.\n\nIf INE is not found or an error occurs (such as service being in maintenance) then the success field will be false\nand the field resultDetails will have additional information.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IneResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-fetch-ine/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-fetch-ine.md"
      }
    },
    "/api/fetch/curp/v3": {
      "get": {
        "tags": [
          "API validations"
        ],
        "summary": "Fetch CURP scraping results",
        "description": "Fetch the results from [/api/validate/curp/v3](#/API%20Validations/validateCurp3). The recommended wait time is 25 secs and retrying every 5 secs after that.\n",
        "operationId": "fetchCurp3",
        "parameters": [
          {
            "name": "idResults",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CurpResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/api-fetch-curp-v3/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/api-fetch-curp-v3.md"
      }
    },
    "/omni/verification/async/{referenceId}": {
      "get": {
        "tags": [
          "Ekyb"
        ],
        "summary": "Get async vendor verification status/result",
        "description": "Retrieves the status and persisted result of a previously initiated async vendor\nverification request. The result field is null while the request is PENDING,\ncarries the verification response body once COMPLETED, and carries error details\nwhen FAILED. The result is also delivered via the corresponding webhook\n(EKYB_VERIFICATION_RESULT / EKYC_VERIFICATION_RESULT / KYB_RESULT); this endpoint is a\nread-only status check. For `type` KYB, `result` is a `KybResult`. Returns 404 if the\nreferenceId is not found or belongs to a different tenant.\n",
        "operationId": "getAsyncVendorVerificationResult",
        "parameters": [
          {
            "name": "referenceId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "Request found — status is PENDING, COMPLETED, or FAILED",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncVendorVerificationResultResponse"
                }
              }
            }
          },
          "404": {
            "description": "No async verification request found for the given referenceId",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncVendorVerificationResultResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/verification-async-referenceid/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/verification-async-referenceid.md"
      }
    },
    "/omni/updated-watchlist-result": {
      "get": {
        "tags": [
          "Global watchlist"
        ],
        "summary": "Updated global watchlist result",
        "description": "This endpoint gets the latest result for a previous search created with [watch-list](#/Onboarding/getWatchlistResult)\nwith refId from it's response, or gathered from an update notification or with interviewId that the search is associated with.\n",
        "operationId": "getupdatedwatchlistresult",
        "parameters": [
          {
            "name": "ref",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WatchlistSearchResultResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/updated-watchlist-result/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/updated-watchlist-result.md"
      }
    },
    "/omni/trust-graph/reason-categories": {
      "get": {
        "tags": [
          "Trust graph"
        ],
        "summary": "Get reason categories from TrustGraph",
        "description": "Returns reason categories (with reasons) from TrustGraph",
        "operationId": "getReasonCategories",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReasonCategoriesResponseDto"
                }
              }
            }
          }
        },
        "x-incode-status": "undocumented"
      }
    },
    "/omni/sna/status/{checkId}": {
      "get": {
        "tags": [
          "Phone number input"
        ],
        "summary": "Get Silent Network Authentication (SNA) status",
        "description": "Returns the current state of a check started by `POST /omni/sna/initiate`. Use it to poll while the\ndevice is following `checkUrl`, or to recover the result after the client lost the response of\n`POST /omni/sna/complete`. The endpoint always answers HTTP 200; branch on `status`:\n- `ACCEPTED` or `PENDING` - the provider has not finished; `pending` is `true`, keep polling.\n- `COMPLETED` - `complete` is `true` and `match` carries the result.\n- `EXPIRED` or `ERROR` - the check will not complete; `match` is `null`. Fall back to SMS OTP.\n  Note that `EXPIRED` without a provider error code is reported with `pending: true`, so do not\n  rely on `pending` alone to stop polling.\n",
        "operationId": "snaStatus",
        "parameters": [
          {
            "name": "checkId",
            "in": "path",
            "description": "`checkId` returned by `POST /omni/sna/initiate`.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SnaStatusResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/sna-status-checkid/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/sna-status-checkid.md"
      }
    },
    "/omni/session/status/get": {
      "get": {
        "tags": [
          "Interview"
        ],
        "summary": "Get session status",
        "description": "Get the status of current session.",
        "operationId": "getSessionStatus",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetStatusResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/session-status-get/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/session-status-get.md"
      }
    },
    "/omni/send/sms-otp": {
      "get": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Send SMS with One Time Password for onboarding",
        "description": "Send SMS with an OTP (One Time Password) code to validate an onboarding.\nPhone number is obtained from interview data, so phone step it's required.\n",
        "operationId": "sendOTP",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OTP sent successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Contact Already Verified - The phone/email is already verified for this session",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                },
                "examples": {
                  "Contact already verified": {
                    "description": "Contact already verified",
                    "value": {
                      "timestamp": 1234567890,
                      "status": 4300,
                      "error": "Contact Already Verified",
                      "message": "OtpException: Session has verified contact",
                      "path": "/omni/send/sms-otp"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests - Cooldown period not completed",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/send-sms-otp/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/send-sms-otp.md"
      }
    },
    "/omni/send/otp": {
      "get": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Send SMS with One Time Password for onboarding",
        "description": "Send SMS with an OTP (One Time Password) code to validate an onboarding.\nPhone number is obtained from interview data, so phone step it's required.\n",
        "operationId": "getOTP",
        "parameters": [
          {
            "name": "communicationchannel",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "SMS",
                "EMAIL"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OTP sent successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Contact Already Verified - The phone/email is already verified for this session",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                },
                "examples": {
                  "Contact already verified": {
                    "description": "Contact already verified",
                    "value": {
                      "timestamp": 1234567890,
                      "status": 4300,
                      "error": "Contact Already Verified",
                      "message": "OtpException: Session has verified contact",
                      "path": "/omni/send/sms-otp"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests - Cooldown period not completed",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/send-otp/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/send-otp.md"
      }
    },
    "/omni/queue/conference/next": {
      "get": {
        "tags": [
          "Video conference"
        ],
        "summary": "Get next customer from the queue",
        "description": "Fetch next customer from a conference queue. In case no customer in the queue, and empty body is returned.",
        "operationId": "getNext",
        "parameters": [
          {
            "name": "queueName",
            "in": "query",
            "description": "The name of the queue the user is entering in the case the conference call will be used. If not set,\nthe default queue will be used. Same value for queueName needs to be used across all requests in one onboarding session.\n",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "aristotle",
                "buddha",
                "confucius",
                "diogenes"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InterviewAnswerResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/queue-conference-next/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/queue-conference-next.md"
      }
    },
    "/omni/queue/conference/index": {
      "get": {
        "tags": [
          "Video conference"
        ],
        "summary": "Get user's position in queue",
        "description": "Use this endpoint to check user's position in waiting queue. Once the index in the response is 0, users can connect to\nthe conference call. Use endpoint Get position in queue. Once the index becomes 0, the customer can connect to the interview.\nCall [Connect](#/Conference/getInterviewerInfo) to fetch connection data.\n",
        "operationId": "getQueueIndex",
        "parameters": [
          {
            "name": "queueName",
            "in": "query",
            "description": "The name of the queue the user is entering in case a conference call will be used. If not set, the default queue\nwill be used. Possible values: aristotle, buddha, confucius, diogenes. Same value for queueName needs to be used\nacross all requests in one onboarding session.\n",
            "required": false,
            "schema": {
              "type": "string",
              "default": ""
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QueueIndexResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/queue-conference-index/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/queue-conference-index.md"
      }
    },
    "/omni/queue/conference/connection-details": {
      "get": {
        "tags": [
          "Video conference"
        ],
        "summary": "Get connection details",
        "description": "An executive can invite the user to join a conference if the connection is lost by sending uuid ID to user.\nUsing this uuid connection details for that session can be fetched.\n",
        "operationId": "connectToConference",
        "parameters": [
          {
            "name": "uuid",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConnectionDetailsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/queue-conference-connection-details/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/queue-conference-connection-details.md"
      }
    },
    "/omni/process/antifraud": {
      "get": {
        "tags": [
          "Antifraud"
        ],
        "summary": "Process Antifraud",
        "description": "This endpoint should be called only after [process-id](ref:processid) and [process-face](ref:processface) both are over.\nThis endpoint gives ability to compare current interview with existing interviews and customers and detect anomalies than could be signs of fraud.\n**Important: Calling this endpoint affects the total [score](ref:getscores).**",
        "operationId": "getantifraudresult",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AntifraudCheckResultBaseDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/process-antifraud/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/process-antifraud.md"
      }
    },
    "/omni/onboarding-url": {
      "get": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch onboarding url",
        "description": "Fetch onboarding URL generated for specific user and specific flow. Only supply a `clientId`, if a redirect to mobile feature\nhas been added to the flow configuration and SMS and desktop onboarding is needed. Alternatively, if only a QR code is needed,\nit's recommended to supply `clientId`, `components` and `tag` parameters. The alternative will return a highly performant\napp launcher screen when redirect to mobile has been ena    bled.\n",
        "operationId": "getonboardingurl",
        "parameters": [
          {
            "name": "components",
            "in": "query",
            "description": "URL encode String Array of accepted string values",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "qr"
              ]
            }
          },
          {
            "name": "tag",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "payments",
                "verification"
              ]
            }
          },
          {
            "name": "shortUrl",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/onboarding-url/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/onboarding-url.md"
      }
    },
    "/omni/kyb/form": {
      "get": {
        "tags": [
          "Ekyb"
        ],
        "summary": "KYB form for an onboarding session",
        "description": "Returns the form to collect the business details for the KYB step of an onboarding session.\nRender it as is: which modules run for the country, which fields are shown and required, and\ntheir formats are already decided.\n\nCall it first without `country`: the form has only a country field, listing the countries the\norganization can run KYB for. Each time the country changes (the field's `refetchOnChange`), call\nit again with `country`: the form then has the fields for that country and a `submit` section\nfor `POST /omni/kyb`. Modules selected for the step that are not supported for the country are\nlisted in `context.unsupportedModules`; they are still submitted and come back with a\n`notSupported` error.\n\nTexts carry a translation `key` and an English `text` fallback.\n",
        "operationId": "kybForm",
        "parameters": [
          {
            "name": "country",
            "in": "query",
            "description": "Country of the business, ISO 3166-1 alpha-2. Omit for the first form.",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "US"
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "The form",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/KybForm"
                }
              }
            }
          },
          "400": {
            "description": "Unknown `country`, or no KYB provider configured for it in this organization",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "401": {
            "description": "Missing, invalid or expired session token. The response has no body"
          },
          "403": {
            "description": "Not an onboarding session token, the session is closed, or KYB is not part of the session's flow or workflow",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/kyb-form/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/kyb-form.md"
      }
    },
    "/omni/interview-events/dictionary": {
      "get": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch interview event dictionary",
        "description": "Returns the list of all existing interview event types",
        "operationId": "getDictionary",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/InterviewEventDictionaryDto"
                  }
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/interview-events-dictionary/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/interview-events-dictionary.md"
      }
    },
    "/omni/identity-reuse/documents": {
      "get": {
        "tags": [
          "Identity reuse"
        ],
        "summary": "Get identity reuse documents",
        "description": "Returns all found identity documents across all candidate identities",
        "operationId": "getidentityreusedocuments",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IdentityReuseDocumentsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/identity-reuse-documents/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/identity-reuse-documents.md"
      }
    },
    "/omni/get/user-consent": {
      "get": {
        "tags": [
          "User consent"
        ],
        "summary": "Get user consent",
        "description": "Fetches user consent with title, content and status from session.",
        "operationId": "getuserconsent",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Session id",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserConsentResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-user-consent/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-user-consent.md"
      }
    },
    "/omni/get/signing-ceremony-url": {
      "get": {
        "tags": [
          "Electronic signature"
        ],
        "summary": "Get signing ceremony URL",
        "description": "Fetches signing ceremony URL for the current session.",
        "operationId": "getSigningCeremonyUrl",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SigningCeremonyUrlResponse"
                },
                "example": {
                  "signingCeremonyUrl": "https://exaple.com"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-signing-ceremony-url/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-signing-ceremony-url.md"
      }
    },
    "/omni/get/signed-contracts-links": {
      "get": {
        "tags": [
          "Electronic signature"
        ],
        "summary": "Get signed contracts links",
        "description": "Fetches temporary link of the signed contracts uploaded for the current session.",
        "operationId": "getSignedContracts",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtendedResponse"
                },
                "example": {
                  "success": true,
                  "sessionStatus": "Alive",
                  "additionalInformation": {
                    "document ID1": "Temporary URL to signed document with ID1",
                    "document ID2": "Temporary URL to signed document with ID2",
                    "document ID3": "Temporary URL to signed document with ID3"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-signed-contracts-links/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-signed-contracts-links.md"
      }
    },
    "/omni/get/score": {
      "get": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch scores",
        "description": "Get id validation, liveness and face recognition results for given interviewId.",
        "operationId": "getscores",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Id of onboarding for which score is requests. If not present, it will be extracted from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScoreResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden - Score retrieval is disabled for this organization for session users.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-score/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-score.md"
      }
    },
    "/omni/get/raw-idv-results": {
      "get": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch raw IDV results",
        "description": "Returns raw id-validation-service check results with original naming preserved (no mapping to user-service key constants, no threshold-binarization), plus the raw checkFraudRisk result.",
        "operationId": "getrawidvresults",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Id of interview for which raw IDV results are requested. If not present, it will be extracted from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RawIdvResultsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-raw-idv-results/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-raw-idv-results.md"
      }
    },
    "/omni/get/questionAndAnswer": {
      "get": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Fetch random questions and answers for video selfie",
        "description": "Fetch a number random questions and answers for video selfie for given apiKey. If there are no defined QA pairs for the apiKey,\na random QA pair is returned from the default set.\n",
        "operationId": "getQuestionAndAnswer",
        "parameters": [
          {
            "name": "numberOfQuestions",
            "in": "query",
            "description": "Number of questions to be returned to client",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "returnVoiceConsentQuestion",
            "in": "query",
            "description": "Flag stating if voice consent question should be included in response",
            "required": false,
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RandomQandAListResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-questionandanswer/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-questionandanswer.md"
      }
    },
    "/omni/get/process-batch-status": {
      "get": {
        "tags": [
          "Organization"
        ],
        "summary": "Get batch processing status",
        "description": "Returns the status of the [/omni/process/batch](#/Onboarding/processBatch) progress",
        "operationId": "getprocessbatchstatus",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-process-batch-status/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-process-batch-status.md"
      }
    },
    "/omni/get/postprocess/isfinished": {
      "get": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Fetch processing status",
        "description": "Check if session processing is done.",
        "operationId": "checkIfPostProcessingIsFinished",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "finished: Boolean. A flag stating if processing is done or not.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-postprocess-isfinished/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-postprocess-isfinished.md"
      }
    },
    "/omni/get/phone": {
      "get": {
        "tags": [
          "Phone number input"
        ],
        "summary": "Get phone",
        "description": "Get the phone previously added to the interview. Deprecated, use GET /phone instead.",
        "operationId": "getphone",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PhoneResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "deprecated": true,
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-phone/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-phone.md"
      }
    },
    "/omni/get/onboarding/status": {
      "get": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch onboarding status",
        "description": "Check the status of onboarding session.",
        "operationId": "getonboardingstatus",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Represents interview id for which status is requested. If it is not present it will be read from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "onboardingStatus: String. A flag indicating current status of onboarding session. Possible values:\n- ID_VALIDATION_FINISHED - User finished with capturing of ID,\n- POST_PROCESSING_FINISHED - ID postprocessing finished on server,\n- FACE_VALIDATION_FINISHED - User finished with selfie capture,\n- ONBOARDING_FINISHED - User finished onboarding process,\n- MANUAL_REVIEW_APPROVED - Session that was in Needs Review state, manually approved by Executive,\n- MANUAL_REVIEW_REJECTED - Session that was in Needs Review state, manually rejected by Executive,\n- UNKNOWN - Unable to determine status of onboarding session - user still didn't start onboarding or user is still in the process of capturing ID.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-onboarding-status/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-onboarding-status.md"
      }
    },
    "/omni/get/ocr-data/v2": {
      "get": {
        "tags": [
          "Id capture"
        ],
        "summary": "Fetch ocr data v2",
        "description": "Returns data about user read from id and address statement wrapped in ocrData object.",
        "operationId": "getocrdatav2",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Id of onboarding for which data are requested. If not present, it will be extracted from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OcrDataResponsePacked"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-ocr-data-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-ocr-data-v2.md"
      }
    },
    "/omni/get/ocr-data-second-id": {
      "get": {
        "tags": [
          "Id capture"
        ],
        "summary": "Fetch ocr data for second id",
        "description": "Returns data about user read from the second id.",
        "operationId": "getOcrDataSecondId",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Id of onboarding for which data are requested. If not present, it will be extracted from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OcrDataResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-ocr-data-second-id/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-ocr-data-second-id.md"
      }
    },
    "/omni/get/ocr-data": {
      "get": {
        "tags": [
          "Id capture"
        ],
        "summary": "Fetch ocr data",
        "description": "Returns data about user read from id and address statement.",
        "operationId": "getOcrData",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Id of onboarding for which data are requested. If not present, it will be extracted from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OcrDataResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-ocr-data/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-ocr-data.md"
      }
    },
    "/omni/get/interviewer-info": {
      "get": {
        "tags": [
          "Video conference"
        ],
        "summary": "Connect to conference call",
        "description": "Get interviewer name for given interview ID read from token. If the interviewer is not yet assigned to interview, null\nwill be returned. This method also returns credentials for OpenTok session. It is recommended to call this method\nafter [Get-user's-position](#/Conference/getQueueIndex) returns 0 in response.\n",
        "operationId": "getInterviewerInfo",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InterviewerInfoResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-interviewer-info/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-interviewer-info.md"
      }
    },
    "/omni/get/imss": {
      "get": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch IMSS labor history",
        "description": "Fetch user's labor history from IMSS. Interview id is extracted from jwt token.",
        "operationId": "getLaborHistoryInfo",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkHistoryResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-imss/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-imss.md"
      }
    },
    "/omni/get/id-summary": {
      "get": {
        "tags": [
          "Id capture"
        ],
        "summary": "Get ID Summary",
        "description": "Returns success information about addFront and addBack. Also returns onlyFront flag.",
        "operationId": "getIdSummary",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Id of onboarding for which data are requested. If not present, it will be extracted from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IdSummaryResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-id-summary/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-id-summary.md"
      }
    },
    "/omni/get/fingerprints": {
      "get": {
        "tags": [],
        "summary": "Get Fingerprints",
        "description": "This endpoint is used for fetching fingerprints for current session.",
        "operationId": "getfingerprints",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FingerprintsData"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-fingerprints/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-fingerprints.md"
      }
    },
    "/omni/get/email": {
      "get": {
        "tags": [
          "Email input"
        ],
        "summary": "Get email",
        "description": "Get email from interview previously added via [Add email](ref:addemail) endpoint",
        "operationId": "getEmail",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EmailResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-email/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-email.md"
      }
    },
    "/omni/get/device-info": {
      "get": {
        "tags": [
          "Interview"
        ],
        "summary": "Fetch device info",
        "description": "Fetch information about device user was using during onboarding",
        "operationId": "getdeviceinfo",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Represents interview id for which device data are requested. If it is not present it will be read from token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "returnData",
            "in": "query",
            "description": "If it is set to true, string representation of map which contains all data that enters the hash will be returned.",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DeviceInfoResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-device-info/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-device-info.md"
      }
    },
    "/omni/get/custom-fields": {
      "get": {
        "tags": [
          "Custom fields"
        ],
        "summary": "Get custom fields",
        "description": "This endpoint is used for fetching custom fields for current session.",
        "operationId": "getcustomfields",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomFieldsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-custom-fields/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-custom-fields.md"
      }
    },
    "/omni/get/contracts-links": {
      "get": {
        "tags": [
          "Document capture"
        ],
        "summary": "Get contracts links",
        "description": "Fetches temporary link of the contracts uploaded for the current session.",
        "operationId": "getContracts",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtendedResponse"
                },
                "example": {
                  "success": true,
                  "sessionStatus": "Alive",
                  "additionalInformation": {
                    "document ID1": "Temporary URL to uploaded document with ID1",
                    "document ID2": "Temporary URL to uploaded document with ID2",
                    "document ID3": "Temporary URL to uploaded document with ID3"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-contracts-links/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-contracts-links.md"
      }
    },
    "/omni/get/conference/notes": {
      "get": {
        "tags": [
          "Video conference"
        ],
        "summary": "Fetch notes",
        "description": "This endpoint is used for fetching conference notes for interview/session. Works with <Glossary>Admin Token</Glossary>.",
        "operationId": "getconferencenotes",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "ID of interview. If omitted, the interview ID from teh token is used (current session)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "notes: String. Notes saved for interview.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-conference-notes/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-conference-notes.md"
      }
    },
    "/omni/get/conference/feedback": {
      "get": {
        "tags": [
          "Video conference"
        ],
        "summary": "Fetch conference feedback",
        "description": "This endpoint is used for fetching conference feedback for the interview/session. Works with <Glossary>Admin Token</Glossary>.",
        "operationId": "getconferencefeedback",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "ID of interview. If omitted the interview ID from token is used (current session)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "conferenceFeedback: String. Feedback saved for interview.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-conference-feedback/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-conference-feedback.md"
      }
    },
    "/omni/get/conference-status": {
      "get": {
        "tags": [
          "Video conference"
        ],
        "summary": "Fetch conference status",
        "description": "Returns data about conference session for given ID.",
        "operationId": "getconferencedetails",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "description": "ID of onboarding for which data is requested. If not present, it will be extracted from the token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConferenceDetailsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-conference-status/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-conference-status.md"
      }
    },
    "/omni/get/combined-consent": {
      "get": {
        "tags": [
          "Shared consent"
        ],
        "summary": "Get combined consent for requested language",
        "description": "Fetches combined consent for requested language.",
        "operationId": "getcombinedconsent",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Consent id",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "language",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LanguageConsentDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-combined-consent/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-combined-consent.md"
      }
    },
    "/omni/get/chat": {
      "get": {
        "tags": [
          "Video conference"
        ],
        "summary": "Fetch conference chat",
        "description": "Fetch conference chat for given 'interviewId'.Works with <Glossary>Admin Token</Glossary>.",
        "operationId": "getchats",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "description": "Interview id.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/ChatDto"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-chat/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-chat.md"
      }
    },
    "/omni/get/archives": {
      "get": {
        "tags": [
          "Video conference"
        ],
        "summary": "Fetch video archive urls",
        "description": "Fetch URLs of video archives from given 'interviewId' or if omitted for given 'since' timestamp. If not provided,\n'since' will be defaulted to time of first created archive. The maximum fetch size is 1000. In case maximum fetch size\nis reached, a new fetch should be triggered, using 'startTime' of last record from previous fetch as 'since'. URLs returned are\ntemporary URLs, which expire in 5 days.\n",
        "operationId": "geturlarchives",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "description": "In case this parameter is provided, 'since' is ignored, and response will contain single interview requested.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "since",
            "in": "query",
            "description": "Timestamp — beginning of export. If omitted, it will be defaulted to time of first created archive.",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "- archives: Array of archive objects\n    - interviewId: String. ID of interview.\n    - name: String. Name of the user in conference call.\n    - url: String. URL of archive file.\n    - startTime: Long. Timestamp of archive creation.\n",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/get-archives/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/get-archives.md"
      }
    },
    "/omni/generateVideoSelfieDownloadUrl": {
      "get": {
        "tags": [
          "Videoselfie"
        ],
        "summary": "Get download URL of videoselfie",
        "description": "Get URL for downloading video recording of video selfie. This is temporary pre-signed url, that expires in 1 hour",
        "operationId": "generatevideoselfiedownloadurl",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "description": "Session ID for which url is generated. In case not set, interviewId will be determined from token from header.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/generatevideoselfiedownloadurl/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/generatevideoselfiedownloadurl.md"
      }
    },
    "/omni/generateSessionRecordingDownloadUrl": {
      "get": {
        "tags": [
          "Interview"
        ],
        "summary": "Get url to download session recording",
        "description": "Get url to download session recording",
        "operationId": "generatesessionrecordingdownloadurl",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "type",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "frontId",
                "backId",
                "merged",
                "selfie",
                "authenticationattempt",
                "videoselfie"
              ]
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SessionRecordingDownloadResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/generatesessionrecordingdownloadurl/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/generatesessionrecordingdownloadurl.md"
      }
    },
    "/omni/form/answers": {
      "get": {
        "tags": [
          "Forms and data entry"
        ],
        "summary": "Fetch Form Answers",
        "description": " Retrieves all questions and answers that a user has responded to during a session, regardless of the form module configurations used.\n\nWorks with <Glossary>Admin Token</Glossary>.",
        "operationId": "fetchFormAnswers",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FormAnswersResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/form-answers/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/form-answers.md"
      }
    },
    "/omni/fiscal-qr-url-response/{interviewId}": {
      "get": {
        "tags": [
          "Fiscal qr url"
        ],
        "summary": "Get fiscal qr url response",
        "description": "Get the information obtained from a fiscal qr url added to the session.\n(México only)\n",
        "operationId": "getfiscalqrurlresponse",
        "parameters": [
          {
            "name": "interviewId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/fiscal-qr-url-response/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/fiscal-qr-url-response.md"
      }
    },
    "/omni/externalVerification/ekyc/session": {
      "get": {
        "tags": [
          "Ekyc"
        ],
        "summary": "Get eKYC session data for the current session",
        "description": "Returns stored eKYC verification request/response data for the interview associated with the caller's session token.",
        "operationId": "externalVerificationEkycSession",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EkycDataResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/externalverification-ekyc-session/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/externalverification-ekyc-session.md"
      }
    },
    "/omni/externalVerification/ekyb/session": {
      "get": {
        "tags": [
          "Ekyb"
        ],
        "summary": "Get eKYB session data for the current session",
        "description": "Returns stored eKYB verification request/response data for the interview associated with the\ncaller's session token. Intended for downstream onboarding steps (e.g. the business watchlist\nscreen) to reuse data the user already entered on the eKYB form, such as `businessName`,\n`country` and `taxId`, without requiring an executive token.",
        "operationId": "externalVerificationEkybSession",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EkybDataResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/externalverification-ekyb-session/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/externalverification-ekyb-session.md"
      }
    },
    "/omni/es/documents/signed/v2": {
      "get": {
        "tags": [
          "Electronic signature advanced"
        ],
        "summary": "Get signed documents",
        "description": "This endpoint is used to get signed documents for a session",
        "operationId": "getSignedDocumentsV2",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageNo",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 20
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ESignedDocumentsResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/es-documents-signed-v2/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/es-documents-signed-v2.md"
      }
    },
    "/omni/cross-doc-data-check/results": {
      "get": {
        "tags": [
          "Id capture"
        ],
        "summary": "Get cross-document comparison results",
        "description": "Fetch cross-document data check results for a given interview ID. If no ID is provided, it defaults to the user's ID from the JWT.",
        "operationId": "cross-doc-check-results",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "Response contains a map of results with detailed comparison information.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": {
                    "additionalProp1": [
                      {
                        "interviewId": "string",
                        "comparisonName": "string",
                        "comparisonId": "string",
                        "result": "OK",
                        "leftValueDetails": {
                          "documentType": "string",
                          "fieldName": "string",
                          "value": {},
                          "sourceNotFound": true
                        },
                        "rightValueDetails": {
                          "documentType": "string",
                          "fieldName": "string",
                          "value": {},
                          "sourceNotFound": true
                        },
                        "severity": "ultra_low"
                      }
                    ],
                    "additionalProp2": [
                      {
                        "interviewId": "string",
                        "comparisonName": "string",
                        "comparisonId": "string",
                        "result": "OK",
                        "leftValueDetails": {
                          "documentType": "string",
                          "fieldName": "string",
                          "value": {},
                          "sourceNotFound": true
                        },
                        "rightValueDetails": {
                          "documentType": "string",
                          "fieldName": "string",
                          "value": {},
                          "sourceNotFound": true
                        },
                        "severity": "ultra_low"
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/cross-doc-data-check-results/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/cross-doc-data-check-results.md"
      }
    },
    "/omni/conference/get/events": {
      "get": {
        "tags": [
          "Video conference"
        ],
        "summary": "Fetch conference events",
        "description": "Fetch conference events for given 'interviewId'.",
        "operationId": "getConferenceEvents",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "description": "Interview id.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/ConferenceEvent"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/conference-get-events/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/conference-get-events.md"
      }
    },
    "/omni/compare/sms-otp": {
      "get": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Compare/Validate OTP code obtained through SMS for onboarding",
        "description": "Send OTP code obtained through SMS to validate an onboarding.\nPhone number is obtained from interview data, so phone step it's required.\nSuccess will be false if code sent doesn't match.\n",
        "operationId": "compareOTP",
        "parameters": [
          {
            "name": "code",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/compare-sms-otp/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/compare-sms-otp.md"
      }
    },
    "/omni/code/generate": {
      "get": {
        "tags": [
          "Onboarding"
        ],
        "summary": "Generate interview code",
        "description": "Generate interview code for this session.",
        "operationId": "generateInterviewCode",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "interviewCode: String. 6 characters. Newly generated code to be verified before connecting to video conference.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/code-generate/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/code-generate.md"
      }
    },
    "/omni/b2b/trust-graph/result": {
      "get": {
        "tags": [
          "Trust graph"
        ],
        "summary": "Get trust graph check results",
        "description": "Retrieves the results of fraud checks performed on a specific interview, identified by its interview ID.",
        "operationId": "getTrustGraphCheckResult",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrustGraphCheckResultB2BDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExceptionResponse"
                }
              }
            }
          }
        },
        "x-incode-status": "undocumented"
      }
    },
    "/omni/session/externalId": {
      "delete": {
        "tags": [
          "Interview"
        ],
        "summary": "Delete PII data for single onboarding session by external ID.",
        "description": "Delete single onboarding session using the external ID as identifier.\nNote:\nWorks with <Glossary>Admin Token</Glossary>.Please, bear in mind that usage of this API endpoint for deletion of Customer Data will mean that Incode will no longer have access to it nor will be able to review or analyze any issue related to deleted Customer Data. After deletion, as Incode will not be able to retrieve the deleted Customer Data, any potential claims related to such data will be waived by Customer.\nFinally, for clarity purposes, Incode may continue to process information derived from Customer Data that has been deidentified, anonymized, and/or aggregated such that the data is no longer considered Personal Data under applicable Data Protection Laws and in a manner that does not identify individuals or Customer to improve its services and defend its legitimate interests.\n",
        "operationId": "cleansingleonboardingsessionwithexternalid",
        "parameters": [
          {
            "name": "externalId",
            "in": "query",
            "description": "Specify which external-id.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "keepCustomer",
            "in": "query",
            "description": "True or false. Indicates whether to keep idenity of the customer or not. Default is false(which means session and customer identity both will be deleted).",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "sendNotification",
            "in": "query",
            "description": "Flag to send a notification about a change interview status",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          }
        },
        "deprecated": true,
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/session-externalid/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/session-externalid.md"
      }
    },
    "/omni/interviews": {
      "delete": {
        "tags": [
          "Interview"
        ],
        "summary": "Delete PII data for multiple onboarding sessions with multiple options.",
        "description": "Delete all PII data for onboarding sessions by given array of interview ids.\nNote:\nWorks with <Glossary>Admin Token</Glossary>.Please, bear in mind that usage of this API endpoint for deletion of Customer Data will mean that Incode will no longer have access to it nor will be able to review or analyze any issue related to deleted Customer Data. After deletion, as Incode will not be able to retrieve the deleted Customer Data, any potential claims related to such data will be waived by Customer.\nFinally, for clarity purposes, Incode may continue to process information derived from Customer Data that has been deidentified, anonymized, and/or aggregated such that the data is no longer considered Personal Data under applicable Data Protection Laws and in a manner that does not identify individuals or Customer to improve its services and defend its legitimate interests.\n",
        "operationId": "cleanallonboardingsessions",
        "parameters": [
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DeleteInterviewsRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncDeletionTaskResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/interviews/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/interviews.md"
      }
    },
    "/omni/interview": {
      "delete": {
        "tags": [
          "Interview"
        ],
        "summary": "Delete PII data for single onboarding session.",
        "description": "Delete all PII data for onboarding sessions by given array of interview ids.\nNote:\nWorks with <Glossary>Admin Token</Glossary>.Please, bear in mind that usage of this API endpoint for deletion of Customer Data will mean that Incode will no longer have access to it nor will be able to review or analyze any issue related to deleted Customer Data. After deletion, as Incode will not be able to retrieve the deleted Customer Data, any potential claims related to such data will be waived by Customer.\nFinally, for clarity purposes, Incode may continue to process information derived from Customer Data that has been deidentified, anonymized, and/or aggregated such that the data is no longer considered Personal Data under applicable Data Protection Laws and in a manner that does not identify individuals or Customer to improve its services and defend its legitimate interests.\n",
        "operationId": "cleansingleonboardingsession",
        "parameters": [
          {
            "name": "interviewId",
            "in": "query",
            "description": "Specify which interview.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "keepCustomer",
            "in": "query",
            "description": "True or false. Indicates whether to keep idenity of the customer or not. Default is false(which means session and customer identity both will be deleted).",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "sendNotification",
            "in": "query",
            "description": "Flag to send a notification about a change interview status",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "header",
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BasicResponse"
                }
              }
            }
          }
        },
        "externalDocs": {
          "description": "Documentation for this endpoint",
          "url": "https://developer.incode.com/api-reference/interview/"
        },
        "x-incode-markdown": "https://developer.incode.com/api-reference/interview.md"
      }
    }
  },
  "components": {
    "schemas": {
      "AntifraudScoreValidation": {
        "type": "object",
        "properties": {
          "overall": {
            "$ref": "#/components/schemas/ResultBean"
          }
        }
      },
      "AppliedFlowRule": {
        "type": "object",
        "description": "Specific rule from rule engine",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the rule."
          },
          "expression": {
            "type": "string",
            "description": "A logical expression of the rule."
          },
          "ruleType": {
            "type": "string",
            "enum": [
              "idValidation",
              "secondIdValidation",
              "faceValidation",
              "liveness",
              "deepsight",
              "eKyc",
              "videoselfie",
              "faceAuthentication",
              "total",
              "phoneRisk",
              "emailRisk",
              "governmentValidation"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "OK",
              "WARN",
              "FAIL",
              "UNKNOWN",
              "MANUAL",
              "MANUAL_OK",
              "MANUAL_FAIL",
              "MANUAL_PENDING"
            ]
          }
        }
      },
      "AppliedFlowRuleDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the rule."
          },
          "expression": {
            "type": "string",
            "description": "A logical expression of the rule."
          },
          "ruleType": {
            "type": "string",
            "enum": [
              "idValidation",
              "secondIdValidation",
              "faceValidation",
              "liveness",
              "deepsight",
              "eKyc",
              "videoselfie",
              "faceAuthentication",
              "total",
              "phoneRisk",
              "emailRisk",
              "governmentValidation"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "OK",
              "WARN",
              "FAIL",
              "UNKNOWN",
              "MANUAL",
              "MANUAL_OK",
              "MANUAL_FAIL",
              "MANUAL_PENDING"
            ]
          }
        }
      },
      "AuthenticationDto": {
        "type": "object",
        "properties": {
          "overall": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Composite result for authentication score."
          },
          "identityId": {
            "type": "string"
          },
          "appliedRule": {
            "$ref": "#/components/schemas/AppliedFlowRule"
          }
        }
      },
      "AutopilotDto": {
        "type": "object",
        "properties": {
          "overall": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "failedFeatures": {
            "type": "array",
            "deprecated": true,
            "description": "Deprecated; use failedFeatureDetails.",
            "items": {
              "type": "string"
            }
          },
          "legitFeatures": {
            "type": "array",
            "deprecated": true,
            "description": "Deprecated; use legitFeatureDetails.",
            "items": {
              "type": "string"
            }
          },
          "failedFeatureDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutopilotFeatureDetail"
            }
          },
          "legitFeatureDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutopilotFeatureDetail"
            }
          },
          "responseText": {
            "type": "string"
          },
          "responseCategory": {
            "type": "string"
          }
        }
      },
      "AutopilotFeatureDetail": {
        "type": "object",
        "description": "An autopilot Risk-AI feature: 'description' is the default English text; 'code' is its stable translation key, or null when no code is available (in which case 'description' is shown untranslated).",
        "properties": {
          "code": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      },
      "BehavioralTrustScoreDto": {
        "type": "object",
        "properties": {
          "overall": {
            "$ref": "#/components/schemas/ResultBean"
          }
        }
      },
      "CameraTrustScoreDto": {
        "type": "object",
        "properties": {
          "overall": {
            "$ref": "#/components/schemas/ResultBean"
          }
        }
      },
      "CurpResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "curp": {
            "type": "string",
            "description": "Curp"
          },
          "sex": {
            "type": "string",
            "description": "Sex",
            "enum": [
              "Mujer",
              "Hombre",
              "X"
            ]
          },
          "nationality": {
            "type": "string",
            "description": "Nationality"
          },
          "result": {
            "type": "string"
          },
          "transactionId": {
            "type": "string"
          },
          "renapo_valid": {
            "type": "boolean",
            "description": "Flag indicating if CURP validation passed - tipoError present in response"
          },
          "names": {
            "type": "string",
            "description": "Names"
          },
          "paternal_surname": {
            "type": "string",
            "description": "Paternal surname"
          },
          "mothers_maiden_name": {
            "type": "string",
            "description": "Mother maiden name"
          },
          "birthdate": {
            "type": "string",
            "description": "Birth Date in format DD/MM/YYYY"
          },
          "entity_birth": {
            "type": "string",
            "description": "Birth State"
          },
          "probation_document": {
            "type": "string",
            "description": "Probation Document"
          },
          "probation_document_data": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            },
            "description": "Key/Value structure. All keys are type of string. Available Key values:\n- anioReg\n- foja\n- tomo\n- libro\n- numActa\n- CRIP\n- numEntidadReg\n- cveMunicipioReg\n- NumRegExtranjeros\n- FolioCarta\n- cveEntidadNac\n- cveEntidadEmisora\n"
          },
          "status_curp": {
            "type": "string",
            "description": "Status Curp"
          },
          "deceasedStatus": {
            "type": "string",
            "description": "Deceased Status"
          }
        }
      },
      "DeepsightScoreDto": {
        "type": "object",
        "properties": {
          "multimodalIntelligence": {
            "$ref": "#/components/schemas/MultimodalIntelligenceDto"
          },
          "deviceTrust": {
            "$ref": "#/components/schemas/DeviceTrustScoreDto"
          },
          "behavioralTrust": {
            "$ref": "#/components/schemas/BehavioralTrustScoreDto"
          },
          "cameraTrust": {
            "$ref": "#/components/schemas/CameraTrustScoreDto"
          },
          "overall": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "appliedRule": {
            "$ref": "#/components/schemas/AppliedFlowRule"
          }
        }
      },
      "DeviceTrustScoreDto": {
        "type": "object",
        "properties": {
          "overall": {
            "$ref": "#/components/schemas/ResultBean"
          }
        }
      },
      "DocumentOnEdgeInfo": {
        "type": "object",
        "properties": {
          "frontDocumentIsOnTheEdge": {
            "type": "boolean"
          },
          "backDocumentIsOnTheEdge": {
            "type": "boolean"
          }
        }
      },
      "ExternalFaceMatchScoreDto": {
        "type": "object",
        "properties": {
          "faceMaskCheck": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows if mask is detected on the external face"
          },
          "lensesCheck": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows if lenses are detected on the external face"
          },
          "headCoverCheck": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows info if head cover was detected on the external face"
          },
          "closedEyeCheck": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows info if closed eyes are detected on the external face"
          },
          "imageQualityCheck": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows image quality of external face"
          },
          "faceOccluded": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Returns flag if external face is occluded on the image"
          },
          "vsIdMatch": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows how much face from ID matches the external face"
          },
          "vsSelfieMatch": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows how much selfie matches the external face"
          },
          "overall": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Composite result for external face match score"
          }
        }
      },
      "FaceAttributesScoreDto": {
        "type": "object",
        "properties": {
          "maskCheck": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows info if the user was wearing a mask during selfie capture"
          },
          "lensesCheck": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows info if the user was wearing lenses during selfie capture"
          },
          "hasHeadCover": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Returns flag if the hat/cap is detected on the image. Only if hats detected option is configured"
          },
          "hasClosedEyes": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Returns flag if closed eyes is detected on the image. Only if hats detected option is configured"
          },
          "faceOcclusion": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Returns flag if captured face is occluded on the image. Only if hats detected option is configured"
          }
        }
      },
      "FaceCaptureAssessmentScoreDto": {
        "type": "object",
        "properties": {
          "faceAttributes": {
            "$ref": "#/components/schemas/FaceAttributesScoreDto",
            "description": "Contains face attributes"
          },
          "qualityChecks": {
            "$ref": "#/components/schemas/QualityChecksScoreDto",
            "description": "Contains quality checks"
          }
        }
      },
      "FaceRecognitionDto": {
        "type": "object",
        "properties": {
          "existingUser": {
            "type": "boolean",
            "description": "Flag indicating if a user is already enrolled"
          },
          "customerId": {
            "type": "string",
            "description": "Id of enrolled user"
          },
          "existingInterviewId": {
            "type": "string",
            "description": "Session ID, in case the user is approved in another session"
          },
          "existingExternalId": {
            "type": "string",
            "description": "External ID, in case the user is approved in another session"
          },
          "maskCheck": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows info if the user was wearing a mask during selfie capture"
          },
          "lensesCheck": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows info if the user was wearing lenses during selfie capture"
          },
          "faceBrightness": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows status and level of brightness during selfie capture"
          },
          "imageQuality": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows image quality during selfie capture"
          },
          "nameMatch": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows if the name matches the previously used (only in case the user is already approved in another session)"
          },
          "appliedRule": {
            "$ref": "#/components/schemas/AppliedFlowRuleDto",
            "description": "Specific rule from rule engine for faceValidation"
          },
          "overall": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows how much face from ID matches the selfie"
          },
          "hasHeadCover": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Returns flag if the hat/cap is detected on the image. Only if hats detected option is configured"
          },
          "hasClosedEyes": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Returns flag if closed eyes is detected on the image. Only if hats detected option is configured"
          },
          "faceOcclusion": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Returns flag if captured face is occluded on the image. Only if hats detected option is configured"
          }
        }
      },
      "GovernmentRegistryAddress": {
        "type": "object",
        "properties": {
          "fullAddress": {
            "type": "string",
            "description": "Address as a single line, when the source returns it unsplit (MM_ARGENTINA_RENAPER_EXTENDED).",
            "example": "RIO DE LA PLATA 1935 CP: 6300,LA PAMPA,ARGENTINA"
          },
          "street": {
            "type": "string",
            "description": "Street name (RENAPER_PREMIUM calle).",
            "example": "RIO DE LA PLATA"
          },
          "number": {
            "type": "string",
            "description": "Street number (RENAPER_PREMIUM numero).",
            "example": 1935
          },
          "floor": {
            "type": "string",
            "description": "Floor (RENAPER_PREMIUM piso).",
            "example": 2
          },
          "apartment": {
            "type": "string",
            "description": "Apartment (RENAPER_PREMIUM departamento).",
            "example": "A"
          },
          "postalCode": {
            "type": "string",
            "description": "Postal code (RENAPER_PREMIUM codigo_postal).",
            "example": 6300
          },
          "neighborhood": {
            "type": "string",
            "description": "Neighborhood (RENAPER_PREMIUM barrio).",
            "example": "CENTRO"
          },
          "building": {
            "type": "string",
            "description": "Building block (RENAPER_PREMIUM monoblock).",
            "example": 3
          },
          "city": {
            "type": "string",
            "description": "City (RENAPER_PREMIUM ciudad).",
            "example": "SANTA ROSA"
          },
          "municipality": {
            "type": "string",
            "description": "Municipality (RENAPER_PREMIUM municipio).",
            "example": "SANTA ROSA"
          },
          "state": {
            "type": "string",
            "description": "State or province (RENAPER_PREMIUM provincia).",
            "example": "LA PAMPA"
          },
          "country": {
            "type": "string",
            "description": "Country as the source names it (RENAPER_PREMIUM pais).",
            "example": "ARGENTINA"
          }
        }
      },
      "GovernmentRegistryData": {
        "type": "object",
        "properties": {
          "taxIdNumber": {
            "type": "string",
            "description": "Tax identification number the government source holds for the person: Argentina CUIL from RENAPER_PREMIUM and MM_ARGENTINA_RENAPER_EXTENDED.",
            "example": 20123456785
          },
          "address": {
            "$ref": "#/components/schemas/GovernmentRegistryAddress",
            "description": "Address the government source holds for the person: RENAPER_PREMIUM returns it split into parts, MM_ARGENTINA_RENAPER_EXTENDED as a single fullAddress line. Absent when the source reported no address."
          },
          "documentStatus": {
            "type": "string",
            "description": "Status the government source holds for the document: Colombia cedula state from BECOME_DIGITAL, TUS_DATOS and CO_PPT.",
            "enum": [
              "VALID",
              "CANCELLED",
              "PENDING",
              "UNKNOWN"
            ],
            "example": "VALID"
          },
          "documentStatusReason": {
            "type": "string",
            "description": "Why the document is not VALID, in Incode vocabulary rather than the provider's own text. Absent when the document is VALID: Colombia cedula state from BECOME_DIGITAL, TUS_DATOS and CO_PPT.",
            "enum": [
              "CANCELLED",
              "IN_PROCESS",
              "NOT_FOUND",
              "PROVIDER_UNAVAILABLE",
              "UNKNOWN"
            ],
            "example": "CANCELLED"
          },
          "fullName": {
            "type": "string",
            "description": "Full name the government source holds for the person, as the registry spells it: Colombia from BECOME_DIGITAL, TUS_DATOS and CO_PPT; Peru from QUERTIUM, PE_MIGRATION_INSTITUTE and the TOC carne de extranjeria flow. Absent on the TOC DNI (RENIEC) flow, which reports only which checked fields matched.",
            "example": "JUAN CARLOS PEREZ GOMEZ"
          },
          "documentNumber": {
            "type": "string",
            "description": "Document number the government source holds for the person, which is not necessarily the number read off the captured document: Colombia NUIP, PPT or CE from BECOME_DIGITAL, TUS_DATOS and CO_PPT.",
            "example": 1020304050
          },
          "deceased": {
            "type": "boolean",
            "description": "Whether the government source holds a death notice for the person (RENAPER_PREMIUM codigo_fallecido: 04 = true, 03 = false). Absent when the source did not answer the question or returned an undocumented code. A true value fails the validation with status personDeceased.",
            "example": false
          }
        }
      },
      "GovernmentValidation": {
        "type": "object",
        "description": "- recognitionConfidence: Only present in case face validation is performed as a part of government check\n- fingerprintConfidence: Only present in case fingerprint validation is performed as a part of government check\n- minimumPassingFingerprints: Only present in case fingerprint validation is performed.\n\n     Maps to configured number of minimum fingerprints configured at the time of score calculation.\n- validationStatus: Possible values: processingIne, ok, validationError, ineConnectionError, ineInfrastructureError, moduleNotSupported,\n    missingDocumentId, missingSelfie, userNotFound, userNotFoundInIneDb, notEnoughData, livenessFail, ineNotCurrent,\n    ineReportedLost, ineReportedStolen, ineSignaturError, transactionLimitReached, geographicRegionNotSupported\n\n    Key-value mapping:\n    - -1: processingIne\n    - 0: ok\n    - 1: validationError\n    - 2: ineConnectionError\n    - 3: ineInfrastructureError\n    - 4: moduleNotSupported\n    - 5: missingDocumentId\n    - 6: missingSelfie\n    - 7: userNotFound\n    - 8: userNotFoundInIneDb\n    - 9: notEnoughData\n    - 10: livenessFail\n    - 11: ineNotCurrent\n    - 12: ineReportedLost\n    - 13: ineReportedStolen\n    - 14: ineSignaturError\n    - 99: geographicRegionNotSupported\n    - 205: transactionLimitReached\n- ocrValidation: List of value, status, key objects.\n\n    Not all of the following keys are always present: issueDate firstName, maternalLastName, paternalLastName, ocr, personalId,\n    electorsKey, emissionNumber, registrationDate\n- ocrValidationOverall: Composite result for ocrValidation score\n- credentialStatus: List of value, status, key objects carrying issuing-authority verdicts about\n    the credential itself, e.g. nonCommercialDriverLicenseStatus, indefiniteExpiration.\n\n    Informational only - these never affect the government validation score or overall status.\n    An entry is present only when the check was requested; status OK means confirmed, FAIL refuted,\n    UNKNOWN the authority did not report it.\n- validationSource: Where the validated identity data came from: ID_CAPTURE (captured ID on the session),\n    REQUEST_BODY (data sent in the government validation request) or KYX_PREFILL (eKYC pre-fill).\n    Absent for sessions validated before it was recorded or through the legacy government validation module.\n- registryData: Values the government source holds for the person (taxIdNumber, address, documentStatus,\n    documentStatusReason, fullName, documentNumber). Present only when the latest attempt of the provider\n    shown in \"provider\" reported at least one value. Informational only - never affects the government\n    validation score or overall status.\n- overall\n",
        "properties": {
          "recognitionConfidence": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "fingerprintConfidence": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "minimumPassingFingerprints": {
            "type": "integer",
            "format": "int32"
          },
          "validationStatus": {
            "$ref": "#/components/schemas/IdResultBean"
          },
          "ocrValidation": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IdResultBean"
            }
          },
          "credentialStatus": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IdResultBean"
            }
          },
          "registryData": {
            "$ref": "#/components/schemas/GovernmentRegistryData",
            "description": "Values the government source holds for the person, under provider-neutral names so the same field\nreads the same across providers. Present only when the provider shown in \"provider\" reported\nat least one value."
          },
          "ocrValidationOverall": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "overall": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "provider": {
            "type": "string"
          },
          "validationSource": {
            "type": "string",
            "enum": [
              "ID_CAPTURE",
              "REQUEST_BODY",
              "KYX_PREFILL"
            ]
          },
          "appliedRule": {
            "$ref": "#/components/schemas/AppliedFlowRule"
          }
        }
      },
      "IdOcrConfidence": {
        "type": "object",
        "properties": {
          "overallConfidence": {
            "$ref": "#/components/schemas/ResultBean"
          }
        }
      },
      "IdResultBean": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string",
            "maximum": 100,
            "minimum": 0
          },
          "status": {
            "type": "string",
            "enum": [
              "OK",
              "WARN",
              "FAIL",
              "UNKNOWN",
              "MANUAL",
              "MANUAL_OK",
              "MANUAL_FAIL",
              "MANUAL_PENDING"
            ]
          },
          "key": {
            "type": "string"
          }
        }
      },
      "IdValidation": {
        "type": "object",
        "properties": {
          "photoSecurityAndQuality": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IdResultBean"
            }
          },
          "idSpecific": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IdResultBean"
            }
          },
          "customFields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IdResultBean"
            }
          },
          "appliedRule": {
            "$ref": "#/components/schemas/AppliedFlowRule"
          },
          "overall": {
            "$ref": "#/components/schemas/ResultBean"
          }
        }
      },
      "IdValidationDeepCheckScore": {
        "type": "object",
        "properties": {
          "overall": {
            "$ref": "#/components/schemas/ResultBean"
          }
        }
      },
      "IdentityCrosscheck": {
        "type": "object",
        "description": "Identity cross-check score comparing account creation data with IDV extracted data",
        "properties": {
          "overall": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Overall validation result"
          },
          "checks": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/ResultBean"
            },
            "description": "Individual validation checks"
          },
          "riskLevel": {
            "type": "string",
            "description": "Risk level assessment",
            "example": "LOW"
          }
        }
      },
      "IncodeWatchlistScore": {
        "type": "object",
        "properties": {
          "watchlistScore": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "dataMatches": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "incodeWatchlistId": {
            "type": "string"
          }
        }
      },
      "IneResult": {
        "type": "object",
        "properties": {
          "get_version": {
            "type": "integer",
            "format": "int64"
          },
          "scrapingStatus": {
            "type": "string",
            "description": "Scraping status",
            "enum": [
              "IN_PROGRESS",
              "FINISHED",
              "ERROR"
            ]
          },
          "success": {
            "type": "boolean",
            "description": "Flag indicating if the process finished successfully."
          },
          "result": {
            "type": "string",
            "description": "Result",
            "enum": [
              "success",
              "error"
            ]
          },
          "resultDetails": {
            "type": "string"
          },
          "screenshotUrl": {
            "type": "string"
          },
          "cic": {
            "type": "string",
            "description": "Cic value."
          },
          "claveElector": {
            "type": "string",
            "description": "Clave de elector."
          },
          "numeroEmision": {
            "type": "string",
            "description": "Emission number."
          },
          "ocr": {
            "type": "string",
            "description": "Ocr number."
          },
          "anioRegistro": {
            "type": "string",
            "description": "Registration year."
          },
          "anioEmision": {
            "type": "string",
            "description": "Emission year."
          }
        }
      },
      "Invoice": {
        "type": "object",
        "properties": {
          "overall": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "checks": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/ResultBean"
            }
          }
        }
      },
      "LivenessDto": {
        "type": "object",
        "properties": {
          "hasHeadCover": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Returns flag if the hat/cap is detected on the image. Only if hats detected option is configured"
          },
          "hasClosedEyes": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Returns flag if closed eyes is detected on the image. Only if hats detected option is configured"
          },
          "physicalAttack": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Returns flag if physical attack is detected. Only if this option is configured"
          },
          "digitalAttack": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Returns flag if digital attack is detected. Only if this option is configured"
          },
          "evasionAttack": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Returns flag if evasion attack is detected. Only if this option is configured"
          },
          "deepfakeAttack": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Returns flag if deepfake attack is detected. Only if digital attack is configured"
          },
          "digitalManipulationAttack": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Returns flag if digital manipulation attack is detected. Only if digital attack is configured"
          },
          "appliedRule": {
            "$ref": "#/components/schemas/AppliedFlowRule",
            "description": "Information about applied rule"
          },
          "spoofDetectionMethod": {
            "type": "string",
            "description": "Information about method used",
            "enum": [
              "SF",
              "SF_MM",
              "SF_MM_V"
            ]
          },
          "overall": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Composite result for liveness score."
          },
          "livenessScore": {
            "$ref": "#/components/schemas/ResultBean",
            "deprecated": true,
            "description": "Returns flag if physical attack is detected. Only if this option is configured. Deprecated, use 'physicalAttack' instead."
          }
        }
      },
      "MultimodalIntelligenceDto": {
        "type": "object",
        "properties": {
          "physicalAttack": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "digitalAttack": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "deepfakeAttack": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "digitalManipulationAttack": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "evasionAttack": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "spoofDetectionMethod": {
            "type": "string",
            "enum": [
              "SF",
              "SF_MM",
              "SF_MM_V"
            ]
          },
          "faceExplanation": {
            "$ref": "#/components/schemas/SpoofResultExplanationDto"
          },
          "faceOverall": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "aiGeneratedDocument": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "visualAnomaly": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "documentOverall": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "overall": {
            "$ref": "#/components/schemas/ResultBean"
          }
        }
      },
      "QualityChecksScoreDto": {
        "type": "object",
        "properties": {
          "faceBrightness": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows status of brightness during selfie capture"
          },
          "imageQuality": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Shows status of image quality check"
          }
        }
      },
      "ResultBean": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string",
            "maximum": 100,
            "minimum": 0
          },
          "status": {
            "type": "string",
            "enum": [
              "OK",
              "WARN",
              "FAIL",
              "UNKNOWN",
              "MANUAL",
              "MANUAL_OK",
              "MANUAL_FAIL",
              "MANUAL_PENDING"
            ]
          }
        }
      },
      "RetryInfo": {
        "type": "object",
        "properties": {
          "failedAttemptsCounter": {
            "type": "object",
            "additionalProperties": {
              "type": "integer",
              "format": "int32"
            },
            "description": "Object with counter of failed attempts per step"
          },
          "stepsToRetry": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "frontId",
                "backId",
                "selfie",
                "poa",
                "governmentValidation"
              ]
            }
          }
        }
      },
      "ScoreResponseDto": {
        "type": "object",
        "description": "Score payload is composed of subsections. Scores are calculated once onboarding is completed",
        "properties": {
          "authentication": {
            "$ref": "#/components/schemas/AuthenticationDto",
            "description": "The result of authentication containing overall score and list of executed checks."
          },
          "idValidation": {
            "$ref": "#/components/schemas/IdValidation",
            "description": "Id validation of its overall score and two lists of executed tests and checks"
          },
          "antifraud": {
            "$ref": "#/components/schemas/AntifraudScoreValidation",
            "description": "The result of antifraud check where we compare the current interview with existing interviews and customers and detect anomalies than could be signs of fraud"
          },
          "secondIdValidation": {
            "$ref": "#/components/schemas/IdValidation",
            "description": "Same as idValidation only applicable if onboarding is configured to capture a second id"
          },
          "liveness": {
            "$ref": "#/components/schemas/LivenessDto"
          },
          "deepsight": {
            "$ref": "#/components/schemas/DeepsightScoreDto"
          },
          "faceCaptureAssessment": {
            "$ref": "#/components/schemas/FaceCaptureAssessmentScoreDto"
          },
          "faceRecognition": {
            "$ref": "#/components/schemas/FaceRecognitionDto"
          },
          "faceRecognitionSecondId": {
            "$ref": "#/components/schemas/FaceRecognitionDto",
            "description": "Same as faceRecognition only applicable if onboarding is configured to capture a second id"
          },
          "externalFaceMatchScore": {
            "$ref": "#/components/schemas/ExternalFaceMatchScoreDto",
            "description": "The result of external face match containing overall score and list of executed checks"
          },
          "governmentValidation": {
            "$ref": "#/components/schemas/GovernmentValidation"
          },
          "videoConference": {
            "$ref": "#/components/schemas/VideoSelfie"
          },
          "curpVerification": {
            "$ref": "#/components/schemas/CurpResponse",
            "description": "Only for Mex documents, in case CURP validation was performed"
          },
          "ineScrapingValidation": {
            "$ref": "#/components/schemas/IneResult",
            "description": "Only for Mex documents in case INE scraping was performed"
          },
          "idOcrConfidence": {
            "$ref": "#/components/schemas/IdOcrConfidence",
            "description": "Confidence level for read ocr data from ID"
          },
          "idOcrConfidenceSecondId": {
            "$ref": "#/components/schemas/IdOcrConfidence",
            "description": "Same as idOcrConfidence only applicable if onboarding is configured to capture a second id"
          },
          "incodeWatchlistScore": {
            "$ref": "#/components/schemas/IncodeWatchlistScore",
            "description": "Incode watchlist score"
          },
          "retryInfo": {
            "$ref": "#/components/schemas/RetryInfo",
            "description": "Info about failed onboarding attempts (only if 'Onboarding flow attempts' > 0 in ID Capture module)"
          },
          "documentOnEdgeInfo": {
            "$ref": "#/components/schemas/DocumentOnEdgeInfo",
            "description": "Info about image alignment characteristic (if is on the image edge)"
          },
          "appliedRule": {
            "$ref": "#/components/schemas/AppliedFlowRule",
            "description": "Specific rule from rule engine for total"
          },
          "needsReviewReason": {
            "type": "string",
            "description": "In case the overall score status is MANUAL (Needs Review), returns reason",
            "enum": [
              "MANUAL_CAPTURE",
              "RULE_APPLIED",
              "OLD_ID",
              "FLOW_CONFIGURATION",
              "FRONT_ID_CAPTURE_ATTEMPTS",
              "BACK_ID_CAPTURE_ATTEMPTS",
              "SELFIE_CAPTURE_ATTEMPTS",
              "ANTIFRAUD",
              "MISSING_DEPTH_DATA",
              "CUSTOM"
            ]
          },
          "sessionRecording": {
            "$ref": "#/components/schemas/SessionRecording"
          },
          "trustGraph": {
            "$ref": "#/components/schemas/TrustGraph",
            "description": "Analysis of trust relationships and signals detected during onboarding, such as connections between devices and identities, used to assess the overall trustworthiness of the onboarding attempt."
          },
          "identityCrosscheck": {
            "$ref": "#/components/schemas/IdentityCrosscheck",
            "description": "Simple identity crosscheck that compare names and dates of birth from different sources"
          },
          "invoiceValidation": {
            "$ref": "#/components/schemas/Invoice",
            "description": "Analysis of invoice data"
          },
          "idValidationDeepCheck": {
            "$ref": "#/components/schemas/IdValidationDeepCheckScore",
            "description": "Asynchronous secondary ID validation deep check"
          },
          "autopilot": {
            "$ref": "#/components/schemas/AutopilotDto",
            "description": "Autopilot is a machine learning based score"
          },
          "overall": {
            "$ref": "#/components/schemas/ResultBean",
            "description": "Composite result for previous sections"
          }
        }
      },
      "SessionRecording": {
        "type": "object",
        "properties": {
          "mergedRecordingQualityChecks": {
            "$ref": "#/components/schemas/SessionRecordingQualityChecksScore"
          }
        }
      },
      "SessionRecordingQualityChecksScore": {
        "type": "object",
        "properties": {
          "fileIsPresent": {
            "type": "string",
            "enum": [
              "PRESENT",
              "NOT_PRESENT",
              "UNKNOWN"
            ]
          },
          "hasVideo": {
            "type": "string",
            "enum": [
              "YES",
              "NO",
              "UNKNOWN"
            ]
          },
          "hasAudio": {
            "type": "string",
            "enum": [
              "YES",
              "NO",
              "UNKNOWN"
            ]
          },
          "fileNotEmpty": {
            "type": "string",
            "enum": [
              "NOT_EMPTY",
              "EMPTY",
              "UNKNOWN"
            ]
          },
          "recordingQuality": {
            "$ref": "#/components/schemas/ResultBean"
          }
        }
      },
      "SpoofDetectionExplanationKeywordsDto": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string"
          },
          "isDepthFlat": {
            "type": "boolean"
          },
          "isVideoCorrupted": {
            "type": "boolean"
          }
        }
      },
      "SpoofResultExplanationDto": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string"
          },
          "keywords": {
            "$ref": "#/components/schemas/SpoofDetectionExplanationKeywordsDto"
          }
        }
      },
      "TrustGraph": {
        "type": "object",
        "properties": {
          "riskResults": {
            "$ref": "#/components/schemas/TrustGraphRiskResults"
          }
        }
      },
      "TrustGraphRiskResults": {
        "type": "object",
        "properties": {
          "overall": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "reasonCategoryScores": {
            "type": "object",
            "additionalProperties": {
              "type": "string",
              "enum": [
                "OK",
                "AT_RISK",
                "NOT_EXECUTED"
              ]
            }
          }
        }
      },
      "VideoSelfie": {
        "type": "object",
        "description": "- speechTranscript: Extracted text from speech, during video recording\n- videoSelfieLiveness: Shows liveness confidence that the person is real based on video conference\n- videoSelfieFaceRecognition: Shows how much face from id matches the video conference capture\n- speechRecognition: This shows how much the recognized speech matches the expected result\n- score: Overall video recording score\n",
        "properties": {
          "speechTranscript": {
            "type": "string"
          },
          "speechTranscriptWhisper": {
            "type": "string"
          },
          "videoSelfieLiveness": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "videoSelfieFaceRecognition": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "speechRecognition": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "score": {
            "$ref": "#/components/schemas/ResultBean"
          },
          "appliedRule": {
            "$ref": "#/components/schemas/AppliedFlowRule"
          }
        }
      },
      "BasicResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          }
        }
      },
      "AddressBean": {
        "type": "object",
        "properties": {
          "street": {
            "type": "string",
            "description": "Street line in the way it is read from address string."
          },
          "streetName": {
            "type": "string",
            "description": "Street name without exterior and interior numbers."
          },
          "colony": {
            "type": "string",
            "description": "Colony line the way it is read from address string. (Not applicable for all countries)"
          },
          "postalCode": {
            "type": "string",
            "description": "Postal code in the way it is read from address string."
          },
          "city": {
            "type": "string",
            "description": "City in the way it is read from address string."
          },
          "state": {
            "type": "string",
            "description": "State in the way it is read from address string."
          },
          "stateName": {
            "type": "string",
            "description": "Full StateName."
          },
          "district": {
            "type": "string",
            "description": "District in the way it is read from address string."
          },
          "stateCode": {
            "type": "string",
            "description": "State code if applicable."
          },
          "addressCountryCode": {
            "type": "string",
            "description": "Address country code if applicable."
          },
          "label": {
            "type": "string",
            "description": "Full address label."
          },
          "exteriorNumber": {
            "type": "string",
            "description": "Exterior street number."
          },
          "interiorNumber": {
            "type": "string",
            "description": "Interior street number."
          },
          "addressLine1": {
            "type": "string",
            "description": "The primary line in the address that contains the most essential details for locating a place."
          },
          "streetType": {
            "type": "string",
            "description": "Street type"
          }
        }
      },
      "NameBean": {
        "type": "object",
        "properties": {
          "fullName": {
            "type": "string"
          },
          "fullNameNativeScript": {
            "type": "string"
          },
          "firstNameNativeScript": {
            "type": "string"
          },
          "paternalLastNameNativeScript": {
            "type": "string"
          },
          "maternalLastNameNativeScript": {
            "type": "string"
          },
          "machineReadableFullName": {
            "type": "string",
            "description": "Full name from Barcode or MRZ"
          },
          "firstName": {
            "type": "string"
          },
          "middleName": {
            "type": "string"
          },
          "givenName": {
            "type": "string"
          },
          "givenNameMrz": {
            "type": "string"
          },
          "initials": {
            "type": "string",
            "description": "Initials as returned by bank-ID schemes (e.g. iDIN) — the only given-name evidence they provide"
          },
          "nameSuffix": {
            "type": "string"
          },
          "paternalLastName": {
            "type": "string"
          },
          "maternalLastName": {
            "type": "string"
          },
          "lastNameMrz": {
            "type": "string"
          },
          "familyName": {
            "type": "string"
          }
        }
      },
      "ExceptionResponse": {
        "type": "object",
        "properties": {
          "timestamp": {
            "type": "integer",
            "format": "int64",
            "description": "UTC timestamp in milliseconds"
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "description": "Custom error code or HTTP status code"
          },
          "error": {
            "type": "string",
            "description": "HTTP status error"
          },
          "message": {
            "type": "string",
            "description": "Custom error message"
          },
          "path": {
            "type": "string",
            "description": "Endpoint path"
          },
          "details": {
            "type": "object",
            "description": "Custom error details"
          }
        }
      },
      "UpdateManualReviewRequest": {
        "type": "object",
        "properties": {
          "manualReviewStatus": {
            "type": "string",
            "enum": [
              "REQUIRED",
              "APPROVED",
              "REJECTED"
            ]
          },
          "newReason": {
            "type": "string",
            "description": "Intended to be use when setting manualReviewStatus as required, it will be added to the list of reasons\nwhy a session was flagged as needs manual review.\n"
          },
          "comment": {
            "type": "string",
            "description": "Required comment in written form.\n"
          }
        },
        "required": [
          "manualReviewStatus"
        ]
      },
      "UpdateApiKeyRequest": {
        "type": "object",
        "properties": {
          "valid": {
            "type": "boolean",
            "description": "Key validity.",
            "example": false
          },
          "name": {
            "type": "string",
            "description": "Key name.",
            "example": "key12",
            "minLength": 1
          },
          "apiKey": {
            "type": "string",
            "description": "Organization reference.",
            "example": "6efbabe21a3b44955be51d25336fb7876b68a234"
          }
        },
        "required": [
          "valid"
        ]
      },
      "RotatableApiKeyDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Key name.",
            "example": "key1"
          },
          "value": {
            "type": "string",
            "description": "Key value, sha1(clientId).",
            "example": "f35844c8bcb417be1a64fd6e8d622cc93b0fcfaa"
          },
          "clientId": {
            "type": "string",
            "description": "Key clientId, name + random 3 digits.",
            "example": "key1254"
          },
          "valid": {
            "type": "boolean",
            "description": "Key validity."
          },
          "createdAt": {
            "type": "integer",
            "format": "int64",
            "description": "Key creation timestamp.",
            "example": 1678185005948
          },
          "updatedAt": {
            "type": "integer",
            "format": "int64",
            "description": "Key adjustment timestamp.",
            "example": 1678185005948
          }
        }
      },
      "CustomerEditableOcrDataRequest": {
        "type": "object",
        "properties": {
          "address": {
            "type": "string"
          },
          "documentNumber": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "paternalLastName": {
            "type": "string"
          },
          "maternalLastName": {
            "type": "string"
          },
          "personalNumber": {
            "type": "string"
          },
          "curp": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "birthDate": {
            "type": "string"
          },
          "expireAt": {
            "type": "string"
          },
          "gender": {
            "type": "string"
          }
        }
      },
      "UpdateRequest": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the person obtained from ocr can be updated here.",
            "example": "John Smith"
          },
          "birthDate": {
            "type": "string",
            "description": "Birth date of the person obtained from ocr can be updated here.",
            "example": "02/15/1990"
          },
          "address": {
            "type": "string",
            "description": "Address of the person obtained from ocr can be updated here.",
            "example": "221B Baker Street"
          },
          "gender": {
            "type": "string",
            "description": "Gender of the person obtained from ocr can be updated here.",
            "example": "Male"
          },
          "manualIdCheckNeeded": {
            "type": "boolean",
            "description": "If set to true, indicates that manual check is needed for validating id.",
            "example": true
          },
          "manualSelfieCheckNeeded": {
            "type": "boolean",
            "description": "If set to true, indicates that manual check is needed for validating selfie image.",
            "example": false
          }
        }
      },
      "VerifyInterviewRequest": {
        "type": "object",
        "properties": {
          "interviewCode": {
            "type": "string",
            "description": "Interview code received in response of [start](#/Onboarding/startInterview) call.",
            "example": "PTSFP6"
          }
        }
      },
      "AddToQueueResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "waitingTimeInSeconds": {
            "type": "integer",
            "format": "int64",
            "description": "Average waiting time before user joins conference call.",
            "example": 203
          }
        }
      },
      "FinishInterviewRequest": {
        "type": "object",
        "properties": {
          "interviewId": {
            "type": "string",
            "description": "Interview id."
          },
          "status": {
            "type": "string",
            "default": "NEEDS_REVIEW",
            "description": "Status of finished interview",
            "enum": [
              "NO_CONFERENCE",
              "APPROVED",
              "REJECTED",
              "ABANDONED",
              "NEEDS_REVIEW",
              "REJECTED_BY_RISK",
              "COMPLETED"
            ]
          }
        }
      },
      "FinishInterviewResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "urls": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "uuid": {
            "type": "string",
            "description": "ID of newly created customer (if onboarding was approved)."
          }
        }
      },
      "CustomFieldsRequest": {
        "type": "object",
        "properties": {
          "customFields": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            },
            "description": "Used to send any additional information in key value pair format. Max fields: {maxEntries}, max key length: {keyMaxLength}, max value length: {valueMaxLength}",
            "example": {
              "customFields": {
                "watchlistName": "Name"
              }
            }
          }
        }
      },
      "FaceCoordinatesDto": {
        "type": "object",
        "properties": {
          "leftEyeX": {
            "type": "number",
            "format": "float",
            "description": "Left eye coordinates for X",
            "example": 1391.01
          },
          "leftEyeY": {
            "type": "number",
            "format": "float",
            "description": "Left eye coordinates for Y",
            "example": 1334.62
          },
          "rightEyeX": {
            "type": "number",
            "format": "float",
            "description": "Right eye coordinates for X",
            "example": 918.383
          },
          "rightEyeY": {
            "type": "number",
            "format": "float",
            "description": "Right eye coordinates for Y",
            "example": 1359.96
          },
          "mouthX": {
            "type": "number",
            "format": "float",
            "deprecated": true,
            "description": "Left mouth coordinates for X. Note: the field is deprecated, use leftMouthX instead",
            "example": 918.383
          },
          "leftMouthX": {
            "type": "number",
            "format": "float",
            "description": "Left mouth coordinates for X",
            "example": 918.383
          },
          "mouthY": {
            "type": "number",
            "format": "float",
            "deprecated": true,
            "description": "Left mouth coordinates for Y. Note: the field is deprecated, use leftMouthY instead",
            "example": 1359.96
          },
          "leftMouthY": {
            "type": "number",
            "format": "float",
            "description": "Left mouth coordinates for Y",
            "example": 1359.96
          },
          "rightMouthX": {
            "type": "number",
            "format": "float",
            "description": "Right mouth coordinates for X",
            "example": 918.383
          },
          "rightMouthY": {
            "type": "number",
            "format": "float",
            "description": "Right mouth coordinates for Y",
            "example": 1359.96
          },
          "noseTipX": {
            "type": "number",
            "format": "float",
            "description": "Nose coordinates for X",
            "example": 918.383
          },
          "noseTipY": {
            "type": "number",
            "format": "float",
            "description": "Nose coordinates for Y",
            "example": 1359.96
          },
          "x": {
            "type": "number",
            "format": "float",
            "description": "X coordinate of face rectangle.",
            "example": 448
          },
          "y": {
            "type": "number",
            "format": "float",
            "description": "Y coordinate of face rectangle.",
            "example": 778
          },
          "width": {
            "type": "number",
            "format": "float",
            "description": "Width of face rectangle.",
            "example": 1366
          },
          "height": {
            "type": "number",
            "format": "float",
            "description": "Height of face rectangle.",
            "example": 1366
          }
        },
        "required": [
          "height",
          "leftEyeX",
          "leftEyeY",
          "noseTipX",
          "noseTipY",
          "rightEyeX",
          "rightEyeY",
          "rightMouthX",
          "rightMouthY",
          "width",
          "x",
          "y"
        ]
      },
      "StatelessAuthenticationSelfieRequest": {
        "type": "object",
        "properties": {
          "base64Image": {
            "type": "string",
            "description": "Image of user's face represented in base64.",
            "example": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEB...",
            "minLength": 1
          },
          "customerId": {
            "type": "string",
            "description": "Customer Id.",
            "minLength": 1
          },
          "sessionId": {
            "type": "string",
            "description": "Session Id.",
            "minLength": 1
          }
        }
      },
      "StatelessAuthenticationSelfieResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Operation result."
          },
          "candidate": {
            "type": "string",
            "description": "Id of the candidate for reference selfie."
          }
        }
      },
      "OneToNRequestV2": {
        "type": "object",
        "properties": {
          "selfie": {
            "$ref": "#/components/schemas/SelfieWithCoordinates"
          },
          "returnFirst": {
            "type": "boolean"
          }
        }
      },
      "SelfieWithCoordinates": {
        "type": "object",
        "properties": {
          "base64Image": {
            "type": "string",
            "description": "Image of user's face represented in base64.",
            "example": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEB..."
          },
          "faceCoordinates": {
            "$ref": "#/components/schemas/FaceCoordinatesDto",
            "description": "Face coordinates"
          }
        }
      },
      "AuthenticationAttemptResponse": {
        "type": "object",
        "properties": {
          "customerId": {
            "type": "string",
            "example": "6ea0859301170f0016fbd985"
          },
          "token": {
            "type": "string",
            "example": "eyJhbGciOiJIUzI1NiJ9.eyJleHRlcm5hbFVzZXJJZCI6IjYx85Mjdh..."
          },
          "interviewId": {
            "type": "string",
            "example": "6gdftr59301170f0011234567"
          },
          "interviewToken": {
            "type": "string",
            "example": "eyJhbGciOiJIUzI1NiJ9.eyJleHR6IjYx85Mj6IjYx85Mjlcm..."
          },
          "transactionId": {
            "type": "string",
            "description": "Authentication attempt identifier.",
            "example": "6128ca6c515d0e0013806d55"
          },
          "externalId": {
            "type": "string",
            "description": "External ID of customer, provided by client on /omni/start call."
          },
          "externalCustomerId": {
            "type": "string",
            "description": "External ID of customer, provided by client on /omni/start call."
          },
          "faceMatch": {
            "type": "boolean"
          },
          "spoofAttempt": {
            "type": "boolean",
            "description": "Flag indicating if this was spoof attempt."
          },
          "secondFactor": {
            "type": "boolean"
          },
          "children": {
            "type": "array",
            "deprecated": true,
            "items": {
              "type": "object",
              "deprecated": true
            }
          },
          "spoofConfidence": {
            "type": "number",
            "format": "float",
            "description": "Score between 0 and 1 that indicates if an image is a spoof. Scores closer to 0 indicate a legitimate session with a live user,\nwhereas scores closer to 1 indicate a higher probability that the provided image is spoofed and that the session may be fraudulent.\n"
          },
          "overallScore": {
            "type": "number",
            "format": "float",
            "description": "Overall score search, value form 0 to 100.",
            "maximum": 100,
            "minimum": 0
          },
          "overallStatus": {
            "type": "string",
            "description": "Overall status",
            "enum": [
              "PASS",
              "FAIL"
            ]
          },
          "deviceIPLocationData": {
            "$ref": "#/components/schemas/DeviceIPLocationDataDto"
          }
        }
      },
      "DeviceIPLocationDataDto": {
        "type": "object",
        "properties": {
          "ipAddress": {
            "type": "string"
          },
          "ipCountry": {
            "type": "string"
          },
          "ipCity": {
            "type": "string"
          },
          "ipRegion": {
            "type": "string"
          }
        }
      },
      "OneToNMfaRequest": {
        "type": "object",
        "properties": {
          "verificationCode": {
            "type": "string",
            "description": "The last 4 digits of the user's phone number.",
            "example": 4892,
            "minLength": 1
          },
          "transactionId": {
            "type": "string",
            "description": "Authentication identifier received in [/omni/oneToN/identify](#/Login/oneToNIdentify).",
            "example": "6128ca6c515d0e0013806d55",
            "minLength": 1
          }
        }
      },
      "OneToNRequest": {
        "type": "object",
        "properties": {
          "selfie": {
            "$ref": "#/components/schemas/SelfieWithoutCoordinates"
          },
          "returnFirst": {
            "type": "boolean"
          }
        }
      },
      "SelfieWithoutCoordinates": {
        "type": "object",
        "properties": {
          "base64Image": {
            "type": "string",
            "description": "Image of user's face represented in base64.",
            "example": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEB..."
          }
        }
      },
      "NotificationDelivery": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Notification type, can be SMS, EMAIL or URL.",
            "enum": [
              "SMS",
              "EMAIL",
              "URL"
            ]
          },
          "email": {
            "type": "string",
            "description": "Applicant email. Required for notification type EMAIL."
          },
          "phone": {
            "type": "string",
            "description": "Applicant phone. Required for notification type SMS."
          }
        },
        "required": [
          "type"
        ]
      },
      "NewOnboardingResponse": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "description": "Generated onboarding URL."
          },
          "interviewId": {
            "type": "string",
            "description": "Interview identifier."
          }
        }
      },
      "AdditionalName": {
        "type": "object",
        "properties": {
          "refNumber": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "BarcodeMeta": {
        "type": "object",
        "properties": {
          "ecLevel": {
            "type": "integer",
            "format": "int32"
          },
          "noSegments": {
            "type": "integer",
            "format": "int32"
          },
          "segmentWidth": {
            "type": "number",
            "format": "float"
          },
          "corners": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Coordinate"
            }
          },
          "cornersFullFrame": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Coordinate"
            }
          },
          "rawBytes": {
            "type": "string"
          },
          "pdf417RowNumber": {
            "type": "integer",
            "format": "int32"
          },
          "pdf417ColumnNumber": {
            "type": "integer",
            "format": "int32"
          },
          "pdf417CodewordLengthMin": {
            "type": "integer",
            "format": "int32"
          },
          "pdf417CodewordLengthMax": {
            "type": "integer",
            "format": "int32"
          },
          "pdf417CorrectedErrorsCount": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "Coordinate": {
        "type": "object",
        "properties": {
          "x": {
            "type": "number",
            "format": "float"
          },
          "y": {
            "type": "number",
            "format": "float"
          }
        }
      },
      "DLClassRestriction": {
        "type": "object",
        "properties": {
          "dlClass": {
            "type": "string"
          },
          "raw": {
            "type": "string"
          },
          "fullRaw": {
            "type": "string"
          },
          "baseCode": {
            "type": "string"
          },
          "subCode": {
            "type": "string"
          },
          "payload": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "OcrDataConfidence": {
        "type": "object",
        "description": "Structure containing ocr reliability confidence for each extracted ocr field. Confidence values are Floats between 0 and 1.",
        "properties": {
          "birthDateConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "nameConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "nameNativeScriptConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "firstNameNativeScriptConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "paternalLastNameNativeScriptConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "maternalLastNameNativeScriptConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "givenNameConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "firstNameConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "middleNameConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "nameSuffixConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "mothersSurnameConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "fathersSurnameConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "nickNameConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "fullNameMrzConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "mothersNameConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "fathersNameConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "mothersIdNumberConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "fathersIdNumberConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "spouseNameConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "birthNameConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "addressConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "streetConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "colonyConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "postalCodeConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "cityConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "stateConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "districtConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "stateCodeConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "countryCodeConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "genderConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "issueDateConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "expirationDateConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "issuedAtConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "expireAtConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "issuingAuthorityConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "mrz1Confidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "mrz2Confidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "mrz3Confidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "mrzFullConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "documentNumberConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "backNumberConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "personalNumberConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "nationalNumberConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "claveDeElectorConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "numeroEmisionCredencialConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "curpConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "nueConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "registrationDateConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "heightConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "birthPlaceConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "bloodTypeConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "eyeColorConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "classesConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "condConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "mentionsConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "refNumberConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "weightConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "hairConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "restrictionsConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "nationalityConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "nationalityMrzConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "nationalityAlpha3Confidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "maritalStatusConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "raceConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "taxIdNumberConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          },
          "jurisdictionCodeConfidence": {
            "type": "number",
            "format": "float",
            "maximum": 1,
            "minimum": 0
          }
        }
      },
      "Base64ImageRequest": {
        "type": "object",
        "properties": {
          "base64Image": {
            "type": "string",
            "description": "Base64 string representation of the image",
            "minLength": 1
          }
        },
        "required": [
          "base64Image"
        ]
      },
      "AddFiscalQrUrlResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "rfc": {
            "type": "string"
          },
          "curp": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "firstLastName": {
            "type": "string"
          },
          "secondLastName": {
            "type": "string"
          },
          "birthdate": {
            "type": "string"
          },
          "denomination": {
            "type": "string"
          },
          "regime": {
            "type": "string"
          },
          "constitutionDate": {
            "type": "string"
          },
          "operationStartDate": {
            "type": "string"
          },
          "personStatus": {
            "type": "string"
          },
          "lastSituationChangeDate": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "delegation": {
            "type": "string"
          },
          "colony": {
            "type": "string"
          },
          "streetType": {
            "type": "string"
          },
          "streetName": {
            "type": "string"
          },
          "extNumber": {
            "type": "string"
          },
          "intNumber": {
            "type": "string"
          },
          "postalCode": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "al": {
            "type": "string"
          },
          "fiscalRegime": {
            "type": "string"
          },
          "fiscalStartDate": {
            "type": "string"
          },
          "error": {
            "type": "string"
          },
          "result": {
            "type": "string"
          }
        }
      },
      "AdditionalDocumentAttempt": {
        "type": "object",
        "discriminator": {
          "propertyName": "documentType"
        },
        "properties": {
          "documentType": {
            "type": "string",
            "enum": [
              "ASYLUM_SEEKER",
              "BANK_STATEMENT",
              "COLOMBIAN_BIRTH_CERTIFICATE",
              "CURP",
              "GENERIC",
              "MEXICAN_TAX_DECLARATION",
              "MEXICAN_TAX_STATUS",
              "POA",
              "REFUGEE_ID",
              "REFUGEE_STATUS",
              "RFC",
              "V5C_LOGBOOK",
              "CAR_INVOICE",
              "CIRCULATION_CARD",
              "BANK_CHECK",
              "LETTER_OF_AUTHORIZATION",
              "FINANCE_SETTLEMENT",
              "INE_MEX",
              "COLOMBIA_RUT_FORM",
              "W8_BEN",
              "W8_BEN_E",
              "UNKNOWN"
            ]
          },
          "format": {
            "type": "string",
            "enum": [
              "IMAGE",
              "PDF"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "SUCCESS",
              "VALIDATION_ERROR",
              "FAIL"
            ]
          },
          "attemptTimestamp": {
            "type": "integer",
            "format": "int64"
          },
          "classificationConfidence": {
            "type": "number",
            "format": "float"
          },
          "image": {
            "$ref": "#/components/schemas/ImageAttempt"
          },
          "multiPageDocImages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImageAttempt"
            }
          },
          "attemptType": {
            "type": "string",
            "enum": [
              "POA",
              "DOCUMENT_CAPTURE"
            ]
          },
          "antiSpoofResult": {
            "$ref": "#/components/schemas/PoaAntiSpoofResult"
          }
        }
      },
      "AdditionalVerificationInfo": {
        "type": "object",
        "properties": {
          "creditFileDetails": {
            "$ref": "#/components/schemas/CreditFileDetails"
          }
        }
      },
      "AddressStatementDate": {
        "type": "object",
        "properties": {
          "get_version": {
            "type": "integer",
            "format": "int64"
          },
          "dateType": {
            "type": "string",
            "description": "Description of timestamp."
          },
          "addressStatementTimestamp": {
            "type": "integer",
            "format": "int64",
            "description": "UTC timestamp."
          }
        }
      },
      "AndroidInjectionData": {
        "type": "object",
        "properties": {
          "constraintsApplicationTime": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            }
          },
          "appliedConstraints": {
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        }
      },
      "AntifraudResult": {
        "type": "object",
        "properties": {
          "originalStatus": {
            "type": "string",
            "enum": [
              "FAILED",
              "PASSED",
              "NOT_EXECUTED",
              "MANUAL_REVIEW"
            ]
          },
          "resolved": {
            "type": "boolean"
          },
          "resolvedReason": {
            "type": "string"
          }
        }
      },
      "AsylumSeekerDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "firstName": {
                "type": "string"
              },
              "lastName": {
                "type": "string"
              },
              "countryOfOrigin": {
                "type": "string"
              },
              "dateOfBirth": {
                "type": "integer",
                "format": "int64"
              },
              "expiryDate": {
                "type": "integer",
                "format": "int64"
              },
              "issueDate": {
                "type": "integer",
                "format": "int64"
              },
              "gender": {
                "type": "string",
                "enum": [
                  "MALE",
                  "FEMALE"
                ]
              },
              "nationality": {
                "type": "string"
              },
              "placeOfIssue": {
                "type": "string"
              },
              "referenceNumber": {
                "type": "string"
              },
              "residentialAddressLines": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        ]
      },
      "BankCheckDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "accountNumber": {
                "type": "string"
              },
              "routingNumber": {
                "type": "string"
              },
              "unparsedCheckNumber": {
                "type": "string"
              }
            }
          }
        ]
      },
      "BankStatementDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "fullName": {
                "type": "string"
              },
              "address": {
                "type": "string"
              },
              "accountNumber": {
                "type": "string"
              },
              "bankName": {
                "type": "string"
              },
              "documentDate": {
                "type": "string"
              }
            }
          }
        ]
      },
      "BavHolder": {
        "type": "object",
        "properties": {
          "holder": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "balance": {
            "type": "number",
            "format": "float"
          },
          "currency": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "timestamp": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "BehaviorInfo": {
        "type": "object",
        "properties": {
          "detectionValuesDeviation": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          },
          "monotonicBorder": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          },
          "motionStatus": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          }
        }
      },
      "BrowserInfo": {
        "type": "object",
        "properties": {
          "userAgent": {
            "type": "string"
          },
          "getUserMediaAvailability": {
            "$ref": "#/components/schemas/GetUserMediaAvailability"
          },
          "webglFingerprint": {
            "type": "string"
          },
          "inspectorOpened": {
            "type": "boolean"
          },
          "isMockedBrowser": {
            "type": "boolean"
          }
        }
      },
      "BusinessVerificationRequest": {
        "type": "object",
        "properties": {
          "plugins": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "businessName": {
            "type": "string"
          },
          "addressLine1": {
            "type": "string"
          },
          "street": {
            "type": "string"
          },
          "houseNo": {
            "type": "string"
          },
          "addressLine2": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "postalCode": {
            "type": "string"
          },
          "country": {
            "type": "string",
            "enum": [
              "US",
              "BR",
              "CA",
              "CN",
              "UK",
              "GB",
              "DE",
              "FR",
              "RO",
              "ES",
              "IT",
              "IL",
              "AR",
              "IE",
              "JP",
              "SE",
              "NO",
              "VN",
              "NL",
              "NG",
              "KE",
              "CM",
              "HK",
              "IN",
              "MX",
              "DK",
              "BG",
              "MT",
              "LT",
              "KM",
              "TR",
              "EG",
              "AE",
              "SA",
              "AU",
              "GR",
              "PT",
              "BE",
              "AT"
            ]
          },
          "taxId": {
            "type": "string"
          },
          "uboNames": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "directors": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "BusinessVerificationResult": {
        "type": "object",
        "properties": {
          "businessName": {
            "type": "string"
          },
          "businessClassification": {
            "type": "string"
          },
          "addressVerification": {
            "type": "string"
          },
          "cityVerification": {
            "type": "string"
          },
          "postalCodeVerification": {
            "type": "string"
          },
          "stateVerification": {
            "type": "string"
          },
          "addressPropertyType": {
            "type": "string"
          },
          "addressDeliverability": {
            "type": "string"
          },
          "tinVerification": {
            "type": "string"
          },
          "uboNameMatch": {
            "type": "string"
          },
          "registrationStatus": {
            "type": "string",
            "enum": [
              "Active",
              "Inactive",
              "Unknown"
            ]
          },
          "entityType": {
            "$ref": "#/components/schemas/EntityType"
          },
          "verificationMessages": {
            "$ref": "#/components/schemas/VerificationMessages"
          },
          "uboNameVerificationResults": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UboNameVerificationResult"
            }
          },
          "directorsVerificationResults": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UboNameVerificationResult"
            }
          },
          "people": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/People"
            }
          }
        }
      },
      "CameraCheckData": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "FRONT",
              "BACK"
            ]
          },
          "isAvailable": {
            "type": "boolean"
          },
          "faceDetected": {
            "type": "boolean"
          },
          "idDetected": {
            "type": "boolean"
          },
          "isTimeoutReached": {
            "type": "boolean"
          }
        }
      },
      "CameraInfo": {
        "type": "object",
        "properties": {
          "facingMode": {
            "type": "string",
            "enum": [
              "FRONTAL",
              "BACK"
            ]
          },
          "settings": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "capabilities": {
            "type": "object"
          },
          "labels": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "CaptureMetadata": {
        "type": "object",
        "properties": {
          "timestamp": {
            "type": "integer",
            "format": "int64"
          },
          "sdkPlatform": {
            "type": "string",
            "enum": [
              "WEBAPP",
              "IOS",
              "ANDROID"
            ]
          },
          "sdkVersion": {
            "type": "string"
          },
          "callerId": {
            "type": "string"
          },
          "device": {
            "$ref": "#/components/schemas/MetadataDeviceInfo"
          },
          "browser": {
            "$ref": "#/components/schemas/BrowserInfo"
          },
          "camera": {
            "$ref": "#/components/schemas/CameraInfo"
          },
          "iad": {
            "$ref": "#/components/schemas/IadInfo"
          },
          "behavior": {
            "$ref": "#/components/schemas/BehaviorInfo"
          },
          "captureMode": {
            "type": "string",
            "enum": [
              "AUTO",
              "MANUAL"
            ]
          },
          "hasDepth": {
            "type": "boolean"
          },
          "expectedDepth": {
            "type": "boolean"
          },
          "mediaInfo": {
            "$ref": "#/components/schemas/MediaInfo"
          },
          "clientLogs": {
            "type": "string"
          }
        }
      },
      "CarInvoiceDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "$ref": "#/components/schemas/NameBean"
              },
              "dealerLegalName": {
                "type": "string"
              },
              "vin": {
                "type": "string"
              },
              "invoiceIssuingDate": {
                "type": "integer",
                "format": "int64"
              },
              "invoiceCertificationDate": {
                "type": "integer",
                "format": "int64"
              },
              "engineNumber": {
                "type": "string"
              },
              "carModelYear": {
                "type": "integer",
                "format": "int32"
              },
              "issuerRFC": {
                "type": "string"
              },
              "recipientRFC": {
                "type": "string"
              },
              "digitalTaxStampUuid": {
                "type": "string"
              },
              "carPrice": {
                "type": "number"
              },
              "issuerTaxRegime": {
                "type": "string"
              },
              "recipientTaxRegime": {
                "type": "string"
              },
              "qrIssuerRFC": {
                "type": "string"
              },
              "qrRecipientRFC": {
                "type": "string"
              },
              "qrDigitalTaxStampUuid": {
                "type": "string"
              },
              "validationErrors": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ValidationErrorSchema"
                }
              }
            }
          }
        ]
      },
      "CctInjectionData": {
        "type": "object",
        "properties": {
          "initialCct": {
            "type": "integer",
            "format": "int32"
          },
          "minColorTemperatureParameters": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CctParams"
            }
          },
          "maxColorTemperatureParameters": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CctParams"
            }
          }
        }
      },
      "CctParams": {
        "type": "object",
        "properties": {
          "value": {
            "type": "integer",
            "format": "int32"
          },
          "applicationTime": {
            "type": "integer",
            "format": "int32"
          },
          "appliedConstraints": {
            "type": "object"
          },
          "isTimeoutReached": {
            "type": "boolean"
          },
          "framePixelDelta": {
            "type": "number",
            "format": "float"
          }
        }
      },
      "CirculationCardDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "$ref": "#/components/schemas/NameBean"
              },
              "vin": {
                "type": "string"
              },
              "engineNumber": {
                "type": "string"
              },
              "carModelYear": {
                "type": "integer",
                "format": "int32"
              },
              "licensePlates": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "color": {
                "type": "string"
              },
              "vehicleUse": {
                "type": "string"
              },
              "validationErrors": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ValidationErrorSchema"
                }
              }
            }
          }
        ]
      },
      "ColombiaRutFormDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "$ref": "#/components/schemas/NameBean"
              },
              "taxIdNumber": {
                "type": "string"
              },
              "identificationNumber": {
                "type": "string"
              },
              "issueDate": {
                "type": "integer",
                "format": "int64"
              },
              "generationDate": {
                "type": "integer",
                "format": "int64"
              },
              "mainActivityCode": {
                "type": "string"
              },
              "secondaryActivityCode": {
                "type": "string"
              },
              "otherActivityCode1": {
                "type": "string"
              },
              "otherActivityCode2": {
                "type": "string"
              },
              "validationErrors": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ValidationErrorSchema"
                }
              }
            }
          }
        ]
      },
      "ColombianBirthCertificateDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "nationalNumber": {
                "type": "string"
              },
              "paternalLastname": {
                "type": "string"
              },
              "maternalLastname": {
                "type": "string"
              },
              "fullName": {
                "type": "string"
              },
              "dateOfBirth": {
                "type": "integer",
                "format": "int64"
              },
              "motherFullName": {
                "type": "string"
              },
              "motherNationalNumber": {
                "type": "string"
              },
              "fatherFullName": {
                "type": "string"
              },
              "fatherNationalNumber": {
                "type": "string"
              },
              "birthPlace": {
                "type": "string"
              }
            }
          }
        ]
      },
      "ContrastSharpnessSaturation": {
        "type": "object",
        "properties": {
          "contrast": {
            "type": "integer",
            "format": "int32"
          },
          "sharpness": {
            "type": "integer",
            "format": "int32"
          },
          "saturation": {
            "type": "integer",
            "format": "int32"
          },
          "metrics": {
            "type": "number",
            "format": "float"
          },
          "isTimeoutReached": {
            "type": "boolean"
          },
          "framePixelDelta": {
            "type": "number",
            "format": "float"
          }
        }
      },
      "ContrastSharpnessSaturationData": {
        "type": "object",
        "properties": {
          "initialValues": {
            "$ref": "#/components/schemas/ContrastSharpnessSaturation"
          },
          "appliedValues": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ContrastSharpnessSaturation"
            }
          }
        }
      },
      "CreditFileDetails": {
        "type": "object",
        "properties": {
          "creditFileNumber": {
            "type": "string"
          },
          "creditFileCreationDate": {
            "type": "string"
          }
        }
      },
      "CurpCecobanValidation": {
        "type": "object",
        "properties": {
          "returnCode": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "uniquePopulationRegistrationKeyMatch": {
            "type": "boolean"
          }
        }
      },
      "CurpDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "fullName": {
                "type": "string"
              },
              "curpNumber": {
                "type": "string"
              },
              "registrationDate": {
                "type": "integer",
                "format": "int64"
              },
              "registrationEntity": {
                "type": "string"
              },
              "idNumber": {
                "type": "string"
              }
            }
          }
        ]
      },
      "CustomDate": {
        "type": "object",
        "properties": {
          "dateType": {
            "type": "string",
            "description": "Description of timestamp."
          },
          "timestamp": {
            "type": "integer",
            "format": "int64",
            "description": "UTC timestamp."
          }
        }
      },
      "CustomField": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "CustomFieldValid": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "boolean"
          }
        }
      },
      "Detail": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string"
          },
          "error": {
            "type": "string"
          },
          "loc": {
            "type": "string"
          },
          "explanation": {
            "type": "string"
          }
        }
      },
      "ESignedDocument": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string"
          },
          "s3location": {
            "type": "string"
          },
          "createdTime": {
            "type": "integer",
            "format": "int64"
          },
          "signerKeyName": {
            "type": "string"
          },
          "externalFileId": {
            "type": "string"
          },
          "qesAttemptId": {
            "type": "string"
          }
        }
      },
      "EUnsignedDocument": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string"
          },
          "s3location": {
            "type": "string"
          },
          "createdTime": {
            "type": "integer",
            "format": "int64"
          },
          "documentName": {
            "type": "string"
          }
        }
      },
      "EconomicActivity": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "percentage": {
            "type": "integer",
            "format": "int32"
          },
          "startDate": {
            "type": "integer",
            "format": "int64"
          },
          "endDate": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "Employment": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "sector": {
            "type": "string"
          }
        }
      },
      "EntityType": {
        "type": "object",
        "properties": {
          "entityType": {
            "type": "string"
          }
        }
      },
      "EnvironmentIntegrity": {
        "type": "object",
        "properties": {
          "rootDetected": {
            "type": "boolean"
          },
          "storageTamperingDetected": {
            "type": "boolean"
          },
          "environmentHookingDetected": {
            "type": "boolean"
          },
          "wasmTamperingDetected": {
            "type": "boolean"
          },
          "challengeInterruptionDetected": {
            "type": "boolean"
          },
          "debugModeDetected": {
            "type": "boolean"
          },
          "rootDetectionLevel": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "ExifMetadata": {
        "type": "object",
        "properties": {
          "timestampOriginal": {
            "type": "integer",
            "format": "int64"
          },
          "software": {
            "type": "string"
          }
        }
      },
      "ExposureData": {
        "type": "object",
        "properties": {
          "exposureParams": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/ExposureParams"
              }
            }
          },
          "frames": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/ExposureFrame"
              }
            }
          },
          "sessionDiagnostics": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SessionDiagnostics"
            }
          }
        }
      },
      "ExposureFrame": {
        "type": "object",
        "properties": {
          "timestamp": {
            "type": "number",
            "format": "double"
          },
          "exposureType": {
            "type": "string"
          },
          "requestedMode": {
            "type": "string"
          },
          "requestedCompensation": {
            "type": "number",
            "format": "float"
          },
          "brightness": {
            "type": "number",
            "format": "float"
          },
          "isCanonical": {
            "type": "boolean"
          },
          "applyConstraintsTime": {
            "type": "integer",
            "format": "int32"
          },
          "reportedMode": {
            "type": "string"
          },
          "reportedCompensation": {
            "type": "number",
            "format": "float"
          },
          "reportedExposureTime": {
            "type": "number",
            "format": "float"
          },
          "isTimeoutReached": {
            "type": "boolean"
          },
          "imageWidth": {
            "type": "integer",
            "format": "int32"
          },
          "imageHeight": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "ExposureParams": {
        "type": "object",
        "properties": {
          "applyConstraintsTime": {
            "type": "integer",
            "format": "int32"
          },
          "exposureType": {
            "type": "string",
            "enum": [
              "INITIAL",
              "MIN",
              "MAX",
              "TOGGLE"
            ]
          },
          "exposureMode": {
            "type": "string",
            "enum": [
              "CONTINUOUS",
              "MANUAL"
            ]
          },
          "exposureCompensation": {
            "type": "number",
            "format": "float"
          },
          "exposureTime": {
            "type": "number",
            "format": "float"
          },
          "brightness": {
            "type": "number",
            "format": "float"
          },
          "isTimeoutReached": {
            "type": "boolean"
          }
        }
      },
      "ExternalVerificationRequest": {
        "type": "object",
        "properties": {
          "plugins": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "source": {
            "type": "string",
            "enum": [
              "US_DRIVERS_LICENSE_1",
              "US_TELCO_1",
              "US_TELCO_2",
              "US_TELCO_4",
              "US_TELCO_5",
              "US_CREDIT_BUREAU_1",
              "US_CREDIT_BUREAU_3",
              "US_ADDRESS_1",
              "US_CONSUMER_1",
              "MX_CONSUMER_1",
              "MX_CONSUMER_2",
              "BR_GOVT_1",
              "BR_CPF_1",
              "CA_RES_CREDIT",
              "CA_CREDIT_FINTRAC",
              "CA_TELCO",
              "UK_CREDIT_BUREAU_1",
              "UK_VOTER_REGISTER",
              "ES_PHONE_REGISTER_2",
              "CL_1",
              "CL_CIVIL_REGISTER_3",
              "AR_1",
              "AR_RES_REGISTER",
              "AR_CREDIT_BUR_1",
              "GR_1",
              "GT_1",
              "CR_1",
              "CO_1",
              "PHONE_RISK_1",
              "PHONE_RISK_2",
              "PHONE_PROFILE",
              "EMAIL_RISK_1",
              "RISK_ADDONS_ONLY",
              "GH_CARD_VERIFY_1",
              "PE_MIGRATION_INSTITUTE",
              "KE_IDENTIFYAFRICA",
              "INDIA_PAN",
              "INDIA_PAN_1",
              "INDIA_PASSPORT_1",
              "IN_DMV",
              "NG_MONO_BVN",
              "NG_MONO_NIN",
              "US_CREDIT_TELCO",
              "PH_RES_CREDIT",
              "VE_CIVIL_REGISTER",
              "CO_CIVIL_REGISTER_1",
              "MX_CIVIL_REGISTER_2",
              "BR_TAX_PHONE_REGISTER",
              "NL_CONSUMER_POP_REG_TELCO",
              "NL_CIVIL_REG_CREDIT_TELCO",
              "FI_NATIONAL_ID",
              "FI_CONSUMER_POP_REG_TELCO",
              "BE_CREDIT_TELCO",
              "DK_CIVIL_REG_CREDIT_TELCO",
              "GB_2X2",
              "PE_CIVIL_REGISTER_2",
              "NO_CONS_POP_REG",
              "DE_PHONE_MOBILE_REGISTER",
              "IT_CIVIL_REG_CREDIT_TELCO",
              "SG_PHONE_REGISTER",
              "PT_CIVIL_REG_CREDIT_TELCO",
              "EC_PHONE_REGISTER",
              "PT_PHONE_REGISTER",
              "HK_RESIDENT_REGISTER"
            ]
          },
          "fullName": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "middleName": {
            "type": "string"
          },
          "surName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "street": {
            "type": "string"
          },
          "houseNo": {
            "type": "string"
          },
          "postalCode": {
            "type": "string"
          },
          "countryCode": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "ssn": {
            "type": "string"
          },
          "dateOfBirth": {
            "type": "string"
          },
          "ipAddress": {
            "type": "string"
          },
          "taxIdStatus": {
            "type": "string"
          },
          "nationality": {
            "type": "string"
          },
          "dlNumber": {
            "type": "string"
          },
          "dlExpireAt": {
            "type": "string"
          },
          "dlState": {
            "type": "string"
          },
          "last4SSN": {
            "type": "string"
          },
          "idNumber": {
            "type": "string"
          },
          "panNumber": {
            "type": "string"
          }
        }
      },
      "FinanceSettlementDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "$ref": "#/components/schemas/NameBean"
              },
              "settlementDate": {
                "type": "integer",
                "format": "int64"
              },
              "settlementFigure": {
                "type": "number"
              },
              "agreementReference": {
                "type": "string"
              },
              "vehicleRegistrationNumber": {
                "type": "string"
              },
              "financeCompany": {
                "type": "string"
              },
              "accountNumber": {
                "type": "string"
              },
              "sortCode": {
                "type": "string"
              },
              "validationErrors": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ValidationErrorSchema"
                }
              }
            }
          }
        ]
      },
      "FlowRule": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "expression": {
            "type": "string"
          },
          "ruleType": {
            "type": "string",
            "enum": [
              "idValidation",
              "secondIdValidation",
              "faceValidation",
              "liveness",
              "deepsight",
              "eKyc",
              "videoselfie",
              "faceAuthentication",
              "total",
              "phoneRisk",
              "emailRisk",
              "governmentValidation"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "OK",
              "WARN",
              "FAIL",
              "UNKNOWN",
              "MANUAL",
              "MANUAL_OK",
              "MANUAL_FAIL",
              "MANUAL_PENDING"
            ]
          },
          "triggered": {
            "type": "boolean"
          }
        }
      },
      "FrameDuplicationData": {
        "type": "object",
        "properties": {
          "validDuplicateCount": {
            "type": "integer",
            "format": "int32"
          },
          "invalidDuplicateCount": {
            "type": "integer",
            "format": "int32"
          },
          "continuousValidDuplicateCount": {
            "type": "integer",
            "format": "int32"
          },
          "continuousInvalidDuplicateCount": {
            "type": "integer",
            "format": "int32"
          },
          "isTimeoutReached": {
            "type": "boolean"
          },
          "initialDuplicateFramesDetected": {
            "type": "boolean"
          },
          "initialOpenCaptureDuplicateFramesDetected": {
            "type": "boolean"
          },
          "invalidInitialDuplicateFramesDetected": {
            "type": "boolean"
          },
          "continuousDuplicateFramesDetected": {
            "type": "boolean"
          },
          "numInitialDuplicateInstances": {
            "type": "integer",
            "format": "int32"
          },
          "numInitialOpenCaptureDuplicateInstances": {
            "type": "integer",
            "format": "int32"
          },
          "numInvalidInitialDuplicateInstances": {
            "type": "integer",
            "format": "int32"
          },
          "numContinuousDuplicateInstances": {
            "type": "integer",
            "format": "int32"
          },
          "preCaptureTotalFrames": {
            "type": "integer",
            "format": "int32"
          },
          "preCaptureUniqueHashes": {
            "type": "integer",
            "format": "int32"
          },
          "preCaptureMaxConsecutiveRun": {
            "type": "integer",
            "format": "int32"
          },
          "preCaptureMaxOccurrenceCount": {
            "type": "integer",
            "format": "int32"
          },
          "preCaptureMaxOccurrencePercentage": {
            "type": "number",
            "format": "float"
          },
          "frameStats": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FrameStats"
            }
          },
          "perPhaseStats": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PerPhaseStats"
            }
          }
        }
      },
      "FrameStats": {
        "type": "object",
        "properties": {
          "frameCount": {
            "type": "integer",
            "format": "int32"
          },
          "isBlack": {
            "type": "boolean"
          },
          "isUnique": {
            "type": "boolean"
          },
          "timestamp": {
            "type": "integer",
            "format": "int32"
          },
          "updatedPercentage": {
            "type": "number",
            "format": "float"
          }
        }
      },
      "FrontBackCameraData": {
        "type": "object",
        "properties": {
          "cameraCheckData": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CameraCheckData"
            }
          },
          "phashMinRotHamming": {
            "type": "integer",
            "format": "int32"
          },
          "colorHistChiSqr": {
            "type": "number",
            "format": "float"
          },
          "noiseMaeRatio": {
            "type": "number",
            "format": "float"
          },
          "noiseDistroChiSqr": {
            "type": "number",
            "format": "float"
          },
          "initialFrameCount": {
            "type": "integer",
            "format": "int32"
          },
          "oppositeFrameCount": {
            "type": "integer",
            "format": "int32"
          },
          "oppositeWithinPhashHammingMean": {
            "type": "number",
            "format": "float"
          },
          "oppositeWithinPhashHammingMax": {
            "type": "number",
            "format": "float"
          },
          "oppositeWithinNoiseMaeStdev": {
            "type": "number",
            "format": "float"
          },
          "oppositeWithinBrightnessStdev": {
            "type": "number",
            "format": "float"
          },
          "crossPhashHammingMean": {
            "type": "number",
            "format": "float"
          },
          "crossPhashHammingMin": {
            "type": "number",
            "format": "float"
          },
          "crossPhashHammingMax": {
            "type": "number",
            "format": "float"
          },
          "crossColorHistChiSqrMean": {
            "type": "number",
            "format": "float"
          },
          "crossNoiseMaeDelta": {
            "type": "number",
            "format": "float"
          },
          "crossNoiseDistroChiSqrMean": {
            "type": "number",
            "format": "float"
          },
          "crossBrightnessDelta": {
            "type": "number",
            "format": "float"
          },
          "initialSceneFeatures": {
            "type": "array",
            "items": {
              "type": "number",
              "format": "float"
            }
          },
          "oppositeSceneFeatures": {
            "type": "array",
            "items": {
              "type": "number",
              "format": "float"
            }
          },
          "crossSceneFeatureDeltas": {
            "type": "array",
            "items": {
              "type": "number",
              "format": "float"
            }
          },
          "oppositeTemporalKurtosis": {
            "type": "number",
            "format": "float"
          },
          "oppositeTemporalKsToGaussian": {
            "type": "number",
            "format": "float"
          },
          "oppositeTemporalLevelsRatio": {
            "type": "number",
            "format": "float"
          },
          "oppositeTemporalVarianceMean": {
            "type": "number",
            "format": "float"
          },
          "oppositeTemporalVarianceStdev": {
            "type": "number",
            "format": "float"
          },
          "initialDeviceId": {
            "type": "string"
          },
          "oppositeDeviceId": {
            "type": "string"
          },
          "initialGroupId": {
            "type": "string"
          },
          "oppositeGroupId": {
            "type": "string"
          },
          "initialFacingMode": {
            "type": "string"
          },
          "oppositeFacingMode": {
            "type": "string"
          },
          "initialWidth": {
            "type": "integer",
            "format": "int32"
          },
          "initialHeight": {
            "type": "integer",
            "format": "int32"
          },
          "oppositeWidth": {
            "type": "integer",
            "format": "int32"
          },
          "oppositeHeight": {
            "type": "integer",
            "format": "int32"
          },
          "initialFrameRate": {
            "type": "number",
            "format": "float"
          },
          "oppositeFrameRate": {
            "type": "number",
            "format": "float"
          },
          "deviceIdsDiffer": {
            "type": "boolean"
          },
          "groupIdsMatch": {
            "type": "boolean"
          },
          "experimentIncomplete": {
            "type": "boolean"
          }
        }
      },
      "GenericDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "fullName": {
                "type": "string"
              },
              "address": {
                "type": "string"
              },
              "issueDate": {
                "type": "integer",
                "format": "int64"
              }
            }
          }
        ]
      },
      "GenericInjectionData": {
        "type": "object",
        "properties": {
          "streamInitializationTime": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            }
          },
          "timeToFirstFrame": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            }
          },
          "appliedConstraints": {
            "type": "object"
          },
          "isTimeoutReached": {
            "type": "boolean"
          },
          "sitAborted": {
            "type": "boolean"
          },
          "warmInitializationTime": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "GetUserMediaAvailability": {
        "type": "object",
        "properties": {
          "webkit": {
            "type": "boolean"
          },
          "mozilla": {
            "type": "boolean"
          },
          "opera": {
            "type": "boolean"
          },
          "microsoft": {
            "type": "boolean"
          }
        }
      },
      "GovernmentFingerprintsBean": {
        "type": "object",
        "properties": {
          "finger1": {
            "type": "number",
            "format": "float",
            "description": "Match confidence for finger 1 (right thumb)."
          },
          "finger2": {
            "type": "number",
            "format": "float",
            "description": "Match confidence for finger 2 (right index)."
          },
          "finger3": {
            "type": "number",
            "format": "float",
            "description": "Match confidence for finger 3 (right middle)."
          },
          "finger4": {
            "type": "number",
            "format": "float",
            "description": "Match confidence for finger 4 (right ring)."
          },
          "finger5": {
            "type": "number",
            "format": "float",
            "description": "Match confidence for finger 5 (right pinky)."
          },
          "finger6": {
            "type": "number",
            "format": "float",
            "description": "Match confidence for finger 6 (left thumb)."
          },
          "finger7": {
            "type": "number",
            "format": "float",
            "description": "Match confidence for finger 7 (left index)."
          },
          "finger8": {
            "type": "number",
            "format": "float",
            "description": "Match confidence for finger 8 (left middle)."
          },
          "finger9": {
            "type": "number",
            "format": "float",
            "description": "Match confidence for finger 9 (left ring)."
          },
          "finger10": {
            "type": "number",
            "format": "float",
            "description": "Match confidence for finger 10 (left pinky)."
          }
        }
      },
      "IadInfo": {
        "type": "object",
        "properties": {
          "isDeepsightEnabled": {
            "type": "boolean"
          },
          "deepsightLiveness": {
            "type": "string",
            "enum": [
              "SINGLE_FRAME",
              "MULTIMODAL",
              "VIDEOLIVENESS"
            ]
          },
          "zoomCheck": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          },
          "exposureCompensationCheck": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          },
          "cctCheck": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          },
          "genericCheck": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          },
          "mobileTemporalCheck": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          },
          "contrastSharpnessSaturationCheck": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          },
          "frontBackCameraCheck": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          },
          "frameDuplicationCheck": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          },
          "exposureCheck": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          },
          "replayAttackCheck": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          },
          "environmentIntegrityCheck": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          },
          "extendedDeviceAndBrowserClassificationData": {
            "type": "object"
          },
          "deviceEmulationCheck": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "UNCLEAR"
            ]
          },
          "contrastSharpnessSaturationData": {
            "$ref": "#/components/schemas/ContrastSharpnessSaturationData"
          },
          "genericInjectionData": {
            "$ref": "#/components/schemas/GenericInjectionData"
          },
          "iosInjectionData": {
            "$ref": "#/components/schemas/IosInjectionData"
          },
          "cctInjectionData": {
            "$ref": "#/components/schemas/CctInjectionData"
          },
          "androidInjectionData": {
            "$ref": "#/components/schemas/AndroidInjectionData"
          },
          "frontBackCameraData": {
            "$ref": "#/components/schemas/FrontBackCameraData"
          },
          "frameDuplicationData": {
            "$ref": "#/components/schemas/FrameDuplicationData"
          },
          "zoomData": {
            "$ref": "#/components/schemas/ZoomData"
          },
          "exposureData": {
            "$ref": "#/components/schemas/ExposureData"
          },
          "replayAttackData": {
            "$ref": "#/components/schemas/ReplayAttackData"
          },
          "environmentIntegrity": {
            "$ref": "#/components/schemas/EnvironmentIntegrity"
          },
          "isMotionEnabled": {
            "type": "boolean"
          },
          "sensorDataReference": {
            "type": "string"
          }
        }
      },
      "ImageAttempt": {
        "type": "object",
        "properties": {
          "imageRef": {
            "type": "string"
          },
          "timestamp": {
            "type": "integer",
            "format": "int64"
          },
          "exifMetadata": {
            "$ref": "#/components/schemas/ExifMetadata"
          }
        }
      },
      "Income": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string"
          },
          "range": {
            "type": "string"
          }
        }
      },
      "IneMexDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "address": {
                "type": "string"
              },
              "addressList": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "voterIDNumber": {
                "type": "string"
              },
              "curpNumber": {
                "type": "string"
              },
              "dateOfBirth": {
                "type": "integer",
                "format": "int64"
              },
              "gender": {
                "type": "string"
              },
              "birthPlace": {
                "type": "string"
              },
              "nationality": {
                "type": "string"
              },
              "validFrom": {
                "type": "integer",
                "format": "int64"
              },
              "validTo": {
                "type": "integer",
                "format": "int64"
              },
              "registrationDate": {
                "type": "integer",
                "format": "int64"
              },
              "cicNumber": {
                "type": "string"
              },
              "ocrNumber": {
                "type": "string"
              },
              "idNumber": {
                "type": "string"
              },
              "credentialIssueNumber": {
                "type": "string"
              }
            }
          }
        ]
      },
      "Interview": {
        "type": "object",
        "properties": {
          "get_version": {
            "type": "integer",
            "format": "int64"
          },
          "secondDocumentInterviewId": {
            "type": "string"
          },
          "parentInterviewId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "fullNameMrz": {
            "type": "string"
          },
          "displayName": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "birthDate": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "location": {
            "type": "string"
          },
          "longitude": {
            "type": "number",
            "format": "float"
          },
          "latitude": {
            "type": "number",
            "format": "float"
          },
          "gender": {
            "type": "string"
          },
          "typeOfId": {
            "type": "string"
          },
          "externalId": {
            "type": "string"
          },
          "flowWalletAddress": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "mrz1": {
            "type": "string"
          },
          "mrz2": {
            "type": "string"
          },
          "mrz3": {
            "type": "string"
          },
          "street": {
            "type": "string"
          },
          "colony": {
            "type": "string"
          },
          "postalCode": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "stateCode": {
            "type": "string"
          },
          "countryCode": {
            "type": "string"
          },
          "cic": {
            "type": "string"
          },
          "ocr": {
            "type": "string"
          },
          "claveDeElector": {
            "type": "string"
          },
          "numeroEmisionCredencial": {
            "type": "string"
          },
          "personalNumber": {
            "type": "string"
          },
          "nationalNumber": {
            "type": "string"
          },
          "personalIdNumber": {
            "type": "string"
          },
          "taxIdNumber": {
            "type": "string"
          },
          "issueFront": {
            "type": "integer",
            "format": "int32"
          },
          "issueBack": {
            "type": "integer",
            "format": "int32"
          },
          "issuingCountry": {
            "type": "string"
          },
          "registrationDate": {
            "type": "integer",
            "format": "int32"
          },
          "documentId": {
            "type": "string"
          },
          "deviceType": {
            "type": "string",
            "enum": [
              "IOS",
              "ANDROID",
              "WEBAPP"
            ]
          },
          "height": {
            "type": "string"
          },
          "birthPlace": {
            "type": "string"
          },
          "bloodType": {
            "type": "string"
          },
          "curp": {
            "type": "string"
          },
          "recognitionConfidence": {
            "type": "number",
            "format": "float"
          },
          "nfcRecognitionConfidence": {
            "$ref": "#/components/schemas/NfcRecognitionConfidence"
          },
          "spoofConfidence": {
            "type": "number",
            "format": "float",
            "deprecated": true
          },
          "idValidationScore": {
            "type": "string"
          },
          "tamperedConfidence": {
            "type": "number",
            "format": "float"
          },
          "tamperedModelVersion": {
            "type": "string"
          },
          "fakeIdConfidence": {
            "type": "number",
            "format": "float"
          },
          "retouchFrontConfidence": {
            "type": "number",
            "format": "float"
          },
          "frontClassification": {
            "type": "string",
            "enum": [
              "Unknown",
              "Passport",
              "Visa",
              "DriversLicense",
              "IdentificationCard",
              "Permit",
              "Currency",
              "ResidenceDocument",
              "TravelDocument",
              "BirthCertificate",
              "VehicleRegistration",
              "Other",
              "WeaponLicense",
              "TribalIdentification",
              "VoterIdentification",
              "Military",
              "TaxIdentification",
              "FederalID",
              "MedicalCard"
            ]
          },
          "backClassification": {
            "type": "string",
            "enum": [
              "Unknown",
              "Passport",
              "Visa",
              "DriversLicense",
              "IdentificationCard",
              "Permit",
              "Currency",
              "ResidenceDocument",
              "TravelDocument",
              "BirthCertificate",
              "VehicleRegistration",
              "Other",
              "WeaponLicense",
              "TribalIdentification",
              "VoterIdentification",
              "Military",
              "TaxIdentification",
              "FederalID",
              "MedicalCard"
            ]
          },
          "frontIdFaceCount": {
            "type": "integer",
            "format": "int32"
          },
          "manualIdCheckNeeded": {
            "type": "boolean"
          },
          "manualSelfieCheckNeeded": {
            "type": "boolean"
          },
          "frontSharpness": {
            "type": "integer",
            "format": "int32"
          },
          "frontGlare": {
            "type": "integer",
            "format": "int32"
          },
          "frontHorizontalResolution": {
            "type": "integer",
            "format": "int32"
          },
          "frontShadowConfidence": {
            "type": "number",
            "format": "float"
          },
          "frontPerFieldReadability": {
            "type": "integer",
            "format": "int32"
          },
          "backSharpness": {
            "type": "integer",
            "format": "int32"
          },
          "backGlare": {
            "type": "integer",
            "format": "int32"
          },
          "backHorizontalResolution": {
            "type": "integer",
            "format": "int32"
          },
          "backShadowConfidence": {
            "type": "number",
            "format": "float"
          },
          "backPerFieldReadability": {
            "type": "integer",
            "format": "int32"
          },
          "issueDate": {
            "type": "integer",
            "format": "int32"
          },
          "expirationDate": {
            "type": "integer",
            "format": "int32"
          },
          "qr": {
            "type": "boolean"
          },
          "manualCorrectionBy": {
            "type": "string"
          },
          "waitingTime": {
            "type": "integer",
            "format": "int64"
          },
          "logRecognitionConfidence": {
            "type": "number",
            "format": "float"
          },
          "readabilityConfidence": {
            "type": "number",
            "format": "float"
          },
          "frontSeccion": {
            "type": "string"
          },
          "printingNumber": {
            "type": "string"
          },
          "duplicateNumber": {
            "type": "string"
          },
          "preparationNumber": {
            "type": "string"
          },
          "confSelfieConfidence": {
            "type": "number",
            "format": "float"
          },
          "confSelfieLogConfidence": {
            "type": "number",
            "format": "float"
          },
          "confFrontIDConfidence": {
            "type": "number",
            "format": "float"
          },
          "confFrontIDLogConfidence": {
            "type": "number",
            "format": "float"
          },
          "notes": {
            "type": "string"
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "croppedIDFaceRef": {
            "type": "string"
          },
          "croppedNfcFaceRef": {
            "type": "string"
          },
          "fullFrameFrontIDRef": {
            "type": "string"
          },
          "fullFrameBackIDRef": {
            "type": "string"
          },
          "croppedFrontIDRef": {
            "type": "string"
          },
          "croppedBackIDRef": {
            "type": "string"
          },
          "croppedFaceRef": {
            "type": "string"
          },
          "confSelfieRef": {
            "type": "string"
          },
          "confFrontIDRef": {
            "type": "string"
          },
          "confBackIDRef": {
            "type": "string"
          },
          "additionalNames": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AdditionalName"
            }
          },
          "additionalAttrs": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "DOCUMENTO_INFANTIL",
                "IDADE_PRE_ESCOLAR",
                "MENOR_DE_ANOS",
                "NAO_ASSINA",
                "EM_FASE_DE_ALFABETIZACAO",
                "IMPOSSIBILITADO_DE_ASSINAR",
                "LIMITED_TERM",
                "FEDERAL_LIMITS_APPLY",
                "PERMISO_PARA_TRABAJAR",
                "EXTRANJERO",
                "INDIA_DIGITAL_VID",
                "VETERAN",
                "MOTORCYCLE_LICENSE",
                "NON_DOMICILED",
                "COMMERCIAL_LICENSE",
                "RESIDENTE",
                "MIGRANTE",
                "TEMPORAL",
                "VISITANTE",
                "TRAMITE",
                "RUEX",
                "INDIGENA",
                "AFROMEXICANA",
                "INDIA_DIGITAL_TAXID",
                "PHOTO_ONLY",
                "CANADA_TRAVEL_DOCUMENT"
              ]
            }
          },
          "additionalTimestamps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomDate"
            }
          },
          "religion": {
            "type": "string"
          },
          "customFields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomField"
            }
          },
          "customFieldsValid": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomFieldValid"
            }
          },
          "expirationDateCheckDigit": {
            "type": "string"
          },
          "streetName": {
            "type": "string"
          },
          "exteriorNumber": {
            "type": "string"
          },
          "interiorNumber": {
            "type": "string"
          },
          "district": {
            "type": "string"
          },
          "addressCountryCode": {
            "type": "string"
          },
          "issuerCode": {
            "type": "string"
          },
          "redirectionUrl": {
            "type": "string"
          },
          "maritalStatus": {
            "type": "string"
          },
          "race": {
            "type": "string"
          },
          "notExtractedDetails": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "issuingAuthority": {
            "type": "string"
          },
          "qrContents": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "qrFrontContents": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "qrBackContents": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "conferenceFeedback": {
            "type": "string"
          },
          "barcodeRawData": {
            "type": "string"
          },
          "nameParsed": {
            "type": "boolean"
          },
          "backClassificationFailReason": {
            "type": "string",
            "enum": [
              "UNKNOWN_DOCUMENT_TYPE",
              "WRONG_DOCUMENT_SIDE",
              "WRONG_ONE_SIDED_DOCUMENT",
              "UNFOLDED_DOCUMENT_PAGE_MISMATCH",
              "WRONG_UNFOLDED_DOCUMENT",
              "DOCUMENT_NOT_READABLE",
              "UNABLE_TO_ALIGN_DOCUMENT",
              "ID_TYPE_UNACCEPTABLE",
              "UNEXPECTED_ERROR_OCCURRED",
              "DIGITAL_ID_REQUESTED_BUT_OTHER_PROVIDED"
            ]
          },
          "nameBean": {
            "$ref": "#/components/schemas/NameBean"
          },
          "backTypeOfId": {
            "type": "string"
          },
          "documentFrontSubtype": {
            "type": "string"
          },
          "documentFrontState": {
            "type": "string"
          },
          "documentBackSubtype": {
            "type": "string"
          },
          "documentBackState": {
            "type": "string"
          },
          "documentNumberCheckDigit": {
            "type": "string"
          },
          "dateOfBirthCheckDigit": {
            "type": "string"
          },
          "expireAt": {
            "type": "string"
          },
          "issuedAt": {
            "type": "string"
          },
          "issuingCountryBack": {
            "type": "string"
          },
          "finishStatus": {
            "type": "boolean"
          },
          "videoSelfieTypeOfIdMatch": {
            "type": "boolean"
          },
          "videoSelfieBackTypeOfIdMatch": {
            "type": "boolean"
          },
          "videoSelfieFaceMatched": {
            "type": "boolean"
          },
          "videoSelfieNameOcrMatched": {
            "type": "boolean"
          },
          "videoSelfieBacksideOcrMatched": {
            "type": "boolean"
          },
          "videoSelfieVoiceConsentFaceMatched": {
            "type": "boolean"
          },
          "vendorValidationScore": {
            "type": "number",
            "format": "double"
          },
          "videoSelfieRecognitionConfidence": {
            "type": "number",
            "format": "float"
          },
          "videoSelfieLogRecognitionConfidence": {
            "type": "number",
            "format": "float"
          },
          "videoSelfieSpoofConfidence": {
            "type": "number",
            "format": "float"
          },
          "paperConfidence": {
            "type": "number",
            "format": "float"
          },
          "screenConfidence": {
            "type": "number",
            "format": "float"
          },
          "screenModelVersion": {
            "type": "string"
          },
          "paperModelVersion": {
            "type": "string"
          },
          "idAlterationConfidence": {
            "type": "number",
            "format": "float"
          },
          "frontClassificationFailReason": {
            "type": "string",
            "enum": [
              "UNKNOWN_DOCUMENT_TYPE",
              "WRONG_DOCUMENT_SIDE",
              "WRONG_ONE_SIDED_DOCUMENT",
              "UNFOLDED_DOCUMENT_PAGE_MISMATCH",
              "WRONG_UNFOLDED_DOCUMENT",
              "DOCUMENT_NOT_READABLE",
              "UNABLE_TO_ALIGN_DOCUMENT",
              "ID_TYPE_UNACCEPTABLE",
              "UNEXPECTED_ERROR_OCCURRED",
              "DIGITAL_ID_REQUESTED_BUT_OTHER_PROVIDED"
            ]
          },
          "frontCroppingError": {
            "type": "string",
            "enum": [
              "ID_IS_CUT",
              "ID_NOT_DETECTED"
            ]
          },
          "backCroppingError": {
            "type": "string",
            "enum": [
              "ID_IS_CUT",
              "ID_NOT_DETECTED"
            ]
          },
          "frontSharpnessSource": {
            "type": "string",
            "enum": [
              "ML_BACKEND",
              "CLIENT"
            ]
          },
          "frontGlareSource": {
            "type": "string",
            "enum": [
              "ML_BACKEND",
              "CLIENT"
            ]
          },
          "backSharpnessSource": {
            "type": "string",
            "enum": [
              "ML_BACKEND",
              "CLIENT"
            ]
          },
          "backGlareSource": {
            "type": "string",
            "enum": [
              "ML_BACKEND",
              "CLIENT"
            ]
          },
          "frontClientSharpness": {
            "type": "integer",
            "format": "int32"
          },
          "frontClientGlare": {
            "type": "integer",
            "format": "int32"
          },
          "backClientSharpness": {
            "type": "integer",
            "format": "int32"
          },
          "backClientGlare": {
            "type": "integer",
            "format": "int32"
          },
          "isRealId": {
            "type": "boolean"
          },
          "barcodeMeta": {
            "$ref": "#/components/schemas/BarcodeMeta"
          },
          "barcodeReader": {
            "type": "string"
          },
          "barcodeSignatureVerified": {
            "type": "boolean"
          },
          "fullFrameFrontIDRefs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImageAttempt"
            }
          },
          "fullFrameBackIDRefs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImageAttempt"
            }
          },
          "refCroppedFrontIDRef": {
            "type": "string"
          },
          "refCroppedBackIDRef": {
            "type": "string"
          },
          "croppedOriginalFrontIDRef": {
            "type": "string",
            "deprecated": true
          },
          "croppedOriginalBackIDRef": {
            "type": "string",
            "deprecated": true
          },
          "voiceConsentSelfieRefs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/VoiceConsentSelfieAttempt"
            }
          },
          "voiceConsentSelfieRef": {
            "type": "string"
          },
          "originalNfcFaceRef": {
            "type": "string"
          },
          "confPoaRef": {
            "type": "string"
          },
          "idSegmentImagesRefs": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "ocrResultsId": {
            "type": "string"
          },
          "interviewerId": {
            "type": "string"
          },
          "interviewerName": {
            "type": "string"
          },
          "interviewSessionId": {
            "type": "string"
          },
          "interviewCode": {
            "type": "string"
          },
          "oldInterviewId": {
            "type": "string"
          },
          "externalCustomerId": {
            "type": "string"
          },
          "nue": {
            "type": "string"
          },
          "nss": {
            "type": "string"
          },
          "sessionStatus": {
            "type": "string",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "closedAt": {
            "type": "integer",
            "format": "int64"
          },
          "deletedAt": {
            "type": "integer",
            "format": "int64"
          },
          "speechOpentokSessionId": {
            "type": "string"
          },
          "speechOpentokArchiveId": {
            "type": "string"
          },
          "speechOffset": {
            "type": "number",
            "format": "float"
          },
          "language": {
            "type": "string"
          },
          "signingCeremonyUrl": {
            "type": "string"
          },
          "videoSelfieFileIsPresent": {
            "type": "string",
            "enum": [
              "PRESENT",
              "NOT_PRESENT",
              "UNKNOWN"
            ]
          },
          "videoSelfieHasVideo": {
            "type": "string",
            "enum": [
              "YES",
              "NO",
              "UNKNOWN"
            ]
          },
          "videoSelfieHasAudio": {
            "type": "string",
            "enum": [
              "YES",
              "NO",
              "UNKNOWN"
            ]
          },
          "videoSelfieFileNotEmpty": {
            "type": "string",
            "enum": [
              "NOT_EMPTY",
              "EMPTY",
              "UNKNOWN"
            ]
          },
          "videoWidth": {
            "type": "integer",
            "format": "int32"
          },
          "videoHeight": {
            "type": "integer",
            "format": "int32"
          },
          "videoBitRate": {
            "type": "integer",
            "format": "int32"
          },
          "videoDuration": {
            "type": "number",
            "format": "float"
          },
          "videoQuality": {
            "type": "boolean"
          },
          "speechTranscript": {
            "type": "string"
          },
          "speechTranscriptWhisper": {
            "type": "string"
          },
          "processSpeechResultWhisper": {
            "type": "boolean"
          },
          "processSpeechResult": {
            "type": "boolean"
          },
          "processSpeechResultGoogleLLM": {
            "type": "boolean"
          },
          "sessionRecordingRefs": {
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/ImageAttempt"
            },
            "deprecated": true
          },
          "additionalDocumentAttempts": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/AsylumSeekerDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/BankCheckDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/BankStatementDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/CarInvoiceDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/CirculationCardDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/ColombiaRutFormDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/ColombianBirthCertificateDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/CurpDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/FinanceSettlementDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/GenericDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/IneMexDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/LetterOfAuthorizationDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/MexicanTaxDeclarationDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/MexicanTaxStatusDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/PoaDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/RefugeeIdDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/RefugeeStatusDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/RfcDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/UnknownDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/V5CLogbookDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/W8BenDocumentAttempt"
                },
                {
                  "$ref": "#/components/schemas/W8BenEDocumentAttempt"
                }
              ]
            }
          },
          "poaName": {
            "type": "string"
          },
          "proofOfAddress": {
            "type": "string"
          },
          "proofOfAddressScore": {
            "type": "number",
            "format": "float"
          },
          "addressStatementTimestamp": {
            "type": "integer",
            "format": "int64"
          },
          "addressStatementTimestamps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AddressStatementDate"
            }
          },
          "documentType": {
            "type": "string",
            "enum": [
              "aysa",
              "edelap",
              "edenor",
              "edesur",
              "epec",
              "metrogas",
              "a1",
              "aggm",
              "apg",
              "energieAg",
              "cre",
              "eaab",
              "enel",
              "vanti",
              "aforeAzteca",
              "aforeBanorte",
              "amd",
              "amicsa",
              "att",
              "axtel",
              "bancoppel",
              "bancoAzteca",
              "banorte",
              "bbva",
              "cab",
              "caev",
              "capa",
              "cea",
              "cfe",
              "citibanamex",
              "cmapa",
              "cmapaGrande",
              "cmapas",
              "cmas",
              "cmasBlue",
              "comapa",
              "comapaRed",
              "coppel",
              "dapa",
              "dhc",
              "drenaje",
              "ecogas",
              "engie",
              "gasNatural",
              "h",
              "hsbc",
              "inbursa",
              "infonavit",
              "interapas",
              "isagas",
              "izzi",
              "jad",
              "japam",
              "japama",
              "japami",
              "japay",
              "jiapaz",
              "jmas",
              "jras",
              "jumapac",
              "jumapam",
              "lerdo",
              "liverpool",
              "mas",
              "megacable",
              "naturgy",
              "oapas",
              "odapas",
              "ooapas",
              "opdm",
              "oroapa",
              "sacmex",
              "sacmexCdmx",
              "santander",
              "sapa",
              "sapal",
              "sapamuy",
              "sapasa",
              "sapasma",
              "scotiabank",
              "seapal",
              "siapa",
              "siapaTepic",
              "simapag",
              "simapas",
              "simas",
              "smapa",
              "smapac",
              "smapam",
              "smapas",
              "spectrum",
              "stori",
              "sura",
              "tam",
              "telcel",
              "telmex",
              "totalplay",
              "veolia",
              "victoria",
              "wizz",
              "asylumSeeker",
              "refugeeId",
              "refugeeStatus",
              "ute",
              "telkom",
              "tmobile",
              "verizon",
              "xfinity",
              "aforeCoppel",
              "americanExpress",
              "ap",
              "telnor",
              "wellsFargo",
              "otherPoa"
            ]
          },
          "poaFields": {
            "$ref": "#/components/schemas/AddressBean"
          },
          "poaSuccessfullyClassified": {
            "type": "boolean"
          },
          "fullAddress": {
            "type": "boolean"
          },
          "checkedAddress": {
            "type": "string"
          },
          "checkedAddressBean": {
            "$ref": "#/components/schemas/AddressBean"
          },
          "classifier": {
            "type": "string",
            "enum": [
              "INCODE"
            ]
          },
          "bankLoginSuccess": {
            "type": "boolean"
          },
          "governmentRecognitionConfidence": {
            "type": "number",
            "format": "float"
          },
          "governmentRecognitionConfidence2": {
            "type": "number",
            "format": "float"
          },
          "governmentFingerprintConfidence": {
            "$ref": "#/components/schemas/GovernmentFingerprintsBean"
          },
          "governmentValidationStatus": {
            "type": "string",
            "enum": [
              "PROCESSING",
              "PROCESSING_DATA",
              "PROCESSING_FACE",
              "PROCESSING_INE",
              "OK",
              "VALIDATION_ERROR",
              "INE_CONNECTION_ERROR",
              "INE_INFRASTRUCTURE_ERROR",
              "MODULE_NOT_SUPPORTED",
              "MISSING_DOCUMENT_ID",
              "MISSING_SELFIE",
              "USER_NOT_FOUND",
              "USER_NOT_FOUND_IN_INE_DB",
              "NOT_ENOUGH_DATA",
              "LIVENESS_FAIL",
              "INE_NOT_CURRENT",
              "INE_REPORTED_LOST",
              "INE_REPORTED_STOLEN",
              "INE_SIGNATURE_ERROR",
              "INE_NOT_VALID",
              "CPF_NUMBER_INVALID_OR_MISSING",
              "CONNECTION_ERROR",
              "INFRASTRUCTURE_ERROR",
              "PROVIDER_NOT_CONFIGURED",
              "DOCUMENT_TYPE_NOT_SUPPORTED",
              "PROVIDER_UNAVAILABLE",
              "COUNTRY_NOT_SUPPORTED",
              "STATE_NOT_SUPPORTED",
              "PROVISIONING_NOT_EXECUTED",
              "COUNTRY_SETTINGS_NOT_CONFIGURED",
              "EMPTY_INTERFACE_PROVIDER",
              "SELFIE_CHECKS_FAILED",
              "NO_INFORMATION",
              "TRANSACTION_LIMIT_REACHED",
              "USER_IN_RISK_WATCHLIST",
              "FACE_COMPARISON_FAILED",
              "INVALID_EXPIRATION_DATE",
              "DOCUMENT_NUMBER_MISMATCH",
              "FACE_COMPARISON_UNAVAILABLE",
              "IMAGE_QUALITY_INVALID",
              "QR_DATA_MISMATCH",
              "PERSON_DECEASED",
              "USER_DENIED",
              "SESSION_EXPIRED",
              "MISSING_FINGERPRINTS"
            ]
          },
          "governmentRecognitionThreshold": {
            "type": "number",
            "format": "double"
          },
          "registralSituation": {
            "$ref": "#/components/schemas/RegistralSituation"
          },
          "curpCecobanValidation": {
            "$ref": "#/components/schemas/CurpCecobanValidation"
          },
          "ineTransactionId": {
            "type": "string"
          },
          "existingUser": {
            "type": "boolean"
          },
          "nameMatched": {
            "type": "boolean"
          },
          "existingInterviewId": {
            "type": "string"
          },
          "existingExternalId": {
            "type": "string"
          },
          "customerId": {
            "type": "string"
          },
          "parentCustomerId": {
            "type": "string"
          },
          "incodeIdCustomer": {
            "type": "string"
          },
          "faceAuthCustomerId": {
            "type": "string"
          },
          "incodeIdConsentGiven": {
            "type": "boolean"
          },
          "onlyFront": {
            "type": "boolean"
          },
          "onlyBack": {
            "type": "boolean"
          },
          "forceBackForDob": {
            "type": "boolean"
          },
          "hasNfcChip": {
            "type": "boolean"
          },
          "barcodeCapture": {
            "type": "boolean"
          },
          "usSmartCapture": {
            "type": "boolean"
          },
          "alignment": {
            "type": "boolean",
            "deprecated": true
          },
          "frontAlignment": {
            "type": "boolean"
          },
          "frontAlignmentForced": {
            "type": "boolean"
          },
          "backAlignmentForced": {
            "type": "boolean"
          },
          "alreadyApprovedCustomerConfidence": {
            "type": "number",
            "format": "float"
          },
          "punchedHolesConfidence": {
            "type": "number",
            "format": "float"
          },
          "fakeIdInternalConfidence": {
            "type": "number",
            "format": "float"
          },
          "mandatoryConsentGiven": {
            "type": "boolean"
          },
          "frontDocumentIsOnTheEdge": {
            "type": "boolean"
          },
          "backDocumentIsOnTheEdge": {
            "type": "boolean"
          },
          "backAlignment": {
            "type": "boolean"
          },
          "surveyData": {
            "type": "string"
          },
          "frontIdAttempts": {
            "type": "integer",
            "format": "int32"
          },
          "backIdAttempts": {
            "type": "integer",
            "format": "int32"
          },
          "selfieAttempts": {
            "type": "integer",
            "format": "int32"
          },
          "authenticationAttempts": {
            "type": "integer",
            "format": "int32"
          },
          "onboardingAttempts": {
            "type": "integer",
            "format": "int32"
          },
          "sessionContinuationCount": {
            "type": "integer",
            "format": "int32"
          },
          "failedAttemptsCounter": {
            "type": "object",
            "additionalProperties": {
              "type": "integer",
              "format": "int32"
            }
          },
          "idValidationFinished": {
            "type": "boolean"
          },
          "faceValidationFinished": {
            "type": "boolean"
          },
          "idFaceExtractionSkipped": {
            "type": "boolean"
          },
          "faceMatchingType": {
            "type": "string",
            "enum": [
              "selfieVsId",
              "selfieVsNfc",
              "idVsNfc",
              "nfc3Way"
            ]
          },
          "partialOnboarding": {
            "type": "boolean"
          },
          "frontCaptureRedacted": {
            "type": "boolean"
          },
          "backCaptureRedacted": {
            "type": "boolean"
          },
          "multipleDocumentsInFrame": {
            "type": "boolean"
          },
          "callbackUrl": {
            "type": "string",
            "deprecated": true
          },
          "governmentValidationFinished": {
            "type": "boolean"
          },
          "conferenceStatus": {
            "type": "string",
            "enum": [
              "NO_CONFERENCE",
              "APPROVED",
              "REJECTED",
              "ABANDONED",
              "NEEDS_REVIEW",
              "REJECTED_BY_RISK",
              "COMPLETED"
            ]
          },
          "termsAccepted": {
            "type": "boolean"
          },
          "creditBureauConsentGiven": {
            "type": "boolean"
          },
          "applicantDataConfirmed": {
            "type": "boolean"
          },
          "configurationId": {
            "type": "string"
          },
          "configurationName": {
            "type": "string"
          },
          "configurationVersion": {
            "type": "integer",
            "format": "int32"
          },
          "flowType": {
            "type": "string",
            "enum": [
              "configuration",
              "flow",
              "workflow"
            ]
          },
          "queueName": {
            "type": "string"
          },
          "gdcAddressScore": {
            "type": "string",
            "enum": [
              "FullMatch",
              "PartialMatch",
              "NoMatch"
            ]
          },
          "gdcIdentityScore": {
            "type": "string",
            "enum": [
              "FullMatch",
              "PartialMatch",
              "NoMatch"
            ]
          },
          "subscribedToWatchlistUpdates": {
            "type": "boolean"
          },
          "onboardingStatus": {
            "type": "string",
            "enum": [
              "UNKNOWN",
              "ID_VALIDATION_FINISHED",
              "POST_PROCESSING_FINISHED",
              "FACE_VALIDATION_FINISHED",
              "GOVERNMENT_VALIDATION_FINISHED",
              "EKYC_VALIDATION_FINISHED",
              "ONBOARDING_FINISHED",
              "MANUAL_REVIEW_APPROVED",
              "MANUAL_REVIEW_REJECTED",
              "MANUAL_REVIEW_PENDING",
              "EXPIRED",
              "DELETED",
              "QES_FINISHED"
            ]
          },
          "deletedWithMode": {
            "type": "string",
            "enum": [
              "BIOMETRICS",
              "PII_EXCEPT_AUTH_DATA",
              "PII",
              "FULL"
            ]
          },
          "retentionRegion": {
            "$ref": "#/components/schemas/RetentionRegion"
          },
          "onboardingCompleteTimestamp": {
            "type": "integer",
            "format": "int64"
          },
          "sessionExpiredAt": {
            "type": "integer",
            "format": "int64"
          },
          "loginHint": {
            "type": "string"
          },
          "authUuid": {
            "type": "string"
          },
          "integrationReference": {
            "type": "string"
          },
          "validationArchiveRef": {
            "type": "string"
          },
          "validationArchiveNom151": {
            "type": "string"
          },
          "selfieRef": {
            "type": "string"
          },
          "selfieRefs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImageAttempt"
            }
          },
          "sorSelfieRef": {
            "type": "string"
          },
          "videoSelfieRef": {
            "type": "string"
          },
          "documentRef": {
            "type": "string"
          },
          "documentRefs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ImageAttempt"
            }
          },
          "signatureRef": {
            "type": "string"
          },
          "initialsRef": {
            "type": "string"
          },
          "secondIdRef": {
            "type": "string"
          },
          "thirdIdRef": {
            "type": "string"
          },
          "medicalDocImgRef": {
            "type": "string"
          },
          "videoSelfieCompareIDRef": {
            "type": "string"
          },
          "videoSelfieCompareOcrRef": {
            "type": "string"
          },
          "videoSelfieCompareBackIDRef": {
            "type": "string"
          },
          "videoSelfieCompareBackOcrRef": {
            "type": "string"
          },
          "otherDocument1Ref": {
            "type": "string"
          },
          "otherDocument2Ref": {
            "type": "string"
          },
          "otherDocument3Ref": {
            "type": "string"
          },
          "paymentProofRef": {
            "type": "string"
          },
          "consentRef": {
            "type": "string"
          },
          "renaperCroppedRef": {
            "type": "string"
          },
          "signatureRefs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SignatureAttempt"
            }
          },
          "initialsRefs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SignatureAttempt"
            }
          },
          "contractRefs": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "signedContractRefs": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "governmentValidationProvider": {
            "type": "string",
            "enum": [
              "QUERTIUM",
              "RENAPER",
              "RENAPER_PREMIUM",
              "METAMAP_RENAPER",
              "MM_ARGENTINA_RENAPER_EXTENDED",
              "METAMAP_RENAPER_PREMIUM",
              "MM_RENAPER",
              "NATIONALCRIMECHECK",
              "SERPRO",
              "SERPRO_FACE",
              "UNICO",
              "SINACOFI",
              "INCODE_SCRAPER_CHL",
              "TUSDATOS",
              "BECOME_DIGITAL",
              "GSE",
              "OPERATOR_BTC",
              "OLIMPIA",
              "OLIMPIA_TUSDATOS",
              "AUTHBRIDGE",
              "AUTHBRIDGE_FACE",
              "WITHTRUSTLINK",
              "INE",
              "INE_CECOBAN",
              "INE_TELCEL",
              "INE_FIMPE",
              "INE_HSBC",
              "INCODE_SCRAPER_MEX",
              "INCODE_SCRAPER_ASYNC_MEX",
              "MEX_PASSPORT_PILOT",
              "TOC",
              "PE_MIGRATION_INSTITUTE",
              "VERIFYID",
              "AAMVA",
              "PA_DLDV",
              "AAMVA_V3",
              "PA_DLDV_V3",
              "AAMVA_V3_PHOTOMATCH",
              "NY_VERIFIABLE_CREDENTIAL",
              "CA_DMV",
              "CA_MDL",
              "FL_GOVALIDATE",
              "FL_GOVALIDATE_PROD",
              "GA_DDS",
              "GA_DDS_THIRD_PARTIES",
              "VA_DMV",
              "WI_CIS",
              "MD_MVA_INTERNAL",
              "INCODE_DMV_INTERNAL_DEMO_ONLY",
              "INCODE_SCRAPER_PHILIPPINES_PHILSYS",
              "IDFY_PHILSYS_PHILIPPINES",
              "FRANKIE_ONE",
              "METAMAP_GUATEMALA_TSE",
              "METAMAP_COSTA_RICA_CCSS",
              "CR_TSE",
              "METAMAP_COLOMBIA_BDUA",
              "METAMAP_COLOMBIA_NIT",
              "CO_PPT",
              "METAMAP_DOMINICAN_RNC",
              "METAMAP_DOMINICAN_JCE",
              "METAMAP_PHILIPPINES_UMID_SSN",
              "CHILE_RUT",
              "AZ_IDEMIA",
              "DE_IDEMIA",
              "MS_IDEMIA",
              "MM_ARGENTINIAN_RENAPER_FACEMATCH",
              "AGY_LA_GOVALIDATE",
              "AGY_MS_GOVALIDATE",
              "AGY_TX_GOVALIDATE",
              "MONO_BVN",
              "MONO_NIN",
              "BO_OEP",
              "SHRINQ_AVE",
              "PA_TSE",
              "EC_SRI"
            ]
          },
          "governmentValidationWorkflow": {
            "type": "string"
          },
          "governmentValidationShadowMode": {
            "type": "boolean"
          },
          "governmentValid": {
            "type": "boolean"
          },
          "governmentValidationResponse": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "governmentValidationRequest": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "paternalLastNameValid": {
            "type": "boolean"
          },
          "maternalLastNameValid": {
            "type": "boolean"
          },
          "firstNameValid": {
            "type": "boolean"
          },
          "middleNameValid": {
            "type": "boolean"
          },
          "suffixNameValid": {
            "type": "boolean"
          },
          "fullNameValid": {
            "type": "boolean"
          },
          "curpValid": {
            "type": "boolean"
          },
          "ineCurpValid": {
            "type": "boolean"
          },
          "curpValidationResponse": {
            "$ref": "#/components/schemas/CurpResponse"
          },
          "curpDataMatch": {
            "type": "boolean"
          },
          "renapoCurp": {
            "type": "string"
          },
          "ineScrapingValid": {
            "type": "boolean"
          },
          "ineValidationResponse": {
            "$ref": "#/components/schemas/IneResult"
          },
          "fiscalQrUrlResponse": {
            "$ref": "#/components/schemas/AddFiscalQrUrlResponse"
          },
          "ocrValid": {
            "type": "boolean"
          },
          "claveDeElectorValid": {
            "type": "boolean"
          },
          "numeroEmisionCredencialValid": {
            "type": "boolean"
          },
          "registrationDateValid": {
            "type": "boolean"
          },
          "issueDateValid": {
            "type": "boolean"
          },
          "birthDateValid": {
            "type": "boolean"
          },
          "documentNumberValid": {
            "type": "boolean"
          },
          "sexValid": {
            "type": "boolean"
          },
          "heightValid": {
            "type": "boolean"
          },
          "weightValid": {
            "type": "boolean"
          },
          "eyeColorValid": {
            "type": "boolean"
          },
          "addressValid": {
            "type": "boolean"
          },
          "addressLine2Valid": {
            "type": "boolean"
          },
          "cityValid": {
            "type": "boolean"
          },
          "stateCodeValid": {
            "type": "boolean"
          },
          "zipCodeValid": {
            "type": "boolean"
          },
          "genderValid": {
            "type": "boolean"
          },
          "personalNumberValid": {
            "type": "boolean"
          },
          "placeOfBirthValid": {
            "type": "boolean"
          },
          "expirationDateValid": {
            "type": "boolean"
          },
          "totalScore": {
            "type": "number",
            "format": "float"
          },
          "livenessScore": {
            "type": "number",
            "format": "float"
          },
          "faceRecognitionScore": {
            "type": "number",
            "format": "float"
          },
          "incodeIdValidationScore": {
            "type": "number",
            "format": "float"
          },
          "idOcrValidationScore": {
            "type": "number",
            "format": "float"
          },
          "governmentScore": {
            "type": "number",
            "format": "float"
          },
          "videoConferenceScore": {
            "type": "number",
            "format": "float"
          },
          "totalScoreStatus": {
            "type": "string",
            "enum": [
              "OK",
              "WARN",
              "FAIL",
              "UNKNOWN",
              "MANUAL",
              "MANUAL_OK",
              "MANUAL_FAIL",
              "MANUAL_PENDING"
            ]
          },
          "livenessScoreStatus": {
            "type": "string",
            "enum": [
              "OK",
              "WARN",
              "FAIL",
              "UNKNOWN",
              "MANUAL",
              "MANUAL_OK",
              "MANUAL_FAIL",
              "MANUAL_PENDING"
            ]
          },
          "faceRecognitionScoreStatus": {
            "type": "string",
            "enum": [
              "OK",
              "WARN",
              "FAIL",
              "UNKNOWN",
              "MANUAL",
              "MANUAL_OK",
              "MANUAL_FAIL",
              "MANUAL_PENDING"
            ]
          },
          "incodeIdValidationScoreStatus": {
            "type": "string",
            "enum": [
              "OK",
              "WARN",
              "FAIL",
              "UNKNOWN",
              "MANUAL",
              "MANUAL_OK",
              "MANUAL_FAIL",
              "MANUAL_PENDING"
            ]
          },
          "idOcrValidationScoreStatus": {
            "type": "string",
            "enum": [
              "OK",
              "WARN",
              "FAIL",
              "UNKNOWN",
              "MANUAL",
              "MANUAL_OK",
              "MANUAL_FAIL",
              "MANUAL_PENDING"
            ]
          },
          "governmentScoreStatus": {
            "type": "string",
            "enum": [
              "OK",
              "WARN",
              "FAIL",
              "UNKNOWN",
              "MANUAL",
              "MANUAL_OK",
              "MANUAL_FAIL",
              "MANUAL_PENDING"
            ]
          },
          "videoConferenceStatus": {
            "type": "string",
            "enum": [
              "OK",
              "WARN",
              "FAIL",
              "UNKNOWN",
              "MANUAL",
              "MANUAL_OK",
              "MANUAL_FAIL",
              "MANUAL_PENDING"
            ]
          },
          "customWatchlistModuleEnabled": {
            "type": "boolean"
          },
          "incodeWatchlistScore": {
            "type": "number",
            "format": "float"
          },
          "watchlistDataMatches": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "incodeWatchlistId": {
            "type": "string"
          },
          "externalVerificationRequest": {
            "$ref": "#/components/schemas/ExternalVerificationRequest"
          },
          "premiumExternalVerification": {
            "$ref": "#/components/schemas/PremiumExternalVerification"
          },
          "externalVerificationThirdPartyRequest": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "externalVerificationThirdPartyResponse": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "businessVerificationRequest": {
            "$ref": "#/components/schemas/BusinessVerificationRequest"
          },
          "businessVerification": {
            "$ref": "#/components/schemas/BusinessVerificationResult"
          },
          "bavHolders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BavHolder"
            }
          },
          "bavLinkId": {
            "type": "string"
          },
          "bavNumberOfRetries": {
            "type": "integer",
            "format": "int32"
          },
          "rfc": {
            "type": "string"
          },
          "rfcValidationResponse": {
            "$ref": "#/components/schemas/RfcValidationResponse"
          },
          "federalRevenueNumber": {
            "type": "string"
          },
          "mothersName": {
            "type": "string"
          },
          "mothersIdNumber": {
            "type": "string"
          },
          "originDocumentId": {
            "type": "string"
          },
          "fathersName": {
            "type": "string"
          },
          "fathersIdNumber": {
            "type": "string"
          },
          "spouseName": {
            "type": "string"
          },
          "driversLicenseCategory": {
            "type": "string"
          },
          "controlNumber": {
            "type": "string"
          },
          "renach": {
            "type": "string"
          },
          "eyeColor": {
            "type": "string"
          },
          "classes": {
            "type": "string"
          },
          "cond": {
            "type": "string"
          },
          "mentions": {
            "type": "string"
          },
          "refNumber": {
            "type": "string"
          },
          "familyNumber": {
            "type": "string"
          },
          "restrictions": {
            "type": "string"
          },
          "weight": {
            "type": "string"
          },
          "hairColor": {
            "type": "string"
          },
          "nationality": {
            "type": "string"
          },
          "nationalityMrz": {
            "type": "string"
          },
          "nationalityAlpha3": {
            "type": "string"
          },
          "jurisdictionCode": {
            "type": "string"
          },
          "medicalOcrData": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/KeyValue"
            }
          },
          "interviewRejected": {
            "type": "boolean"
          },
          "approvalSource": {
            "type": "string",
            "deprecated": true,
            "enum": [
              "AUTOAPPROVE",
              "CONFERENCE",
              "MANUAL"
            ]
          },
          "manualReviewStatus": {
            "type": "string",
            "enum": [
              "UNSET",
              "REQUIRED",
              "APPROVED",
              "REJECTED",
              "PENDING"
            ]
          },
          "manualReviewReasons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "manualReviewComment": {
            "type": "string"
          },
          "faceLenses": {
            "type": "boolean"
          },
          "hasFaceClosedEyes": {
            "type": "boolean"
          },
          "hasFaceHeadCover": {
            "type": "boolean"
          },
          "hasFaceMask": {
            "type": "boolean"
          },
          "faceIsBright": {
            "type": "boolean"
          },
          "faceAge": {
            "type": "integer",
            "format": "int32"
          },
          "hasVideoSelfieLenses": {
            "type": "boolean"
          },
          "hasVideoSelfieClosedEyes": {
            "type": "boolean"
          },
          "hasVideoSelfieHeadCover": {
            "type": "boolean"
          },
          "hasVideoSelfieMask": {
            "type": "boolean"
          },
          "digitalAttack": {
            "type": "boolean",
            "deprecated": true
          },
          "digitalAttackSeverity": {
            "type": "string",
            "deprecated": true,
            "enum": [
              "ultra low",
              "low",
              "medium",
              "high",
              "llava"
            ]
          },
          "digitalAttackVersion": {
            "type": "string",
            "deprecated": true
          },
          "evasionAttack": {
            "type": "boolean",
            "deprecated": true
          },
          "evasionAttackSeverity": {
            "type": "string",
            "deprecated": true,
            "enum": [
              "ultra low",
              "low",
              "medium",
              "high",
              "llava"
            ]
          },
          "evasionAttackVersion": {
            "type": "string",
            "deprecated": true
          },
          "spoofDetectionResult": {
            "$ref": "#/components/schemas/SpoofDetectionResult"
          },
          "faceCaptureAttemptId": {
            "type": "string"
          },
          "faceCaptureRecordingAttemptId": {
            "type": "string"
          },
          "videoSelfieCaptureAttemptId": {
            "type": "string"
          },
          "authenticationAttemptId": {
            "type": "string"
          },
          "onboardingAttemptId": {
            "type": "string"
          },
          "frontIdCaptureMetadata": {
            "$ref": "#/components/schemas/CaptureMetadata"
          },
          "backIdCaptureMetadata": {
            "$ref": "#/components/schemas/CaptureMetadata"
          },
          "ocrDataConfidence": {
            "$ref": "#/components/schemas/OcrDataConfidence"
          },
          "userConsentTitle": {
            "type": "string"
          },
          "userConsentText": {
            "type": "string"
          },
          "userConsentStatus": {
            "type": "boolean"
          },
          "mlConsentStatus": {
            "type": "boolean"
          },
          "signedConsents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SignedConsent"
            }
          },
          "frontIdCaptureType": {
            "type": "string",
            "enum": [
              "AUTO",
              "MANUAL",
              "NATIVE",
              "UPLOAD"
            ]
          },
          "backIdCaptureType": {
            "type": "string",
            "enum": [
              "AUTO",
              "MANUAL",
              "NATIVE",
              "UPLOAD"
            ]
          },
          "selfieCaptureType": {
            "type": "string",
            "enum": [
              "AUTO",
              "MANUAL",
              "NATIVE",
              "UPLOAD"
            ]
          },
          "omniVersion": {
            "type": "string"
          },
          "clientId": {
            "type": "string"
          },
          "scoresInfoId": {
            "type": "string"
          },
          "shadowScoresInfoId": {
            "type": "string"
          },
          "idAlreadyUsed": {
            "type": "boolean"
          },
          "idAlreadyUsedInterviewId": {
            "type": "string"
          },
          "appliedTotalRule": {
            "$ref": "#/components/schemas/FlowRule"
          },
          "needsReviewReason": {
            "type": "string",
            "enum": [
              "MANUAL_CAPTURE",
              "RULE_APPLIED",
              "OLD_ID",
              "FLOW_CONFIGURATION",
              "FRONT_ID_CAPTURE_ATTEMPTS",
              "BACK_ID_CAPTURE_ATTEMPTS",
              "SELFIE_CAPTURE_ATTEMPTS",
              "ANTIFRAUD",
              "MISSING_DEPTH_DATA",
              "CUSTOM"
            ]
          },
          "documentSubmissionMethod": {
            "type": "string",
            "enum": [
              "CAPTURED_DOCUMENT",
              "UPLOADED_FILE",
              "IMPORTED_CREDENTIAL"
            ]
          },
          "credentialsProvider": {
            "type": "string",
            "enum": [
              "APPLE",
              "GOOGLE",
              "DIGILOCKER",
              "SAMSUNG",
              "TRINSIC",
              "NETHERLANDS_IDIN",
              "FINNISH_TRUST_NETWORK",
              "BELGIUM_ITSME",
              "ITALY_SPID",
              "DENMARK_MITID",
              "SWEDEN_BANKID",
              "FRANCE_IDENTITE",
              "FRANCE_IDENTITE_NUMERIQUE",
              "USA_LA_WALLET",
              "INDIA_DIGILOCKER_AADHAAR"
            ]
          },
          "formName": {
            "type": "string"
          },
          "formFirstName": {
            "type": "string"
          },
          "formLastName": {
            "type": "string"
          },
          "formCpf": {
            "type": "string"
          },
          "documentNumberSource": {
            "type": "string",
            "enum": [
              "FORM",
              "OCR"
            ]
          },
          "antifraudResult": {
            "$ref": "#/components/schemas/AntifraudResult"
          },
          "scannerSignals": {
            "$ref": "#/components/schemas/ScannerSignals"
          },
          "elUnsignedDocuments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EUnsignedDocument"
            },
            "uniqueItems": true
          },
          "elSignedDocuments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ESignedDocument"
            },
            "uniqueItems": true
          },
          "elSignedSignerKeyName": {
            "type": "string"
          },
          "otpPhoneVerified": {
            "type": "boolean"
          },
          "otpEmailVerified": {
            "type": "boolean"
          },
          "tamperedSeverity": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high"
            ]
          },
          "paperSeverity": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high"
            ]
          },
          "screenSeverity": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high"
            ]
          },
          "idAlterationModelVersion": {
            "type": "string"
          },
          "idAlterationSeverity": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high"
            ]
          },
          "fontAlterationConfidence": {
            "type": "number",
            "format": "float"
          },
          "fontAlterationModelVersion": {
            "type": "string"
          },
          "fontAlterationSeverity": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high"
            ]
          },
          "punchedHolesModelVersion": {
            "type": "string"
          },
          "punchedHolesSeverity": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high"
            ]
          },
          "idLaminationModelVersion": {
            "type": "string"
          },
          "idLaminationSeverity": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high"
            ]
          },
          "idLaminationConfidence": {
            "type": "number",
            "format": "float"
          },
          "idDamageDetectionModelVersion": {
            "type": "string"
          },
          "idDamageDetectionSeverity": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high"
            ]
          },
          "idDamageDetectionConfidence": {
            "type": "number",
            "format": "float"
          },
          "aiGeneratedDocumentSeverity": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high"
            ]
          },
          "aiGeneratedDocumentModelVersion": {
            "type": "string"
          },
          "aiGeneratedDocumentConfidence": {
            "type": "number",
            "format": "float"
          },
          "documentVisualAnomalySeverity": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high"
            ]
          },
          "documentVisualAnomalyModelVersion": {
            "type": "string"
          },
          "documentVisualAnomalyConfidence": {
            "type": "number",
            "format": "float"
          },
          "fakeIdSeverity": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high"
            ]
          },
          "fakeIdModelVersion": {
            "type": "string"
          },
          "fakeIdInternalSeverity": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high"
            ]
          },
          "fakeIdInternalModelVersion": {
            "type": "string"
          },
          "batchId": {
            "type": "string"
          },
          "tamperedConfidenceCorrected": {
            "type": "number",
            "format": "float"
          },
          "fakeIdConfidenceCorrected": {
            "type": "number",
            "format": "float"
          },
          "paperConfidenceCorrected": {
            "type": "number",
            "format": "float"
          },
          "screenConfidenceCorrected": {
            "type": "number",
            "format": "float"
          },
          "faceSpoofCorrected": {
            "type": "boolean"
          },
          "faceMismatchCorrected": {
            "type": "boolean"
          },
          "labelingComplete": {
            "type": "boolean"
          },
          "personalIdentificationNumberProvider": {
            "type": "string",
            "enum": [
              "UNKNOWN",
              "FIMPE_CURP",
              "CECOBAN_CURP",
              "INCODE_CURP_SCRAPPER",
              "INCODE_CURP_MANUAL"
            ]
          },
          "ineReferenceId": {
            "type": "string"
          },
          "isReportedAsFraud": {
            "type": "boolean"
          },
          "fraudCandidateId": {
            "type": "string"
          },
          "cleanedExceptAuthData": {
            "type": "boolean"
          },
          "isPartOfExperimentGroup": {
            "type": "boolean"
          },
          "featureGates": {
            "type": "object",
            "additionalProperties": {
              "type": "boolean"
            }
          },
          "userProvidedName": {
            "type": "string"
          },
          "userProvidedBirthDate": {
            "type": "string"
          },
          "paperFrontConfidence": {
            "type": "number",
            "format": "float",
            "deprecated": true
          },
          "paperFrontModelVersion": {
            "type": "string",
            "deprecated": true
          },
          "screenFrontConfidence": {
            "type": "number",
            "format": "float",
            "deprecated": true
          },
          "screenFrontModelVersion": {
            "type": "string",
            "deprecated": true
          },
          "paperBackConfidence": {
            "type": "number",
            "format": "float",
            "deprecated": true
          },
          "paperBackModelVersion": {
            "type": "string",
            "deprecated": true
          },
          "screenBackConfidence": {
            "type": "number",
            "format": "float",
            "deprecated": true
          },
          "screenBackModelVersion": {
            "type": "string",
            "deprecated": true
          },
          "paperFrontConfidenceCorrected": {
            "type": "number",
            "format": "float",
            "deprecated": true
          },
          "screenFrontConfidenceCorrected": {
            "type": "number",
            "format": "float",
            "deprecated": true
          },
          "paperBackConfidenceCorrected": {
            "type": "number",
            "format": "float",
            "deprecated": true
          },
          "screenBackConfidenceCorrected": {
            "type": "number",
            "format": "float",
            "deprecated": true
          },
          "idAlterationFrontConfidence": {
            "type": "number",
            "format": "float",
            "deprecated": true
          },
          "idAlterationBackConfidence": {
            "type": "number",
            "format": "float",
            "deprecated": true
          },
          "frontPunchedHoles": {
            "$ref": "#/components/schemas/PunchedHoles",
            "deprecated": true
          },
          "backPunchedHoles": {
            "$ref": "#/components/schemas/PunchedHoles",
            "deprecated": true
          },
          "faceBrightness": {
            "type": "number",
            "format": "float",
            "deprecated": true
          },
          "dlClassRestrictions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DLClassRestriction"
            }
          },
          "idValidationDeepCheck": {
            "type": "boolean"
          },
          "acuantId": {
            "type": "string"
          },
          "mAdminArea": {
            "type": "string"
          },
          "mSubAdminArea": {
            "type": "string"
          },
          "mLocality": {
            "type": "string"
          },
          "mSubLocality": {
            "type": "string"
          },
          "mThoroughfare": {
            "type": "string"
          },
          "mSubThoroughfare": {
            "type": "string"
          },
          "mPostalCode": {
            "type": "string"
          },
          "mCountryCode": {
            "type": "string"
          },
          "mCountryName": {
            "type": "string"
          },
          "gWatchlistType": {
            "type": "string",
            "enum": [
              "person",
              "company"
            ]
          },
          "gWatchlistShareUrl": {
            "type": "string"
          },
          "gWatchlistMatchStatus": {
            "type": "string",
            "enum": [
              "no_match",
              "false_positive",
              "potential_match",
              "true_positive",
              "unknown",
              "true_positive_approve",
              "true_positive_reject"
            ]
          },
          "gWatchlistRiskLevel": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high",
              "unknown"
            ]
          },
          "gWatchlistTotalHits": {
            "type": "integer",
            "format": "int32"
          },
          "gWatchlistTotalMatches": {
            "type": "integer",
            "format": "int32"
          },
          "gWatchlistSanctionsMatchScore": {
            "type": "number",
            "format": "float"
          },
          "gWatchlistWarningMatchScore": {
            "type": "number",
            "format": "float"
          }
        }
      },
      "IosInjectionData": {
        "type": "object",
        "properties": {
          "createStreamTime": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            }
          },
          "frameStats": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FrameStats"
            }
          },
          "appliedConstraints": {
            "type": "object"
          },
          "isTimeoutReached": {
            "type": "boolean"
          }
        }
      },
      "KeyValue": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "object"
          }
        }
      },
      "LetterOfAuthorizationDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "businessName": {
                "type": "string"
              },
              "address": {
                "type": "string"
              }
            }
          }
        ]
      },
      "MediaInfo": {
        "type": "object",
        "properties": {
          "videoChecksum": {
            "type": "string"
          }
        }
      },
      "MediaQualityResult": {
        "type": "object",
        "properties": {
          "modality": {
            "type": "string",
            "enum": [
              "depth"
            ]
          },
          "name": {
            "type": "string",
            "enum": [
              "depthQuality"
            ]
          },
          "result": {
            "type": "string",
            "enum": [
              "passed",
              "failed"
            ]
          },
          "parameters": {
            "type": "string"
          }
        }
      },
      "MetadataDeviceInfo": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "MOBILE",
              "DESKTOP"
            ]
          },
          "model": {
            "type": "string"
          },
          "os": {
            "type": "string"
          },
          "osVersion": {
            "type": "string"
          },
          "screenDimensions": {
            "$ref": "#/components/schemas/ScreenDimensions"
          },
          "numTouchPoints": {
            "type": "integer",
            "format": "int32"
          },
          "fingerprintHash": {
            "type": "string"
          },
          "ip": {
            "type": "string"
          },
          "backgroundMode": {
            "type": "boolean"
          },
          "hookDetected": {
            "type": "boolean"
          },
          "emulatorDetected": {
            "type": "boolean"
          },
          "rootDetected": {
            "type": "boolean"
          },
          "virtualEnvironmentDetected": {
            "type": "boolean"
          },
          "jailbreakDetectionDisabled": {
            "type": "boolean"
          }
        }
      },
      "MexicanTaxDeclarationDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "rfcNumber": {
                "type": "string"
              },
              "corporateName": {
                "type": "string"
              },
              "fullName": {
                "type": "string"
              },
              "declarationType": {
                "type": "string"
              },
              "fiscalYear": {
                "type": "integer",
                "format": "int32"
              },
              "submissionDate": {
                "type": "integer",
                "format": "int64"
              },
              "hasIncomeStatement": {
                "type": "boolean"
              },
              "hasFinancialPositionStatement": {
                "type": "boolean"
              },
              "totalIncome": {
                "type": "number"
              },
              "capitalFromContributions": {
                "type": "number"
              },
              "capitalFromCapitalization": {
                "type": "number"
              },
              "accumulatedLosses": {
                "type": "number"
              },
              "currentYearLosses": {
                "type": "number"
              },
              "accumulatedProfits": {
                "type": "number"
              },
              "currentYearProfits": {
                "type": "number"
              },
              "amountToPay": {
                "type": "number"
              },
              "amountDue": {
                "type": "number"
              },
              "operationNumber": {
                "type": "string"
              }
            }
          }
        ]
      },
      "MexicanTaxStatusDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "issueDate": {
                "type": "integer",
                "format": "int64"
              },
              "rfcNumber": {
                "type": "string"
              },
              "corporateName": {
                "type": "string"
              },
              "fullName": {
                "type": "string"
              },
              "registryStatus": {
                "type": "string"
              },
              "capitalRegime": {
                "type": "string"
              },
              "legalName": {
                "type": "string"
              },
              "addressComponents": {
                "$ref": "#/components/schemas/AddressBean"
              },
              "economicActivities": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/EconomicActivity"
                }
              },
              "regimes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Regime"
                }
              },
              "barcodes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/PoaBarcode"
                }
              }
            }
          }
        ]
      },
      "NfcRecognitionConfidence": {
        "type": "object",
        "properties": {
          "nfcVsSelfieConfidence": {
            "type": "number",
            "format": "float"
          },
          "nfcVsSelfieLogConfidence": {
            "type": "number",
            "format": "float"
          },
          "nfcVsIdConfidence": {
            "type": "number",
            "format": "float"
          },
          "nfcVsIdLogConfidence": {
            "type": "number",
            "format": "float"
          }
        }
      },
      "People": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "titles": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Title"
            }
          },
          "memberType": {
            "type": "string"
          }
        }
      },
      "PerPhaseStats": {
        "type": "object",
        "properties": {
          "invalidDuplicateCount": {
            "type": "integer",
            "format": "int32"
          },
          "totalFrames": {
            "type": "integer",
            "format": "int32"
          },
          "uniqueHashes": {
            "type": "integer",
            "format": "int32"
          },
          "maxOccurrencePercentage": {
            "type": "number",
            "format": "float"
          }
        }
      },
      "PoaAntiSpoofResult": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "PASS",
              "FAIL",
              "NOT_EXECUTED"
            ]
          },
          "kinds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "confidence": {
            "type": "number",
            "format": "float"
          },
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Detail"
            }
          }
        }
      },
      "PoaBarcode": {
        "type": "object",
        "properties": {
          "format": {
            "type": "string"
          },
          "contentType": {
            "type": "string"
          },
          "text": {
            "type": "string"
          },
          "error": {
            "type": "string"
          }
        }
      },
      "PoaDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "address": {
                "type": "string"
              },
              "timestamp": {
                "type": "integer",
                "format": "int64"
              },
              "addressStatementTimestamps": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AddressStatementDate"
                }
              },
              "issuer": {
                "type": "string",
                "enum": [
                  "aysa",
                  "edelap",
                  "edenor",
                  "edesur",
                  "epec",
                  "metrogas",
                  "a1",
                  "aggm",
                  "apg",
                  "energieAg",
                  "cre",
                  "eaab",
                  "enel",
                  "vanti",
                  "aforeAzteca",
                  "aforeBanorte",
                  "amd",
                  "amicsa",
                  "att",
                  "axtel",
                  "bancoppel",
                  "bancoAzteca",
                  "banorte",
                  "bbva",
                  "cab",
                  "caev",
                  "capa",
                  "cea",
                  "cfe",
                  "citibanamex",
                  "cmapa",
                  "cmapaGrande",
                  "cmapas",
                  "cmas",
                  "cmasBlue",
                  "comapa",
                  "comapaRed",
                  "coppel",
                  "dapa",
                  "dhc",
                  "drenaje",
                  "ecogas",
                  "engie",
                  "gasNatural",
                  "h",
                  "hsbc",
                  "inbursa",
                  "infonavit",
                  "interapas",
                  "isagas",
                  "izzi",
                  "jad",
                  "japam",
                  "japama",
                  "japami",
                  "japay",
                  "jiapaz",
                  "jmas",
                  "jras",
                  "jumapac",
                  "jumapam",
                  "lerdo",
                  "liverpool",
                  "mas",
                  "megacable",
                  "naturgy",
                  "oapas",
                  "odapas",
                  "ooapas",
                  "opdm",
                  "oroapa",
                  "sacmex",
                  "sacmexCdmx",
                  "santander",
                  "sapa",
                  "sapal",
                  "sapamuy",
                  "sapasa",
                  "sapasma",
                  "scotiabank",
                  "seapal",
                  "siapa",
                  "siapaTepic",
                  "simapag",
                  "simapas",
                  "simas",
                  "smapa",
                  "smapac",
                  "smapam",
                  "smapas",
                  "spectrum",
                  "stori",
                  "sura",
                  "tam",
                  "telcel",
                  "telmex",
                  "totalplay",
                  "veolia",
                  "victoria",
                  "wizz",
                  "asylumSeeker",
                  "refugeeId",
                  "refugeeStatus",
                  "ute",
                  "telkom",
                  "tmobile",
                  "verizon",
                  "xfinity",
                  "aforeCoppel",
                  "americanExpress",
                  "ap",
                  "telnor",
                  "wellsFargo",
                  "otherPoa"
                ]
              },
              "addressComponents": {
                "$ref": "#/components/schemas/AddressBean"
              },
              "parsedAddressComponents": {
                "$ref": "#/components/schemas/AddressBean"
              }
            }
          }
        ]
      },
      "PremiumExternalVerification": {
        "type": "object",
        "properties": {
          "level": {
            "type": "string"
          },
          "verifications": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "income": {
            "$ref": "#/components/schemas/Income"
          },
          "employment": {
            "$ref": "#/components/schemas/Employment"
          },
          "reasonCodes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/VerificationReasonCodes"
            }
          },
          "additionalVerificationInfo": {
            "$ref": "#/components/schemas/AdditionalVerificationInfo"
          }
        }
      },
      "PunchedHoles": {
        "type": "object",
        "properties": {
          "confidence": {
            "type": "number",
            "format": "float"
          }
        }
      },
      "ReasonCode": {
        "type": "object",
        "properties": {
          "reasonCode": {
            "type": "string",
            "enum": [
              "A40SS",
              "A70SS",
              "A4070SS",
              "AASE",
              "ACV",
              "ADC",
              "ADCMS",
              "ADCUD",
              "AFAEI",
              "AFM",
              "AFMNCC",
              "AFMSCC",
              "AHNI",
              "AHR",
              "AIA",
              "AII",
              "AIR",
              "AMCC",
              "AMI",
              "AMICC",
              "AMICCMM",
              "AMICCSE",
              "ANA",
              "AND",
              "ANF",
              "APA",
              "APAI",
              "APCC",
              "APNV",
              "ARNF",
              "ASC",
              "ASCV",
              "ASDL",
              "ASU",
              "AUICCM",
              "AWS",
              "EA1Y",
              "EA2Y",
              "EA4M",
              "EA4Y",
              "EA6M",
              "EAC1F",
              "EACMF",
              "EADP",
              "EAF1",
              "EAF2",
              "EAF3",
              "EAF4Y",
              "EAFC",
              "EAG1",
              "EAG2",
              "EAG3",
              "EAG4",
              "EAG5",
              "EAG6",
              "EAHF",
              "EALLI",
              "EALSM",
              "EALTW",
              "EAM",
              "EAMC",
              "EAMF",
              "EAMI",
              "EAMP",
              "EANA",
              "EANE",
              "EANI",
              "EANP",
              "EAPF",
              "EAQ3",
              "EAQ4",
              "EAQM",
              "EASI",
              "EAVQ",
              "EAW",
              "EAY",
              "ED4M",
              "EDCH",
              "EDCO",
              "EDDN",
              "EDHA",
              "EDHC",
              "EDHI",
              "EDHN",
              "EDI",
              "EDL",
              "EDLC",
              "EDM",
              "EDNP",
              "EDPR",
              "EDVH",
              "EDVHC",
              "EDVHI",
              "EE24",
              "EE90",
              "EEPEII",
              "EMA24",
              "EMA90",
              "ESG24",
              "ESG90",
              "EVS24",
              "EVS90",
              "P2OSOV",
              "P3OSOV",
              "P4OSOV",
              "P5OSOV",
              "PA2M",
              "PA3M",
              "PA15",
              "PA24",
              "PABA",
              "PABM",
              "PACF",
              "PADU",
              "PAE",
              "PAHR",
              "PAIN",
              "PALT",
              "PAM",
              "PAMA",
              "PAML",
              "PANN",
              "PANV",
              "PAPM",
              "PAPO",
              "PAUD",
              "PAV",
              "PAVN",
              "PAW",
              "PBL",
              "PBOT",
              "PCC",
              "PDI",
              "PDL",
              "PDLA",
              "PE24",
              "PE90",
              "PECD",
              "PELT",
              "PES90",
              "PES",
              "PFIS",
              "PFN",
              "PFOI",
              "PFOS",
              "PFRD",
              "PH90",
              "PHAI",
              "PHAO",
              "PHLT",
              "PHRL",
              "PHSLT",
              "PILE",
              "PINV",
              "PLEA",
              "PLLT",
              "PLS",
              "PLST",
              "PMA24",
              "PMA90",
              "PMAE",
              "PMAIC",
              "PMAOC",
              "PMAOP",
              "PMAOT",
              "PML",
              "PMNA",
              "PMO",
              "PMS",
              "PMST",
              "PMU",
              "PMVS",
              "PN3M",
              "PNC",
              "PNMB",
              "PNN",
              "PNNS",
              "PNO",
              "PNPB",
              "PNRR",
              "PNS",
              "PNU",
              "POD",
              "PPC3",
              "PPC5",
              "PPC6",
              "PPC9",
              "PPGR",
              "PPN",
              "PPPH",
              "PPRT",
              "PPV",
              "PRC",
              "PRCO",
              "PRM",
              "PROM",
              "PRP",
              "PRSA",
              "PRSK",
              "PRSV",
              "PSCD",
              "PSDBM",
              "PSFE",
              "PSG24",
              "PSG90",
              "PSHRSN",
              "PSM90",
              "PSMDB",
              "PSMRN",
              "PSMSN",
              "PSTF",
              "PTFN",
              "PTL",
              "PTO",
              "PVLA",
              "PVLS",
              "PVMN",
              "PVOIP",
              "PVRC",
              "PVS24",
              "PVS90",
              "PVST",
              "PVSTF",
              "TANO",
              "TDDA",
              "TFAD1",
              "TFADF",
              "TFADI",
              "TFVE",
              "TFVI",
              "TH3AA",
              "TH3AH",
              "TH3AI",
              "TH3AO",
              "TH3AS",
              "TH3BO",
              "TH3CH",
              "TH3DB",
              "TH3DI",
              "TH3ED",
              "TH3FG",
              "TH3FR",
              "TH3IT",
              "TH3MR",
              "TH3NN",
              "TH3OM",
              "TH3PB",
              "TH3PH",
              "TH3PR",
              "TH3RI",
              "TH3SA",
              "TH3SF",
              "TH3SM",
              "THAAA",
              "THAAH",
              "THAAI",
              "THAAO",
              "THAAS",
              "THABO",
              "THACH",
              "THADB",
              "THADI",
              "THAED",
              "THAFG",
              "THAFR",
              "THAIT",
              "THAMR",
              "THANN",
              "THAOM",
              "THAPB",
              "THAPH",
              "THAPR",
              "THARI",
              "THASA",
              "THASF",
              "THASM",
              "THPAA",
              "THPAH",
              "THPAI",
              "THPAO",
              "THPAS",
              "THPBO",
              "THPCH",
              "THPDB",
              "THPDI",
              "THPED",
              "THPFG",
              "THPFR",
              "THPIT",
              "THPMR",
              "THPNN",
              "THPOM",
              "THPPB",
              "THPPH",
              "THPPR",
              "THPRI",
              "THPSA",
              "THPSF",
              "THPSM",
              "THTAH",
              "THTAV",
              "THTBE",
              "THTBP",
              "THTDI",
              "THTED",
              "THTES",
              "THTFG",
              "THTFR",
              "THTGP",
              "THTHE",
              "THTIA",
              "THTIH",
              "THTIP",
              "THTMX",
              "THTNN",
              "THTOM",
              "THTPR",
              "THTRP",
              "THTSG",
              "THTVP",
              "TIAWB",
              "TIAWF",
              "TINO",
              "TL3AA",
              "TL3AH",
              "TL3AI",
              "TL3AO",
              "TL3AS",
              "TL3BO",
              "TL3CH",
              "TL3DB",
              "TL3DI",
              "TL3ED",
              "TL3FG",
              "TL3FR",
              "TL3IT",
              "TL3MR",
              "TL3NN",
              "TL3OM",
              "TL3PB",
              "TL3PH",
              "TL3PR",
              "TL3RI",
              "TL3SA",
              "TL3SF",
              "TL3SM",
              "TLAAA",
              "TLAAH",
              "TLAAI",
              "TLAAO",
              "TLAAS",
              "TLABO",
              "TLACH",
              "TLADB",
              "TLADI",
              "TLAED",
              "TLAFG",
              "TLAFR",
              "TLAIT",
              "TLAMR",
              "TLANN",
              "TLAOM",
              "TLAPB",
              "TLAPH",
              "TLAPR",
              "TLARI",
              "TLASA",
              "TLASF",
              "TLASM",
              "TLGPD",
              "TLPAA",
              "TLPAH",
              "TLPAI",
              "TLPAO",
              "TLPAS",
              "TLPBO",
              "TLPCH",
              "TLPDB",
              "TLPDI",
              "TLPED",
              "TLPFG",
              "TLPFR",
              "TLPIT",
              "TLPMR",
              "TLPNN",
              "TLPOM",
              "TLPPB",
              "TLPPH",
              "TLPPR",
              "TLPRI",
              "TLPSA",
              "TLPSF",
              "TLPSM",
              "TLTAH",
              "TLTAV",
              "TLTBE",
              "TLTBP",
              "TLTDI",
              "TLTED",
              "TLTES",
              "TLTFG",
              "TLTFR",
              "TLTGP",
              "TLTHE",
              "TLTIA",
              "TLTIH",
              "TLTIP",
              "TLTMX",
              "TLTNN",
              "TLTOM",
              "TLTPR",
              "TLTRP",
              "TLTSG",
              "TLTVP",
              "TMAI",
              "TMFSI",
              "TNAPD",
              "TNASM",
              "TNPID",
              "TNPIE",
              "TNPIN",
              "TNPIP",
              "TNPIR",
              "TNPIS",
              "TNPIZ",
              "TNPMS",
              "TOAB",
              "TOAF",
              "TPAI",
              "TPDNV",
              "TPSMT",
              "TSAC",
              "TSAF",
              "TSBF",
              "TSBG",
              "TSBH",
              "TSBI",
              "TSBJ",
              "TBK",
              "TSBN",
              "TSBO",
              "TSCG",
              "TSCH",
              "TSDC",
              "TSDD",
              "TSDE",
              "TSDF",
              "TSDG",
              "TSDH",
              "TSDI",
              "TSDJ",
              "TSDK",
              "TSDL",
              "TSDM",
              "TSDN",
              "TSDO",
              "TSDP",
              "TSMA",
              "TSMB",
              "TSMC",
              "TNSA",
              "TSNB",
              "TSNC",
              "TSOA",
              "TSKU",
              "TSLI",
              "TSLJ",
              "TSLK",
              "TSLN",
              "TSLO",
              "TSDV",
              "TSNA",
              "TSNV",
              "TSOD",
              "TSOP",
              "TSPNA",
              "TSPNM",
              "TSR",
              "TSRD",
              "TSRF",
              "TSSF",
              "TSTUT",
              "TTIQ",
              "TXHR",
              "TXMTW",
              "TXNA",
              "TXR",
              "TXTW",
              "TXVHR",
              "TSRP"
            ]
          },
          "description": {
            "type": "string"
          }
        }
      },
      "RefugeeIdDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "firstNames": {
                "type": "string"
              },
              "lastName": {
                "type": "string"
              },
              "gender": {
                "type": "string",
                "enum": [
                  "MALE",
                  "FEMALE"
                ]
              },
              "countryOfBirth": {
                "type": "string"
              },
              "dateOfBirth": {
                "type": "integer",
                "format": "int64"
              },
              "nationality": {
                "type": "string"
              },
              "maritalStatus": {
                "type": "string"
              },
              "issueDate": {
                "type": "integer",
                "format": "int64"
              },
              "expiryDate": {
                "type": "integer",
                "format": "int64"
              },
              "idNumber": {
                "type": "string"
              }
            }
          }
        ]
      },
      "RefugeeStatusDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "fullName": {
                "type": "string"
              },
              "gender": {
                "type": "string",
                "enum": [
                  "MALE",
                  "FEMALE"
                ]
              },
              "dateOfBirth": {
                "type": "integer",
                "format": "int64"
              },
              "issueDate": {
                "type": "integer",
                "format": "int64"
              },
              "countryOfBirth": {
                "type": "string"
              },
              "nationality": {
                "type": "string"
              },
              "maritalStatus": {
                "type": "string"
              },
              "documentNumber": {
                "type": "string"
              }
            }
          }
        ]
      },
      "Regime": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "startDate": {
            "type": "integer",
            "format": "int64"
          },
          "endDate": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "RegistralSituation": {
        "type": "object",
        "properties": {
          "tipoSituacionRegistral": {
            "type": "string"
          },
          "tipoReporteRoboExtravio": {
            "type": "string"
          }
        }
      },
      "ReplayAttackData": {
        "type": "object",
        "properties": {
          "collisionCount": {
            "type": "integer",
            "format": "int32"
          },
          "isTimeoutReached": {
            "type": "boolean"
          },
          "intraSessionLoop": {
            "type": "boolean"
          },
          "intraSessionLookahead": {
            "type": "boolean"
          },
          "interSessionLookahead": {
            "type": "boolean"
          },
          "totalFrames": {
            "type": "integer",
            "format": "int32"
          },
          "uniqueHashes": {
            "type": "integer",
            "format": "int32"
          },
          "maxConsecutiveRun": {
            "type": "integer",
            "format": "int32"
          },
          "maxOccurrenceCount": {
            "type": "integer",
            "format": "int32"
          },
          "storedSessionsCount": {
            "type": "integer",
            "format": "int32"
          },
          "storedHashesCount": {
            "type": "integer",
            "format": "int32"
          },
          "storedSessionSizes": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            }
          },
          "intraIncodeSessionLoop": {
            "type": "boolean"
          },
          "interIncodeSessionLoop": {
            "type": "boolean"
          }
        }
      },
      "RetentionRegion": {
        "type": "object",
        "properties": {
          "ipRegion": {
            "type": "string"
          },
          "ocrRegion": {
            "type": "string"
          }
        }
      },
      "RfcDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "fullName": {
                "type": "string"
              },
              "rfcNumber": {
                "type": "string"
              },
              "idCIF": {
                "type": "string"
              }
            }
          }
        ]
      },
      "RfcValidationResponse": {
        "type": "object",
        "properties": {
          "validRFC": {
            "type": "boolean"
          },
          "status": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "rfcType": {
            "type": "string"
          },
          "messageCode": {
            "type": "string"
          },
          "errorMessage": {
            "type": "string"
          },
          "rfcMessageCode": {
            "type": "string",
            "description": "Machine-readable reason for the validation outcome. Populated on both the success and the error paths. RFC_PROVIDER_UNAVAILABLE means the RFC could not be checked, not that it is invalid.",
            "enum": [
              "RFC_VALID",
              "RFC_VALID_NOT_INVOICEABLE",
              "RFC_NOT_FOUND",
              "RFC_FORMAT_INVALID",
              "RFC_PROVIDER_UNAVAILABLE",
              "CURP_PROVIDER_UNAVAILABLE",
              "CURP_NOT_FOUND",
              "CURP_INVALID",
              "CURP_DATA_INSUFFICIENT",
              "RFC_UNKNOWN"
            ]
          }
        }
      },
      "ScannerSignals": {
        "type": "object",
        "properties": {
          "b900InkCheck": {
            "type": "boolean"
          },
          "uvDullnessFront": {
            "type": "boolean"
          },
          "uvDullnessBack": {
            "type": "boolean"
          },
          "motionDetectionFront": {
            "type": "boolean"
          },
          "motionDetectionBack": {
            "type": "boolean"
          }
        }
      },
      "ScreenDimensions": {
        "type": "object",
        "properties": {
          "width": {
            "type": "integer",
            "format": "int32"
          },
          "height": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "SessionDiagnostics": {
        "type": "object",
        "properties": {
          "exposureSupported": {
            "type": "boolean"
          },
          "exposureApplyConstraintError": {
            "type": "boolean"
          },
          "exposureApplyConstraintTimeout": {
            "type": "boolean"
          },
          "invalidTrackStateDetected": {
            "type": "boolean"
          },
          "exposureInconsistencyDetected": {
            "type": "boolean"
          },
          "interruptedCapture": {
            "type": "boolean"
          },
          "cameraCaptureStatus": {
            "type": "integer",
            "format": "int32"
          },
          "exposureMinDelay": {
            "type": "integer",
            "format": "int32"
          },
          "exposureInitialDelay": {
            "type": "integer",
            "format": "int32"
          },
          "baselineBrightness": {
            "type": "number",
            "format": "float"
          }
        }
      },
      "SignatureAttempt": {
        "type": "object",
        "properties": {
          "imageRef": {
            "type": "string"
          },
          "signatureType": {
            "type": "string"
          }
        }
      },
      "SignedConsent": {
        "type": "object",
        "properties": {
          "consentType": {
            "type": "string",
            "enum": [
              "ML",
              "PRIVACY",
              "MANDATORY"
            ]
          },
          "regulationType": {
            "type": "string",
            "enum": [
              "US",
              "Other",
              "Worldwide",
              "US_Illinois",
              "US_California",
              "US_Texas",
              "US_Washington"
            ]
          },
          "signed": {
            "type": "boolean"
          },
          "consentId": {
            "type": "string"
          },
          "signedTime": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "SpoofCheckResult": {
        "type": "object",
        "properties": {
          "confidence": {
            "type": "number",
            "format": "float"
          },
          "isSpoof": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "passed",
              "failed",
              "notExecuted"
            ]
          },
          "severity": {
            "type": "string",
            "enum": [
              "ultra low",
              "low",
              "medium",
              "high",
              "llava"
            ]
          },
          "version": {
            "type": "string"
          },
          "checkName": {
            "type": "string",
            "enum": [
              "physicalAttack",
              "digitalAttack",
              "evasionAttack",
              "motionAttack",
              "deepfakeAttack",
              "digitalManipulationAttack",
              "physicalAttack/constrained",
              "physicalAttack/assisted",
              "physicalAttack/unconstrained",
              "physicalAttack/webcam",
              "physicalAttack/constrained/multimodal"
            ]
          },
          "reason": {
            "type": "string",
            "enum": [
              "FACE_CROPPING_FAILURE",
              "UNSATISFIED_FACE_SIZE",
              "UNSATISFIED_BLURRINESS_LEVEL",
              "UNSATISFIED_BRIGHTNESS_LEVEL",
              "UNSATISFIED_IMAGE_COMPRESSION_LEVEL"
            ]
          }
        }
      },
      "SpoofDetectionErrorDetails": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "enum": [
              "BAD_REQUEST",
              "UNAUTHORIZED",
              "PAYMENT_REQUIRED",
              "FORBIDDEN",
              "NOT_FOUND",
              "METHOD_NOT_ALLOWED",
              "NOT_ACCEPTABLE",
              "PROXY_AUTHENTICATION_REQUIRED",
              "REQUEST_TIMEOUT",
              "CONFLICT",
              "GONE",
              "LENGTH_REQUIRED",
              "PRECONDITION_FAILED",
              "PAYLOAD_TOO_LARGE",
              "URI_TOO_LONG",
              "UNSUPPORTED_MEDIA_TYPE",
              "REQUESTED_RANGE_NOT_SATISFIABLE",
              "EXPECTATION_FAILED",
              "I_AM_A_TEAPOT",
              "UNPROCESSABLE_ENTITY",
              "LOCKED",
              "FAILED_DEPENDENCY",
              "UPGRADE_REQUIRED",
              "PRECONDITION_REQUIRED",
              "TOO_MANY_REQUESTS",
              "REQUEST_HEADER_FIELDS_TOO_LARGE",
              "UNAVAILABLE_FOR_LEGAL_REASONS",
              "CONFIGURATION_ERROR",
              "INTERNAL_SERVER_ERROR",
              "BAD_GATEWAY",
              "SERVICE_UNAVAILABLE",
              "USER_NOT_ENROLLED",
              "FACE_CROPPING_FAILED",
              "FACE_TOO_SMALL",
              "FACE_TOO_BLURRY",
              "FACE_TOO_DARK",
              "BAD_PHOTO_QUALITY",
              "INVALID_DEPTH_IMAGE",
              "INVALID_VIDEO",
              "USER_BLACKLISTED",
              "NONEXISTENT_CUSTOMER",
              "SPOOF_ATTEMPT_DETECTED",
              "USER_ALREADY_EXISTS",
              "OMNICHANNEL_NOT_SUPPORTED",
              "UUID_ALREADY_USED",
              "MULTIPLE_FACES_DETECTED",
              "SIGNATURE_DOES_NOT_MATCH",
              "INVALID_LOGIN_CREDENTIALS",
              "USER_IS_NOT_APPROVED",
              "INVALID_INTERVIEW_CODE",
              "USER_IS_NOT_RECOGNIZED",
              "INVALID_API_KEY_USAGE",
              "INVALID_IMAGE",
              "MODULE_NOT_SUPPORTED",
              "FACE_NOT_FOUND",
              "IMAGE_NOT_FOUND",
              "TOO_MANY_RECORDS",
              "INVALID_PHONE_FORMAT",
              "DUPLICATE_EMAIL",
              "DUPLICATE_PHONE_NUMBER",
              "DUPLICATE_MAC_ADDRESS",
              "INVALID_UUID_PARAMETER",
              "INVALID_CONFIGURATION_ID_PARAMETER",
              "FLOW_NOT_ACTIVATED",
              "INVALID_EVENT_NAME",
              "FLOW_NAME_EXISTS",
              "INVALID_REDIRECTION_URL",
              "INVALID_RULE_CONFIGURED",
              "TWO_GOV_VALIDATION_MODULES",
              "MULTIPLE_ELECTRONIC_SIGNATURE_MODULES",
              "INVALID_CLIENT_ID_FOR_OAUTH2_SECURED",
              "REDIRECT_URI_REQUIRED_FOR_OAUTH2_SECURED",
              "REDIRECT_URI_INVALID_FOR_OAUTH2_SECURED",
              "WORKFLOW_ASYNC_RESOLUTION_NODE_MISSING",
              "WORKFLOW_ASYNC_MODULE_MISSING_FOR_RESOLUTION",
              "WORKFLOW_NAME_EXISTS",
              "WORKFLOW_NODE_WRONG_TYPE",
              "WORKFLOW_ROOT_NODE_NOT_SINGLE",
              "WORKFLOW_ROOT_NODE_ID_NOT_MATCH_ROOT_NODE",
              "WORKFLOW_CONDITION_NODE_NOT_COMPLETE",
              "WORKFLOW_NODE_SUCCESSOR_NOT_FOUND",
              "WORKFLOW_GRAPH_NOT_CONNECTED",
              "WORKFLOW_RESULT_NODE_NOT_FINISH",
              "WORKFLOW_TEMPLATE",
              "WORKFLOW_TEMPLATE_NOT_FOUND",
              "MODULE_CONFIGURATION_INCOMPLETE",
              "ORGANIZATION_NAME_EXISTS",
              "WORKFLOW_NODE_ALREADY_HAS_PARENT",
              "WORKFLOW_NODE_BELONGS_TO_DIFFERENT_WORKFLOW",
              "WORKFLOW_ASYNC_RESOLUTION_REQUIRES_ASYNC_MODULE_BEFORE",
              "WORKFLOW_MODULE_CANNOT_BE_ADDED_AFTER_ASYNC_RESOLUTION",
              "ORGANIZATION_VANITY_URL_SLUG_EXISTS",
              "WORKFLOW_GROUP_ENTRY_INVALID",
              "WORKFLOW_GROUP_NESTED_NOT_ALLOWED",
              "WORKFLOW_GROUP_MEMBER_NOT_REACHABLE",
              "WORKFLOW_GROUP_EXIT_NOT_WIRED",
              "ENTITY_INSERT_FAILED",
              "ENTITY_UPDATE_FAILED",
              "WORKFLOW_GROUP_STRUCTURE_LOCKED",
              "ENTITY_ALREADY_EXISTS",
              "INVALID_EMAIL_FORMAT",
              "SELFIE_IMAGE_MISSING",
              "INVALID_MODULE_CONFIGURATION",
              "INVALID_DATE_FORMAT",
              "INVALID_TAX_ID_FORMAT",
              "INVALID_US_STATE_CODE",
              "INVALID_CA_REGION_CODE",
              "SELFIE_IMAGE_LOW_QUALITY",
              "SELFIE_FACE_OCCLUDED",
              "QR_PHISHING_INVALID_VALIDATION",
              "START_ENHANCED_SECURITY_VALIDATION",
              "ONBOARDING_URL_ALREADY_USED",
              "ID_FACE_EXTRACTION_SKIPPED",
              "ID_IMAGE_TOO_SMALL",
              "SESSION_CONTINUATION_PERIOD_EXCEEDED",
              "SESSION_CONTINUATION_LIMIT_REACHED",
              "SESSION_NOT_ACTIVE",
              "SESSION_CONTINUATION_INVALID_IDENTIFIER",
              "CAPTURE_ATTEMPT_CONTEXT_NOT_FOUND",
              "INSUFFICIENT_ACCESS_LEVEL",
              "UNSUPPORTED_IMAGE",
              "API_KEY_NAME_EXISTS",
              "WEBHOOK_TYPE_DEFINED",
              "BAV_ATTEMPTS_EXCEEDED",
              "INVALID_CREDIT_DATA",
              "BATCH_ALREADY_RUNNING",
              "CONSENT_ALREADY_EXISTS",
              "CONSENT_NOT_GRANTED",
              "MODULE_NOT_PROVISIONED",
              "WATCHLIST_ID_CLASSIFICATION_FAILED",
              "AGE_ASSURANCE_VALIDATION_FAILED",
              "LOGIN_HINT_NOT_FOUND",
              "ESCALATION_ALREADY_OPENED_BY_INCODE",
              "EKYB_NO_RESULTS",
              "EKYB_TIN_VERIFICATION_FAILED",
              "EKYC_PREFILL_PHONE_COUNTRY_NOT_SUPPORTED",
              "INTEGRATION_NOT_FOUND_BY_REFERENCE",
              "INVALID_LOGIN_HINT",
              "LOGIN_HINT_ATTEMPTS_EXCEEDED",
              "CONTACT_ALREADY_VERIFIED",
              "TRIAL_ORGANIZATION_SESSION_LIMIT_REACHED",
              "DOCUMENT_NOT_FOUND",
              "DOCUMENT_TOO_LARGE",
              "MAC_ALGORITHM_REQUIRED_CLIENT_SECRET_JWT",
              "SIGNATURE_ALGORITHM_REQUIRED_PRIVATE_KEY_JWT",
              "JWK_SET_URL_NEEDED_FOR_PRIVATE_KEY_JWT",
              "NON_UNIQUE_CLIENT_NAME",
              "SINGLE_INTEGRATION_NOT_FOUND_BY_TYPE",
              "MULTIPLE_INTEGRATIONS_FOUND_BY_TYPE",
              "VERIFICATION_CANNOT_BE_STARTED",
              "PROCESSING_ERROR",
              "EXTERNAL_API_ERROR"
            ]
          },
          "detailMessage": {
            "type": "string"
          }
        }
      },
      "SpoofDetectionResult": {
        "type": "object",
        "properties": {
          "overallConfidence": {
            "type": "number",
            "format": "float"
          },
          "isSpoof": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "passed",
              "failed",
              "notExecuted"
            ]
          },
          "physicalAttack": {
            "$ref": "#/components/schemas/SpoofCheckResult"
          },
          "digitalAttack": {
            "$ref": "#/components/schemas/SpoofCheckResult"
          },
          "evasionAttack": {
            "$ref": "#/components/schemas/SpoofCheckResult"
          },
          "motionAttack": {
            "$ref": "#/components/schemas/SpoofCheckResult"
          },
          "deepfakeAttack": {
            "$ref": "#/components/schemas/SpoofCheckResult"
          },
          "digitalManipulationAttack": {
            "$ref": "#/components/schemas/SpoofCheckResult"
          },
          "mediaQualityResults": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MediaQualityResult"
            }
          },
          "options": {
            "$ref": "#/components/schemas/SpoofResultOptions"
          },
          "method": {
            "type": "string",
            "enum": [
              "SINGLE_FRAME",
              "SINGLE_FRAME_MULTIMODAL",
              "SINGLE_FRAME_MULTIMODAL_VIDEO"
            ]
          },
          "explanation": {
            "$ref": "#/components/schemas/SpoofResultExplanation"
          },
          "spoofDetectionErrorDetails": {
            "$ref": "#/components/schemas/SpoofDetectionErrorDetails"
          }
        }
      },
      "SpoofResultExplanation": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string"
          },
          "keywords": {
            "$ref": "#/components/schemas/SpoofResultExplanationKeywords"
          }
        }
      },
      "SpoofResultExplanationKeywords": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string"
          },
          "isDepthFlat": {
            "type": "boolean"
          },
          "isVideoCorrupted": {
            "type": "boolean"
          }
        }
      },
      "SpoofResultOptions": {
        "type": "object",
        "properties": {
          "cameraFacingMode": {
            "type": "string",
            "enum": [
              "FRONTAL",
              "BACK",
              "UNKNOWN"
            ]
          },
          "source": {
            "type": "string",
            "enum": [
              "MOBILE",
              "DESKTOP",
              "UNKNOWN"
            ]
          },
          "enforceQSV": {
            "type": "boolean"
          },
          "strictVideoChecks": {
            "type": "boolean"
          }
        }
      },
      "Title": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          }
        }
      },
      "UboNameVerificationResult": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "uboNameMatch": {
            "type": "string"
          },
          "matchId": {
            "type": "string"
          },
          "ownershipPercentage": {
            "type": "string"
          }
        }
      },
      "UnknownDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          }
        ]
      },
      "V5CLogbookDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "fullName": {
                "type": "string"
              },
              "address": {
                "type": "string"
              },
              "addressList": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "registrationNumber": {
                "type": "string"
              },
              "v5cNumber": {
                "type": "string"
              },
              "referenceNumber": {
                "type": "string"
              },
              "vin": {
                "type": "string"
              },
              "validationErrors": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ValidationErrorSchema"
                }
              }
            }
          }
        ]
      },
      "ValidationErrorSchema": {
        "type": "object",
        "description": "Document validation error schema.",
        "properties": {
          "kind": {
            "type": "string",
            "description": "Validation error kind. Known values: documentIntegrity, layoutMismatch (see ValidationErrorKind). Kept as a free-form string for forward-compatibility with future kinds."
          },
          "error": {
            "type": "string",
            "description": "Error message"
          },
          "loc": {
            "type": "string",
            "description": "Location of the error(s)"
          },
          "explanation": {
            "type": "string",
            "description": "Error explanation"
          }
        },
        "required": [
          "error",
          "explanation",
          "kind",
          "loc"
        ]
      },
      "VerificationMessages": {
        "type": "object",
        "properties": {
          "tinVerificationMessage": {
            "type": "string"
          }
        }
      },
      "VerificationReasonCodes": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "reasonCodes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ReasonCode"
            }
          }
        }
      },
      "VoiceConsentSelfieAttempt": {
        "type": "object",
        "properties": {
          "imageRef": {
            "type": "string"
          },
          "timestamp": {
            "type": "integer",
            "format": "int64"
          },
          "confidence": {
            "type": "number",
            "format": "float"
          },
          "threshold": {
            "type": "number",
            "format": "float"
          }
        }
      },
      "W8Address": {
        "type": "object",
        "properties": {
          "street": {
            "type": "string",
            "description": "Street line as printed on the W-8 form"
          },
          "cityStateProvincePostalCode": {
            "type": "string",
            "description": "Combined city or town, state or province, and postal code line as printed on the W-8 form"
          },
          "country": {
            "type": "string",
            "description": "Country name as printed on the W-8 form"
          },
          "raw": {
            "type": "string",
            "description": "Full address as a single string"
          }
        }
      },
      "W8BenDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "beneficialOwnerName": {
                "type": "string"
              },
              "beneficialOwnerFirstName": {
                "type": "string"
              },
              "beneficialOwnerLastName": {
                "type": "string"
              },
              "countryOfCitizenship": {
                "type": "string"
              },
              "permanentResidenceAddress": {
                "$ref": "#/components/schemas/W8Address"
              },
              "mailingAddress": {
                "$ref": "#/components/schemas/W8Address"
              },
              "ssnOrItin": {
                "type": "string"
              },
              "foreignTin": {
                "type": "string"
              },
              "ftinNotLegallyRequired": {
                "type": "boolean"
              },
              "dateOfBirth": {
                "type": "integer",
                "format": "int64"
              },
              "treatyResidenceCountry": {
                "type": "string"
              },
              "signaturePresent": {
                "type": "boolean"
              },
              "dateSigned": {
                "type": "integer",
                "format": "int64"
              },
              "signerName": {
                "type": "string"
              },
              "revisionDetected": {
                "type": "string"
              },
              "formStatus": {
                "$ref": "#/components/schemas/W8FormStatus"
              }
            }
          }
        ]
      },
      "W8BenEDocumentAttempt": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttempt"
          },
          {
            "type": "object",
            "properties": {
              "legalEntityName": {
                "type": "string"
              },
              "countryOfIncorporationOrOrganization": {
                "type": "string"
              },
              "chapter3Status": {
                "type": "object",
                "additionalProperties": {
                  "type": "boolean"
                }
              },
              "chapter3AmbiguousOptions": {
                "type": "object",
                "additionalProperties": {
                  "type": "boolean"
                }
              },
              "hybridEntityTreatyClaim": {
                "type": "string"
              },
              "chapter4Status": {
                "type": "object",
                "additionalProperties": {
                  "type": "boolean"
                }
              },
              "chapter4AmbiguousOptions": {
                "type": "object",
                "additionalProperties": {
                  "type": "boolean"
                }
              },
              "permanentResidenceAddress": {
                "$ref": "#/components/schemas/W8Address"
              },
              "mailingAddress": {
                "$ref": "#/components/schemas/W8Address"
              },
              "ein": {
                "type": "string"
              },
              "giin": {
                "type": "string"
              },
              "foreignTin": {
                "type": "string"
              },
              "ftinNotLegallyRequired": {
                "type": "boolean"
              },
              "substantialUsOwners": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/W8SubstantialUsOwner"
                }
              },
              "signaturePresent": {
                "type": "boolean"
              },
              "dateSigned": {
                "type": "integer",
                "format": "int64"
              },
              "signerName": {
                "type": "string"
              },
              "revisionDetected": {
                "type": "string"
              },
              "formStatus": {
                "$ref": "#/components/schemas/W8FormStatus"
              }
            }
          }
        ]
      },
      "W8FormStatus": {
        "type": "object",
        "properties": {
          "dateSigned": {
            "type": "integer",
            "format": "int64",
            "description": "Date the form was signed, epoch millis at UTC midnight"
          },
          "expiresOn": {
            "type": "integer",
            "format": "int64",
            "description": "Date the form expires (Dec 31 of the third year after signing), epoch millis at UTC midnight"
          },
          "expired": {
            "type": "boolean",
            "description": "Whether the form has expired"
          },
          "missingRequiredFields": {
            "type": "array",
            "description": "Required fields missing from the form; empty when the form is complete",
            "items": {
              "type": "string"
            }
          },
          "complete": {
            "type": "boolean",
            "description": "Whether all required fields are present on the form"
          }
        }
      },
      "W8SubstantialUsOwner": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the substantial U.S. owner (W-8BEN-E Part XXIX)"
          },
          "address": {
            "type": "string",
            "description": "Address of the substantial U.S. owner as a single string"
          },
          "tin": {
            "type": "string",
            "description": "U.S. TIN of the substantial U.S. owner"
          }
        }
      },
      "ZoomData": {
        "type": "object",
        "properties": {
          "initialConstraints": {
            "type": "object"
          },
          "initialZoom": {
            "type": "number",
            "format": "float"
          },
          "maxZoomParameters": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ZoomParams"
            }
          },
          "minZoomParameters": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ZoomParams"
            }
          },
          "zoomInconsistencyDetected": {
            "type": "boolean"
          }
        }
      },
      "ZoomParams": {
        "type": "object",
        "properties": {
          "applicationTime": {
            "type": "integer",
            "format": "int32"
          },
          "appliedConstraints": {
            "type": "object"
          },
          "appliedZoom": {
            "type": "number",
            "format": "float"
          },
          "isTimeoutReached": {
            "type": "boolean"
          }
        }
      },
      "FraudCandidateRequestDto": {
        "type": "object",
        "properties": {
          "sourceEntityId": {
            "type": "string"
          },
          "reason": {
            "type": "string",
            "minLength": 1
          },
          "comment": {
            "type": "string"
          }
        }
      },
      "DefraudInterviewBatchRequestDto": {
        "type": "object",
        "properties": {
          "interviewIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "maxItems": 2147483647,
            "minItems": 1
          }
        },
        "required": [
          "interviewIds"
        ]
      },
      "StartRequest": {
        "type": "object",
        "properties": {
          "language": {
            "type": "string",
            "description": "Language code to be used when doing speech to text. Possible values: en-US, es-ES, pt-BR."
          },
          "externalId": {
            "type": "string",
            "deprecated": true,
            "description": "Id that identifies user in clients system should be used for externalId. (Deprecated, use externalCustomerId instead)",
            "example": "client34598"
          },
          "externalCustomerId": {
            "type": "string",
            "description": "Id that identifies user in clients external system.",
            "example": "client123"
          },
          "uuid": {
            "type": "string",
            "description": "uuid key used in redis, can be used as an alternative to sending interviewId."
          },
          "configurationId": {
            "type": "string",
            "description": "Id of the flow to be used for this onboarding."
          },
          "redirectionUrl": {
            "type": "string",
            "description": "Url the user will be redirected to after finishing the onboarding successfully.",
            "example": "https://www.google.com"
          },
          "integrationReference": {
            "type": "string",
            "description": "Optional integration reference."
          },
          "urlUuid": {
            "type": "string",
            "description": "Url uuid key used in redis. Will be validated in start if qrPhishingResistance is ON."
          },
          "customFields": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Used to send any additional information in key value pair format. Max fields: {maxEntries}, max key length: {keyMaxLength}, max value length: {valueMaxLength}",
            "example": {
              "firstName": "Mike",
              "lastName": "Larson"
            }
          }
        }
      },
      "StartResponse": {
        "type": "object",
        "properties": {
          "interviewId": {
            "type": "string",
            "description": "Identifies the onboarding session that is initialized. Can be used for fetching data about that session in future calls.",
            "maxLength": 24,
            "minLength": 24
          },
          "token": {
            "type": "string",
            "description": "Internal JWT token used for the future subsequent calls. It is the value for X-Incode-Hardware-Id header in all other calls.",
            "maxLength": 2048
          },
          "interviewCode": {
            "type": "string",
            "description": "This value is used for connecting to conference call.",
            "maxLength": 6,
            "minLength": 6
          },
          "flowType": {
            "type": "string",
            "description": "(only if configurationId is sent in request). Type of the flow used. Could be flow (in most cases), or legacy type configuration (not used anymore).",
            "enum": [
              "configuration",
              "flow",
              "workflow"
            ]
          },
          "idCaptureTimeout": {
            "type": "integer",
            "format": "int32",
            "description": "Number of seconds after which manual capture button should be shown to the user, while capturing ID when ID is detected."
          },
          "idDetectionTimeout": {
            "type": "integer",
            "format": "int32",
            "description": "Number of seconds after which manual capture button should be shown to the user, if ID is not detected."
          },
          "selfieCaptureTimeout": {
            "type": "integer",
            "format": "int32",
            "description": "Number of seconds after which manual capture button should be shown to the user, while capturing selfie."
          },
          "idCaptureRetries": {
            "type": "integer",
            "format": "int32",
            "description": "Number of ID captures after which user should be taken to next screen."
          },
          "selfieCaptureRetries": {
            "type": "integer",
            "format": "int32",
            "description": "Number of selfie captures after which user should be taken to next screen."
          },
          "curpValidationRetries": {
            "type": "integer",
            "format": "int32",
            "description": "Number of curp validations after which user should be taken to next screen. (only for Mexico)"
          },
          "clientId": {
            "type": "string",
            "description": "Customer specific clientId that corresponds to api key."
          },
          "env": {
            "type": "string",
            "description": "Server environment. Could be one of: stage, demo, saas."
          },
          "existingSession": {
            "type": "boolean",
            "description": "It's true if interviewId corresponds to an existing Onboarding Session."
          }
        }
      },
      "ApproveRequest": {
        "type": "object",
        "properties": {
          "approveComponents": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          }
        }
      },
      "ApproveOnboardingResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "uuid": {
            "type": "string",
            "description": "Id of newly created customer if approval was successful."
          },
          "token": {
            "type": "string",
            "description": "Access token to be used for newly created customer, in case approval was successful."
          }
        }
      },
      "AsyncDeletionTaskResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "taskId": {
            "type": "string"
          },
          "statusUri": {
            "type": "string"
          }
        }
      },
      "ImagesRequest": {
        "type": "object",
        "properties": {
          "images": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "selfie",
                "authenticationSelfie",
                "sorSelfie",
                "videoSelfie",
                "externalFace",
                "croppedFace",
                "croppedAuthenticationSelfie",
                "croppedFrameAnalysisSelfie",
                "croppedExternalFace",
                "croppedIDFace",
                "croppedNfcFace",
                "document",
                "originalSignature",
                "signature",
                "initials",
                "fullFrameFrontID",
                "fullFrameBackID",
                "croppedFrontID",
                "refCroppedFrontID",
                "croppedBackID",
                "refCroppedBackID",
                "croppedOriginalFrontID",
                "croppedOriginalBackID",
                "confSelfie",
                "confFrontID",
                "confBackID",
                "confPoa",
                "addressStatement",
                "medicalDoc",
                "secondId",
                "thirdId",
                "contract",
                "signedContract",
                "videoSelfieCompareID",
                "videoSelfieCompareOcr",
                "videoSelfieCompareBackID",
                "videoSelfieCompareBackOcr",
                "otherDocument1",
                "otherDocument2",
                "otherDocument3",
                "paymentProof",
                "consent",
                "annotationImg",
                "externalScreen",
                "eSignDocument",
                "sessionExport",
                "zoomedFrontId",
                "zoomedBackId",
                "zoomedSelfie",
                "regionBasedTemplate",
                "renaperCropped",
                "voiceConsentSelfie",
                "v5cLogbook",
                "v5cMultiPageLogbook",
                "carInvoice",
                "circulationCard",
                "financeSettlement",
                "w8Ben",
                "w8BenE",
                "faceRecordingFrame",
                "signatureImageID",
                "ghostSignatureImageID",
                "ghostPortraitImageID",
                "fingerprintImageID",
                "documentNumberCropImageID",
                "ineMexScan",
                "originalNfcFace"
              ]
            }
          }
        },
        "required": [
          "images"
        ]
      },
      "ExecutiveEventFilter": {
        "type": "object",
        "description": "Provides filter for audit logs.",
        "properties": {
          "codes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "SESSION_DELETED",
                "IDENTITY_DELETED",
                "SESSION_FACE_ADDED",
                "IDENTITY_FACE_ADDED",
                "SESSION_MANUALLY_APPROVED",
                "SESSION_MANUALLY_REJECTED",
                "SESSION_VIEWED",
                "SESSIONS_VIEWED",
                "SESSION_PDF_DOWNLOADED",
                "LOGIN_ATTEMPT",
                "LOGOUT",
                "USER_CREATED",
                "USER_DELETED",
                "USER_UPDATED",
                "USER_API_ACCESS_BLOCKED",
                "USER_API_ACCESS_UNBLOCKED",
                "USER_SERVICE_ACCOUNT_ENABLED",
                "USER_SERVICE_ACCOUNT_DISABLED",
                "USER_IAM_MIGRATION_INITIATED",
                "CONFIGURATION_CREATE",
                "CONFIGURATION_CLONED",
                "CONFIGURATION_RESET",
                "CONFIGURATION_UPDATE",
                "FLOW_CREATE",
                "FLOW_UPDATE",
                "FLOW_DELETE",
                "FLOW_CLONE",
                "IDENTITIES_REPORT_GENERATED",
                "SESSIONS_REPORT_GENERATED",
                "AUTHENTICATIONS_REPORT_GENERATED",
                "WATCH_LISTS_REPORT_GENERATED",
                "USERS_REPORT_GENERATED",
                "DOUBLE_CHECK_RECORD_FETCHED",
                "DOUBLE_CHECK_RECORD_UPDATED",
                "DOUBLE_CHECK_FINISHED",
                "SESSION_ANTIFRAUD_RESOLVED",
                "WATCH_LISTS_ENTRY_CREATED",
                "GOVERNMENT_VERIFICATION_PROVIDERS_UPDATED",
                "GOVERNMENT_VERIFICATION_PROVIDERS_CREATED",
                "GOVERNMENT_VERIFICATION_PROVIDERS_DELETED",
                "WATCHLIST_PROVIDER_SETTINGS_CREATED",
                "WATCHLIST_PROVIDER_SETTINGS_UPDATED",
                "WATCHLIST_PROVIDER_SETTINGS_DELETED",
                "PAYMENTS_PROVIDER_SETTINGS_CREATED",
                "PAYMENTS_PROVIDER_SETTINGS_UPDATED",
                "PAYMENTS_PROVIDER_SETTINGS_DELETED",
                "PERSONAL_IDENTIFICATION_NUMBER_PROVIDERS_UPDATED",
                "PERSONAL_IDENTIFICATION_NUMBER_PROVIDERS_DELETED",
                "PERSONAL_IDENTIFICATION_NUMBER_PROVIDERS_CREATED",
                "EKYB_PROVIDERS_UPDATED",
                "EKYB_PROVIDERS_CREATED",
                "EKYB_PROVIDERS_DELETED",
                "EKYC_PROVIDERS_CREATED",
                "EKYC_PROVIDERS_UPDATED",
                "EKYC_PROVIDERS_DELETED",
                "QES_PROVIDERS_UPDATED",
                "QES_PROVIDERS_DELETED",
                "QES_PROVIDERS_CREATED",
                "GENERAL_PROVISIONING_SETTINGS_UPDATED",
                "MODULES_PROVISIONING_SETTINGS_UPDATED",
                "ORGANIZATION_IAM_MIGRATION_INITIATED",
                "SIGN_IN_URL_UPDATED",
                "WORKFLOW_CREATED",
                "WORKFLOW_IMPORTED",
                "WORKFLOW_EDITED",
                "WORKFLOW_UPDATED",
                "WORKFLOW_DELETED",
                "WORKFLOW_ACTIVATED",
                "WORKFLOW_PAUSED",
                "CONSENT_CREATED",
                "CONSENT_UPDATED",
                "CONSENT_DELETED",
                "FRAUD_REPORTED",
                "FRAUD_REPORT_REVOKED",
                "WEBHOOK_CREATED",
                "WEBHOOK_UPDATE",
                "WEBHOOK_DELETE",
                "WEBHOOK_AUTH_CONFIG_CREATE",
                "WEBHOOK_AUTH_CONFIG_UPDATE",
                "DATA_DELETION_UPDATE",
                "WATCHLIST_ENTRY_DELETED",
                "WATCHLIST_ENTRY_UPDATED",
                "WATCHLIST_LIST_VIEWED",
                "AUTHENTICATION_LIST_VIEWED",
                "IDENTITY_VIEWED",
                "SESSION_LIST_VIEWED",
                "IDENTITY_LIST_VIEWED",
                "AUDIT_LOG_REPORT_GENERATED",
                "SINGLE_SESSION_REPORT_GENERATED",
                "DATA_DELETION_DISABLE",
                "FACE_ADDED_TO_DATABASE",
                "SELFIE_ADDED_TO_IDENTITY_TEMPLATE",
                "FRAUD_RING_RENAMED",
                "FRAUD_RING_NOTE_ADDED",
                "TRUSTGRAPH_SESSION_EXCLUDED",
                "TRUSTGRAPH_SESSION_EXCLUSION_REVOKED",
                "USER_DEACTIVATED",
                "USER_ACTIVATED",
                "ROLE_CREATED",
                "ROLE_UPDATED",
                "ROLE_DELETED",
                "ROLE_ASSIGNED",
                "ROLE_UNASSIGNED",
                "GROUP_ROLE_MAPPING_UPDATED",
                "ROLE_SOURCE_UPDATED",
                "SSO_CONFIGURED",
                "SSO_UPDATED",
                "SSO_REMOVED",
                "SCIM_ENABLED",
                "SCIM_SECRET_ROTATED",
                "SCIM_DISABLED",
                "MFA_SETTINGS_UPDATED",
                "PASSWORD_POLICY_UPDATED",
                "LOGIN_FAILED",
                "ACCOUNT_LOCKED",
                "USER_INVITATION_ACCEPTED",
                "PASSWORD_CHANGED",
                "PASSWORD_RESET_REQUESTED",
                "PASSWORD_RESET_COMPLETED",
                "MFA_METHOD_ENROLLED",
                "MFA_METHOD_REMOVED"
              ]
            },
            "uniqueItems": true
          },
          "before": {
            "type": "string",
            "format": "date-time"
          },
          "after": {
            "type": "string",
            "format": "date-time"
          },
          "executiveIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "entityTypes": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "SESSION",
                "IDENTITY",
                "EXECUTIVE",
                "FLOW",
                "CONFIGURATION",
                "WORKFLOW",
                "WATCHLIST",
                "PROVISIONING",
                "CONSENT",
                "DATA",
                "WEBHOOK",
                "AUDIT_LOG",
                "AUTHENTICATION",
                "USER",
                "FRAUD_RING",
                "ROLE",
                "ORGANIZATION"
              ]
            },
            "uniqueItems": true
          },
          "entityIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          },
          "applications": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "USER_SERVICE",
                "IAM_SERVICE"
              ]
            },
            "uniqueItems": true
          },
          "email": {
            "type": "string"
          },
          "ipAddress": {
            "type": "string"
          },
          "userAgent": {
            "type": "string"
          }
        }
      },
      "Pageable": {
        "type": "object",
        "properties": {
          "page": {
            "type": "integer",
            "format": "int32",
            "minimum": 0
          },
          "size": {
            "type": "integer",
            "format": "int32",
            "minimum": 1
          },
          "sort": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "ExecutiveEventDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "code": {
            "type": "string",
            "enum": [
              "SESSION_DELETED",
              "IDENTITY_DELETED",
              "SESSION_FACE_ADDED",
              "IDENTITY_FACE_ADDED",
              "SESSION_MANUALLY_APPROVED",
              "SESSION_MANUALLY_REJECTED",
              "SESSION_VIEWED",
              "SESSIONS_VIEWED",
              "SESSION_PDF_DOWNLOADED",
              "LOGIN_ATTEMPT",
              "LOGOUT",
              "USER_CREATED",
              "USER_DELETED",
              "USER_UPDATED",
              "USER_API_ACCESS_BLOCKED",
              "USER_API_ACCESS_UNBLOCKED",
              "USER_SERVICE_ACCOUNT_ENABLED",
              "USER_SERVICE_ACCOUNT_DISABLED",
              "USER_IAM_MIGRATION_INITIATED",
              "CONFIGURATION_CREATE",
              "CONFIGURATION_CLONED",
              "CONFIGURATION_RESET",
              "CONFIGURATION_UPDATE",
              "FLOW_CREATE",
              "FLOW_UPDATE",
              "FLOW_DELETE",
              "FLOW_CLONE",
              "IDENTITIES_REPORT_GENERATED",
              "SESSIONS_REPORT_GENERATED",
              "AUTHENTICATIONS_REPORT_GENERATED",
              "WATCH_LISTS_REPORT_GENERATED",
              "USERS_REPORT_GENERATED",
              "DOUBLE_CHECK_RECORD_FETCHED",
              "DOUBLE_CHECK_RECORD_UPDATED",
              "DOUBLE_CHECK_FINISHED",
              "SESSION_ANTIFRAUD_RESOLVED",
              "WATCH_LISTS_ENTRY_CREATED",
              "GOVERNMENT_VERIFICATION_PROVIDERS_UPDATED",
              "GOVERNMENT_VERIFICATION_PROVIDERS_CREATED",
              "GOVERNMENT_VERIFICATION_PROVIDERS_DELETED",
              "WATCHLIST_PROVIDER_SETTINGS_CREATED",
              "WATCHLIST_PROVIDER_SETTINGS_UPDATED",
              "WATCHLIST_PROVIDER_SETTINGS_DELETED",
              "PAYMENTS_PROVIDER_SETTINGS_CREATED",
              "PAYMENTS_PROVIDER_SETTINGS_UPDATED",
              "PAYMENTS_PROVIDER_SETTINGS_DELETED",
              "PERSONAL_IDENTIFICATION_NUMBER_PROVIDERS_UPDATED",
              "PERSONAL_IDENTIFICATION_NUMBER_PROVIDERS_DELETED",
              "PERSONAL_IDENTIFICATION_NUMBER_PROVIDERS_CREATED",
              "EKYB_PROVIDERS_UPDATED",
              "EKYB_PROVIDERS_CREATED",
              "EKYB_PROVIDERS_DELETED",
              "EKYC_PROVIDERS_CREATED",
              "EKYC_PROVIDERS_UPDATED",
              "EKYC_PROVIDERS_DELETED",
              "QES_PROVIDERS_UPDATED",
              "QES_PROVIDERS_DELETED",
              "QES_PROVIDERS_CREATED",
              "GENERAL_PROVISIONING_SETTINGS_UPDATED",
              "MODULES_PROVISIONING_SETTINGS_UPDATED",
              "ORGANIZATION_IAM_MIGRATION_INITIATED",
              "SIGN_IN_URL_UPDATED",
              "WORKFLOW_CREATED",
              "WORKFLOW_IMPORTED",
              "WORKFLOW_EDITED",
              "WORKFLOW_UPDATED",
              "WORKFLOW_DELETED",
              "WORKFLOW_ACTIVATED",
              "WORKFLOW_PAUSED",
              "CONSENT_CREATED",
              "CONSENT_UPDATED",
              "CONSENT_DELETED",
              "FRAUD_REPORTED",
              "FRAUD_REPORT_REVOKED",
              "WEBHOOK_CREATED",
              "WEBHOOK_UPDATE",
              "WEBHOOK_DELETE",
              "WEBHOOK_AUTH_CONFIG_CREATE",
              "WEBHOOK_AUTH_CONFIG_UPDATE",
              "DATA_DELETION_UPDATE",
              "WATCHLIST_ENTRY_DELETED",
              "WATCHLIST_ENTRY_UPDATED",
              "WATCHLIST_LIST_VIEWED",
              "AUTHENTICATION_LIST_VIEWED",
              "IDENTITY_VIEWED",
              "SESSION_LIST_VIEWED",
              "IDENTITY_LIST_VIEWED",
              "AUDIT_LOG_REPORT_GENERATED",
              "SINGLE_SESSION_REPORT_GENERATED",
              "DATA_DELETION_DISABLE",
              "FACE_ADDED_TO_DATABASE",
              "SELFIE_ADDED_TO_IDENTITY_TEMPLATE",
              "FRAUD_RING_RENAMED",
              "FRAUD_RING_NOTE_ADDED",
              "TRUSTGRAPH_SESSION_EXCLUDED",
              "TRUSTGRAPH_SESSION_EXCLUSION_REVOKED",
              "USER_DEACTIVATED",
              "USER_ACTIVATED",
              "ROLE_CREATED",
              "ROLE_UPDATED",
              "ROLE_DELETED",
              "ROLE_ASSIGNED",
              "ROLE_UNASSIGNED",
              "GROUP_ROLE_MAPPING_UPDATED",
              "ROLE_SOURCE_UPDATED",
              "SSO_CONFIGURED",
              "SSO_UPDATED",
              "SSO_REMOVED",
              "SCIM_ENABLED",
              "SCIM_SECRET_ROTATED",
              "SCIM_DISABLED",
              "MFA_SETTINGS_UPDATED",
              "PASSWORD_POLICY_UPDATED",
              "LOGIN_FAILED",
              "ACCOUNT_LOCKED",
              "USER_INVITATION_ACCEPTED",
              "PASSWORD_CHANGED",
              "PASSWORD_RESET_REQUESTED",
              "PASSWORD_RESET_COMPLETED",
              "MFA_METHOD_ENROLLED",
              "MFA_METHOD_REMOVED"
            ]
          },
          "timestamp": {
            "type": "string",
            "format": "date-time"
          },
          "executiveId": {
            "type": "string"
          },
          "managedEntityType": {
            "type": "string",
            "enum": [
              "SESSION",
              "IDENTITY",
              "EXECUTIVE",
              "FLOW",
              "CONFIGURATION",
              "WORKFLOW",
              "WATCHLIST",
              "PROVISIONING",
              "CONSENT",
              "DATA",
              "WEBHOOK",
              "AUDIT_LOG",
              "AUTHENTICATION",
              "USER",
              "FRAUD_RING",
              "ROLE",
              "ORGANIZATION"
            ]
          },
          "managedEntityId": {
            "type": "string"
          },
          "payload": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "apiKey": {
            "type": "string"
          },
          "role": {
            "type": "string",
            "enum": [
              "OPEN",
              "STATISTICS",
              "LIMITED",
              "INCODE_IDENTITY",
              "INCODE_ID_USER",
              "ACCESS",
              "AUTHENTICATOR",
              "REFRESH",
              "REGISTER",
              "INCODE_ID_CLIENT",
              "EXECUTIVE",
              "ADMIN",
              "SCIM_ADMIN",
              "MULTI_ORG_ADMIN",
              "INTEGRATOR",
              "INCODE_EXECUTIVE",
              "INCODE_ADMIN",
              "WIDGET_CLIENT",
              "INTERNAL_SERVICE",
              "AUTHORIZATION_SERVER",
              "KEYCLOAK_SESSION",
              "HIPAA_ADMIN",
              "HIPAA_VIEWER",
              "WORKFORCE_ADMIN",
              "WORKFORCE_HELPDESK_STAFF",
              "WORKFORCE_RECRUITER",
              "SERVER",
              "IDENTITY_SERVICE",
              "TRUST_GRAPH_DATA_LOADER"
            ]
          },
          "application": {
            "type": "string",
            "enum": [
              "USER_SERVICE",
              "IAM_SERVICE"
            ]
          },
          "ipAddress": {
            "type": "string"
          },
          "userAgent": {
            "type": "string"
          },
          "email": {
            "type": "string"
          }
        }
      },
      "ExecutiveEventResponse": {
        "type": "object",
        "properties": {
          "content": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExecutiveEventDto"
            }
          },
          "page": {
            "$ref": "#/components/schemas/Page",
            "deprecated": true
          },
          "total": {
            "type": "integer",
            "format": "int64"
          },
          "more": {
            "type": "boolean"
          }
        }
      },
      "Page": {
        "type": "object",
        "properties": {
          "size": {
            "type": "integer",
            "format": "int32"
          },
          "totalElements": {
            "type": "integer",
            "format": "int64"
          },
          "totalPages": {
            "type": "integer",
            "format": "int64"
          },
          "currentPageNumber": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "AddApiKeyRequest": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Key name.",
            "example": "key12",
            "minLength": 1
          },
          "apiKey": {
            "type": "string",
            "description": "Organization reference.",
            "example": "6efbabe21a3b44955be51d25336fb7876b68a234"
          }
        }
      },
      "ExecutiveCognitoLoginRequest": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "minLength": 1
          },
          "password": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "email",
          "password"
        ]
      },
      "ExecutiveLoginResponse": {
        "type": "object",
        "properties": {
          "token": {
            "type": "string",
            "description": "Access token for next calls",
            "example": "eyJhbGciOasfasiJ9.eyJleHRl2OTg5NX0.zdbAC-kE-I71",
            "maxLength": 2048
          }
        }
      },
      "DeleteWatchlistRequest": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Id of entry in watchlist database",
            "minLength": 1
          }
        }
      },
      "InsertWatchlistRequest": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of person that is being uploaded to Watchlist"
          },
          "birthDate": {
            "type": "string",
            "description": "Birthdate (timestamp) of person that is being uploaded to Watchlist"
          },
          "idNumber": {
            "type": "string",
            "description": "Id number of person that is being uploaded to Watchlist"
          },
          "email": {
            "type": "string",
            "description": "Email of person that is being uploaded to Watchlist"
          },
          "phone": {
            "type": "string",
            "description": "Phone of person that is being uploaded to Watchlist"
          },
          "personalIdNumber": {
            "type": "string",
            "description": "Personal Id Number of person that is being uploaded to Watchlist"
          },
          "externalId": {
            "type": "string",
            "description": "External id of person that is being uploaded to Watchlist"
          },
          "imageBase64": {
            "type": "string",
            "description": "Base64 representation of face image of person that is being uploaded to Watchlist"
          },
          "frontIdBase64": {
            "type": "string",
            "description": "Base64 representation of front side of document image that is being processed to gather OCR data and uploaded to Watchlist"
          },
          "backIdBase64": {
            "type": "string",
            "description": "Base64 representation of back side of document image that is being processed to gather OCR data and uploaded to Watchlist"
          },
          "watchlistType": {
            "type": "string",
            "description": "Defines type of Watchlist to use",
            "enum": [
              "WHITELIST",
              "BLACKLIST"
            ]
          },
          "recordExpiresAt": {
            "type": "string",
            "description": "Date (timestamp) until the watchlist entry is active. When searched after this date, score of watchlist match will be 0."
          }
        }
      },
      "AddSingleWatchlistResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "customerId": {
            "type": "string"
          },
          "watchlistId": {
            "type": "string"
          }
        }
      },
      "AddPhoneResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "existingCustomer": {
            "type": "boolean",
            "description": "Flag indicating if this user with given phone already exists in the system."
          }
        }
      },
      "SendExternalSmsRequest": {
        "type": "object",
        "properties": {
          "smsText": {
            "type": "string",
            "description": "Text to be shown with URL. Needs to have {0} placeholder inside for URL.",
            "example": "Here is the link to finish onboarding {0}",
            "maxLength": 160,
            "minLength": 0
          },
          "clientId": {
            "type": "string",
            "example": "incode",
            "minLength": 1
          },
          "shortUrl": {
            "type": "boolean",
            "description": "Indicates whether the link should be shortened. If set to true, the link will be converted to a shortened version."
          },
          "queryParams": {
            "$ref": "#/components/schemas/SendSmsExternalUrlParams",
            "description": "Additional onboarding url query params allowed: lang"
          },
          "uuid": {
            "type": "string",
            "description": "Optional UUID to be reused for linking the onboarding session. If not provided or invalid, a new one will be generated."
          }
        },
        "required": [
          "clientId"
        ]
      },
      "SendSmsExternalUrlParams": {
        "type": "object",
        "properties": {
          "lang": {
            "type": "string",
            "example": "lang",
            "minLength": 1
          }
        }
      },
      "PhoneRequest": {
        "type": "object",
        "properties": {
          "phone": {
            "type": "string",
            "description": "User's phone number. E.164 number convention.",
            "example": "+1111111"
          },
          "optInGranted": {
            "type": "boolean",
            "default": "false",
            "description": "Indicates whether opt-in is granted"
          }
        }
      },
      "FrameAnalysisRequest": {
        "type": "object",
        "properties": {
          "base64Image": {
            "type": "string",
            "description": "Base64 representation of image.",
            "example": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEB...",
            "minLength": 1
          },
          "videoRef": {
            "type": "string",
            "description": "Reference of video from which frame is extracted."
          },
          "frameRef": {
            "type": "string",
            "description": "Reference of frame that should be analyzed."
          }
        },
        "required": [
          "base64Image"
        ]
      },
      "AnalyzedIdentityDto": {
        "type": "object",
        "properties": {
          "identityId": {
            "type": "string",
            "description": "Id of recognized customer."
          },
          "estimatedAge": {
            "type": "integer",
            "format": "int32",
            "description": "Estimated age based on extracted face."
          },
          "error": {
            "$ref": "#/components/schemas/FrameAnalysisErrorDto",
            "description": "Error name.\nPossible error names are:\n    LENSES_DETECTED,\n    FACE_MASK_DETECTED,\n    HEAD_COVER_DETECTED,\n    CLOSED_EYES_DETECTED,\n    SPOOF_ATTEMPT_DETECTED,\n    USER_IS_NOT_RECOGNIZED\n",
            "example": "{\n    \"name\": \"LENSES_DETECTED\",\n}\n"
          }
        }
      },
      "FrameAnalysisErrorDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          }
        }
      },
      "FrameAnalysisResponse": {
        "type": "object",
        "properties": {
          "identities": {
            "type": "array",
            "description": "List of identities analyzed from input base64image.",
            "items": {
              "$ref": "#/components/schemas/AnalyzedIdentityDto"
            }
          },
          "videoRef": {
            "type": "string",
            "description": "Reference of video from which frame is extracted."
          },
          "frameRef": {
            "type": "string",
            "description": "Reference of frame that is analyzed."
          },
          "error": {
            "$ref": "#/components/schemas/FrameAnalysisErrorDto",
            "description": "Error name.\nPossible error name is:\n    FACE_EXTRACTION_FAILED\n",
            "example": "{\n    \"name\": \"FACE_EXTRACTION_FAILED\",\n}\n"
          }
        }
      },
      "SessionContinueRequestDto": {
        "type": "object",
        "properties": {
          "sessionId": {
            "type": "string",
            "description": "Id of the session to continue. Exactly one of sessionId or externalId must be provided."
          },
          "externalId": {
            "type": "string",
            "description": "Id that identifies the user in the client's system; matches the externalId supplied on /omni/start. Exactly one of sessionId or externalId must be provided.",
            "example": "client34598"
          }
        }
      },
      "SessionContinueResponse": {
        "type": "object",
        "properties": {
          "sessionId": {
            "type": "string",
            "description": "Identifies the onboarding session that is continued. Can be used for fetching data about that session in future calls.",
            "maxLength": 24,
            "minLength": 24
          },
          "token": {
            "type": "string",
            "description": "Internal JWT token used for the future subsequent calls. It is the value for X-Incode-Hardware-Id header in all other calls.",
            "maxLength": 2048
          },
          "interviewCode": {
            "type": "string",
            "description": "This value is used for connecting to conference call.",
            "maxLength": 6,
            "minLength": 6
          },
          "flowType": {
            "type": "string",
            "description": "Type of the flow used. Could be flow (in most cases), or legacy type configuration (not used anymore).",
            "enum": [
              "configuration",
              "flow",
              "workflow"
            ]
          },
          "idCaptureTimeout": {
            "type": "integer",
            "format": "int32",
            "description": "Number of seconds after which manual capture button should be shown to the user, while capturing ID when ID is detected."
          },
          "idDetectionTimeout": {
            "type": "integer",
            "format": "int32",
            "description": "Number of seconds after which manual capture button should be shown to the user, if ID is not detected."
          },
          "selfieCaptureTimeout": {
            "type": "integer",
            "format": "int32",
            "description": "Number of seconds after which manual capture button should be shown to the user, while capturing selfie."
          },
          "idCaptureRetries": {
            "type": "integer",
            "format": "int32",
            "description": "Number of ID captures after which user should be taken to next screen."
          },
          "selfieCaptureRetries": {
            "type": "integer",
            "format": "int32",
            "description": "Number of selfie captures after which user should be taken to next screen."
          },
          "curpValidationRetries": {
            "type": "integer",
            "format": "int32",
            "description": "Number of curp validations after which user should be taken to next screen. (only for Mexico)"
          }
        }
      },
      "AddSelfieToIdentityRequestDto": {
        "type": "object",
        "properties": {
          "sessionId": {
            "type": "string",
            "minLength": 1
          },
          "attemptId": {
            "type": "string"
          }
        }
      },
      "NewOnboardingB2BRequest": {
        "type": "object",
        "properties": {
          "integrationReference": {
            "type": "string",
            "description": "Integration reference for the onboarding request."
          },
          "loginHint": {
            "type": "string",
            "description": "User login hint.",
            "minLength": 1
          },
          "applicantId": {
            "type": "string",
            "description": "Existing applicant id."
          },
          "externalCustomerId": {
            "type": "string",
            "description": "Id that identifies user in clients external system.",
            "example": "client123"
          },
          "name": {
            "type": "string",
            "description": "Applicant name."
          },
          "meetingLink": {
            "type": "string",
            "description": "Meeting link."
          },
          "linkValidityInMinutes": {
            "type": "integer",
            "format": "int32",
            "description": "Link validity in minutes."
          },
          "notification": {
            "$ref": "#/components/schemas/NotificationDelivery",
            "description": "Notification configuration"
          }
        },
        "required": [
          "integrationReference",
          "notification"
        ]
      },
      "AuthenticationAttemptExternalDto": {
        "type": "object",
        "properties": {
          "customerId": {
            "type": "string"
          },
          "deviceType": {
            "type": "string",
            "enum": [
              "IOS",
              "ANDROID",
              "WEBAPP"
            ]
          },
          "deviceName": {
            "type": "string"
          },
          "version": {
            "type": "string"
          },
          "isSpoof": {
            "type": "boolean"
          },
          "get_updatedAt": {
            "type": "integer",
            "format": "int64"
          },
          "url": {
            "type": "string"
          },
          "isAuthenticated": {
            "type": "boolean"
          },
          "recognitionConfidence": {
            "type": "number",
            "format": "float"
          },
          "source": {
            "type": "string"
          },
          "transactionId": {
            "type": "string"
          },
          "authenticationType": {
            "type": "string",
            "enum": [
              "ONE_TO_ONE",
              "ONE_TO_N"
            ]
          },
          "authenticationMethod": {
            "type": "string",
            "enum": [
              "server",
              "local",
              "hybrid"
            ]
          },
          "faceEnrollmentForced": {
            "type": "boolean"
          },
          "isBlocklisted": {
            "type": "boolean"
          },
          "clientRecognitionThreshold": {
            "type": "number",
            "format": "float"
          },
          "clientLivenessThreshold": {
            "type": "number",
            "format": "float"
          },
          "blocklistConfidence": {
            "type": "number",
            "format": "float"
          },
          "videoRecordingUrl": {
            "type": "string"
          }
        }
      },
      "CustomerAuthenticationsExternalResponse": {
        "type": "object",
        "properties": {
          "authenticationAttempts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AuthenticationAttemptExternalDto"
            }
          },
          "total": {
            "type": "integer",
            "format": "int32"
          },
          "more": {
            "type": "boolean"
          }
        }
      },
      "WatchlistRequest": {
        "type": "object",
        "properties": {
          "firstName": {
            "type": "string"
          },
          "surName": {
            "type": "string"
          },
          "birthYear": {
            "type": "integer",
            "format": "int32",
            "description": "Year of birth, if known"
          },
          "countryCodes": {
            "type": "array",
            "items": {
              "description": "Array of ISO 3166-1 alpha-2 strings. List Results are filtered by the entity nationality or country of residence.\n- Country code filtering applies to:\n    - Entity of type PEP only\n    - Entity of type PEP with Adverse Media\n    - Entity that has 1 country value or more (only one has to match)\n- Country code filtering does not apply to (i.e. results will still appear regardless of the country filter):\n    - Entity on sanction lists will always appear regardless of other status (PEP, Adverse media)\n    - Entity that has adverse media mentions only\n    - Entity that does not have a country assigned\n"
            }
          },
          "watchlistTypes": {
            "type": "array",
            "items": {
              "description": "- One or more of:\n    sanction\n    warning\n    fitness-probity\n    pep\n    pep-class-1\n    pep-class-2\n    pep-class-3\n    pep-class-4\n- If you use classic Adverse Media Taxonomy:\n    adverse-media\n    adverse-media-financial-crime\n    adverse-media-violent-crime\n    adverse-media-sexual-crime\n    adverse-media-terrorism\n    adverse-media-fraud\n    adverse-media-narcotics\n    adverse-media-general\n- If you use FATF-aligned Adverse Media Taxonomy:\n    adverse-media-v2-property\n    adverse-media-v2-financial-aml-cft\n    adverse-media-v2-fraud-linked\n    adverse-media-v2-narcotics-aml-cft\n    adverse-media-v2-violence-aml-cft\n    adverse-media-v2-terrorism\n    adverse-media-v2-cybercrime\n    adverse-media-v2-general-aml-cft\n    adverse-media-v2-regulatory\n    adverse-media-v2-financial-difficulty\n    adverse-media-v2-violence-non-aml-cft\n    adverse-media-v2-other-financial\n    adverse-media-v2-other-serious\n    adverse-media-v2-other-minor\n"
            }
          },
          "subscribe": {
            "type": "boolean",
            "description": "Subscribes to updates on the watchlists to receive notification for updates on the search."
          },
          "fuzziness": {
            "type": "number",
            "format": "float",
            "description": "Determines how closely the returned results must match the supplied name."
          },
          "search_profile": {
            "type": "string",
            "description": "Search profile set for the client to use specify what sources they will be searching against."
          }
        }
      },
      "WatchlistSearchResultResponse": {
        "type": "object"
      },
      "VinRequest": {
        "type": "object",
        "properties": {
          "vin": {
            "type": "string",
            "description": "Vehicle Identification Number",
            "minLength": 1
          },
          "getPdf": {
            "type": "boolean",
            "default": "false",
            "description": "Obtains pdf with details in base64 format."
          }
        }
      },
      "ValidateSsnRequest": {
        "type": "object",
        "properties": {
          "ssn": {
            "type": "string",
            "description": "Person's social security number",
            "minLength": 1
          },
          "dateOfBirth": {
            "type": "string",
            "format": "YYYY-MM-DD",
            "description": "Person's birthdate",
            "example": "1976-11-21",
            "minLength": 1
          },
          "firstName": {
            "type": "string",
            "description": "Person's first name",
            "minLength": 1
          },
          "lastName": {
            "type": "string",
            "description": "Person's last name",
            "minLength": 1
          },
          "middleName": {
            "type": "string",
            "description": "Person's middle name"
          },
          "email": {
            "type": "string",
            "description": "Person's email"
          }
        }
      },
      "RFCRequest": {
        "type": "object",
        "properties": {
          "rfc": {
            "type": "string",
            "minLength": 1
          }
        }
      },
      "CurpRequest": {
        "type": "object",
        "properties": {
          "curp": {
            "type": "string",
            "minLength": 1
          },
          "externalId": {
            "type": "string",
            "example": "bdac7bdd-9339-4f85-9b32-bc90d553ddc6"
          }
        }
      },
      "RegistraduriaRequest": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "emissionDate": {
            "type": "string",
            "format": "dd/mm/yyyy",
            "description": "mandatory if isForeign is true, otherwise optional",
            "example": "30/10/2020"
          },
          "fullName": {
            "type": "string"
          },
          "isForeign": {
            "type": "boolean"
          },
          "nameBean": {
            "$ref": "#/components/schemas/NameBean"
          }
        }
      },
      "IneScraperRequest": {
        "type": "object",
        "properties": {
          "ocr": {
            "type": "string"
          },
          "identificadorCiudadano": {
            "type": "string"
          },
          "cic": {
            "type": "string",
            "description": "Mandatory for model D,E,F,G,H"
          },
          "claveElector": {
            "type": "string",
            "description": "Mandatory for model C"
          },
          "numeroEmision": {
            "type": "string",
            "description": "Mandatory for model C, should have a length of 2: ex 02"
          }
        },
        "required": [
          "ocr"
        ]
      },
      "CurpDataRequest": {
        "type": "object",
        "properties": {
          "curp": {
            "type": "string",
            "description": "User's curp. Has to be in valid format. If it isn't present, then curp value from interview is used.",
            "example": "COHJ950918HCMVRS09"
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "firstLastName": {
            "type": "string",
            "minLength": 1
          },
          "secondLastName": {
            "type": "string"
          },
          "gender": {
            "type": "string",
            "description": "Valid gender values are \"H\" (Hombre, male), \"M\" (mujer, female) and \"X\" (otro, other)",
            "enum": [
              "H",
              "M",
              "X"
            ],
            "minLength": 1
          },
          "birthDate": {
            "type": "string",
            "format": "dd/mm/yyyy",
            "example": "07/06/1995",
            "minLength": 1
          },
          "state": {
            "type": "string",
            "example": "CM",
            "minLength": 1
          },
          "externalId": {
            "type": "string",
            "example": "bdac7bdd-9339-4f85-9b32-bc90d553ddc6"
          }
        }
      },
      "Base64AccountStatementMxRequest": {
        "type": "object",
        "properties": {
          "base64File": {
            "type": "string",
            "description": "Base64 string representation of the bank statement pdf.",
            "minLength": 1
          }
        },
        "required": [
          "base64File"
        ]
      },
      "CalculateRFCRequest": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 80,
            "minLength": 2
          },
          "firstLastName": {
            "type": "string",
            "maxLength": 40,
            "minLength": 2
          },
          "secondLastName": {
            "type": "string"
          },
          "birthDate": {
            "type": "string",
            "format": "dd/mm/yyyy",
            "minLength": 1
          }
        },
        "required": [
          "birthDate",
          "firstLastName",
          "name",
          "secondLastName"
        ]
      },
      "RFCResponse": {
        "type": "object",
        "properties": {
          "calculatedRFC": {
            "type": "string"
          }
        }
      },
      "VideoSelfieHashResponse": {
        "type": "object",
        "properties": {
          "hash": {
            "type": "string"
          },
          "hashimage": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      },
      "UploadVideoPartResponse": {
        "type": "object",
        "properties": {
          "partNumber": {
            "type": "integer",
            "format": "int32"
          },
          "eTag": {
            "type": "string"
          }
        }
      },
      "InitiateVideoUploadResponse": {
        "type": "object",
        "properties": {
          "uploadId": {
            "type": "string"
          }
        }
      },
      "CompleteVideoUploadRequest": {
        "type": "object",
        "properties": {
          "uploadId": {
            "type": "string"
          },
          "parts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PartInfo"
            },
            "minItems": 1
          }
        },
        "required": [
          "uploadId"
        ]
      },
      "PartInfo": {
        "type": "object",
        "properties": {
          "partNumber": {
            "type": "integer",
            "format": "int32"
          },
          "eTag": {
            "type": "string"
          }
        },
        "required": [
          "eTag",
          "partNumber"
        ]
      },
      "VideoUploadStatusResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string"
          }
        }
      },
      "MatchRequest": {
        "type": "object",
        "properties": {
          "base64Image": {
            "type": "string",
            "description": "Base64 string representation of the image.",
            "example": "/9j/4AAQSkZJRgABAQABLn0kvWaa6Dxv7Kk9Z89nveU+mjuQKB29EWOavLyBDr7nL...",
            "minLength": 1
          },
          "interviewId": {
            "type": "string",
            "description": "5c10c728c7a29d001536ad13"
          },
          "compareWith": {
            "type": "string",
            "enum": [
              "selfie",
              "videoSelfie",
              "id",
              "nfc"
            ]
          }
        },
        "required": [
          "compareWith"
        ]
      },
      "WebappRecognizeResponse": {
        "type": "object",
        "properties": {
          "confidence": {
            "type": "number",
            "format": "float",
            "description": "Confidence value of comparing. Number between 0 and 1.",
            "maximum": 1,
            "minimum": 0
          }
        }
      },
      "QuestionAndAnswerWithId": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID of the given Question-Answer pair."
          },
          "question": {
            "type": "string",
            "description": "Random question to be shown in video selfie."
          },
          "answer": {
            "type": "string",
            "description": "Corresponding answer to the question."
          }
        }
      },
      "ReasonCategoryConfig": {
        "type": "object",
        "properties": {
          "reasonCategoryConfigStatus": {
            "type": "string",
            "enum": [
              "ENABLED",
              "DISABLED",
              "NOT_CONFIGURED"
            ]
          }
        }
      },
      "SnaInitiateRequest": {
        "type": "object",
        "properties": {
          "phoneNumber": {
            "type": "string",
            "description": "Phone number to verify, in international format (e.g. `+5215512345678`). When present it takes precedence over any phone number already known for the session. When absent the session phone is used, see the endpoint description.",
            "example": "+5215512345678"
          }
        }
      },
      "SnaInitiateResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "`true` when an SNA check was started and `checkUrl` must be opened on the device."
          },
          "method": {
            "type": "string",
            "description": "Always `SNA`, also when SNA could not be used; read `fallbackReason` to detect the fall back to SMS OTP. Absent when the request failed with `INITIATION_ERROR`.",
            "enum": [
              "SNA"
            ]
          },
          "checkId": {
            "type": "string",
            "description": "Identifier of the SNA check. Send it to `POST /omni/sna/complete` and `GET /omni/sna/status/{checkId}`. Absent when `success` is `false`."
          },
          "checkUrl": {
            "type": "string",
            "description": "URL the device must open over its mobile data connection to prove it owns the number. Absent when `success` is `false`."
          },
          "status": {
            "type": "string",
            "description": "Provider status of the check right after creation. Absent when `success` is `false`.",
            "enum": [
              "ACCEPTED",
              "PENDING"
            ]
          },
          "message": {
            "type": "string",
            "description": "Human readable outcome, for logging. Not meant to be shown to the end user."
          },
          "requiresUserAction": {
            "type": "boolean",
            "description": "Reserved. Currently always `false`; decide on `success` and `checkUrl` instead."
          },
          "fallbackReason": {
            "type": "string",
            "description": "Present, with `success: false`, when SNA could not be used for this number and the client must continue with SMS OTP. Examples: `SNA disabled in organization settings`, `SNA disabled in phone configuration`, `SNA not supported for this network`, `SIM recently swapped - security measure`, `PhoneCheck initiation failed`."
          },
          "phoneNumber": {
            "type": "string",
            "description": "Phone number that was resolved and stored on the session, in international format. Absent when the request failed with `errorCode`."
          },
          "phoneSource": {
            "type": "string",
            "description": "Where `phoneNumber` came from. `USER_INPUT` when it was sent in the request body; otherwise the session source that provided it. Absent when the request failed with `errorCode`.",
            "enum": [
              "USER_INPUT",
              "SESSION_PHONE",
              "CUSTOM_FIELD",
              "FORM_ANSWER",
              "LOGIN_HINT"
            ]
          },
          "errorCode": {
            "type": "string",
            "description": "Present, with `success: false`, when the request itself failed. `PHONE_REQUIRED`: no phone in the body and none could be resolved from the session, show the phone capture screen. `INVALID_PHONE`: the phone number could not be parsed. `INTERVIEW_NOT_FOUND`: the session token does not match an existing session. `INITIATION_ERROR`: unexpected server error, retry or fall back to SMS OTP.",
            "enum": [
              "PHONE_REQUIRED",
              "INVALID_PHONE",
              "INTERVIEW_NOT_FOUND",
              "INITIATION_ERROR"
            ]
          }
        }
      },
      "SnaCompleteRequest": {
        "type": "object",
        "properties": {
          "checkId": {
            "type": "string",
            "description": "`checkId` returned by `POST /omni/sna/initiate`."
          },
          "code": {
            "type": "string",
            "description": "Code returned to the device by the redirect at the end of `checkUrl`."
          }
        },
        "required": [
          "checkId",
          "code"
        ]
      },
      "SnaCompleteResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "`true` when the provider confirmed the device owns the phone number."
          },
          "method": {
            "type": "string",
            "description": "Verification method, always `SNA` for this endpoint.",
            "enum": [
              "SNA"
            ]
          },
          "checkId": {
            "type": "string",
            "description": "Identifier of the SNA check, echoed from the request."
          },
          "status": {
            "type": "string",
            "description": "Provider status of the check as returned by the provider, normally `COMPLETED`. `ERROR` when the check could not be completed; `PENDING` or `EXPIRED` when the device never finished `checkUrl`, in which case `match` is `false` and the client must fall back to SMS OTP.",
            "enum": [
              "ACCEPTED",
              "PENDING",
              "COMPLETED",
              "EXPIRED",
              "ERROR"
            ]
          },
          "match": {
            "type": "boolean",
            "description": "`true` when the device matched the phone number, `false` when it did not. `null` when the provider reported an error before producing a result."
          },
          "complete": {
            "type": "boolean",
            "description": "`true` when the check reached a final state and must not be completed again."
          },
          "shouldFallbackToOtp": {
            "type": "boolean",
            "description": "`true` whenever `success` is `false`: the client must verify the number with SMS OTP (or let the user enter another number when the flow has `snaRetryWithNewPhone` enabled)."
          },
          "message": {
            "type": "string",
            "description": "Human readable outcome, for logging. Not meant to be shown to the end user."
          },
          "errorCode": {
            "type": "string",
            "description": "Present when `success` is `false`. `NO_MATCH`: the device does not own the number. `VERIFICATION_ERROR`: the check could not be completed. Any other value is the provider's own error code."
          }
        }
      },
      "SignNom151StringRequest": {
        "type": "object",
        "properties": {
          "stringToSign": {
            "type": "string",
            "description": "String to be signed with NOM151",
            "minLength": 1
          }
        }
      },
      "SignNom151HashRequest": {
        "type": "object",
        "properties": {
          "hashToSign": {
            "type": "string",
            "description": "Hash to be signed with NOM151",
            "minLength": 1,
            "pattern": "^[0-9a-fA-F]{64}$"
          }
        }
      },
      "SignNom151DocumentRequest": {
        "type": "object",
        "properties": {
          "documentToSign": {
            "type": "string",
            "description": "Base64-encoded document to be signed with NOM151",
            "minLength": 1
          }
        }
      },
      "SignCombinedConsentRequest": {
        "type": "object",
        "properties": {
          "languageConsentId": {
            "type": "string"
          },
          "checkboxes": {
            "type": "object",
            "additionalProperties": {
              "type": "boolean"
            }
          }
        }
      },
      "SessionDownloadRequest": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "minLength": 1
          }
        }
      },
      "GetStatusResponse": {
        "type": "object",
        "properties": {
          "get_id": {
            "type": "string",
            "description": "Session id."
          },
          "get_createdAt": {
            "type": "integer",
            "format": "int64",
            "description": "Timestamp, when was the session created"
          },
          "get_updatedAt": {
            "type": "integer",
            "format": "int64",
            "description": "Timestamp, when was the session last updated."
          },
          "closedAt": {
            "type": "integer",
            "format": "int64",
            "description": "Timestamp, when was the session last closed."
          },
          "frontIdAttempts": {
            "type": "integer",
            "format": "int32",
            "description": "Attempts to save front id."
          },
          "backIdAttempts": {
            "type": "integer",
            "format": "int32",
            "description": "Attempts to save back id."
          },
          "selfieAttempts": {
            "type": "integer",
            "format": "int32",
            "description": "Attempts to save selfie."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          }
        }
      },
      "ImportSessionRecordingResponse": {
        "type": "object",
        "properties": {
          "recordingId": {
            "type": "string"
          }
        }
      },
      "StoreVideoRequest": {
        "type": "object",
        "properties": {
          "video": {
            "type": "string",
            "description": "Video of capture attempt, represented in base64.",
            "minLength": 1
          },
          "type": {
            "type": "string",
            "description": "Type of recording that should be stored. Possible values: selfie, frontId, backId.",
            "enum": [
              "frontId",
              "backId",
              "merged",
              "selfie",
              "authenticationattempt",
              "videoselfie"
            ]
          }
        },
        "required": [
          "video"
        ]
      },
      "InterviewStopRecordRequest": {
        "type": "object",
        "properties": {
          "opentokArchiveId": {
            "type": "string",
            "description": "ID of OpenTok archive for which recording stop is requested. In case omitted, last created archive on given interview will be stopped."
          }
        }
      },
      "InterviewStartRecordRequest": {
        "type": "object",
        "properties": {
          "interviewId": {
            "type": "string",
            "description": "ID of interview for which recording is started."
          }
        }
      },
      "InterviewStartRecordResponse": {
        "type": "object",
        "properties": {
          "opentokArchiveId": {
            "type": "string",
            "description": "ID of created OpenTok archive."
          }
        }
      },
      "QrValidationRequest": {
        "type": "object",
        "properties": {
          "urlUuid": {
            "type": "string",
            "minLength": 1
          },
          "onboardingId": {
            "type": "string",
            "minLength": 1
          }
        }
      },
      "QrRefreshResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "urlUuid": {
            "type": "string",
            "description": "Short-lived uuid for validation"
          }
        }
      },
      "QrRefreshRequest": {
        "type": "object",
        "properties": {
          "onboardingId": {
            "type": "string",
            "minLength": 1
          }
        }
      },
      "ProcessWatchlistResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "match": {
            "type": "boolean",
            "description": "Flag indicating if a match in the watchlist has been found."
          }
        }
      },
      "ProcessIdResponseDto": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "isDocumentExpired": {
            "type": "boolean",
            "description": "Flag indicating if the document is expired."
          }
        }
      },
      "ProcessPaymentProofResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "requestId": {
            "type": "string",
            "description": "Id associated with request"
          }
        }
      },
      "ProcessImssRequest": {
        "type": "object",
        "properties": {
          "curp": {
            "type": "string",
            "description": "If not specified it will use one from interview"
          }
        }
      },
      "Fingerprint": {
        "type": "object",
        "properties": {
          "index": {
            "type": "integer",
            "format": "int32",
            "maximum": 10
          },
          "base64Fingerprint": {
            "type": "string",
            "minLength": 1
          },
          "fingerprintMetadata": {
            "$ref": "#/components/schemas/FingerprintMetadata"
          }
        }
      },
      "FingerprintMetadata": {
        "type": "object",
        "properties": {
          "device": {
            "type": "string"
          },
          "resolution": {
            "type": "string"
          },
          "qualityScore": {
            "type": "string"
          }
        }
      },
      "FingerprintsData": {
        "type": "object",
        "properties": {
          "type": {
            "type": "integer",
            "format": "int32"
          },
          "fingerprints": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Fingerprint"
            }
          }
        },
        "required": [
          "fingerprints"
        ]
      },
      "GovernmentValidationDataRequest": {
        "type": "object",
        "properties": {
          "ocr": {
            "type": "string"
          },
          "cic": {
            "type": "string"
          },
          "nombre": {
            "type": "string"
          },
          "apellidoPaterno": {
            "type": "string"
          },
          "apellidoMaterno": {
            "type": "string"
          },
          "anioRegistro": {
            "type": "string"
          },
          "anioEmision": {
            "type": "string"
          },
          "numeroEmisionCredencial": {
            "type": "string"
          },
          "claveElector": {
            "type": "string"
          },
          "curp": {
            "type": "string"
          },
          "base64Image": {
            "type": "string"
          },
          "idNumber": {
            "type": "string"
          },
          "fechaEmision": {
            "type": "string"
          },
          "personalNumber": {
            "type": "string"
          },
          "birthDate": {
            "type": "string"
          },
          "gender": {
            "type": "string"
          },
          "birthPlace": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "addressLine2": {
            "type": "string"
          },
          "addressState": {
            "type": "string"
          },
          "latitude": {
            "type": "string"
          },
          "longitude": {
            "type": "string"
          },
          "macAddress": {
            "type": "string"
          },
          "ip": {
            "type": "string"
          },
          "osVersion": {
            "type": "string"
          },
          "applicationName": {
            "type": "string"
          },
          "sufix": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "givenName": {
            "type": "string"
          },
          "middleName": {
            "type": "string"
          },
          "maternalLastName": {
            "type": "string"
          },
          "paternalLastName": {
            "type": "string"
          },
          "documentType": {
            "type": "string",
            "enum": [
              "Unknown",
              "Passport",
              "Visa",
              "DriversLicense",
              "IdentificationCard",
              "Permit",
              "Currency",
              "ResidenceDocument",
              "TravelDocument",
              "BirthCertificate",
              "VehicleRegistration",
              "Other",
              "WeaponLicense",
              "TribalIdentification",
              "VoterIdentification",
              "Military",
              "TaxIdentification",
              "FederalID",
              "MedicalCard"
            ]
          },
          "refNumber": {
            "type": "string"
          },
          "issuerState": {
            "type": "string"
          },
          "aamvaMessageDestination": {
            "type": "string"
          },
          "realIdConformantCode": {
            "type": "string"
          },
          "driverLicenseNonCommercialStatusCode": {
            "type": "string"
          },
          "documentTypeId": {
            "type": "integer",
            "format": "int32"
          },
          "issuedAt": {
            "type": "string"
          },
          "documentNumber": {
            "type": "string"
          },
          "expireAt": {
            "type": "string"
          },
          "eyeColor": {
            "type": "string"
          },
          "height": {
            "type": "string"
          },
          "weight": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "postalCode": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "fullName": {
            "type": "string"
          },
          "nationality": {
            "type": "string"
          },
          "dateFormat": {
            "type": "string"
          },
          "fingerprintsData": {
            "$ref": "#/components/schemas/FingerprintsData"
          }
        }
      },
      "AdditionalDocumentAttemptDto": {
        "type": "object",
        "description": "Base definition for additional document attempts. This definition is used to represent the attempt to submit an additional document during the onboarding process. It includes common fields such as document type, status, attempt timestamp, and a list of image URLs.",
        "discriminator": {
          "propertyName": "documentType",
          "mapping": {
            "ASYLUM_SEEKER": "#/components/schemas/AsylumSeekerDocumentAttemptDto",
            "BANK_STATEMENT": "#/components/schemas/BankStatementDocumentAttemptDto",
            "COLOMBIAN_BIRTH_CERTIFICATE": "#/components/schemas/ColombianBirthCertificateDocumentAttemptDto",
            "CURP": "#/components/schemas/CurpDocumentAttemptDto",
            "GENERIC": "#/components/schemas/GenericDocumentAttemptDto",
            "MEXICAN_TAX_DECLARATION": "#/components/schemas/MexicanTaxDeclarationDocumentAttemptDto",
            "MEXICAN_TAX_STATUS": "#/components/schemas/MexicanTaxStatusDocumentAttemptDto",
            "REFUGEE_ID": "#/components/schemas/RefugeeIdDocumentAttemptDto",
            "REFUGEE_STATUS": "#/components/schemas/RefugeeStatusDocumentAttemptDto",
            "POA": "#/components/schemas/PoaDocumentAttemptDto",
            "RFC": "#/components/schemas/RfcDocumentAttemptDto",
            "V5C_LOGBOOK": "#/components/schemas/V5CLogbookAttemptDto",
            "CAR_INVOICE": "#/components/schemas/CarInvoiceAttemptDto",
            "CIRCULATION_CARD": "#/components/schemas/CirculationCardAttemptDto",
            "INE_MEX": "#/components/schemas/IneMexDocumentAttemptDto",
            "BANK_CHECK": "#/components/schemas/BankCheckDocumentAttemptDto",
            "LETTER_OF_AUTHORIZATION": "#/components/schemas/LetterOfAuthorizationDocumentAttemptDto",
            "FINANCE_SETTLEMENT": "#/components/schemas/FinanceSettlementDocumentAttemptDto",
            "COLOMBIA_RUT_FORM": "#/components/schemas/ColombiaRutFormDocumentAttemptDto",
            "W8_BEN": "#/components/schemas/W8BenDocumentAttemptDto",
            "W8_BEN_E": "#/components/schemas/W8BenEDocumentAttemptDto",
            "UNKNOWN": "#/components/schemas/UnknownDocumentAttemptDto"
          }
        },
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "SUCCESS",
              "VALIDATION_ERROR",
              "FAIL"
            ]
          },
          "attemptTimestamp": {
            "type": "integer",
            "format": "int64"
          },
          "imagesUrl": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "attemptType": {
            "type": "string",
            "enum": [
              "POA",
              "DOCUMENT_CAPTURE"
            ]
          },
          "antiSpoofResult": {
            "$ref": "#/components/schemas/PoaAntiSpoofResult"
          },
          "documentType": {
            "type": "string"
          }
        },
        "required": [
          "documentType"
        ]
      },
      "AsylumSeekerDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "firstName": {
                "type": "string"
              },
              "lastName": {
                "type": "string"
              },
              "countryOfOrigin": {
                "type": "string"
              },
              "dateOfBirth": {
                "type": "integer",
                "format": "int64"
              },
              "expiryDate": {
                "type": "integer",
                "format": "int64"
              },
              "issueDate": {
                "type": "integer",
                "format": "int64"
              },
              "gender": {
                "type": "string",
                "enum": [
                  "MALE",
                  "FEMALE"
                ]
              },
              "nationality": {
                "type": "string"
              },
              "placeOfIssue": {
                "type": "string"
              },
              "referenceNumber": {
                "type": "string"
              },
              "residentialAddressLines": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        ]
      },
      "BankCheckDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "accountNumber": {
                "type": "string"
              },
              "routingNumber": {
                "type": "string"
              },
              "unparsedCheckNumber": {
                "type": "string"
              }
            }
          }
        ]
      },
      "BankStatementDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "fullName": {
                "type": "string"
              },
              "address": {
                "type": "string"
              },
              "accountNumber": {
                "type": "string"
              },
              "bankName": {
                "type": "string"
              },
              "documentDate": {
                "type": "string"
              }
            }
          }
        ]
      },
      "CarInvoiceAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "$ref": "#/components/schemas/NameBean"
              },
              "dealerLegalName": {
                "type": "string"
              },
              "vin": {
                "type": "string"
              },
              "invoiceIssuingDate": {
                "type": "integer",
                "format": "int64"
              },
              "invoiceCertificationDate": {
                "type": "integer",
                "format": "int64"
              },
              "engineNumber": {
                "type": "string"
              },
              "carModelYear": {
                "type": "integer",
                "format": "int32"
              },
              "issuerRFC": {
                "type": "string"
              },
              "recipientRFC": {
                "type": "string"
              },
              "digitalTaxStampUuid": {
                "type": "string"
              },
              "carPrice": {
                "type": "number"
              },
              "issuerTaxRegime": {
                "type": "string"
              },
              "recipientTaxRegime": {
                "type": "string"
              },
              "qrIssuerRFC": {
                "type": "string"
              },
              "qrRecipientRFC": {
                "type": "string"
              },
              "qrDigitalTaxStampUuid": {
                "type": "string"
              },
              "validationErrors": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ValidationErrorSchema"
                }
              }
            }
          }
        ]
      },
      "CirculationCardAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "$ref": "#/components/schemas/NameBean"
              },
              "vin": {
                "type": "string"
              },
              "engineNumber": {
                "type": "string"
              },
              "carModelYear": {
                "type": "integer",
                "format": "int32"
              },
              "licensePlates": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "color": {
                "type": "string"
              },
              "vehicleUse": {
                "type": "string"
              },
              "validationErrors": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ValidationErrorSchema"
                }
              }
            }
          }
        ]
      },
      "ColombiaRutFormDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "$ref": "#/components/schemas/NameBean"
              },
              "taxIdNumber": {
                "type": "string"
              },
              "identificationNumber": {
                "type": "string"
              },
              "issueDate": {
                "type": "integer",
                "format": "int64"
              },
              "generationDate": {
                "type": "integer",
                "format": "int64"
              },
              "mainActivityCode": {
                "type": "string"
              },
              "secondaryActivityCode": {
                "type": "string"
              },
              "otherActivityCode1": {
                "type": "string"
              },
              "otherActivityCode2": {
                "type": "string"
              },
              "validationErrors": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ValidationErrorSchema"
                }
              }
            }
          }
        ]
      },
      "ColombianBirthCertificateDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "nationalNumber": {
                "type": "string"
              },
              "paternalLastname": {
                "type": "string"
              },
              "maternalLastname": {
                "type": "string"
              },
              "fullName": {
                "type": "string"
              },
              "dateOfBirth": {
                "type": "integer",
                "format": "int64"
              },
              "motherFullName": {
                "type": "string"
              },
              "motherNationalNumber": {
                "type": "string"
              },
              "fatherFullName": {
                "type": "string"
              },
              "fatherNationalNumber": {
                "type": "string"
              },
              "birthPlace": {
                "type": "string"
              }
            }
          }
        ]
      },
      "CurpDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "fullName": {
                "type": "string"
              },
              "curpNumber": {
                "type": "string"
              },
              "registrationDate": {
                "type": "integer",
                "format": "int64"
              },
              "registrationEntity": {
                "type": "string"
              },
              "idNumber": {
                "type": "string"
              }
            }
          }
        ]
      },
      "DLClassDetails": {
        "type": "object",
        "description": "Driver's license details",
        "properties": {
          "dlClass": {
            "type": "string",
            "description": "Driver's license class."
          },
          "validFromDate": {
            "type": "integer",
            "format": "int64",
            "description": "DL class valid from UTC timestamp"
          },
          "validToDate": {
            "type": "integer",
            "format": "int64",
            "description": "DL class valid to UTC timestamp."
          },
          "additionalCodes": {
            "type": "string",
            "description": "Additional codes associated with DL class."
          },
          "restrictions": {
            "type": "array",
            "description": "Restriction codes associated with DL class.",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "DeviceInfoResponse": {
        "type": "object",
        "properties": {
          "ipAddress": {
            "type": "string",
            "description": "IP address of the device from which onboarding is being executed.",
            "maxLength": 15
          },
          "hash": {
            "type": "string",
            "description": "Hash is generated out of data specific to user device and browser: userAgent, webdriver, language, colorDepth, deviceMemory,\nhardwareConcurrency, screenResolution, availableScreenResolution, timezoneOffset, timezone, sessionStorage, localStorage,\nindexedDb, cpuClass, platform, plugins, canvas, webgl, webglVendorAndRenderer, adBlock, hasLiedLanguages, hasLiedResolution,\nhasLiedOs, hasLiedBrowser, touchSupport, fonts, audio.\n",
            "maxLength": 64
          },
          "deviceType": {
            "type": "string",
            "description": "Device type",
            "enum": [
              "IOS",
              "ANDROID",
              "WEBAPP"
            ]
          },
          "osVersion": {
            "type": "string"
          },
          "deviceModel": {
            "type": "string"
          },
          "sdkVersion": {
            "type": "string"
          },
          "browser": {
            "type": "string"
          },
          "hasLiedBrowser": {
            "type": "boolean"
          },
          "longitude": {
            "type": "number",
            "format": "float",
            "description": "User's geolocation longitude."
          },
          "latitude": {
            "type": "number",
            "format": "float",
            "description": "User's geolocation latitude."
          },
          "location": {
            "type": "string",
            "description": "User's location at the moment of onboarding process."
          },
          "getmAdminArea": {
            "type": "string",
            "description": "State",
            "example": "CA"
          },
          "getmSubAdminArea": {
            "type": "string",
            "description": "County",
            "example": "Santa Clara"
          },
          "getmLocality": {
            "type": "string",
            "description": "City"
          },
          "getmSubLocality": {
            "type": "string",
            "description": "Neighborhood, common name",
            "example": "Mission District"
          },
          "getmThoroughfare": {
            "type": "string",
            "description": "Street name."
          },
          "getmSubThoroughfare": {
            "type": "string",
            "description": "Number."
          },
          "getmPostalCode": {
            "type": "string",
            "description": "Zip code",
            "example": 95014
          },
          "getmCountryCode": {
            "type": "string",
            "description": "Country code",
            "example": "US"
          },
          "getmCountryName": {
            "type": "string",
            "description": "Country name",
            "example": "United States"
          },
          "hostingApp": {
            "type": "string",
            "description": "Hosting App",
            "example": "Onboarding"
          }
        }
      },
      "FinanceSettlementDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "$ref": "#/components/schemas/NameBean"
              },
              "settlementDate": {
                "type": "integer",
                "format": "int64"
              },
              "settlementFigure": {
                "type": "number"
              },
              "agreementReference": {
                "type": "string"
              },
              "vehicleRegistrationNumber": {
                "type": "string"
              },
              "financeCompany": {
                "type": "string"
              },
              "accountNumber": {
                "type": "string"
              },
              "sortCode": {
                "type": "string"
              },
              "validationErrors": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ValidationErrorSchema"
                }
              }
            }
          }
        ]
      },
      "GenericDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "fullName": {
                "type": "string"
              },
              "address": {
                "type": "string"
              },
              "issueDate": {
                "type": "integer",
                "format": "int64"
              }
            }
          }
        ]
      },
      "GovernmentComparisonResults": {
        "type": "object",
        "description": "Government validation data. Only for supported government validation countries.",
        "properties": {
          "paternalLastNameValid": {
            "type": "boolean",
            "description": "Indicates validity of person's paternal last name through government validation apis."
          },
          "maternalLastNameValid": {
            "type": "boolean",
            "description": "Indicates validity of person's maternal last name through government validation apis."
          },
          "firstNameValid": {
            "type": "boolean",
            "description": "Indicates validity of person's first name through government validation apis."
          },
          "curpValid": {
            "type": "boolean",
            "description": "Indicates CURP validity through RENAPO/CURP provider validation."
          },
          "ineCurpValid": {
            "type": "boolean",
            "description": "Indicates CURP validity through INE government validation (separate from RENAPO)."
          },
          "ocrValid": {
            "type": "boolean",
            "description": "Indicates ocr validity through government validation apis."
          },
          "claveDeElectorValid": {
            "type": "boolean",
            "description": "Indicates \"clave de elector\" validity through government validation apis."
          },
          "numeroEmisionCredencialValid": {
            "type": "boolean",
            "description": "Indicates \"numero emision credencial\" validity through government validation apis."
          },
          "registrationDateValid": {
            "type": "boolean",
            "description": "Indicates registration date validity through government validation apis."
          },
          "issueDateValid": {
            "type": "boolean",
            "description": "Indicates issue date validity through government validation apis."
          }
        }
      },
      "GovernmentValidationResponse": {
        "type": "object",
        "properties": {
          "valid": {
            "type": "boolean"
          },
          "statusCode": {
            "type": "integer",
            "format": "int32"
          },
          "registralSituation": {
            "$ref": "#/components/schemas/RegistralSituation"
          },
          "governmentValidation": {
            "$ref": "#/components/schemas/GovernmentValidation"
          },
          "curpCecobanValidation": {
            "$ref": "#/components/schemas/CurpCecobanValidation"
          },
          "customFields": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "ocrData": {
            "$ref": "#/components/schemas/OcrDataResponse"
          },
          "deviceInfo": {
            "$ref": "#/components/schemas/DeviceInfoResponse"
          },
          "ineTransactionId": {
            "type": "string"
          },
          "errorDescription": {
            "type": "string"
          },
          "fallbackCalled": {
            "type": "boolean"
          }
        }
      },
      "IneMexDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "address": {
                "type": "string"
              },
              "addressList": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "voterIDNumber": {
                "type": "string"
              },
              "curpNumber": {
                "type": "string"
              },
              "dateOfBirth": {
                "type": "integer",
                "format": "int64"
              },
              "gender": {
                "type": "string"
              },
              "birthPlace": {
                "type": "string"
              },
              "nationality": {
                "type": "string"
              },
              "validFrom": {
                "type": "integer",
                "format": "int64"
              },
              "validTo": {
                "type": "integer",
                "format": "int64"
              },
              "registrationDate": {
                "type": "integer",
                "format": "int64"
              },
              "cicNumber": {
                "type": "string"
              },
              "ocrNumber": {
                "type": "string"
              },
              "idNumber": {
                "type": "string"
              },
              "credentialIssueNumber": {
                "type": "string"
              }
            }
          }
        ]
      },
      "JsonNode": {
        "type": "object"
      },
      "LetterOfAuthorizationDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "businessName": {
                "type": "string"
              },
              "address": {
                "type": "string"
              }
            }
          }
        ]
      },
      "MexicanTaxDeclarationDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "rfcNumber": {
                "type": "string"
              },
              "corporateName": {
                "type": "string"
              },
              "fullName": {
                "type": "string"
              },
              "declarationType": {
                "type": "string"
              },
              "fiscalYear": {
                "type": "integer",
                "format": "int32"
              },
              "submissionDate": {
                "type": "integer",
                "format": "int64"
              },
              "hasIncomeStatement": {
                "type": "boolean"
              },
              "hasFinancialPositionStatement": {
                "type": "boolean"
              },
              "totalIncome": {
                "type": "number"
              },
              "capitalFromContributions": {
                "type": "number"
              },
              "capitalFromCapitalization": {
                "type": "number"
              },
              "accumulatedLosses": {
                "type": "number"
              },
              "currentYearLosses": {
                "type": "number"
              },
              "accumulatedProfits": {
                "type": "number"
              },
              "currentYearProfits": {
                "type": "number"
              },
              "amountToPay": {
                "type": "number"
              },
              "amountDue": {
                "type": "number"
              },
              "operationNumber": {
                "type": "string"
              }
            }
          }
        ]
      },
      "MexicanTaxStatusDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "issueDate": {
                "type": "integer",
                "format": "int64"
              },
              "rfcNumber": {
                "type": "string"
              },
              "corporateName": {
                "type": "string"
              },
              "fullName": {
                "type": "string"
              },
              "registryStatus": {
                "type": "string"
              },
              "capitalRegime": {
                "type": "string"
              },
              "legalName": {
                "type": "string"
              },
              "addressComponents": {
                "$ref": "#/components/schemas/AddressBean"
              },
              "economicActivities": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/EconomicActivity"
                }
              },
              "regimes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Regime"
                }
              },
              "barcodes": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/PoaBarcode"
                }
              }
            }
          }
        ]
      },
      "OcrDataResponse": {
        "type": "object",
        "properties": {
          "name": {
            "$ref": "#/components/schemas/NameBean"
          },
          "address": {
            "type": "string",
            "description": "Address as read from id. Address can have two or three lines. Lines are separated by \\n"
          },
          "addressFields": {
            "$ref": "#/components/schemas/AddressBean"
          },
          "fullAddress": {
            "type": "boolean",
            "description": "This field is set to true if address from id is full (has three lines) or not (For Mexican Voter IDs only)."
          },
          "invalidAddress": {
            "type": "boolean",
            "description": "This field checks for a valid street, numeric postal code with 5 digits, and that both colony and city have values. (Only checked for Mexican IDs)"
          },
          "checkedAddress": {
            "type": "string",
            "description": "Address as obtained after processing with geocoder geolocation api."
          },
          "checkedAddressBean": {
            "$ref": "#/components/schemas/AddressBean"
          },
          "exteriorNumber": {
            "type": "string",
            "description": "Exterior street number."
          },
          "interiorNumber": {
            "type": "string",
            "description": "Interior street number."
          },
          "addressFromStatement": {
            "type": "string",
            "description": "Address as read from address statement. Lines are separated by \\n."
          },
          "addressFieldsFromStatement": {
            "$ref": "#/components/schemas/AddressBean"
          },
          "invalidAddressFromStatement": {
            "type": "boolean",
            "description": "This field checks for a valid street, numeric postal code with 5 digits, and tha both colony and city have values. (Only checked for Mexican POA)"
          },
          "addressStatementEmissionDate": {
            "type": "integer",
            "format": "int64",
            "description": " Issue date of address statement. The value is presented in UTC milliseconds."
          },
          "documentType": {
            "type": "string",
            "description": "Type of address statement document. Possible values:\n- Mexico: liverpool, citibanamex, cfe, telcel, izzi, axtel, telmex, oapas, sacmex, opdm, naturgy, drenaje, totalplay, dhc, att, cea, smapa, megacable, jmas, amicsa, caev\n- Bolivia: cre\n- Uruguay: ute\n- Unknown document: otherPoa\n",
            "enum": [
              "aysa",
              "edelap",
              "edenor",
              "edesur",
              "epec",
              "metrogas",
              "a1",
              "aggm",
              "apg",
              "energieAg",
              "cre",
              "eaab",
              "enel",
              "vanti",
              "aforeAzteca",
              "aforeBanorte",
              "amd",
              "amicsa",
              "att",
              "axtel",
              "bancoppel",
              "bancoAzteca",
              "banorte",
              "bbva",
              "cab",
              "caev",
              "capa",
              "cea",
              "cfe",
              "citibanamex",
              "cmapa",
              "cmapaGrande",
              "cmapas",
              "cmas",
              "cmasBlue",
              "comapa",
              "comapaRed",
              "coppel",
              "dapa",
              "dhc",
              "drenaje",
              "ecogas",
              "engie",
              "gasNatural",
              "h",
              "hsbc",
              "inbursa",
              "infonavit",
              "interapas",
              "isagas",
              "izzi",
              "jad",
              "japam",
              "japama",
              "japami",
              "japay",
              "jiapaz",
              "jmas",
              "jras",
              "jumapac",
              "jumapam",
              "lerdo",
              "liverpool",
              "mas",
              "megacable",
              "naturgy",
              "oapas",
              "odapas",
              "ooapas",
              "opdm",
              "oroapa",
              "sacmex",
              "sacmexCdmx",
              "santander",
              "sapa",
              "sapal",
              "sapamuy",
              "sapasa",
              "sapasma",
              "scotiabank",
              "seapal",
              "siapa",
              "siapaTepic",
              "simapag",
              "simapas",
              "simas",
              "smapa",
              "smapac",
              "smapam",
              "smapas",
              "spectrum",
              "stori",
              "sura",
              "tam",
              "telcel",
              "telmex",
              "totalplay",
              "veolia",
              "victoria",
              "wizz",
              "asylumSeeker",
              "refugeeId",
              "refugeeStatus",
              "ute",
              "telkom",
              "tmobile",
              "verizon",
              "xfinity",
              "aforeCoppel",
              "americanExpress",
              "ap",
              "telnor",
              "wellsFargo",
              "otherPoa"
            ]
          },
          "addressStatementTimestamps": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AddressStatementDate"
            }
          },
          "poaName": {
            "type": "string",
            "description": "Extracted name from address statement."
          },
          "typeOfId": {
            "type": "string",
            "enum": [
              "Unknown",
              "Passport",
              "Visa",
              "DriversLicense",
              "IdentificationCard",
              "Permit",
              "Currency",
              "ResidenceDocument",
              "TravelDocument",
              "BirthCertificate",
              "VehicleRegistration",
              "Other",
              "WeaponLicense",
              "TribalIdentification",
              "VoterIdentification",
              "Military",
              "TaxIdentification",
              "FederalID",
              "MedicalCard"
            ]
          },
          "documentFrontSubtype": {
            "type": "string",
            "description": "Additional info about ID type (front side)"
          },
          "documentBackSubtype": {
            "type": "string",
            "description": "Additional info about ID type (back side)"
          },
          "issueFront": {
            "type": "integer",
            "format": "int32",
            "description": "Issue year (per classification model) of the ID (front side)"
          },
          "issueBack": {
            "type": "integer",
            "format": "int32",
            "description": "Issue year (per classification model) of the ID (back side)"
          },
          "birthDate": {
            "type": "integer",
            "format": "int64",
            "description": "Date of birth is presented in UTC milliseconds."
          },
          "gender": {
            "type": "string",
            "description": "Gender values are presented in English. \"M\" for male, \"F\" for female and \"X\" for non-binary.",
            "enum": [
              "M",
              "F",
              "X"
            ],
            "maxLength": 1
          },
          "claveDeElector": {
            "type": "string",
            "description": "Clave de elector as read from id. For Mexican IDs only.",
            "maxLength": 18,
            "minLength": 18
          },
          "curp": {
            "type": "string",
            "description": "Curp as read form id. For Mexican IDs only.",
            "maxLength": 18,
            "minLength": 18
          },
          "numeroEmisionCredencial": {
            "type": "string",
            "description": "Numero Emision Credencial as read from id. (For Mexican IDs only).",
            "maxLength": 2,
            "minLength": 2
          },
          "cic": {
            "type": "string",
            "description": "Cic as read from id. (This field is read from back side of id; For Mexican IDs only).",
            "maxLength": 9,
            "minLength": 9
          },
          "ocr": {
            "type": "string",
            "description": "Ocr as read from id. (This field is read from back side of id; For Mexican IDs only).",
            "maxLength": 13,
            "minLength": 13
          },
          "documentNumber": {
            "type": "string",
            "description": "Document number."
          },
          "documentNumberSource": {
            "type": "string",
            "description": "Document number source.",
            "enum": [
              "FORM",
              "OCR"
            ]
          },
          "personalNumber": {
            "type": "string",
            "description": "Personal number."
          },
          "nationalNumber": {
            "type": "string",
            "description": "National number."
          },
          "refNumber": {
            "type": "string",
            "description": "Document Reference Number."
          },
          "familyNumber": {
            "type": "string",
            "description": "Family or household registry number printed on the document."
          },
          "taxIdNumber": {
            "type": "string",
            "description": "Personal tax identification number."
          },
          "nue": {
            "type": "string",
            "description": "NUE number as read from id. (for Resident Cards)"
          },
          "externalId": {
            "type": "string",
            "description": "External user id."
          },
          "issuedAt": {
            "type": "string",
            "description": "Date of issue UTC timestamp."
          },
          "expireAt": {
            "type": "string",
            "description": "Expiration date UTC timestamp."
          },
          "expirationDate": {
            "type": "integer",
            "format": "int32",
            "description": "Expiration year of id."
          },
          "issueDate": {
            "type": "integer",
            "format": "int32",
            "description": "Issue year of id."
          },
          "registrationDate": {
            "type": "integer",
            "format": "int32",
            "description": "Registration date read from id."
          },
          "dlClassDetails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DLClassDetails"
            }
          },
          "issuingCountry": {
            "type": "string",
            "description": "Issuing country of document."
          },
          "issuingState": {
            "type": "string",
            "description": "Issuing state of document."
          },
          "birthPlace": {
            "type": "string",
            "description": "Birth place as read from id."
          },
          "printingNumber": {
            "type": "string",
            "description": "Printing number (número de impresión) printed below the barcode on Colombian IDs."
          },
          "duplicateNumber": {
            "type": "string",
            "description": "Number of duplicates (número de duplicados) printed below the barcode on Colombian IDs."
          },
          "preparationNumber": {
            "type": "string",
            "description": "Preparation number (número de preparación) printed below the barcode on Colombian IDs."
          },
          "issuingAuthority": {
            "type": "string",
            "description": "Issuing Authority as read from id."
          },
          "height": {
            "type": "string",
            "description": "Person's height as read from id."
          },
          "weight": {
            "type": "string",
            "description": "Person's weight."
          },
          "eyeColor": {
            "type": "string",
            "description": "Person's eye color."
          },
          "hairColor": {
            "type": "string",
            "description": "Person's hair color."
          },
          "religion": {
            "type": "string",
            "description": "Person's religion."
          },
          "bloodType": {
            "type": "string",
            "description": "Person's blood type."
          },
          "maritalStatus": {
            "type": "string",
            "description": "Person's marital status."
          },
          "nationality": {
            "type": "string",
            "description": "Person's nationality."
          },
          "race": {
            "type": "string",
            "description": "Person's race."
          },
          "nationalityMrz": {
            "type": "string",
            "description": "Person's nationality as it appears in MRZ (if present)."
          },
          "nationalityAlpha3": {
            "type": "string",
            "description": "Person's nationality Alpha3 code format. Only for Brazilian IDs."
          },
          "governmentComparisonResults": {
            "$ref": "#/components/schemas/GovernmentComparisonResults"
          },
          "notExtracted": {
            "type": "integer",
            "format": "int32",
            "description": "Number of not extracted OCR fields. Only for Mexican IDs."
          },
          "notExtractedDetails": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "classes": {
            "type": "string",
            "description": "Person's driver licence classes."
          },
          "cond": {
            "type": "string",
            "description": "Person's driver licence conditions."
          },
          "mentions": {
            "type": "string",
            "description": "Person's driver licence mentions."
          },
          "restrictions": {
            "type": "string",
            "description": "Person's driver licence restrictions."
          },
          "mrz1": {
            "type": "string",
            "description": "First MRZ line."
          },
          "mrz2": {
            "type": "string",
            "description": "Second MRZ line."
          },
          "mrz3": {
            "type": "string",
            "description": "Third MRZ line."
          },
          "fullNameMrz": {
            "type": "string",
            "description": "Person's full name read from MRZ."
          },
          "documentNumberCheckDigit": {
            "type": "string",
            "description": "Document number check digit read from MRZ."
          },
          "dateOfBirthCheckDigit": {
            "type": "string",
            "description": "Date of birth check digit read from MRZ."
          },
          "expirationDateCheckDigit": {
            "type": "string",
            "description": "Expiration date check digit read from MRZ."
          },
          "barcodeRawData": {
            "type": "string",
            "description": "Full unformatted data read from 2D barcode."
          },
          "qrFrontContents": {
            "type": "array",
            "description": "Raw QR code payloads read from the front of the document, unparsed. Omitted when the capture was redacted.",
            "items": {
              "type": "string"
            }
          },
          "qrBackContents": {
            "type": "array",
            "description": "Raw QR code payloads read from the back of the document, unparsed. Omitted when the capture was redacted.",
            "items": {
              "type": "string"
            }
          },
          "fathersName": {
            "type": "string",
            "description": "Person's father's name. Only for Brazilian and Indian IDs."
          },
          "mothersName": {
            "type": "string",
            "description": "Person's mother's name. Only for Brazilian IDs."
          },
          "fathersIdNumber": {
            "type": "string",
            "description": "Person's father's Id Number. In the context of minors identity validation."
          },
          "mothersIdNumber": {
            "type": "string",
            "description": "Person's mother's Id Number. In the context of minors identity validation."
          },
          "spouseName": {
            "type": "string",
            "description": "Person's spouse's name."
          },
          "federalRevenueNumber": {
            "type": "string",
            "description": "Federal revenue number. Only for Brazilian IDs."
          },
          "originDocumentId": {
            "type": "string",
            "deprecated": true,
            "description": "Origin document ID. Only for Brazilian IDs."
          },
          "driversLicenseCategory": {
            "type": "string",
            "deprecated": true,
            "description": "Driver's licence category. Only for Brazilian IDs."
          },
          "controlNumber": {
            "type": "string",
            "deprecated": true,
            "description": "Control number. Only for Brazilian IDs."
          },
          "renach": {
            "type": "string",
            "deprecated": true,
            "description": "Renach. Only for Brazilian IDs."
          },
          "additionalAttrs": {
            "type": "array",
            "description": "Additional document attributes.",
            "items": {
              "type": "string",
              "enum": [
                "DOCUMENTO_INFANTIL",
                "IDADE_PRE_ESCOLAR",
                "MENOR_DE_ANOS",
                "NAO_ASSINA",
                "EM_FASE_DE_ALFABETIZACAO",
                "IMPOSSIBILITADO_DE_ASSINAR",
                "LIMITED_TERM",
                "FEDERAL_LIMITS_APPLY",
                "PERMISO_PARA_TRABAJAR",
                "EXTRANJERO",
                "INDIA_DIGITAL_VID",
                "VETERAN",
                "MOTORCYCLE_LICENSE",
                "NON_DOMICILED",
                "COMMERCIAL_LICENSE",
                "RESIDENTE",
                "MIGRANTE",
                "TEMPORAL",
                "VISITANTE",
                "TRAMITE",
                "RUEX",
                "INDIGENA",
                "AFROMEXICANA",
                "INDIA_DIGITAL_TAXID",
                "PHOTO_ONLY",
                "CANADA_TRAVEL_DOCUMENT"
              ]
            }
          },
          "ocrDataConfidence": {
            "$ref": "#/components/schemas/OcrDataConfidence"
          },
          "additionalDocumentAttempts": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
            }
          },
          "documentSubmissionMethod": {
            "type": "string",
            "description": "Method used to submit the document.",
            "enum": [
              "CAPTURED_DOCUMENT",
              "UPLOADED_FILE",
              "IMPORTED_CREDENTIAL"
            ]
          },
          "credentialsProvider": {
            "type": "string",
            "description": "Credentials provider used when documentSubmissionMethod is IMPORTED_CREDENTIAL.",
            "enum": [
              "APPLE",
              "GOOGLE",
              "DIGILOCKER",
              "SAMSUNG",
              "DIGITAL_ID",
              "NETHERLANDS_IDIN",
              "FINNISH_TRUST_NETWORK",
              "BELGIUM_ITSME",
              "ITALY_SPID",
              "DENMARK_MITID",
              "SWEDEN_BANKID",
              "FRANCE_IDENTITE",
              "FRANCE_IDENTITE_NUMERIQUE",
              "USA_LA_WALLET",
              "INDIA_DIGILOCKER_AADHAAR"
            ]
          },
          "providerOutput": {
            "$ref": "#/components/schemas/JsonNode",
            "description": "Raw provider data for IMPORTED_CREDENTIAL submissions, passed as-is. Absent when the provider returned no block."
          }
        }
      },
      "PoaDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "address": {
                "type": "string"
              },
              "timestamp": {
                "type": "integer",
                "format": "int64"
              },
              "addressStatementTimestamps": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AddressStatementDate"
                }
              },
              "issuer": {
                "type": "string",
                "enum": [
                  "aysa",
                  "edelap",
                  "edenor",
                  "edesur",
                  "epec",
                  "metrogas",
                  "a1",
                  "aggm",
                  "apg",
                  "energieAg",
                  "cre",
                  "eaab",
                  "enel",
                  "vanti",
                  "aforeAzteca",
                  "aforeBanorte",
                  "amd",
                  "amicsa",
                  "att",
                  "axtel",
                  "bancoppel",
                  "bancoAzteca",
                  "banorte",
                  "bbva",
                  "cab",
                  "caev",
                  "capa",
                  "cea",
                  "cfe",
                  "citibanamex",
                  "cmapa",
                  "cmapaGrande",
                  "cmapas",
                  "cmas",
                  "cmasBlue",
                  "comapa",
                  "comapaRed",
                  "coppel",
                  "dapa",
                  "dhc",
                  "drenaje",
                  "ecogas",
                  "engie",
                  "gasNatural",
                  "h",
                  "hsbc",
                  "inbursa",
                  "infonavit",
                  "interapas",
                  "isagas",
                  "izzi",
                  "jad",
                  "japam",
                  "japama",
                  "japami",
                  "japay",
                  "jiapaz",
                  "jmas",
                  "jras",
                  "jumapac",
                  "jumapam",
                  "lerdo",
                  "liverpool",
                  "mas",
                  "megacable",
                  "naturgy",
                  "oapas",
                  "odapas",
                  "ooapas",
                  "opdm",
                  "oroapa",
                  "sacmex",
                  "sacmexCdmx",
                  "santander",
                  "sapa",
                  "sapal",
                  "sapamuy",
                  "sapasa",
                  "sapasma",
                  "scotiabank",
                  "seapal",
                  "siapa",
                  "siapaTepic",
                  "simapag",
                  "simapas",
                  "simas",
                  "smapa",
                  "smapac",
                  "smapam",
                  "smapas",
                  "spectrum",
                  "stori",
                  "sura",
                  "tam",
                  "telcel",
                  "telmex",
                  "totalplay",
                  "veolia",
                  "victoria",
                  "wizz",
                  "asylumSeeker",
                  "refugeeId",
                  "refugeeStatus",
                  "ute",
                  "telkom",
                  "tmobile",
                  "verizon",
                  "xfinity",
                  "aforeCoppel",
                  "americanExpress",
                  "ap",
                  "telnor",
                  "wellsFargo",
                  "otherPoa"
                ]
              },
              "addressComponents": {
                "$ref": "#/components/schemas/AddressBean"
              },
              "parsedAddressComponents": {
                "$ref": "#/components/schemas/AddressBean"
              }
            }
          }
        ]
      },
      "RefugeeIdDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "firstNames": {
                "type": "string"
              },
              "lastName": {
                "type": "string"
              },
              "gender": {
                "type": "string",
                "enum": [
                  "MALE",
                  "FEMALE"
                ]
              },
              "countryOfBirth": {
                "type": "string"
              },
              "dateOfBirth": {
                "type": "integer",
                "format": "int64"
              },
              "nationality": {
                "type": "string"
              },
              "maritalStatus": {
                "type": "string"
              },
              "issueDate": {
                "type": "integer",
                "format": "int64"
              },
              "expiryDate": {
                "type": "integer",
                "format": "int64"
              },
              "idNumber": {
                "type": "string"
              }
            }
          }
        ]
      },
      "RefugeeStatusDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "fullName": {
                "type": "string"
              },
              "gender": {
                "type": "string",
                "enum": [
                  "MALE",
                  "FEMALE"
                ]
              },
              "dateOfBirth": {
                "type": "integer",
                "format": "int64"
              },
              "issueDate": {
                "type": "integer",
                "format": "int64"
              },
              "countryOfBirth": {
                "type": "string"
              },
              "nationality": {
                "type": "string"
              },
              "maritalStatus": {
                "type": "string"
              },
              "documentNumber": {
                "type": "string"
              }
            }
          }
        ]
      },
      "RfcDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "fullName": {
                "type": "string"
              },
              "rfcNumber": {
                "type": "string"
              },
              "idCIF": {
                "type": "string"
              }
            }
          }
        ]
      },
      "UnknownDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          }
        ]
      },
      "V5CLogbookAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "fullName": {
                "type": "string"
              },
              "address": {
                "type": "string"
              },
              "addressList": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "registrationNumber": {
                "type": "string"
              },
              "v5cNumber": {
                "type": "string"
              },
              "referenceNumber": {
                "type": "string"
              },
              "vin": {
                "type": "string"
              },
              "validationErrors": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ValidationErrorSchema"
                }
              }
            }
          }
        ]
      },
      "W8BenDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "beneficialOwnerName": {
                "type": "string"
              },
              "beneficialOwnerFirstName": {
                "type": "string"
              },
              "beneficialOwnerLastName": {
                "type": "string"
              },
              "countryOfCitizenship": {
                "type": "string"
              },
              "permanentResidenceAddress": {
                "$ref": "#/components/schemas/W8Address"
              },
              "mailingAddress": {
                "$ref": "#/components/schemas/W8Address"
              },
              "ssnOrItin": {
                "type": "string"
              },
              "foreignTin": {
                "type": "string"
              },
              "ftinNotLegallyRequired": {
                "type": "boolean"
              },
              "dateOfBirth": {
                "type": "integer",
                "format": "int64"
              },
              "treatyResidenceCountry": {
                "type": "string"
              },
              "signaturePresent": {
                "type": "boolean"
              },
              "dateSigned": {
                "type": "integer",
                "format": "int64"
              },
              "signerName": {
                "type": "string"
              },
              "revisionDetected": {
                "type": "string"
              },
              "formStatus": {
                "$ref": "#/components/schemas/W8FormStatus"
              }
            }
          }
        ]
      },
      "W8BenEDocumentAttemptDto": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AdditionalDocumentAttemptDto"
          },
          {
            "type": "object",
            "properties": {
              "legalEntityName": {
                "type": "string"
              },
              "countryOfIncorporationOrOrganization": {
                "type": "string"
              },
              "chapter3Status": {
                "type": "object",
                "additionalProperties": {
                  "type": "boolean"
                }
              },
              "chapter3AmbiguousOptions": {
                "type": "object",
                "additionalProperties": {
                  "type": "boolean"
                }
              },
              "hybridEntityTreatyClaim": {
                "type": "string"
              },
              "chapter4Status": {
                "type": "object",
                "additionalProperties": {
                  "type": "boolean"
                }
              },
              "chapter4AmbiguousOptions": {
                "type": "object",
                "additionalProperties": {
                  "type": "boolean"
                }
              },
              "permanentResidenceAddress": {
                "$ref": "#/components/schemas/W8Address"
              },
              "mailingAddress": {
                "$ref": "#/components/schemas/W8Address"
              },
              "ein": {
                "type": "string"
              },
              "giin": {
                "type": "string"
              },
              "foreignTin": {
                "type": "string"
              },
              "ftinNotLegallyRequired": {
                "type": "boolean"
              },
              "substantialUsOwners": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/W8SubstantialUsOwner"
                }
              },
              "signaturePresent": {
                "type": "boolean"
              },
              "dateSigned": {
                "type": "integer",
                "format": "int64"
              },
              "signerName": {
                "type": "string"
              },
              "revisionDetected": {
                "type": "string"
              },
              "formStatus": {
                "$ref": "#/components/schemas/W8FormStatus"
              }
            }
          }
        ]
      },
      "Brazil": {
        "type": "object",
        "description": "Response model for Brazil government validation",
        "properties": {
          "valid": {
            "type": "boolean"
          },
          "statusCode": {
            "type": "integer",
            "format": "int32"
          },
          "governmentValidation": {
            "$ref": "#/components/schemas/GovernmentValidation",
            "description": "    - recognitionConfidence: Present when government face validation is attempted (e.g. SERPRO_FACE).\n        - value: \"100.0\" when face matched, \"0.0\" when no match or face not in SERPRO DB\n        - status: OK when face matched, FAIL when no match or face not in SERPRO DB\n    - validationStatus: Key-value mapping:\n        - OK (0, \"ok\"): CPF found, data and/or face matched\n        - VALIDATION_ERROR (1, \"validationError\")\n        - MODULE_NOT_SUPPORTED (4, \"moduleNotSupported\")\n        - MISSING_SELFIE (6, \"missingSelfie\"): selfie required for SERPRO_FACE\n        - USER_NOT_FOUND (7, \"userNotFound\"): CPF not found in government DB, or face not matched\n        - CPF_NUMBER_INVALID_OR_MISSING (16, \"cpfNumberInvalidOrMissing\")\n        - CONNECTION_ERROR (17, \"connectionError\")\n        - PROVIDER_NOT_CONFIGURED (96, \"providerNotConfigured\")\n        - PROVIDER_UNAVAILABLE (98, \"providerUnavailable\")\n        - GEOGRAPHIC_REGION_NOT_SUPPORTED (99, \"geographicRegionNotSupported\")\n    - ocrValidation: List of value/status/key objects. Keys present for Brazil:\n        - documentNumber: CPF validity check\n        - fullName: name match (derived from firstName, paternalLastName, maternalLastName — all map to the same SERPRO nome field and always share the same status)\n        - birthDate: date of birth match\n        Not all keys are always present.\n    - ocrValidationOverall: Composite result for ocrValidation score\n    - overall: Equals ocrValidationOverall for SERPRO; for SERPRO_FACE the face recognitionConfidence can override it\n        (e.g. face not in DB / not matched drives overall to 0.0 FAIL even when ocrValidationOverall is OK)\n"
          },
          "errorDescription": {
            "type": "string"
          }
        }
      },
      "GovermentValidationResponseObject": {
        "type": "object",
        "oneOf": [
          {
            "$ref": "#/components/schemas/Brazil"
          },
          {
            "$ref": "#/components/schemas/GovernmentValidationResponse"
          }
        ]
      },
      "ProcessFaceResponse": {
        "type": "object",
        "properties": {
          "confidence": {
            "type": "number",
            "format": "float",
            "description": "Value 0 means that selfie doesn't match face photo from ID.",
            "maximum": 1,
            "minimum": 0
          },
          "existingUser": {
            "type": "boolean",
            "description": "Flag indicating if this user already exists in the system."
          },
          "existingInterviewId": {
            "type": "string",
            "description": "Session id where user is approved previously (existingUser=true)."
          },
          "existingExternalId": {
            "type": "string",
            "description": "In case the session does have an externalId which can be assigned at start call."
          },
          "nameMatched": {
            "type": "boolean",
            "description": "In case user is approved previously (existingUser=true), flag indicating if names are matching."
          }
        },
        "required": [
          "confidence",
          "existingUser"
        ]
      },
      "AddDocumentRequest": {
        "type": "object",
        "properties": {
          "base64Image": {
            "type": "string",
            "description": "Image in base64 format. One of base64Image or imageUrl is required",
            "example": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEB..."
          },
          "imageUrl": {
            "type": "string",
            "description": "URL of the image. One of base64Image or imageUrl is required",
            "example": "http://..."
          }
        }
      },
      "AddDocumentResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "AddDocumentStatus",
            "enum": [
              "SUCCESS",
              "PROCESS_DOC_ERROR",
              "SESSION_ERROR",
              "ADD_NEXT_PAGE",
              "OPTIONAL_PAGE_CAPTURE",
              "CLASSIFICATION_ERROR",
              "MULTI_PAGE_CLASSIFICATION_ERROR",
              "V5C_REGISTRATION_NUMBER_MISMATCH",
              "V5C_REFERENCE_NUMBER_MISMATCH",
              "V5C_NUMBER_MISMATCH",
              "FSL_AGREEMENT_REFERENCE_MISMATCH",
              "FSL_NAME_MISMATCH",
              "NOT_W8_BEN",
              "NOT_W8_BEN_E",
              "MANDATORY_FIELD_MISSING",
              "UNSUPPORTED_PAGE_NUMBERS",
              "VALIDATION_ERROR",
              "UNEXPECTED_ERROR",
              "FINALIZE_ERROR_NO_PAGES",
              "UNSUPPORTED_MP_DOCUMENT_TYPE"
            ]
          }
        }
      },
      "OnboardingAuthenticationRequest": {
        "type": "object",
        "properties": {
          "base64Image": {
            "type": "string",
            "description": "Image of user's face represented in base64.",
            "example": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEB...",
            "minLength": 1
          },
          "faceCoordinates": {
            "$ref": "#/components/schemas/FaceCoordinatesDto",
            "description": "Face coordinates"
          },
          "hint": {
            "type": "string",
            "description": "Customer hint. Possible hints are: customer id, email, phone number..."
          },
          "recordingId": {
            "type": "string",
            "description": "Id of recording used in spoof detection."
          }
        },
        "required": [
          "base64Image"
        ]
      },
      "CaptureAttemptsLimitDto": {
        "type": "object",
        "properties": {
          "max": {
            "type": "integer",
            "format": "int32",
            "description": "Maximum number of attempts to capture a photo."
          },
          "remaining": {
            "type": "integer",
            "format": "int32",
            "description": "Number of remaining attempts to capture a photo."
          }
        }
      },
      "OnboardingAuthenticationErrorDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      },
      "OnboardingAuthenticationResponse": {
        "type": "object",
        "properties": {
          "overallStatus": {
            "type": "string",
            "description": "Authentication status: FAIL/PASS.",
            "enum": [
              "PASS",
              "FAIL"
            ]
          },
          "captureAttemptsLimit": {
            "$ref": "#/components/schemas/CaptureAttemptsLimitDto",
            "description": "Checked only if configured in the session flow. Shows remaining number of attempts, and maximum number of attempts allowed."
          },
          "candidate": {
            "type": "string",
            "description": "Id of matched candidate."
          },
          "error": {
            "$ref": "#/components/schemas/OnboardingAuthenticationErrorDto",
            "description": "Error name and description pair.\nPossible error names are:\n    INACTIVE_SESSION,\n    NONEXISTENT_CUSTOMER,\n    LENSES_DETECTED,\n    FACE_MASK_DETECTED,\n    HEAD_COVER_DETECTED,\n    CLOSED_EYES_DETECTED,\n    FACE_TOO_DARK,\n    SPOOF_ATTEMPT_DETECTED,\n    USER_IS_NOT_RECOGNIZED,\n    SELFIE_IMAGE_LOW_QUALITY,\n    MULTIPLE_FACES_DETECTED,\n    HINT_NOT_PROVIDED,\n    FACE_NOT_FOUND,\n    FACE_CROPPING_FAILED,\n    FACE_TOO_SMALL,\n    FACE_TOO_BLURRY,\n    BAD_PHOTO_QUALITY,\n    PROCESSING_ERROR,\n    BAD_REQUEST\n",
            "example": {
              "name": "LENSES_DETECTED",
              "message": "Lenses detected."
            }
          }
        }
      },
      "LaborHistory": {
        "type": "object",
        "properties": {
          "nombrePatron": {
            "type": "string"
          },
          "entidadFederativa": {
            "type": "string"
          },
          "fechaAlta": {
            "type": "string"
          },
          "fechaBaja": {
            "type": "string"
          },
          "salarioBaseCotizacion": {
            "type": "string"
          },
          "registroPatronal": {
            "type": "string"
          }
        }
      },
      "KybRequest": {
        "type": "object",
        "description": "Business to verify and the KYB modules to run.",
        "properties": {
          "plugins": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "country": {
            "type": "string",
            "description": "Country of registration, ISO 3166-1 alpha-2. \"UK\" is accepted for GB.",
            "example": "US",
            "minLength": 1
          },
          "taxId": {
            "type": "string",
            "description": "Tax ID or company registration number. In the United States: 1 to 20 letters, digits, spaces or hyphens; required by the identity module.",
            "example": "12-3456789"
          },
          "businessName": {
            "type": "string",
            "description": "Registered legal name of the business. In the United States, required by the identity, address, webPresence, websiteAnalysis and industryInfo modules.",
            "example": "Incode Technologies, Inc."
          },
          "street": {
            "type": "string",
            "description": "Street address",
            "example": 101
          },
          "city": {
            "type": "string",
            "description": "City. In the United States, required by the address, webPresence, websiteAnalysis and industryInfo modules.",
            "example": "San Francisco"
          },
          "state": {
            "type": "string",
            "description": "State or province. In the United States, required by the address, webPresence, websiteAnalysis and industryInfo modules.",
            "example": "CA"
          },
          "postalCode": {
            "type": "string",
            "description": "Postal code / ZIP",
            "example": 94105
          },
          "personNames": {
            "type": "array",
            "description": "Names to check against the people associated with the business (personAssociation module). One personMatches entry is returned per name.",
            "example": [
              "Jane Doe"
            ],
            "items": {
              "type": "string"
            }
          },
          "website": {
            "type": "string",
            "description": "Business website URL",
            "example": "https://incode.com"
          },
          "alternativeNames": {
            "type": "array",
            "description": "Alternative or trade names for the business",
            "example": [
              "Incode"
            ],
            "items": {
              "type": "string"
            }
          },
          "phoneNumber": {
            "type": "string",
            "description": "Business phone number",
            "example": "+1 (415) 800-9400"
          },
          "email": {
            "type": "string",
            "description": "Business email address",
            "example": "info@incode.com"
          },
          "modules": {
            "type": "array",
            "items": {
              "enum": [
                "identity",
                "address",
                "statusEntityType",
                "personAssociation",
                "webPresence",
                "websiteAnalysis",
                "industryInfo",
                "financialIntelligence",
                "groupStructure"
              ]
            },
            "minItems": 1
          }
        },
        "required": [
          "country"
        ]
      },
      "KybAddressResult": {
        "type": "object",
        "description": "Result of the address module.",
        "properties": {
          "addressVerification": {
            "type": "string",
            "description": "Whether the input address matches a registered address.",
            "enum": [
              "verified",
              "approximateMatch",
              "unverified",
              "notFound",
              "notSupported"
            ]
          },
          "registryAddress": {
            "type": "string",
            "description": "Registered address the input was matched to."
          },
          "registryAddresses": {
            "type": "array",
            "description": "All registered addresses the input address was compared against.",
            "items": {
              "type": "string"
            }
          },
          "officeType": {
            "type": "string",
            "description": "Type of the matched address. Outside the United States, \"No information available\" when the registry does not report one.",
            "example": "headOffice"
          },
          "otherAddresses": {
            "type": "array",
            "description": "Other addresses registered for the business.",
            "items": {
              "$ref": "#/components/schemas/KybOtherAddress"
            }
          },
          "error": {
            "$ref": "#/components/schemas/KybModuleError",
            "description": "Set when this module could not produce a result; the other fields are then omitted."
          }
        }
      },
      "KybAmount": {
        "type": "object",
        "description": "A monetary amount.",
        "properties": {
          "currency": {
            "type": "string",
            "description": "ISO 4217 currency code.",
            "example": "EUR"
          },
          "value": {
            "type": "string",
            "description": "Amount as reported by the registry: a figure, or text such as \"No credit limit\".",
            "example": 5000000
          }
        }
      },
      "KybBankruptcy": {
        "type": "object",
        "description": "A bankruptcy filing.",
        "properties": {
          "bankruptcyType": {
            "type": "string",
            "description": "Bankruptcy type."
          },
          "docketNumber": {
            "type": "string",
            "description": "Docket number."
          },
          "court": {
            "type": "string",
            "description": "Court."
          },
          "title": {
            "type": "string",
            "description": "Case title."
          },
          "dateFiled": {
            "type": "string",
            "description": "Filing date."
          },
          "riskLevel": {
            "type": "string",
            "description": "Risk level of the filing."
          },
          "matchLevel": {
            "type": "string",
            "description": "How closely the filing matches the business."
          }
        }
      },
      "KybFinancialIntelligenceResult": {
        "type": "object",
        "description": "Result of the financialIntelligence module: liens, litigation, bankruptcy and credit information. Which fields are available depends on the country. Liens, litigation and bankruptcy are returned in the United States only; there, an empty list means the search found nothing, and an omitted list means that search did not complete. Credit information is returned outside the United States.",
        "properties": {
          "liens": {
            "type": "array",
            "description": "Lien filings.",
            "items": {
              "$ref": "#/components/schemas/KybLien"
            }
          },
          "litigation": {
            "type": "array",
            "description": "Court cases.",
            "items": {
              "$ref": "#/components/schemas/KybLitigation"
            }
          },
          "bankruptcy": {
            "type": "array",
            "description": "Bankruptcy filings.",
            "items": {
              "$ref": "#/components/schemas/KybBankruptcy"
            }
          },
          "creditRating": {
            "type": "string",
            "description": "Credit rating, A (lowest risk) to D (highest risk), or E when the business is not rated.",
            "example": "A"
          },
          "creditRatingDescription": {
            "type": "string",
            "description": "Meaning of the credit rating."
          },
          "creditLimit": {
            "$ref": "#/components/schemas/KybAmount",
            "description": "Recommended credit limit."
          },
          "probabilityOfDefault": {
            "type": "string",
            "description": "Probability of default, as reported by the registry.",
            "example": 0.336
          },
          "turnover": {
            "$ref": "#/components/schemas/KybTurnover",
            "description": "Annual turnover."
          },
          "employeeCount": {
            "type": "string",
            "description": "Number of employees, as a figure or a band.",
            "example": "3-5"
          },
          "negativeInformation": {
            "type": "object",
            "description": "Adverse information reported by the registry. Its structure varies by country."
          },
          "error": {
            "$ref": "#/components/schemas/KybModuleError",
            "description": "Set when this module, or one of its searches, could not complete. Results from the searches that did complete are still returned alongside it, for example liens when the litigation and bankruptcy search failed."
          }
        }
      },
      "KybGroupCompany": {
        "type": "object",
        "description": "A company in the group.",
        "properties": {
          "name": {
            "type": "string",
            "description": "Company name."
          },
          "country": {
            "type": "string",
            "description": "Country, ISO 3166-1 alpha-2."
          },
          "status": {
            "type": "string",
            "description": "Company status."
          },
          "registrationNumber": {
            "type": "string",
            "description": "Registration number."
          },
          "level": {
            "type": "string",
            "description": "Position in the group. relatedEntities only."
          }
        }
      },
      "KybGroupStructureResult": {
        "type": "object",
        "description": "Result of the groupStructure module: parent, subsidiary and affiliated companies. Some countries report a flat list in relatedEntities, with a level on each entry, instead of named roles.",
        "properties": {
          "ultimateParent": {
            "$ref": "#/components/schemas/KybGroupCompany",
            "description": "Ultimate parent company."
          },
          "immediateParent": {
            "$ref": "#/components/schemas/KybGroupCompany",
            "description": "Immediate parent company."
          },
          "subsidiaryCompanies": {
            "type": "array",
            "description": "Subsidiaries.",
            "items": {
              "$ref": "#/components/schemas/KybGroupCompany"
            }
          },
          "affiliatedCompanies": {
            "type": "array",
            "description": "Affiliated companies.",
            "items": {
              "$ref": "#/components/schemas/KybGroupCompany"
            }
          },
          "relatedEntities": {
            "type": "array",
            "description": "Group companies without a named role.",
            "items": {
              "$ref": "#/components/schemas/KybGroupCompany"
            }
          },
          "error": {
            "$ref": "#/components/schemas/KybModuleError",
            "description": "Set when this module could not produce a result; the other fields are then omitted."
          }
        }
      },
      "KybGstin": {
        "type": "object",
        "description": "An Indian GST registration.",
        "properties": {
          "gstin": {
            "type": "string",
            "description": "GST identification number."
          },
          "state": {
            "type": "string",
            "description": "State of registration."
          },
          "status": {
            "type": "string",
            "description": "Registration status."
          }
        }
      },
      "KybIdentityResult": {
        "type": "object",
        "description": "Result of the identity module: tax ID and business name match.",
        "properties": {
          "taxId": {
            "type": "string",
            "description": "Whether the taxId matches the official record.",
            "enum": [
              "verified",
              "approximateMatch",
              "unverified",
              "notFound",
              "notSupported"
            ]
          },
          "name": {
            "type": "string",
            "description": "Whether the businessName matches the official record.",
            "enum": [
              "verified",
              "approximateMatch",
              "unverified",
              "notFound",
              "notSupported"
            ]
          },
          "registryName": {
            "type": "string",
            "description": "Registered business name the input was matched to."
          },
          "registryNames": {
            "type": "array",
            "description": "All registered names the input business name was compared against.",
            "items": {
              "type": "string"
            }
          },
          "tinMatchType": {
            "type": "string",
            "description": "Kind of US tax ID that matched, EIN or SSN. United States only.",
            "example": "EIN"
          },
          "tinMatchMessage": {
            "type": "string",
            "description": "Outcome of the IRS name and TIN check. United States only."
          },
          "error": {
            "$ref": "#/components/schemas/KybModuleError",
            "description": "Set when this module could not produce a result; the other fields are then omitted."
          }
        }
      },
      "KybIndustryInfoResult": {
        "type": "object",
        "description": "Result of the industryInfo module: industry classification of the business.",
        "properties": {
          "naicsCode": {
            "type": "string",
            "description": "Predicted NAICS code.",
            "example": 541511
          },
          "title": {
            "type": "string",
            "description": "Title of the NAICS code."
          },
          "accuracy": {
            "type": "number",
            "format": "double",
            "description": "Confidence of the prediction, 0.0 to 1.0."
          },
          "riskLevel": {
            "type": "string",
            "description": "Industry risk level: low, medium or high.",
            "example": "low"
          },
          "industryCode": {
            "type": "string",
            "description": "Registered industry code, in the scheme named by classification."
          },
          "classification": {
            "type": "string",
            "description": "Classification scheme of industryCode; varies by country.",
            "example": "SIC07"
          },
          "industryDesc": {
            "type": "string",
            "description": "Description of the industry code."
          },
          "activityDesc": {
            "type": "string",
            "description": "Description of the business activity."
          },
          "error": {
            "$ref": "#/components/schemas/KybModuleError",
            "description": "Set when this module could not produce a result; the other fields are then omitted."
          }
        }
      },
      "KybLien": {
        "type": "object",
        "description": "A lien filing.",
        "properties": {
          "filingNumber": {
            "type": "string",
            "description": "Filing number."
          },
          "filingType": {
            "type": "string",
            "description": "Filing type."
          },
          "filingDate": {
            "type": "string",
            "description": "Filing date."
          },
          "status": {
            "type": "string",
            "description": "Filing status."
          },
          "lienAmount": {
            "type": "number",
            "format": "double",
            "description": "Amount secured by the lien."
          },
          "matchLevel": {
            "type": "string",
            "description": "How closely the filing matches the business."
          }
        }
      },
      "KybLitigation": {
        "type": "object",
        "description": "A court case.",
        "properties": {
          "docketNumber": {
            "type": "string",
            "description": "Docket number."
          },
          "court": {
            "type": "string",
            "description": "Court."
          },
          "state": {
            "type": "string",
            "description": "State."
          },
          "title": {
            "type": "string",
            "description": "Case title."
          },
          "caseType": {
            "type": "string",
            "description": "Case type."
          },
          "dateFiled": {
            "type": "string",
            "description": "Filing date."
          },
          "matchLevel": {
            "type": "string",
            "description": "How closely the case matches the business."
          },
          "riskLevel": {
            "type": "string",
            "description": "Risk level of the case."
          }
        }
      },
      "KybModuleError": {
        "type": "object",
        "description": "Why a module could not produce a result.",
        "properties": {
          "status": {
            "type": "string",
            "description": "Outcome reported for the module.",
            "enum": [
              "verified",
              "approximateMatch",
              "unverified",
              "notFound",
              "notSupported"
            ]
          },
          "message": {
            "type": "string",
            "description": "Human-readable reason.",
            "example": "Tax ID was not found."
          }
        }
      },
      "KybOtherAddress": {
        "type": "object",
        "description": "Another address registered for the business.",
        "properties": {
          "address": {
            "type": "string",
            "description": "Formatted address."
          },
          "type": {
            "type": "string",
            "description": "Address type."
          }
        }
      },
      "KybOtherInfo": {
        "type": "object",
        "description": "Additional registry identifiers.",
        "properties": {
          "vatNo": {
            "type": "string",
            "description": "VAT number."
          },
          "otherNames": {
            "type": "array",
            "description": "Trading and previous names.",
            "items": {
              "$ref": "#/components/schemas/KybOtherName"
            }
          },
          "leiNumber": {
            "type": "string",
            "description": "Legal Entity Identifier."
          },
          "panNumber": {
            "type": "string",
            "description": "PAN. India only."
          },
          "panName": {
            "type": "string",
            "description": "Name registered with the PAN. India only."
          },
          "allGSTINs": {
            "type": "array",
            "description": "GST registrations. India only.",
            "items": {
              "$ref": "#/components/schemas/KybGstin"
            }
          }
        }
      },
      "KybOtherName": {
        "type": "object",
        "description": "Another name the business is or was known by.",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name."
          },
          "businessNameType": {
            "type": "string",
            "description": "Kind of name.",
            "example": "Trading Name"
          }
        }
      },
      "KybPerson": {
        "type": "object",
        "description": "A person associated with the business: an officer, director, shareholder or person with significant control. A shareholder can be a company.",
        "properties": {
          "name": {
            "type": "string",
            "description": "Full name.",
            "example": "Jane Doe"
          },
          "titles": {
            "type": "array",
            "description": "Roles held.",
            "example": [
              "Director"
            ],
            "items": {
              "type": "string"
            }
          },
          "percentSharesHeld": {
            "type": "number",
            "format": "double",
            "description": "Percentage of shares held, when reported."
          }
        }
      },
      "KybPersonAssociationResult": {
        "type": "object",
        "description": "Result of the personAssociation module: people associated with the business, and a match for each submitted name.",
        "properties": {
          "personMatches": {
            "type": "array",
            "description": "One entry per name in personNames. Omitted when no names were sent.",
            "items": {
              "$ref": "#/components/schemas/KybPersonMatch"
            }
          },
          "people": {
            "type": "array",
            "description": "All people associated with the business in the registry: officers and directors, and outside the United States also shareholders (which can be companies) and persons with significant control.",
            "items": {
              "$ref": "#/components/schemas/KybPerson"
            }
          },
          "error": {
            "$ref": "#/components/schemas/KybModuleError",
            "description": "Set when this module could not produce a result. Outside the United States it is also set when the registry lists no associated people; personMatches is then still returned alongside it, with status unverified for every submitted name."
          }
        }
      },
      "KybPersonMatch": {
        "type": "object",
        "description": "Result for one name submitted in personNames.",
        "properties": {
          "checkedName": {
            "type": "string",
            "description": "The name as submitted.",
            "example": "Jane Doe"
          },
          "status": {
            "type": "string",
            "description": "Whether the name matches a person associated with the business.",
            "enum": [
              "verified",
              "approximateMatch",
              "unverified",
              "notFound",
              "notSupported"
            ]
          },
          "matchedName": {
            "type": "string",
            "description": "The matching name as it appears in the registry. Omitted when not found."
          },
          "matchedPerson": {
            "$ref": "#/components/schemas/KybPerson",
            "description": "Details of the matching person. Omitted when not found."
          }
        }
      },
      "KybResult": {
        "type": "object",
        "description": "KYB result. Every requested module is present. A module that is not supported for the country carries an error with status notSupported.",
        "properties": {
          "identity": {
            "$ref": "#/components/schemas/KybIdentityResult",
            "description": "Result of the identity module."
          },
          "address": {
            "$ref": "#/components/schemas/KybAddressResult",
            "description": "Result of the address module."
          },
          "statusEntityType": {
            "$ref": "#/components/schemas/KybStatusEntityTypeResult",
            "description": "Result of the statusEntityType module."
          },
          "personAssociation": {
            "$ref": "#/components/schemas/KybPersonAssociationResult",
            "description": "Result of the personAssociation module."
          },
          "webPresence": {
            "$ref": "#/components/schemas/KybWebPresenceResult",
            "description": "Result of the webPresence module."
          },
          "websiteAnalysis": {
            "$ref": "#/components/schemas/KybWebsiteAnalysisResult",
            "description": "Result of the websiteAnalysis module."
          },
          "industryInfo": {
            "$ref": "#/components/schemas/KybIndustryInfoResult",
            "description": "Result of the industryInfo module."
          },
          "financialIntelligence": {
            "$ref": "#/components/schemas/KybFinancialIntelligenceResult",
            "description": "Result of the financialIntelligence module."
          },
          "groupStructure": {
            "$ref": "#/components/schemas/KybGroupStructureResult",
            "description": "Result of the groupStructure module."
          },
          "scores": {
            "type": "array",
            "description": "Business scores, when available for the country.",
            "items": {
              "$ref": "#/components/schemas/KybScore"
            }
          },
          "pendingModules": {
            "type": "array",
            "description": "Modules still running when the response was returned. Their results arrive in the KYB_RESULT webhook and on GET /omni/verification/async/{referenceId}. Omitted when every module has finished.",
            "items": {
              "type": "string",
              "enum": [
                "identity",
                "address",
                "statusEntityType",
                "personAssociation",
                "webPresence",
                "websiteAnalysis",
                "industryInfo",
                "financialIntelligence",
                "groupStructure"
              ]
            }
          },
          "referenceId": {
            "type": "string",
            "description": "Identifies this run. Matches the referenceId of the KYB_RESULT webhook and is the key for GET /omni/verification/async/{referenceId}. Not included in the webhook's result object.",
            "example": "6716a3f0c2b5e14d0a9e7f21"
          }
        }
      },
      "KybScore": {
        "type": "object",
        "description": "A business score.",
        "properties": {
          "type": {
            "type": "string",
            "description": "Score type.",
            "example": "kyb"
          },
          "score": {
            "type": "number",
            "format": "double",
            "description": "Numeric score."
          },
          "rating": {
            "type": "string",
            "description": "Letter rating, A (best) to F.",
            "example": "A"
          }
        }
      },
      "KybSocialProfile": {
        "type": "object",
        "description": "A social media account found for the business.",
        "properties": {
          "platform": {
            "type": "string",
            "description": "Platform.",
            "example": "linked_in:company"
          },
          "username": {
            "type": "string",
            "description": "Account handle."
          },
          "url": {
            "type": "string",
            "description": "Profile URL."
          },
          "confidence": {
            "type": "string",
            "description": "Confidence that the account belongs to the business: high, medium or low.",
            "example": "high"
          },
          "followers": {
            "type": "integer",
            "format": "int64",
            "description": "Follower count."
          },
          "bio": {
            "type": "string",
            "description": "Profile bio."
          },
          "businessWebsite": {
            "type": "string",
            "description": "Website listed on the profile."
          },
          "verified": {
            "type": "boolean",
            "description": "Whether the platform has verified the account."
          }
        }
      },
      "KybSsl": {
        "type": "object",
        "description": "TLS certificate of the website.",
        "properties": {
          "isValid": {
            "type": "boolean",
            "description": "Whether the certificate is valid."
          },
          "issuer": {
            "type": "string",
            "description": "Certificate issuer."
          },
          "certificateType": {
            "type": "string",
            "description": "Validation level: DV, OV or EV.",
            "example": "DV"
          },
          "tlsVersion": {
            "type": "string",
            "description": "TLS version."
          },
          "expiryDate": {
            "type": "string",
            "description": "Certificate expiry date, ISO-8601."
          },
          "daysUntilExpiry": {
            "type": "integer",
            "format": "int32",
            "description": "Days until the certificate expires."
          },
          "isWildcard": {
            "type": "boolean",
            "description": "Whether it is a wildcard certificate."
          },
          "isSelfSigned": {
            "type": "boolean",
            "description": "Whether the certificate is self-signed."
          },
          "isRevoked": {
            "type": "boolean",
            "description": "Whether the certificate has been revoked."
          }
        }
      },
      "KybStatusEntityTypeResult": {
        "type": "object",
        "description": "Result of the statusEntityType module: registration status and legal form. incorporationDate, companySize and otherInfo are not available in every country.",
        "properties": {
          "registrationStatus": {
            "type": "string",
            "description": "Registration status.",
            "example": "Active"
          },
          "entityType": {
            "type": "string",
            "description": "Legal form of the business, as reported by the registry.",
            "example": "C_CORPORATION"
          },
          "incorporationDate": {
            "type": "string",
            "description": "Date of incorporation."
          },
          "companySize": {
            "type": "string",
            "description": "Company size band."
          },
          "otherInfo": {
            "$ref": "#/components/schemas/KybOtherInfo",
            "description": "Additional registry identifiers."
          },
          "error": {
            "$ref": "#/components/schemas/KybModuleError",
            "description": "Set when this module could not produce a result; the other fields are then omitted."
          }
        }
      },
      "KybTurnover": {
        "type": "object",
        "description": "Annual turnover, as an exact figure or, where the registry has none, a range.",
        "properties": {
          "currency": {
            "type": "string",
            "description": "ISO 4217 currency code.",
            "example": "EUR"
          },
          "value": {
            "type": "number",
            "format": "double",
            "description": "Exact turnover."
          },
          "range": {
            "type": "string",
            "description": "Turnover band, when no exact figure is available."
          }
        }
      },
      "KybWebPresenceResult": {
        "type": "object",
        "description": "Result of the webPresence module: online footprint of the business.",
        "properties": {
          "socialProfiles": {
            "type": "array",
            "description": "Social media accounts found for the business.",
            "items": {
              "$ref": "#/components/schemas/KybSocialProfile"
            }
          },
          "websites": {
            "type": "array",
            "description": "Websites found for the business.",
            "items": {
              "type": "string"
            }
          },
          "phoneNumbers": {
            "type": "array",
            "description": "Phone numbers found for the business.",
            "items": {
              "type": "string"
            }
          },
          "emailAddresses": {
            "type": "array",
            "description": "Email addresses found for the business.",
            "items": {
              "type": "string"
            }
          },
          "error": {
            "$ref": "#/components/schemas/KybModuleError",
            "description": "Set when this module could not produce a result; the other fields are then omitted."
          }
        }
      },
      "KybWebsiteAnalysisResult": {
        "type": "object",
        "description": "Result of the websiteAnalysis module: domain and certificate signals for the website.",
        "properties": {
          "url": {
            "type": "string",
            "description": "Website analysed."
          },
          "domainAgeMonths": {
            "type": "integer",
            "format": "int32",
            "description": "Age of the domain, in months."
          },
          "domainCreatedAt": {
            "type": "string",
            "description": "Domain registration date, ISO-8601."
          },
          "domainExpiresAt": {
            "type": "string",
            "description": "Domain expiry date, ISO-8601."
          },
          "registrar": {
            "type": "string",
            "description": "Domain registrar."
          },
          "parked": {
            "type": "boolean",
            "description": "Whether the domain is parked or a placeholder."
          },
          "buildStatus": {
            "type": "string",
            "description": "Website build status.",
            "example": "active"
          },
          "ssl": {
            "$ref": "#/components/schemas/KybSsl",
            "description": "TLS certificate details."
          },
          "structureMetrics": {
            "$ref": "#/components/schemas/KybWebsiteStructureMetrics",
            "description": "Navigation-structure signals."
          },
          "error": {
            "$ref": "#/components/schemas/KybModuleError",
            "description": "Set when this module could not produce a result; the other fields are then omitted."
          }
        }
      },
      "KybWebsiteStructureMetrics": {
        "type": "object",
        "description": "Navigation-structure signals for the website.",
        "properties": {
          "depth": {
            "type": "string",
            "description": "Navigation depth."
          },
          "breadth": {
            "type": "string",
            "description": "Navigation breadth."
          }
        }
      },
      "IdentityReuseRequest": {
        "type": "object",
        "properties": {
          "documentId": {
            "type": "string"
          },
          "accepted": {
            "type": "boolean"
          }
        }
      },
      "IdentityCrosscheckRequest": {
        "type": "object",
        "description": "Request for identity cross-check comparing account creation data with IDV extracted data",
        "properties": {
          "name": {
            "type": "string",
            "description": "Full name from account creation",
            "example": "John Doe",
            "minLength": 1
          },
          "dateOfBirth": {
            "type": "string",
            "description": "Date of birth in YYYY-MM-DD format",
            "example": "1990-01-15",
            "minLength": 1
          }
        },
        "required": [
          "dateOfBirth",
          "name"
        ]
      },
      "IdentityCrosscheckResponse": {
        "type": "object",
        "description": "Response from identity cross-check operation containing match results and risk assessment",
        "properties": {
          "sessionId": {
            "type": "string",
            "description": "Session ID that was cross-checked",
            "example": "64a7b8c9d1e2f3g4h5i6j7k8"
          },
          "score": {
            "$ref": "#/components/schemas/IdentityCrosscheck",
            "description": "Identity cross-check score results"
          },
          "success": {
            "type": "boolean",
            "description": "Success indicator",
            "example": true
          },
          "errorMessage": {
            "type": "string",
            "description": "Error message if cross-check failed",
            "example": "IDV data not found for session"
          }
        }
      },
      "FinishSessionResponse": {
        "type": "object",
        "properties": {
          "redirectionUrl": {
            "type": "string"
          },
          "action": {
            "type": "string"
          },
          "customerId": {
            "type": "string"
          },
          "scoreStatus": {
            "type": "string",
            "enum": [
              "OK",
              "WARN",
              "FAIL",
              "UNKNOWN",
              "MANUAL",
              "MANUAL_OK",
              "MANUAL_FAIL",
              "MANUAL_PENDING"
            ]
          }
        }
      },
      "FinalizeDocumentRequest": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Type of document image for which processing is being finalized.",
            "enum": [
              "selfie",
              "authenticationSelfie",
              "sorSelfie",
              "videoSelfie",
              "externalFace",
              "croppedFace",
              "croppedAuthenticationSelfie",
              "croppedFrameAnalysisSelfie",
              "croppedExternalFace",
              "croppedIDFace",
              "croppedNfcFace",
              "document",
              "originalSignature",
              "signature",
              "initials",
              "fullFrameFrontID",
              "fullFrameBackID",
              "croppedFrontID",
              "refCroppedFrontID",
              "croppedBackID",
              "refCroppedBackID",
              "croppedOriginalFrontID",
              "croppedOriginalBackID",
              "confSelfie",
              "confFrontID",
              "confBackID",
              "confPoa",
              "addressStatement",
              "medicalDoc",
              "secondId",
              "thirdId",
              "contract",
              "signedContract",
              "videoSelfieCompareID",
              "videoSelfieCompareOcr",
              "videoSelfieCompareBackID",
              "videoSelfieCompareBackOcr",
              "otherDocument1",
              "otherDocument2",
              "otherDocument3",
              "paymentProof",
              "consent",
              "annotationImg",
              "externalScreen",
              "eSignDocument",
              "sessionExport",
              "zoomedFrontId",
              "zoomedBackId",
              "zoomedSelfie",
              "regionBasedTemplate",
              "renaperCropped",
              "voiceConsentSelfie",
              "v5cLogbook",
              "v5cMultiPageLogbook",
              "carInvoice",
              "circulationCard",
              "financeSettlement",
              "w8Ben",
              "w8BenE",
              "faceRecordingFrame",
              "signatureImageID",
              "ghostSignatureImageID",
              "ghostPortraitImageID",
              "fingerprintImageID",
              "documentNumberCropImageID",
              "ineMexScan",
              "originalNfcFace"
            ]
          }
        },
        "required": [
          "type"
        ]
      },
      "EkycIncomeVerificationRequest": {
        "type": "object",
        "properties": {
          "taxId": {
            "type": "string",
            "description": "11 digit CPF",
            "example": 12345678910
          },
          "country": {
            "type": "string",
            "description": "Two letter Alpha-2 country code. (Must be BR).",
            "example": "BR"
          }
        },
        "required": [
          "country",
          "taxId"
        ]
      },
      "EkycRiskAddonResponse": {
        "type": "object",
        "description": "Result of one eKYC risk add-on. The type field carries the add-on name used in riskAddons of the request and selects the shape of the entry.",
        "discriminator": {
          "propertyName": "type"
        },
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "phoneCheck",
              "advancedPhoneCheck",
              "emailCheck",
              "phoneProfile"
            ]
          }
        }
      },
      "EkycVerification": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "Indicates a type of risk, such as addressRiskLevel. The overallLevel key name is an aggregate risk score for all risk types.\nIt can be used to obtain a single risk score for a whole result set.\n"
          },
          "status": {
            "type": "string",
            "description": "Explains the risk level, ie \"low\", \"medium\", or \"high\". When doing a social security number check, the API will return status\nvalues of nomatch, fuzzy, exact or unknown. Fuzzy means there is plausible match between the name and the social security number,\nlike Dave and David both resolve to the same SSN. Unknown means no match result could be determined, for example because the\ndata source has no record of the value.\n"
          },
          "sub_label": {
            "type": "string",
            "description": "Additional info on the status."
          },
          "message": {
            "type": "string"
          },
          "reasonCodes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "EkycVerificationResponse": {
        "type": "object",
        "properties": {
          "kyc": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EkycVerification"
            }
          },
          "income": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EkycVerification"
            }
          },
          "riskAddons": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PhoneProfileRiskAddonResponse"
                }
              ]
            }
          },
          "additionalVerificationInfo": {
            "$ref": "#/components/schemas/AdditionalVerificationInfo"
          },
          "sot": {
            "type": "string"
          }
        }
      },
      "PhoneProfileAdditionalProfileResponse": {
        "type": "object",
        "properties": {
          "firstName": {
            "type": "string",
            "description": "First name of the alternate candidate identity."
          },
          "lastName": {
            "type": "string",
            "description": "Last name of the alternate candidate identity."
          },
          "dob": {
            "type": "string",
            "description": "Date of birth of the alternate candidate identity, yyyy-MM-dd, when the provider returns it."
          },
          "addresses": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PhoneProfileAddressResponse"
            }
          }
        }
      },
      "PhoneProfileAddressResponse": {
        "type": "object",
        "properties": {
          "address1": {
            "type": "string",
            "description": "Single concatenated address string, not split into street, city, state or postal code."
          }
        }
      },
      "PhoneProfileRiskAddonResponse": {
        "allOf": [
          {
            "$ref": "#/components/schemas/EkycRiskAddonResponse"
          },
          {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "description": "Add-on that produced this entry, always phoneProfile for this shape.",
                "enum": [
                  "phoneCheck",
                  "advancedPhoneCheck",
                  "emailCheck",
                  "phoneProfile"
                ]
              },
              "checkStatus": {
                "type": "string",
                "description": "Outcome of the check for the provided phone number: found or notFound."
              },
              "message": {
                "type": "string",
                "description": "Explanation returned when checkStatus is notFound."
              },
              "confidenceLevel": {
                "type": "string",
                "description": "Confidence in the returned identity match: low, medium or high."
              },
              "phoneFirstName": {
                "type": "string",
                "description": "First name on file for the phone number."
              },
              "phoneLastName": {
                "type": "string",
                "description": "Last name on file for the phone number."
              },
              "phoneDob": {
                "type": "string",
                "description": "Date of birth on file, yyyy-MM-dd. Availability varies by country."
              },
              "phoneValid": {
                "type": "boolean",
                "description": "Whether the provider considers the phone number valid."
              },
              "phoneCountry": {
                "type": "string",
                "description": "Country of the phone number as reported by the provider."
              },
              "phoneAddresses": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/PhoneProfileAddressResponse"
                }
              },
              "nameReturned": {
                "type": "boolean",
                "description": "True only when both phoneFirstName and phoneLastName were returned."
              },
              "phonePersonAge": {
                "type": "integer",
                "format": "int32",
                "description": "Age computed from phoneDob at the time of the check. Absent when phoneDob is unavailable."
              },
              "isAdult": {
                "type": "boolean",
                "description": "True when phonePersonAge is 18 or more, or, without a date of birth, when a name was returned."
              },
              "additionalProfiles": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/PhoneProfileAdditionalProfileResponse"
                }
              },
              "reasonCodes": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        ]
      },
      "EkycVerificationRequest": {
        "type": "object",
        "properties": {
          "plugins": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "kyc"
              ]
            }
          },
          "firstName": {
            "type": "string",
            "description": "The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;|=`",
            "example": "Jon"
          },
          "surName": {
            "type": "string",
            "description": "The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;|=`",
            "example": "Hasselhoff"
          },
          "middleName": {
            "type": "string",
            "description": "The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;|=`",
            "example": "Michael"
          },
          "maternalSurname": {
            "type": "string",
            "description": "The following special characters are not supported: `^±!@£$%&*_+¡€#¢§¶•ªº«<>?\\/:;|=`",
            "example": "Ronaldo"
          },
          "email": {
            "type": "string",
            "example": "david.hasselhoff@email.com"
          },
          "street": {
            "type": "string",
            "example": 101
          },
          "streetNo": {
            "type": "string",
            "example": 101
          },
          "floor": {
            "type": "string",
            "example": 1
          },
          "apartment": {
            "type": "string",
            "example": 6
          },
          "postalCode": {
            "type": "string",
            "example": 90210
          },
          "countryCode": {
            "type": "string",
            "description": "ISO 3166-1 alpha-2 format",
            "example": "US"
          },
          "phone": {
            "type": "string",
            "description": "Use E.164 format. Hyphens are optional",
            "example": "+14156067603"
          },
          "state": {
            "type": "string",
            "example": "CA"
          },
          "city": {
            "type": "string",
            "example": "Beverly Hills"
          },
          "idNumber": {
            "type": "string",
            "example": 123456789
          },
          "idNumber1": {
            "type": "string",
            "example": 123456789
          },
          "idNum": {
            "type": "string",
            "description": "Brazilian CPF number for BR_TAX_PHONE_REGISTER (IDmerit BR1)",
            "example": 12345678909
          },
          "gender": {
            "type": "string",
            "example": "F"
          },
          "taxId": {
            "type": "string",
            "example": 123456789
          },
          "dateOfBirth": {
            "type": "string",
            "format": "YYYY-MM-DD",
            "example": "1980-06-01"
          },
          "dlExpireAt": {
            "type": "string",
            "format": "YYYY-MM-DD",
            "example": "2024-04-04"
          },
          "fullName": {
            "type": "string",
            "example": "Jon Hasselhoff"
          },
          "panNumber": {
            "type": "string",
            "description": "Indian Permanent Account Number (PAN), format: AAAAANNNNA",
            "example": "ABCPM1234D"
          },
          "district": {
            "type": "string",
            "description": "District or Barangay (neighbourhood), used for Philippines KYC",
            "example": "Tangil"
          },
          "idType": {
            "type": "string",
            "description": "National ID type. Supported for Philippines KYC: SSS, TIN, GSIS",
            "example": "SSS"
          },
          "issueDate": {
            "type": "string",
            "format": "YYYY-MM-DD",
            "description": "ID document issue date. Required for Colombia Civil Register (CO_CIVIL_REGISTER_1) KYC",
            "example": "1991-08-02"
          },
          "fileNumber": {
            "type": "string",
            "description": "Indian passport file number (PRFN), format: 2 letters followed by 13 digits",
            "example": "BO3072344560818"
          },
          "dateOfIssue": {
            "type": "string",
            "format": "YYYY-MM-DD",
            "description": "Passport issue date, used for INDIA_PASSPORT_1 KYC",
            "example": "2018-05-14"
          }
        }
      },
      "UnifiedEkycRequest": {
        "type": "object",
        "properties": {
          "start": {
            "$ref": "#/components/schemas/StartRequest",
            "description": "Fields used to initialize the onboarding session (same shape as /omni/start)."
          },
          "ekyc": {
            "$ref": "#/components/schemas/EkycVerificationRequest",
            "description": "Fields used for the eKYC verification (same shape as /omni/externalVerification/ekyc)."
          },
          "finishAsync": {
            "type": "boolean",
            "description": "When true (default), finish-session runs asynchronously after the response is sent."
          }
        },
        "required": [
          "ekyc",
          "start"
        ]
      },
      "UnifiedEkycResponse": {
        "type": "object",
        "properties": {
          "interviewId": {
            "type": "string",
            "description": "Identifier of the onboarding session created by /start."
          },
          "token": {
            "type": "string",
            "description": "JWT token for subsequent calls (X-Incode-Hardware-Id header)."
          },
          "interviewCode": {
            "type": "string",
            "description": "Short onboarding code from /start."
          },
          "flowType": {
            "type": "string",
            "description": "Flow type of the configuration used.",
            "enum": [
              "configuration",
              "flow",
              "workflow"
            ]
          },
          "ekyc": {
            "$ref": "#/components/schemas/EkycVerificationResponse",
            "description": "eKYC verification result."
          },
          "ekycStatus": {
            "type": "string",
            "description": "Status of the eKYC verification: SUCCESS, TIMEOUT, or ERROR.",
            "enum": [
              "SUCCESS",
              "TIMEOUT",
              "ERROR"
            ]
          },
          "finishQueued": {
            "type": "boolean",
            "description": "True when finish-session was queued for asynchronous processing."
          }
        }
      },
      "BusinessVerificationRequestDto": {
        "type": "object",
        "properties": {
          "plugins": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "businessName": {
            "type": "string",
            "description": "Name of the business",
            "example": "Incode Technologies, Inc."
          },
          "addressLine1": {
            "type": "string",
            "description": "Address line 1 of the business",
            "example": 575
          },
          "street": {
            "type": "string",
            "description": "Street name of the business address"
          },
          "houseNo": {
            "type": "string",
            "description": "The exterior number of the business address",
            "example": 574
          },
          "addressLine2": {
            "type": "string",
            "description": "Address line 2 of the business",
            "example": "Fl 4"
          },
          "city": {
            "type": "string",
            "description": "City of the business address.",
            "example": "San Francisco"
          },
          "state": {
            "type": "string",
            "description": "State or province of the business address. Send the form the local registry uses: a two-letter code for the United States, the full province name for Canada.",
            "example": "CA"
          },
          "postalCode": {
            "type": "string",
            "description": "Postal code of the business address.",
            "example": 94105
          },
          "country": {
            "type": "string",
            "description": "Two-letter country code of the business address",
            "example": "US"
          },
          "taxId": {
            "type": "string",
            "description": "The tax or company registration id of the business. Many countries require it and answer 400 when it is missing. Canada takes the Corporations Canada corporation number, a provincial registration number or the CRA business number. The United Arab Emirates takes any value that contains a letter or a digit, because each emirate and free zone issues its own format.",
            "example": 4261607
          },
          "uboName": {
            "type": "string",
            "deprecated": true,
            "description": "Ultimate Beneficial Owner name. Deprecated — use uboNames instead."
          },
          "uboNames": {
            "type": "array",
            "description": "Ultimate Beneficial Owners names",
            "example": [
              "John Smith",
              "Jane Smith"
            ],
            "items": {
              "type": "string"
            }
          },
          "directors": {
            "type": "array",
            "description": "Names of the directors of the business",
            "example": [
              "John Smith",
              "Jane Smith"
            ],
            "items": {
              "type": "string"
            }
          }
        }
      },
      "EkybSourceInfo": {
        "type": "object",
        "properties": {
          "uboNames": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UboName"
            }
          }
        }
      },
      "EkybVerification": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "The name of test"
          },
          "status": {
            "type": "string",
            "description": "Whether the test ows passed."
          },
          "sub_label": {
            "type": "string",
            "description": "Additional info on the status."
          },
          "message": {
            "type": "string",
            "description": "Human readable description of the status."
          },
          "reasonCodes": {
            "type": "array",
            "description": "Machine-readable qualifiers for this check, present only when the provider had something to qualify. The \"tin\" entry carries \"Tax ID was not found.\" when the vendor returned no company matching the supplied identifier, REGNO or VATNO on the providers that resolve through a named identifier class, and REGISTRY_RECORD_NOT_VERIFIED when the provider matched a company but reports the registry record behind it as one it could not verify. The \"ubo_name_match\" entry carries NO_SHAREHOLDER_DATA, and \"directors_name_match\" carries NO_DIRECTOR_DATA, when the provider returned no usable records to compare against; on those two keys the field is absent when a comparison actually ran. An \"Unverified\" sub_label accompanied by a no-data code means the check could not be performed, rather than that it was performed and failed. New codes may be added over time, so treat unrecognised values as informational.",
            "example": [
              "NO_SHAREHOLDER_DATA"
            ],
            "items": {
              "type": "string"
            }
          },
          "uboName_input": {
            "type": "string",
            "description": "The beneficial owner name from the request that this \"ubo_name_match\" entry reports on, copied back unchanged. Most providers return one entry per name supplied in uboNames and set this field. In the United States there is at most one entry, which reports on the first name only, and this field is absent.",
            "example": "Sample Holding Company"
          },
          "directorsName_input": {
            "type": "string",
            "description": "The director name from the request that this \"directors_name_match\" entry reports on, copied back unchanged. The providers that return this key return one entry per name supplied in directors and set this field.",
            "example": "Sample Director"
          },
          "entityType": {
            "$ref": "#/components/schemas/EntityTypeInfo",
            "description": "Carried by the \"entityType\" entry instead of sub_label: the legal entity type for the matched company, or \"Unknown\" when none could be determined. Most providers pass through the value the source reports, so the wording is not drawn from a fixed set. For Mexico the value is derived by Incode from the legal-name suffix."
          }
        }
      },
      "EkybVerificationResponse": {
        "type": "object",
        "properties": {
          "kyb": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EkybVerification"
            }
          },
          "kybSource": {
            "$ref": "#/components/schemas/EkybSourceInfo"
          },
          "businessClassification": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EkybVerification"
            }
          },
          "status": {
            "type": "string",
            "description": "Only present on a 202 async dispatch: PENDING until the verification finishes and the result is delivered via the EKYB_VERIFICATION_RESULT webhook.",
            "enum": [
              "PENDING",
              "COMPLETED",
              "FAILED"
            ]
          },
          "referenceId": {
            "type": "string",
            "description": "Only present on a 202 async dispatch: id correlating the webhook notification and the result-poll endpoint with this request."
          }
        }
      },
      "EntityTypeInfo": {
        "type": "object",
        "properties": {
          "entityType": {
            "type": "string",
            "description": "Legal entity type for the matched company, or \"Unknown\" when none could be determined. Most providers pass through the value the source reports; for Mexico it is derived by Incode from the legal-name suffix.",
            "example": "Business Corporation"
          }
        }
      },
      "UboName": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "uboName": {
            "type": "string"
          }
        }
      },
      "ExpireInterviewConfigurationDto": {
        "type": "object",
        "properties": {
          "expirationConditions": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "INCOMPLETE",
                "NEEDS_REVIEW"
              ]
            }
          }
        },
        "required": [
          "expirationConditions"
        ]
      },
      "ExpireInterviewDto": {
        "type": "object",
        "properties": {
          "interviewIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1
          },
          "cleanerConfiguration": {
            "$ref": "#/components/schemas/ExpireInterviewConfigurationDto",
            "description": "Configuration for expiring interview"
          }
        }
      },
      "EmailRequest": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "User's email. Has to be in valid format.",
            "example": "john.doe@example.com",
            "minLength": 1
          }
        }
      },
      "BehavioralStatsRequest": {
        "type": "object",
        "properties": {
          "inspectorOpened": {
            "type": "boolean",
            "description": "Flag indicating web browser inspector detected",
            "example": true
          },
          "frontIdStatsAnalysisStatus": {
            "type": "string",
            "description": "Status of the front ID capture analysis",
            "enum": [
              "PASS",
              "UNCLEAR",
              "FAIL"
            ],
            "example": "PASS"
          },
          "backIdStatsAnalysisStatus": {
            "type": "string",
            "description": "Status of the back ID capture analysis",
            "enum": [
              "PASS",
              "UNCLEAR",
              "FAIL"
            ],
            "example": "PASS"
          },
          "selfieStatsAnalysisStatus": {
            "type": "string",
            "description": "Status of the selfie ID capture analysis",
            "enum": [
              "PASS",
              "UNCLEAR",
              "FAIL"
            ],
            "example": "PASS"
          },
          "motionStatus": {
            "type": "string",
            "description": "Status of motion analysis",
            "enum": [
              "PASS",
              "UNCLEAR",
              "FAIL"
            ],
            "example": "PASS"
          },
          "virtualCameraDetected": {
            "type": "boolean",
            "description": "Flag indicating virtual camera was detected",
            "example": true
          },
          "cameraLabelInspectionStatus": {
            "type": "string",
            "description": "Status of the camera label inspection",
            "enum": [
              "PASS",
              "UNCLEAR",
              "FAIL"
            ],
            "example": "PASS"
          }
        }
      },
      "CleanerConfigurationDto": {
        "type": "object",
        "properties": {
          "deletePiiFieldsOnly": {
            "type": "boolean",
            "default": "false",
            "description": "Flag indicating if this is partial delete, where only PII fields should be removed."
          },
          "piiFieldsToKeep": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "keepEnrolledUser": {
            "type": "boolean",
            "default": "false",
            "description": "Flag indicating if user that was previously enrolled from this session should stay enrolled in the system after this session is deleted"
          },
          "keepTemplates": {
            "type": "boolean",
            "default": "false",
            "description": "Flag indicating if face templates created during onboarding process, should remain in DB"
          },
          "keepImages": {
            "type": "boolean",
            "default": "false",
            "description": "Flag indicating if images captured during onboarding process should remain in the system"
          },
          "keepDeviceFingerprints": {
            "type": "boolean",
            "default": "false",
            "description": "Flag indicating if device fingerprint stored during onboarding process should remain in the system"
          },
          "keepEvents": {
            "type": "boolean",
            "default": "false",
            "description": "Flag indicating if events stored during onboarding process should remain in the system"
          },
          "keepValidationTests": {
            "type": "boolean",
            "default": "false",
            "description": "Flag indicating if validation tests stored during onboarding process should remain in the system"
          },
          "keepVideoArchives": {
            "type": "boolean",
            "default": "false",
            "description": "Flag indicating if video archives stored during onboarding process should remain in the system"
          },
          "keepConferenceEvents": {
            "type": "boolean",
            "default": "false",
            "description": "Flag indicating if events stored during conference video call should remain in the system"
          },
          "keepChats": {
            "type": "boolean",
            "default": "false",
            "description": "Flag indicating if chat stored during conference video call should remain in the system"
          },
          "keepStats": {
            "type": "boolean",
            "default": "false",
            "description": "Flag indicating if statistics stored during onboarding process should remain in the system"
          },
          "deletionMode": {
            "type": "string",
            "description": "Specifies the type of deletion to perform.",
            "enum": [
              "BIOMETRICS",
              "PII",
              "FULL"
            ],
            "example": "FULL"
          }
        }
      },
      "InterviewCleanupRequest": {
        "type": "object",
        "properties": {
          "interviewIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1
          },
          "cleanerConfiguration": {
            "$ref": "#/components/schemas/CleanerConfigurationDto"
          }
        }
      },
      "MdlIssuanceRequestDto": {
        "type": "object",
        "properties": {
          "devicePublicKey": {
            "type": "string",
            "description": "Holder device public key as Base64 (standard) X.509 SubjectPublicKeyInfo DER, EC P-256.",
            "minLength": 1
          }
        }
      },
      "MdlIssuanceResponseDto": {
        "type": "object",
        "properties": {
          "docType": {
            "type": "string",
            "description": "mdoc docType, e.g. org.iso.18013.5.1.mDL."
          },
          "issuerSigned": {
            "type": "string",
            "description": "Base64 (standard) of the CBOR-encoded IssuerSigned (nameSpaces + issuerAuth)."
          },
          "expiresAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the mDL stops being valid (MSO validityInfo.validUntil)."
          }
        }
      },
      "ReportIssueRequest": {
        "type": "object",
        "properties": {
          "interviewId": {
            "type": "string",
            "description": "Interview ID for which issue is reported.",
            "example": "5ec3e2f99bc2710011fba979",
            "minLength": 1
          },
          "opentokSessionId": {
            "type": "string",
            "description": "Opentok session ID of current video conference.",
            "example": "T1==cGFydG5lcl9pZD00NjEzNTg2MiZzaWc9ZjBkMzE5N2I2Y2NkMjFmMmFhNWYzZGQ1OWQ0ZTEzYmQzYTAxYzM2MjpzZXNzaW9"
          },
          "details": {
            "type": "string",
            "description": "Any description that Opentok sends.",
            "example": "Subscriber's stream has been interrupted"
          }
        },
        "required": [
          "details",
          "interviewId",
          "opentokSessionId"
        ]
      },
      "ConfStoreRequest": {
        "type": "object",
        "properties": {
          "base64Image": {
            "type": "string",
            "description": "Base64 string representation of the image.",
            "example": "/9j/4AAQSkZJRgABAQABLn0kvWaa6Dxv7Kk9Z89nveU+mjuQKB29EWOavLyBDr7nL...",
            "minLength": 1
          },
          "interviewId": {
            "type": "string",
            "description": "ID of interview.",
            "example": "5c10c728c7a29d001536ad13"
          },
          "origin": {
            "type": "string",
            "description": "This parameter indicates which type of photo is taken",
            "enum": [
              "selfie",
              "front",
              "back",
              "poa"
            ]
          }
        },
        "required": [
          "origin"
        ]
      },
      "ConferenceEvent": {
        "type": "object",
        "properties": {
          "get_version": {
            "type": "integer",
            "format": "int64"
          },
          "interviewId": {
            "type": "string",
            "description": "Interview ID for which event is reported.",
            "example": "5ec3e2f99bc2710011fba979"
          },
          "opentokSessionId": {
            "type": "string",
            "description": "Opentok session ID of current video conference.",
            "example": "T1==cGFydG5lcl9pZD00NjEzNTg2MiZzaWc9ZjBkMzE5N2I2Y2NkMjFmMmFhNWYzZGQ1OWQ0ZTEzYmQzYTAxYzM2MjpzZXNzaW9"
          },
          "eventType": {
            "type": "string",
            "description": "Opentok event type. Could be anything that Opentok sends, e.g. StreamDisconnected, StreamReconnected, VideoDisabled, VideoEnabled...",
            "example": "StreamDisconnected"
          },
          "details": {
            "type": "string",
            "description": "Any description that Opentok sends.",
            "example": "Subscriber's stream has been interrupted"
          },
          "eventSource": {
            "type": "string",
            "description": "Indicate event caught on customer or executive side.",
            "enum": [
              "customer",
              "executive"
            ],
            "example": "executive"
          }
        },
        "required": [
          "eventSource",
          "eventType",
          "interviewId",
          "opentokSessionId"
        ]
      },
      "VerifyInterviewCodeRequest": {
        "type": "object",
        "properties": {
          "interviewCode": {
            "type": "string",
            "description": "Interview code to be verified against given session.",
            "example": "C8Z38D",
            "maxLength": 6,
            "minLength": 1
          }
        }
      },
      "ChatDto": {
        "type": "object",
        "properties": {
          "date": {
            "type": "integer",
            "format": "int64",
            "description": "UTC timestamp."
          },
          "body": {
            "type": "string",
            "description": "Single message in chat.",
            "minLength": 1
          },
          "author": {
            "type": "string",
            "description": "Author of the message.",
            "enum": [
              "user",
              "interviewer"
            ],
            "minLength": 1
          }
        },
        "required": [
          "body",
          "date"
        ]
      },
      "ChatRequest": {
        "type": "object",
        "properties": {
          "interviewId": {
            "type": "string",
            "description": "Interview id.",
            "minLength": 1
          },
          "chat": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ChatDto"
            },
            "minItems": 1
          }
        },
        "required": [
          "chat"
        ]
      },
      "CalculateContractNom151SignatureRequest": {
        "type": "object",
        "properties": {
          "includeSignedDocumentInResponse": {
            "type": "boolean",
            "description": "Includes the signed document in base64 in response"
          },
          "includeCertificateDetailsInResponse": {
            "type": "boolean",
            "description": "Includes the signed document with the Nom 151 signature attached in the pdf in the response"
          },
          "signedContractId": {
            "type": "string",
            "description": "The id of the already signed contract",
            "example": "cf74e1be-e1bf-4708-9e0e-3b43a8313f85#contract1"
          }
        },
        "required": [
          "signedContractId"
        ]
      },
      "ExtendedResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "additionalInformation": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          }
        }
      },
      "BatchAuthStatsRequest": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/QRScanAttempt"
            }
          }
        }
      },
      "QRScanAttempt": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Identity (customer) id."
          },
          "photo": {
            "type": "string",
            "description": "Base64 of photo."
          },
          "confidence": {
            "type": "number",
            "format": "float",
            "description": "Match confidence."
          },
          "timestamp": {
            "type": "integer",
            "format": "int64",
            "description": "Timestamp"
          },
          "sourceId": {
            "type": "string",
            "description": "Source identifier of batch of authentications"
          },
          "deviceId": {
            "type": "string",
            "description": "User device id"
          },
          "reasonCodes": {
            "type": "array",
            "description": "Reason codes",
            "items": {
              "type": "string"
            }
          },
          "blocked": {
            "type": "boolean",
            "description": "Flag indicating if user is on a blocklist"
          },
          "blocklistConfidence": {
            "type": "number",
            "format": "float",
            "description": "Confidence score related to block list"
          },
          "matchedWatchlistId": {
            "type": "string",
            "description": "Id of the matched watchlist entry when blocklist validation exceeds the confidence threshold"
          }
        }
      },
      "FraudCandidateRequestB2BDto": {
        "type": "object",
        "properties": {
          "sourceEntityId": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          },
          "comment": {
            "type": "string"
          }
        }
      },
      "AuthVerificationRequestDTO": {
        "type": "object",
        "properties": {
          "transactionId": {
            "type": "string",
            "minLength": 1
          },
          "token": {
            "type": "string",
            "minLength": 1
          },
          "interviewToken": {
            "type": "string"
          },
          "customerId": {
            "type": "string"
          }
        }
      },
      "AuthVerificationResponseDTO": {
        "type": "object",
        "properties": {
          "verified": {
            "type": "boolean"
          },
          "reason": {
            "type": "integer",
            "format": "int32"
          },
          "customerId": {
            "type": "string"
          }
        }
      },
      "AttachStampOnAnnotationRequest": {
        "type": "object",
        "properties": {
          "contractId": {
            "type": "string",
            "description": " IDs of previously added contract (ID is returned on /add/document?imageType=contract"
          },
          "customFields": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Use to add substitute text for stamps with asterisk\n\nEg: `{ \"contractId\": \"e81cd044-98fd-47b0-b0c5-937b22b69977#contract1\", \"customFields\": { \"SECOND_NAME\": \"Luke Skywalker\" } }`\n"
          }
        },
        "required": [
          "contractId"
        ]
      },
      "AttachSignatureV2Request": {
        "type": "object",
        "properties": {
          "signaturePositionsOnContracts": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/SignaturePosition"
              }
            }
          },
          "includeSignedDocumentInResponse": {
            "type": "boolean",
            "description": "Includes the signed document in base64 in response."
          },
          "includeNom151SignatureInResponse": {
            "type": "boolean",
            "description": "Includes the Nom 151 signature of the signed document in the response."
          },
          "includeSignedDocumentWithNom151InResponse": {
            "type": "boolean",
            "description": "Includes the signed document with the Nom 151 signature attached in the pdf in the response."
          },
          "includeCertificateDetailsInResponse": {
            "type": "boolean",
            "description": "Include the certificate details with which the Nom151 signature was created."
          }
        }
      },
      "SignaturePosition": {
        "type": "object",
        "properties": {
          "x": {
            "type": "integer",
            "format": "int32",
            "description": "The x axis where to place the signature image (from the left bottom corner of page)."
          },
          "y": {
            "type": "integer",
            "format": "int32",
            "description": "The y axis where to place the signature image (from the left bottom corner of page)."
          },
          "height": {
            "type": "integer",
            "format": "int32",
            "description": "Height of the image when placed in the pdf, keeps aspect ratio."
          },
          "pageNumber": {
            "type": "integer",
            "format": "int32",
            "description": "Number of page on which to put the signature image (pages numbering start from 1, default value is 1)."
          },
          "orientation": {
            "type": "string",
            "description": "Counterclockwise rotation of the signature in degrees",
            "enum": [
              "ORIENTATION_NORMAL",
              "ORIENTATION_90_DEGREE",
              "ORIENTATION_180_DEGREE",
              "ORIENTATION_270_DEGREE"
            ]
          }
        },
        "required": [
          "height",
          "pageNumber",
          "x",
          "y"
        ]
      },
      "AttachSignatureOnAnnotationRequest": {
        "type": "object",
        "example": {
          "contractId": "e81cd044-98fd-47b0-b0c5-937b22b69977#contract1",
          "signatureType": "PATIENTS_SIGNATURE"
        },
        "properties": {
          "contractId": {
            "type": "string",
            "description": "IDs of previously added contract (ID is returned on /add/document?imageType=contract)"
          },
          "signedContractId": {
            "type": "string",
            "description": "IDs of previously signed contract (ID is returned as response from the previous /attach/signature/on/annotation)"
          },
          "signatureType": {
            "type": "string",
            "description": "One of the preselected values for annotation text",
            "enum": [
              "DEFAULT",
              "INITIALS",
              "PATIENTS_SIGNATURE",
              "NON_MEDICAL_SIGNATURE_1",
              "NON_MEDICAL_SIGNATURE_2",
              "MEDICAL_SIGNATURE_1",
              "MEDICAL_SIGNATURE_2",
              "MEDICAL_SIGNATURE_3",
              "PATIENTS_SIGNATURE_NAME",
              "NON_MEDICAL_SIGNATURE_1_NAME",
              "NON_MEDICAL_SIGNATURE_2_NAME",
              "MEDICAL_SIGNATURE_1_NAME",
              "MEDICAL_SIGNATURE_2_NAME"
            ]
          },
          "alternativeSignatureType": {
            "type": "string",
            "description": "If annotation text is none of the preselected values, pass in here the alternative value (signature must be inserted\nwith the alternative value into database as it's signature type)\n"
          }
        },
        "required": [
          "contractId"
        ]
      },
      "InsertSessionToWatchlistRequest": {
        "type": "object",
        "properties": {
          "sessionId": {
            "type": "string"
          },
          "watchlistType": {
            "type": "string",
            "enum": [
              "WHITELIST",
              "BLACKLIST"
            ]
          },
          "recordExpiresAt": {
            "type": "string"
          }
        }
      },
      "InsertIdentityToWatchlistRequest": {
        "type": "object",
        "properties": {
          "identityId": {
            "type": "string"
          },
          "watchlistType": {
            "type": "string",
            "enum": [
              "WHITELIST",
              "BLACKLIST"
            ]
          },
          "recordExpiresAt": {
            "type": "string"
          }
        }
      },
      "UserConsentRequest": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of the consent."
          },
          "content": {
            "type": "string",
            "description": "Text content."
          },
          "status": {
            "type": "boolean",
            "description": "Status"
          }
        }
      },
      "Base64ImageOrImgUrlRequest": {
        "type": "object",
        "properties": {
          "base64Image": {
            "type": "string",
            "description": "Image in base64 format. One of base64Image or imageUrl is required",
            "example": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEB..."
          },
          "imageUrl": {
            "type": "string",
            "description": "URL of the image. One of base64Image or imageUrl is required",
            "example": "http://..."
          }
        }
      },
      "AddCurpRequest": {
        "type": "object",
        "properties": {
          "curp": {
            "type": "string",
            "description": "User's curp. Has to be in valid format. If it isn't present, then curp value from interview is used.",
            "example": "COHJ950918HCMVRS09"
          }
        }
      },
      "AddQrCodeTextRequest": {
        "type": "object",
        "properties": {
          "qrCodeText": {
            "type": "string",
            "description": "QR code raw text.",
            "example": {
              "status": "negative",
              "type": "covid-19"
            },
            "minLength": 1
          }
        }
      },
      "NameRequest": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "User's name.",
            "example": "John Doe",
            "minLength": 1
          }
        }
      },
      "ReverseGeolocationRequest": {
        "type": "object",
        "properties": {
          "longitude": {
            "type": "number",
            "format": "float",
            "description": "User's geolocation longitude",
            "example": 22.3456
          },
          "latitude": {
            "type": "number",
            "format": "float",
            "description": "User's geolocation latitude",
            "example": 44.56783
          },
          "location": {
            "type": "string",
            "description": "User's current location"
          },
          "madminArea": {
            "type": "string"
          },
          "msubAdminArea": {
            "type": "string"
          },
          "mlocality": {
            "type": "string"
          },
          "msubLocality": {
            "type": "string"
          },
          "mthoroughfare": {
            "type": "string"
          },
          "msubThoroughfare": {
            "type": "string"
          },
          "mpostalCode": {
            "type": "string"
          },
          "mcountryCode": {
            "type": "string"
          },
          "mcountryName": {
            "type": "string"
          }
        },
        "required": [
          "latitude",
          "longitude"
        ]
      },
      "IdCaptureV2Request": {
        "type": "object",
        "properties": {
          "base64Image": {
            "type": "string",
            "description": "Image in base64 format. One of base64Image or imageUrl is required",
            "example": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEB..."
          },
          "imageUrl": {
            "type": "string",
            "description": "URL of the image. One of base64Image or imageUrl is required",
            "example": "http://..."
          }
        }
      },
      "AddIdResponse": {
        "type": "object",
        "properties": {
          "correctSharpness": {
            "type": "boolean",
            "description": "It's true if the sharpness of the ID meets the requirements."
          },
          "correctGlare": {
            "type": "boolean",
            "description": "It's true if the glare of the ID meets the requirements."
          },
          "horizontalResolution": {
            "type": "integer",
            "format": "int32",
            "description": "Value is based on the resolution of the cropped photo. Low value means after performing the crop we have a bad quality of image. We recommend to retry capture if value is below 155."
          },
          "shadowConfidence": {
            "type": "number",
            "format": "float",
            "description": "Value 0 means it is no shadow on the image and image quality is good, while value 1 represents bad quality of image with a lot of shadow. We recommend to retry capture if value is 1.",
            "maximum": 1,
            "minimum": 0
          },
          "classification": {
            "type": "boolean",
            "description": "If true, server classified image as a front side of an id. If false, server failed to classify image as valid front side of an id or passport and other parameters can be ignored."
          },
          "readability": {
            "type": "boolean",
            "description": "If true, server can properly read ID. If false server failed to read some key places of the ID."
          },
          "typeOfId": {
            "type": "string",
            "enum": [
              "Unknown",
              "Passport",
              "Visa",
              "DriversLicense",
              "IdentificationCard",
              "Permit",
              "Currency",
              "ResidenceDocument",
              "TravelDocument",
              "BirthCertificate",
              "VehicleRegistration",
              "Other",
              "WeaponLicense",
              "TribalIdentification",
              "VoterIdentification",
              "Military",
              "TaxIdentification",
              "FederalID",
              "MedicalCard"
            ]
          },
          "issueYear": {
            "type": "integer",
            "format": "int32",
            "description": "Issue year of the ID."
          },
          "issueName": {
            "type": "string",
            "description": "Description of the ID. Could contain country code, state, type of ID, subtype of ID."
          },
          "curpCheck": {
            "type": "boolean",
            "description": "Only for Mexican IDs. Flag stating if curp was properly read."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session Status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "countryCode": {
            "type": "string",
            "description": "Valid ISO alpha-2 or alpha-3 code of the ID issuing country."
          },
          "state": {
            "type": "string",
            "description": "Issuing state of the ID."
          },
          "failReason": {
            "type": "string",
            "description": "Classification fail reason",
            "enum": [
              "UNKNOWN_DOCUMENT_TYPE",
              "WRONG_DOCUMENT_SIDE",
              "WRONG_ONE_SIDED_DOCUMENT",
              "UNFOLDED_DOCUMENT_PAGE_MISMATCH",
              "WRONG_UNFOLDED_DOCUMENT",
              "DOCUMENT_NOT_READABLE",
              "UNABLE_TO_ALIGN_DOCUMENT",
              "ID_TYPE_UNACCEPTABLE",
              "UNEXPECTED_ERROR_OCCURRED",
              "DIGITAL_ID_REQUESTED_BUT_OTHER_PROVIDED"
            ]
          },
          "skipBackIdCapture": {
            "type": "boolean",
            "description": "Flag that signals if back id capture should be skipped or not."
          },
          "forceFrontIdCapture": {
            "type": "boolean",
            "description": "Flag that signals if front id capture must be executed after back."
          },
          "showMandatoryConsent": {
            "type": "boolean",
            "description": "Render mandatory consent page based on this parameter value."
          },
          "regulationType": {
            "type": "string",
            "description": "Regulation type for the mandatory consent (only if showMandatoryConsent set to true)."
          },
          "skipGlareFront": {
            "type": "boolean",
            "description": "Flag that signals if front side glare should be ignored."
          },
          "skipGlareBack": {
            "type": "boolean",
            "description": "Flag that signals if back side glare should be ignored."
          },
          "documentIsOnTheEdge": {
            "type": "boolean",
            "description": "Flag that signals if document is on the edge on the full frame image."
          },
          "acceptedDocuments": {
            "type": "array",
            "description": "List of accepted documents for that particular country in case of ID_TYPE_UNACCEPTABLE failReason.",
            "items": {
              "type": "string",
              "enum": [
                "Unknown",
                "Passport",
                "Visa",
                "DriversLicense",
                "IdentificationCard",
                "Permit",
                "Currency",
                "ResidenceDocument",
                "TravelDocument",
                "BirthCertificate",
                "VehicleRegistration",
                "Other",
                "WeaponLicense",
                "TribalIdentification",
                "VoterIdentification",
                "Military",
                "TaxIdentification",
                "FederalID",
                "MedicalCard"
              ]
            },
            "uniqueItems": true
          },
          "imageRedacted": {
            "type": "boolean",
            "description": "Flag that signals if image was redacted as part of the ID capture."
          },
          "idFaceExtractionSkipped": {
            "type": "boolean",
            "description": "True when biometric face extraction from the front ID was skipped because the client passed extractIdFace=false. While this flag is true, face-match flows that require an ID-side template cannot run; the flag is cleared on a subsequent add/front-id call where extractIdFace is true (or omitted)."
          },
          "captureAttemptsLimit": {
            "$ref": "#/components/schemas/CaptureAttemptsLimitDto",
            "description": "Checked only if configured in the session flow."
          },
          "idQualityAttemptApproved": {
            "type": "boolean",
            "description": "ID quality check result based on ML readability estimation. True if perFieldReadability >= 0.9, false otherwise."
          },
          "isDocumentExpired": {
            "type": "boolean",
            "description": "Flag indicating if the document side is expired."
          },
          "attemptId": {
            "type": "string",
            "description": "Created attempt id."
          },
          "nfc": {
            "$ref": "#/components/schemas/NfcCapabilityHint",
            "description": "NFC chip capability of the classified document, so the SDK can skip an NFC step that cannot succeed. Present only when NFC smart gating is enabled for the organization."
          }
        }
      },
      "NfcCapabilityHint": {
        "type": "object",
        "properties": {
          "capability": {
            "type": "string",
            "description": "NO_CHIP or ISSUER_NOT_TRUSTED: skip the NFC step. SUPPORTED or UNKNOWN: run it.",
            "enum": [
              "SUPPORTED",
              "NO_CHIP",
              "ISSUER_NOT_TRUSTED",
              "UNKNOWN"
            ]
          },
          "chipLocation": {
            "type": "string",
            "description": "Where the chip sits: FRONT, BACK, DATA_PAGE, INLAY or UNKNOWN. Present only when the NFC step runs.",
            "enum": [
              "FRONT",
              "BACK",
              "DATA_PAGE",
              "INLAY",
              "UNKNOWN"
            ]
          }
        }
      },
      "AddFiscalQrUrlRequest": {
        "type": "object",
        "properties": {
          "poaUrl": {
            "type": "string"
          }
        }
      },
      "AddFaceRequest": {
        "type": "object",
        "properties": {
          "base64Image": {
            "type": "string",
            "description": "Image of user's face represented in base64.",
            "example": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEB..."
          },
          "imageUrl": {
            "type": "string",
            "description": "URL of face image, required to belong to a whitelisted domain",
            "example": "https://..."
          },
          "faceCoordinates": {
            "$ref": "#/components/schemas/FaceCoordinatesDto",
            "description": "Face coordinates"
          }
        }
      },
      "AddFaceResponse": {
        "type": "object",
        "properties": {
          "age": {
            "type": "integer",
            "format": "int32",
            "description": "Age of th person in the photo."
          },
          "isBright": {
            "type": "boolean",
            "description": "We recommend capturing another photo if value is false."
          },
          "confidence": {
            "type": "number",
            "format": "float",
            "description": "Value 0 means that person on photo is alive. We recommend capturing another photo if value is 1.",
            "maximum": 1,
            "minimum": 0
          },
          "hasLenses": {
            "type": "boolean",
            "description": "We recommend capturing another photo if value is true."
          },
          "hasFaceMask": {
            "type": "boolean",
            "description": "Checked only if configured in the session flow. We recommend capturing another photo if value is true."
          },
          "hasClosedEyes": {
            "type": "boolean",
            "description": "Checked only if configured in the session flow. We recommend capturing another photo if value is true."
          },
          "hasHeadCover": {
            "type": "boolean",
            "description": "Checked only if configured in the session flow. We recommend capturing another photo if value is true."
          },
          "faceOccluded": {
            "type": "boolean",
            "description": "Checked only if configured in the session flow. We recommend capturing another photo if value is true."
          },
          "sessionStatus": {
            "type": "string",
            "description": "SessionStatus",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "captureAttemptsLimit": {
            "$ref": "#/components/schemas/CaptureAttemptsLimitDto",
            "description": "Checked only if configured in the session flow."
          }
        }
      },
      "DocumentIdentifierRequest": {
        "type": "object",
        "properties": {
          "documentIdentifier": {
            "type": "string",
            "description": "Document id.",
            "example": 123456789,
            "minLength": 1
          }
        }
      },
      "DiagnosticsEnvelopeRequest": {
        "type": "object",
        "properties": {
          "version": {
            "type": "integer",
            "format": "int32",
            "description": "Envelope format version"
          },
          "alg": {
            "type": "string",
            "description": "Encryption algorithm",
            "example": "A256GCM"
          },
          "compression": {
            "type": "string",
            "description": "Compression algorithm",
            "example": "gzip"
          },
          "kid": {
            "type": "string",
            "description": "Key identifier",
            "example": "truesight-v1"
          },
          "iv": {
            "type": "string",
            "description": "Initialization vector (Base64)",
            "minLength": 1
          },
          "ciphertext": {
            "type": "string",
            "description": "Encrypted diagnostics payload (Base64)",
            "minLength": 1
          },
          "tag": {
            "type": "string",
            "description": "Authentication tag (Base64)",
            "minLength": 1
          }
        }
      },
      "DiagnosticsResponse": {
        "type": "object",
        "properties": {
          "forwarded": {
            "type": "boolean",
            "description": "True when the diagnostics envelope was forwarded to TrueSight. False when diagnostics ingest is not enabled in this environment."
          }
        }
      },
      "DeviceFingerprintSignalsRequest": {
        "type": "object",
        "properties": {
          "metadata": {
            "type": "string",
            "description": "HMAC-signed Base64-encoded metadata blob.\nFormat: <hmac>.<base64-encoded-json>.\nInner JSON shape: DeviceFingerprintSignalsMetadataDto\n(fields: timestamp, signalsType, payload, sdkPlatform, sdkVersion, signalsVersion).\nServer verifies HMAC via the service-configured `hmac_key` and rejects expired/replayed\nsignatures based on the per-tenant CaptureMetadataConfig timestamp threshold.",
            "example": "abc123def.eyJ0aW1lc3RhbXAiOjE3NDI0NzUxNTE0MTgsLi4ufQ==",
            "minLength": 1
          },
          "interviewEvent": {
            "type": "string",
            "description": "Frontend interview-event code categorizing these signals; resolved against the\ninterview-event dictionary (must be a FRONTEND-sender code, e.g. \"captureAttemptFinished\").",
            "example": "captureAttemptFinished",
            "minLength": 1
          },
          "deviceHashRequested": {
            "type": "boolean",
            "description": "For PID signals: return the device hash in the response, so the SDK can send it to\n/omni/add/device-fingerprint. The signal then stores no device fingerprint of its own.",
            "example": true
          }
        },
        "required": [
          "interviewEvent",
          "metadata"
        ]
      },
      "DeviceFingerprintSignalsResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "deviceHash": {
            "type": "string",
            "description": "Device hash from the PID signal, returned only when the request sets deviceHashRequested."
          },
          "algorithmName": {
            "type": "string",
            "description": "Name of the algorithm that produced deviceHash."
          },
          "algorithmVersion": {
            "type": "string",
            "description": "Version of the algorithm that produced deviceHash."
          }
        }
      },
      "DeviceFingerprintRequest": {
        "type": "object",
        "properties": {
          "deviceType": {
            "type": "string",
            "description": "Platform of device",
            "enum": [
              "IOS",
              "ANDROID",
              "WEBAPP"
            ],
            "example": "IOS"
          },
          "hash": {
            "type": "string",
            "description": "Hash code of the device fingerprint",
            "example": "42ecaaf4a16e626gt",
            "maxLength": 255,
            "minLength": 0
          },
          "ip": {
            "type": "string",
            "description": "IP address of the device",
            "example": "0.0.0.0",
            "maxLength": 45,
            "minLength": 0
          },
          "ipLocation": {
            "$ref": "#/components/schemas/IpLocationDto",
            "description": "Location info based on IP address"
          },
          "data": {
            "type": "string",
            "description": "Additional data about device",
            "example": [
              {
                "key": "userAgent",
                "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 11_0 like Mac OS X) AppleWebKit/604.1.38 (KHTML, like Gecko) Version/11.0 Mobile/15A372 Safari/604.1"
              }
            ],
            "maxLength": 1024,
            "minLength": 0
          },
          "osVersion": {
            "type": "string",
            "description": "OS version. If omitted it is parsed from user agent",
            "example": "iOS 14",
            "maxLength": 255,
            "minLength": 0
          },
          "deviceModel": {
            "type": "string",
            "description": "Device model. If omitted it is parsed from user agent",
            "example": "iPhone 12",
            "maxLength": 255,
            "minLength": 0
          },
          "sdkVersion": {
            "type": "string",
            "description": "Version of SDK used",
            "example": 1,
            "maxLength": 255,
            "minLength": 0
          },
          "hostingApp": {
            "type": "string",
            "description": "hostingApp. Name of the hosting application",
            "example": "Onboarding",
            "maxLength": 255,
            "minLength": 0
          },
          "algorithmName": {
            "type": "string",
            "description": "Name of the fingerprinting algorithm used to produce the hash",
            "example": "fingerprintpro"
          },
          "algorithmVersion": {
            "type": "string",
            "description": "Version of the fingerprinting algorithm used to produce the hash",
            "example": "1.0.0"
          }
        },
        "required": [
          "data",
          "deviceType",
          "hash",
          "ip"
        ]
      },
      "IpLocationDto": {
        "type": "object",
        "properties": {
          "ipCountry": {
            "type": "string",
            "description": "Country from IP address",
            "example": "United States"
          },
          "ipRegion": {
            "type": "string",
            "description": "Region from IP address",
            "example": "Texas"
          },
          "ipCity": {
            "type": "string",
            "description": "City from IP address",
            "example": "Houston"
          },
          "ipLatitude": {
            "type": "number",
            "format": "double",
            "description": "Latitude from IP address",
            "example": 29.123456
          },
          "ipLongitude": {
            "type": "number",
            "format": "double",
            "description": "Longitude from IP address",
            "example": -95.123456
          }
        }
      },
      "AddDeviceFingerprintResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "ipCountry": {
            "type": "string",
            "description": "Current country based on the geolocation Api"
          },
          "ipState": {
            "type": "string",
            "description": "Current state based on the geolocation Api"
          },
          "showMandatoryConsent": {
            "type": "boolean",
            "description": "Render mandatory consent page based on this parameter value."
          },
          "regulationType": {
            "type": "string",
            "description": "Regulation type for the mandatory consent (only if showMandatoryConsent set to true)."
          }
        }
      },
      "AddNotesRequest": {
        "type": "object",
        "properties": {
          "notes": {
            "type": "string",
            "description": "Notes to save",
            "minLength": 1
          }
        }
      },
      "AddConferenceFeedback": {
        "type": "object",
        "properties": {
          "feedback": {
            "type": "string",
            "description": "Feedback to save",
            "minLength": 1
          }
        }
      },
      "AddConferenceModuleRequest": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Conference module name",
            "minLength": 1
          },
          "url": {
            "type": "string",
            "example": "https://example.com",
            "minLength": 1
          },
          "iconBase64": {
            "type": "string",
            "example": "IMAGE BASE64",
            "minLength": 1
          },
          "index": {
            "type": "string",
            "example": 1,
            "minLength": 1
          }
        }
      },
      "ConferenceConsentRequest": {
        "type": "object",
        "properties": {
          "conferenceTermAndConditionsAccepted": {
            "type": "boolean",
            "description": "User accepts terms and conditions."
          },
          "creditBureauConsentGiven": {
            "type": "boolean",
            "description": "User accepts credit bureau check."
          },
          "applicantDataConfirmed": {
            "type": "boolean",
            "description": "Executive has verified user data."
          }
        }
      },
      "BarcodeV2Request": {
        "type": "object",
        "properties": {
          "base64Barcode": {
            "type": "string",
            "description": "Barcode in base64 format.",
            "minLength": 1
          }
        }
      },
      "AddBarcodeResponseDto": {
        "type": "object",
        "properties": {
          "countryCode": {
            "type": "string",
            "description": "Valid ISO alpha-2 or alpha-3 code of the barcode issuing country."
          },
          "forceFrontIdCapture": {
            "type": "boolean",
            "description": "Flag that signals if front id capture must be executed after barcode being added."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "idValidationCompleted": {
            "type": "boolean",
            "description": "Flag that indicates whether ID validation has been completed."
          },
          "isDocumentExpired": {
            "type": "boolean",
            "description": "Flag indicating if the document is expired."
          }
        }
      },
      "BarcodeRequest": {
        "type": "object",
        "properties": {
          "rawBarcode": {
            "type": "string",
            "description": "Barcode in raw format",
            "minLength": 1
          }
        }
      },
      "OneToOneIdentifyCustomerRequestV2": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "description": "Id of previously enrolled user.",
            "example": "6ea0859301170f0016fbd985"
          },
          "externalId": {
            "type": "string",
            "description": "External ID of previously enrolled user."
          },
          "deviceFingerprintHash": {
            "type": "string",
            "description": "Device fingerprint of previously enrolled user."
          },
          "phone": {
            "type": "string",
            "description": "Phone number of previously enrolled user."
          },
          "email": {
            "type": "string",
            "description": "Email of previously enrolled user."
          },
          "nationalNumber": {
            "type": "string",
            "description": "National Number of previously enrolled user."
          },
          "authReference": {
            "type": "string",
            "description": "Reference of previously initialized authentication."
          },
          "selfie": {
            "$ref": "#/components/schemas/SelfieWithCoordinates"
          }
        }
      },
      "OneToOneIdentifyCustomerRequest": {
        "type": "object",
        "properties": {
          "uuid": {
            "type": "string",
            "description": "Id of previously enrolled user.",
            "example": "6ea0859301170f0016fbd985"
          },
          "externalId": {
            "type": "string",
            "description": "External ID of previously enrolled user."
          },
          "deviceFingerprintHash": {
            "type": "string",
            "description": "Device fingerprint of previously enrolled user."
          },
          "phone": {
            "type": "string",
            "description": "Phone number of previously enrolled user."
          },
          "email": {
            "type": "string",
            "description": "Email of previously enrolled user."
          },
          "nationalNumber": {
            "type": "string",
            "description": "National Number of previously enrolled user."
          },
          "authReference": {
            "type": "string",
            "description": "Reference of previously initialized authentication."
          },
          "selfie": {
            "$ref": "#/components/schemas/SelfieWithoutCoordinates"
          }
        }
      },
      "MatchDto": {
        "type": "object",
        "properties": {
          "origin": {
            "type": "string",
            "enum": [
              "REPORTED_BY_CLIENT",
              "REPORTED_BY_INCODE",
              "THIRD_PARTY",
              "UNKNOWN"
            ]
          },
          "reason": {
            "type": "string"
          },
          "checkType": {
            "type": "string",
            "enum": [
              "DEVICE_HASH",
              "DOCUMENT_NUMBER",
              "PERSONAL_NUMBER",
              "VOTER_NUMBER",
              "FACE",
              "FACE_ON_ID",
              "UNKNOWN"
            ]
          }
        }
      },
      "TrustGraphCategoryResultDto": {
        "type": "object",
        "properties": {
          "reasonCategory": {
            "type": "string",
            "enum": [
              "SUSPECTED_REPEAT_FRAUDSTER",
              "FIRST_PARTY_FRAUD",
              "UNUSUAL_ACTIVITY",
              "VELOCITY_CHECKS",
              "FRAUD_RINGS"
            ]
          },
          "config": {
            "$ref": "#/components/schemas/ReasonCategoryConfig"
          },
          "matches": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MatchDto"
            },
            "uniqueItems": true
          }
        }
      },
      "ReasonCategoriesResponseDto": {
        "type": "object",
        "properties": {
          "reasonsAndCategories": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/ReasonConfigDto"
              }
            }
          }
        }
      },
      "ReasonConfigDto": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "descriptions": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "GetInterviewEventsResponse": {
        "type": "object",
        "properties": {
          "events": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InterviewEventDto"
            }
          },
          "more": {
            "type": "boolean"
          },
          "interviewTotalTimeMillis": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "InterviewEventDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "timestamp": {
            "type": "integer",
            "format": "int64"
          },
          "clientTimestamp": {
            "type": "integer",
            "format": "int64"
          },
          "module": {
            "type": "string"
          },
          "screen": {
            "type": "string"
          },
          "assetUrl": {
            "type": "string"
          },
          "videoUrl": {
            "type": "string"
          },
          "payload": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          }
        }
      },
      "InterviewEventDictionaryDto": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "sender": {
            "type": "string",
            "enum": [
              "BACKEND",
              "FRONTEND"
            ]
          },
          "description": {
            "type": "string"
          },
          "locales": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Local"
            }
          }
        }
      },
      "Local": {
        "type": "object",
        "properties": {
          "locale": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "UserConsentResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Flag indicating request passed successfully."
          },
          "sessionStatus": {
            "type": "string",
            "description": "Session status",
            "enum": [
              "Alive",
              "Closed",
              "Deleted"
            ]
          },
          "title": {
            "type": "string",
            "description": "Title of the consent."
          },
          "content": {
            "type": "string",
            "description": "Text content."
          },
          "status": {
            "type": "boolean",
            "description": "Status"
          }
        }
      },
      "QuotedWeeksDto": {
        "type": "object",
        "properties": {
          "discountedWeeks": {
            "type": "integer",
            "format": "int32"
          },
          "listedWeeks": {
            "type": "integer",
            "format": "int32"
          },
          "reinstatedWeeks": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "WorkHistoryDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "curp": {
            "type": "string"
          },
          "apiKey": {
            "type": "string"
          },
          "nss": {
            "type": "string"
          },
          "quotedWeeks": {
            "$ref": "#/components/schemas/QuotedWeeksDto"
          },
          "laborHistoryList": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LaborHistory"
            }
          }
        }
      },
      "WorkHistoryResponseDto": {
        "type": "object",
        "properties": {
          "interviewId": {
            "type": "string"
          },
          "requestId": {
            "type": "string"
          },
          "workHistory": {
            "$ref": "#/components/schemas/WorkHistoryDto"
          }
        }
      },
      "FormAnswerDetailsDto": {
        "type": "object",
        "properties": {
          "singleAnswer": {
            "type": "string",
            "description": "The user's answer to the question.\n\nDate Format: Dates in responses are returned as milliseconds since the Unix epoch (UTC)\nCountry Code Format: Country codes in responses are returned using ISO 3166-1 alpha-3 format. For example, \"USA\" for the United States of America, \"GBR\" for Great Britain.\n"
          },
          "selectedAnswers": {
            "type": "array",
            "description": "Field intended to support multiple selected answers by the user. Currently, this functionality is not supported and will always return as an empty array.\n",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "FormAnswerDto": {
        "type": "object",
        "properties": {
          "question": {
            "type": "string",
            "description": "The question presented to the user"
          },
          "answerDetails": {
            "$ref": "#/components/schemas/FormAnswerDetailsDto",
            "description": "Details on user's answer"
          },
          "inputType": {
            "type": "string",
            "description": "Indicates the type of input used for the answer",
            "enum": [
              "NUMBER",
              "CPF",
              "COUNTRY",
              "NATIONALITY",
              "DATE",
              "PHONE",
              "EMAIL",
              "TEXT",
              "MULTISELECT",
              "YESNO",
              "SELECT"
            ]
          }
        }
      },
      "FormAnswersResponse": {
        "type": "object",
        "properties": {
          "answers": {
            "type": "array",
            "description": "The answers provided by the user",
            "items": {
              "$ref": "#/components/schemas/FormAnswerDto"
            }
          }
        }
      },
      "ESignedDocumentDto": {
        "type": "object",
        "properties": {
          "documentRef": {
            "type": "string"
          },
          "documentUrl": {
            "type": "string"
          },
          "qesAttemptId": {
            "type": "string"
          }
        }
      },
      "ESignedDocumentsResponse": {
        "type": "object",
        "properties": {
          "documents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ESignedDocumentDto"
            }
          },
          "total": {
            "type": "integer",
            "format": "int32"
          },
          "more": {
            "type": "boolean"
          }
        }
      },
      "ConsentCheckbox": {
        "type": "object",
        "properties": {
          "checkboxId": {
            "type": "string"
          },
          "consentText": {
            "type": "string"
          },
          "consentType": {
            "type": "string"
          },
          "origin": {
            "type": "string",
            "enum": [
              "USER",
              "SHARED"
            ]
          },
          "optional": {
            "type": "boolean"
          },
          "editable": {
            "type": "boolean"
          }
        }
      },
      "LanguageConsentDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "languageCode": {
            "type": "string",
            "enum": [
              "ps-AF",
              "sv-AX",
              "sq-AL",
              "ar-DZ",
              "en-AS",
              "ca-AD",
              "pt-AO",
              "en-AI",
              "en-AQ",
              "en-AG",
              "es-AR",
              "hy-AM",
              "nl-AW",
              "en-AU",
              "de-AT",
              "az-AZ",
              "en-BS",
              "ar-BH",
              "bn-BD",
              "en-BB",
              "be-BY",
              "nl-BE",
              "en-BZ",
              "fr-BJ",
              "en-BM",
              "dz-BT",
              "es-BO",
              "nl-BQ",
              "bs-BA",
              "en-BW",
              "no-BV",
              "pt-BR",
              "en-IO",
              "ms-BN",
              "bg-BG",
              "fr-BF",
              "rn-BI",
              "pt-CV",
              "km-KH",
              "fr-CM",
              "en-CA",
              "fr-CA",
              "en-KY",
              "fr-CF",
              "fr-TD",
              "es-CL",
              "zh-CN",
              "en-CX",
              "ms-CC",
              "es-CO",
              "ar-KM",
              "fr-CG",
              "fr-CD",
              "en-CK",
              "es-CR",
              "fr-CI",
              "hr-HR",
              "es-CU",
              "nl-CW",
              "el-CY",
              "cs-CZ",
              "da-DK",
              "fr-DJ",
              "en-DM",
              "es-DO",
              "es-EC",
              "ar-EG",
              "es-SV",
              "es-GQ",
              "aa-ER",
              "et-EE",
              "am-ET",
              "en-FK",
              "fo-FO",
              "en-FJ",
              "fi-FI",
              "fr-FR",
              "fr-GF",
              "fr-PF",
              "fr-TF",
              "fr-GA",
              "en-GM",
              "ka-GE",
              "de-DE",
              "en-GH",
              "en-GI",
              "el-GR",
              "kl-GL",
              "en-GD",
              "fr-GP",
              "en-GU",
              "es-GT",
              "en-GG",
              "fr-GN",
              "pt-GW",
              "en-GY",
              "fr-HT",
              "en-HM",
              "it-VA",
              "es-HN",
              "zh-HK",
              "hu-HU",
              "is-IS",
              "hi-IN",
              "id-ID",
              "fa-IR",
              "ar-IQ",
              "ga-IE",
              "en-IM",
              "he-IL",
              "it-IT",
              "en-JM",
              "ja-JP",
              "en-JE",
              "ar-JO",
              "kk-KZ",
              "sw-KE",
              "en-KI",
              "ko-KP",
              "ko-KR",
              "ar-KW",
              "ky-KG",
              "lo-LA",
              "lv-LV",
              "ar-LB",
              "en-LS",
              "en-LR",
              "ar-LY",
              "de-LI",
              "lt-LT",
              "fr-LU",
              "zh-MO",
              "mg-MG",
              "ny-MW",
              "ms-MY",
              "dv-MV",
              "fr-ML",
              "mt-MT",
              "mh-MH",
              "fr-MQ",
              "ar-MR",
              "en-MU",
              "fr-YT",
              "es-MX",
              "en-FM",
              "ro-MD",
              "fr-MC",
              "mn-MN",
              "sr-ME",
              "en-MS",
              "ar-MA",
              "pt-MZ",
              "my-MM",
              "en-NA",
              "na-NR",
              "ne-NP",
              "nl-NL",
              "fr-NC",
              "en-NZ",
              "es-NI",
              "fr-NE",
              "en-NG",
              "en-NU",
              "en-NF",
              "mk_MK",
              "en-MP",
              "no-NO",
              "ar-OM",
              "ur-PK",
              "en-PW",
              "ar-PS",
              "es-PA",
              "en-PG",
              "es-PY",
              "es-PE",
              "en-PH",
              "en-PN",
              "pl-PL",
              "pt-PT",
              "es-PR",
              "ar-QA",
              "fr-RE",
              "ro-RO",
              "ru-RU",
              "rw-RW",
              "fr-BL",
              "en-SH",
              "en-KN",
              "en-LC",
              "fr-MF",
              "fr-PM",
              "en-VC",
              "sm-WS",
              "it-SM",
              "pt-ST",
              "ar-SA",
              "fr-SN",
              "sr-RS",
              "en-SC",
              "en-SL",
              "en-SG",
              "nl-SX",
              "sk-SK",
              "sl-SI",
              "en-SB",
              "so-SO",
              "en-ZA",
              "en-GS",
              "en-SS",
              "es-ES",
              "si-LK",
              "ar-SD",
              "nl-SR",
              "no-SJ",
              "en-SZ",
              "sv-SE",
              "de-CH",
              "ar-SY",
              "zh-TW",
              "tg-TJ",
              "sw-TZ",
              "th-TH",
              "pt-TL",
              "fr-TG",
              "en-TK",
              "to-TO",
              "en-TT",
              "ar-TN",
              "tr-TR",
              "tk-TM",
              "en-TC",
              "tvl",
              "sw-UG",
              "uk-UA",
              "ar-AE",
              "en-GB",
              "en-US",
              "en-UM",
              "es-UY",
              "uz-UZ",
              "bi-VU",
              "es-VE",
              "vi-VN",
              "en-VG",
              "en-VI",
              "fr-WF",
              "ar-EH",
              "ar-YE",
              "en-ZM",
              "en-ZW",
              "en",
              "es",
              "pt",
              "fr",
              "de",
              "ar"
            ]
          },
          "title": {
            "type": "string"
          },
          "terms": {
            "type": "string"
          },
          "isDefault": {
            "type": "boolean"
          },
          "consents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ConsentCheckbox"
            }
          }
        }
      },
      "BusinessVerificationRequestData": {
        "type": "object",
        "properties": {
          "plugins": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "businessName": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "addressLine1": {
            "type": "string"
          },
          "street": {
            "type": "string"
          },
          "houseNo": {
            "type": "string"
          },
          "addressLine2": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "postalCode": {
            "type": "string"
          },
          "country": {
            "type": "string",
            "enum": [
              "US",
              "BR",
              "CA",
              "CN",
              "UK",
              "GB",
              "DE",
              "FR",
              "RO",
              "ES",
              "IT",
              "IL",
              "AR",
              "IE",
              "JP",
              "SE",
              "NO",
              "VN",
              "NL",
              "NG",
              "KE",
              "CM",
              "HK",
              "IN",
              "MX",
              "DK",
              "BG",
              "MT",
              "LT",
              "KM",
              "TR",
              "EG",
              "AE",
              "SA",
              "AU",
              "GR",
              "PT",
              "BE",
              "AT"
            ]
          },
          "taxId": {
            "type": "string"
          },
          "uboNames": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "directors": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "CustomerSessionIdsResponse": {
        "type": "object",
        "properties": {
          "sessionIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "count": {
            "type": "integer",
            "format": "int32"
          },
          "initialSessionId": {
            "type": "string"
          }
        }
      },
      "SessionListingDto": {
        "type": "object",
        "properties": {
          "sessionId": {
            "type": "string",
            "description": "Onboarding session id"
          },
          "updatedAt": {
            "type": "integer",
            "format": "int64",
            "description": "Timestamp of latest session update"
          },
          "onboardingStatus": {
            "type": "string",
            "description": "Current status of the onboarding session.",
            "enum": [
              "UNKNOWN",
              "ID_VALIDATION_FINISHED",
              "POST_PROCESSING_FINISHED",
              "FACE_VALIDATION_FINISHED",
              "GOVERNMENT_VALIDATION_FINISHED",
              "EKYC_VALIDATION_FINISHED",
              "ONBOARDING_FINISHED",
              "MANUAL_REVIEW_APPROVED",
              "MANUAL_REVIEW_REJECTED",
              "MANUAL_REVIEW_PENDING",
              "EXPIRED",
              "DELETED",
              "QES_FINISHED"
            ]
          },
          "totalScoreStatus": {
            "type": "string",
            "description": "Current total score of the onboarding session",
            "enum": [
              "OK",
              "WARN",
              "FAIL",
              "UNKNOWN",
              "MANUAL",
              "MANUAL_OK",
              "MANUAL_FAIL",
              "MANUAL_PENDING"
            ]
          }
        }
      },
      "FetchIdentityDataResponseDto": {
        "type": "object",
        "properties": {
          "identityId": {
            "type": "string"
          },
          "originalSessionId": {
            "type": "string"
          },
          "ocrData": {
            "$ref": "#/components/schemas/IdentityOcrData"
          },
          "documents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IdentityDocument"
            }
          }
        }
      },
      "IdentityDocument": {
        "type": "object",
        "properties": {
          "documentNumber": {
            "type": "string"
          },
          "issuingCountry": {
            "type": "string"
          },
          "documentType": {
            "type": "string",
            "enum": [
              "Unknown",
              "Passport",
              "Visa",
              "DriversLicense",
              "IdentificationCard",
              "Permit",
              "Currency",
              "ResidenceDocument",
              "TravelDocument",
              "BirthCertificate",
              "VehicleRegistration",
              "Other",
              "WeaponLicense",
              "TribalIdentification",
              "VoterIdentification",
              "Military",
              "TaxIdentification",
              "FederalID",
              "MedicalCard"
            ]
          },
          "documentExpiryDate": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "IdentityOcrData": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "dateOfBirth": {
            "type": "string"
          },
          "personalIdNumber": {
            "type": "string"
          },
          "address": {
            "type": "string"
          },
          "nationalNumber": {
            "type": "string"
          },
          "countryCode": {
            "type": "string"
          },
          "documentType": {
            "type": "string",
            "enum": [
              "Unknown",
              "Passport",
              "Visa",
              "DriversLicense",
              "IdentificationCard",
              "Permit",
              "Currency",
              "ResidenceDocument",
              "TravelDocument",
              "BirthCertificate",
              "VehicleRegistration",
              "Other",
              "WeaponLicense",
              "TribalIdentification",
              "VoterIdentification",
              "Military",
              "TaxIdentification",
              "FederalID",
              "MedicalCard"
            ]
          },
          "docExpiryDate": {
            "type": "integer",
            "format": "int32"
          },
          "nameInfo": {
            "$ref": "#/components/schemas/IdentityOcrNameInfo"
          },
          "displayName": {
            "type": "string",
            "deprecated": true,
            "description": "Deprecated, do not use. Will be removed. Use nameInfo.displayName instead."
          },
          "fullNameMrz": {
            "type": "string",
            "deprecated": true,
            "description": "Deprecated, do not use. Will be removed. Use nameInfo.fullNameMrz instead."
          },
          "gender": {
            "type": "string"
          }
        }
      },
      "IdentityOcrNameInfo": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "displayName": {
            "type": "string"
          },
          "fullNameMrz": {
            "type": "string"
          }
        }
      },
      "CurpResult": {
        "type": "object",
        "properties": {
          "get_version": {
            "type": "integer",
            "format": "int64"
          },
          "scrapingStatus": {
            "type": "string",
            "description": "- IN_PROGRESS: Service hasn't finished and should retry in 5 seconds.\n- FINISHED: Service finished and we got a result. Either a success or an error, such as curp not found.\n- ERROR: Service had an unhandled error, a new attempt is recommended.\n",
            "enum": [
              "IN_PROGRESS",
              "FINISHED",
              "ERROR"
            ]
          },
          "success": {
            "type": "boolean"
          },
          "result": {
            "type": "string",
            "description": "- success: Call finished and data was validated successfully.\n- error: Invalid curp or data, exact details returned by the website can be found in the resultDetails field.\n- timeout: Elements needed for scrapping were never found, isolated network issue, website down or website changed.\n- maintenance: Elements indicating that the website is under maintenance have been found.\n- unhandledError: Unhandled error occured during scrapping.\n"
          },
          "resultDetails": {
            "type": "string"
          },
          "screenshotUrl": {
            "type": "string"
          },
          "curp": {
            "type": "string"
          },
          "nombre": {
            "type": "string"
          },
          "primerApellido": {
            "type": "string"
          },
          "segundoApellido": {
            "type": "string"
          },
          "sexo": {
            "type": "string"
          },
          "nacionalidad": {
            "type": "string"
          },
          "entidadNacimiento": {
            "type": "string"
          },
          "documentoProbatorio": {
            "type": "string"
          },
          "datosDocumentoProbatorio": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            },
            "description": "- municipioRegistro: String.\n- entidadRegistro: String.\n- numeroActa: Integer.\n- anioRegistro: Integer.\n"
          },
          "curpHistoricas": {
            "type": "string"
          },
          "statusCurp": {
            "type": "string"
          },
          "transactionId": {
            "type": "string"
          },
          "codigoRespuestaCCB": {
            "type": "string"
          },
          "descripcionRespuestaCCB": {
            "type": "string"
          },
          "codigoRespuestaRENAPO": {
            "type": "string"
          },
          "descripcionRespuestaRENAPO": {
            "type": "string"
          }
        }
      },
      "AsyncVendorVerificationResultResponse": {
        "type": "object",
        "properties": {
          "referenceId": {
            "type": "string",
            "description": "The referenceId that was requested."
          },
          "status": {
            "type": "string",
            "description": "PENDING, COMPLETED or FAILED.",
            "enum": [
              "PENDING",
              "COMPLETED",
              "FAILED"
            ]
          },
          "type": {
            "type": "string",
            "description": "Product that started the request: EKYB, EKYC or KYB (POST /omni/kyb).",
            "enum": [
              "EKYB",
              "EKYC",
              "KYB"
            ]
          },
          "result": {
            "type": "object",
            "description": "Verification result; its shape depends on type. Null while PENDING."
          }
        }
      },
      "SnaStatusResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "`true` when the check is completed and the device matched the phone number."
          },
          "method": {
            "type": "string",
            "description": "Verification method, always `SNA` for this endpoint.",
            "enum": [
              "SNA"
            ]
          },
          "checkId": {
            "type": "string",
            "description": "Identifier of the SNA check, echoed from the path."
          },
          "status": {
            "type": "string",
            "description": "Provider status of the check.",
            "enum": [
              "ACCEPTED",
              "PENDING",
              "COMPLETED",
              "EXPIRED",
              "ERROR"
            ]
          },
          "match": {
            "type": "boolean",
            "description": "Result of the check when `status` is `COMPLETED`; `null` otherwise."
          },
          "pending": {
            "type": "boolean",
            "description": "`true` while `status` is `ACCEPTED` or `PENDING`; also `true` for `EXPIRED` without a provider error code, so branch on `status` rather than on this flag."
          },
          "complete": {
            "type": "boolean",
            "description": "`true` when `status` is `COMPLETED`; read `match` for the result. `false` on `EXPIRED` and `ERROR` even though the check will not complete."
          },
          "message": {
            "type": "string",
            "description": "Human readable outcome, for logging. Not meant to be shown to the end user."
          }
        }
      },
      "InterviewAnswerResponse": {
        "type": "object",
        "properties": {
          "interviewId": {
            "type": "string",
            "description": "ID of fetched interview."
          },
          "apiKey": {
            "type": "integer",
            "format": "int32",
            "description": "OpenTok apiKey used for connection to video call."
          },
          "interviewToken": {
            "type": "string",
            "description": "OpenTok token used for connection to video call."
          },
          "sessionId": {
            "type": "string",
            "description": "OpenTok session id used for connection to video call."
          }
        }
      },
      "QueueIndexResponse": {
        "type": "object",
        "properties": {
          "index": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "ConnectionDetailsResponse": {
        "type": "object",
        "properties": {
          "accessToken": {
            "type": "string",
            "description": "Access token which needs to be forwarded in header X-Incode-Hardware-Id for future calls. Same purpose as token from [start](#/Onboarding/startInterview)\n"
          },
          "interviewerName": {
            "type": "string",
            "description": "The name of the executive who is on conference call with the user."
          },
          "sessionId": {
            "type": "string",
            "description": "Used for establishing conference connection via OpenTok."
          },
          "interviewToken": {
            "type": "string",
            "description": "Used for establishing conference connection via OpenTok."
          }
        }
      },
      "AntifraudCheckResultBaseDto": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "FAILED",
              "PASSED",
              "NOT_EXECUTED",
              "MANUAL_REVIEW"
            ]
          },
          "stepName": {
            "type": "string",
            "enum": [
              "FuzzyFieldAntifraudExecutor",
              "IdFaceAntifraudExecutor",
              "SelfieFaceAntifraudExecutor",
              "AttemptLimitAntifraudExecutor"
            ]
          }
        }
      },
      "PhoneResponse": {
        "type": "object",
        "properties": {
          "phone": {
            "type": "string"
          }
        }
      },
      "KybForm": {
        "type": "object",
        "description": "KYB form to render as is. Which modules run for the country, and which fields are shown and required, is already decided. Arrays are in display order.",
        "properties": {
          "schemaVersion": {
            "type": "string",
            "description": "Version of this form format.",
            "example": 1
          },
          "formId": {
            "type": "string",
            "description": "Form identifier.",
            "example": "kyb"
          },
          "context": {
            "$ref": "#/components/schemas/KybFormContext",
            "description": "What the form was built for."
          },
          "steps": {
            "type": "array",
            "description": "Steps, in display order.",
            "items": {
              "$ref": "#/components/schemas/KybFormStep"
            }
          },
          "rules": {
            "type": "array",
            "description": "Rules across fields, checked on submit.",
            "items": {
              "$ref": "#/components/schemas/KybFormRule"
            }
          },
          "submit": {
            "$ref": "#/components/schemas/KybFormSubmit",
            "description": "How to submit the form. Omitted until a country is chosen."
          }
        }
      },
      "KybFormContext": {
        "type": "object",
        "description": "What the form was built for.",
        "properties": {
          "country": {
            "type": "string",
            "description": "Country of the business, ISO 3166-1 alpha-2. Omitted until a country is chosen.",
            "example": "US"
          },
          "modules": {
            "type": "array",
            "description": "Modules selected for this onboarding step.",
            "items": {
              "type": "string",
              "enum": [
                "identity",
                "address",
                "statusEntityType",
                "personAssociation",
                "webPresence",
                "websiteAnalysis",
                "industryInfo",
                "financialIntelligence",
                "groupStructure"
              ]
            }
          },
          "unsupportedModules": {
            "type": "array",
            "description": "Selected modules that are not supported for the country. They are still submitted and come back with a notSupported error.",
            "items": {
              "$ref": "#/components/schemas/KybFormUnsupportedModule"
            }
          }
        }
      },
      "KybFormField": {
        "type": "object",
        "description": "One input.",
        "properties": {
          "name": {
            "type": "string",
            "description": "Field identifier.",
            "example": "taxId"
          },
          "type": {
            "type": "string",
            "description": "Kind of input: text, select, list or phone.",
            "example": "text"
          },
          "display": {
            "type": "string",
            "description": "Whether the user can edit it.",
            "example": "editable"
          },
          "required": {
            "type": "boolean",
            "description": "Whether a value is required to submit."
          },
          "value": {
            "type": "object",
            "description": "Initial value: a string, or an array of strings for a list field."
          },
          "label": {
            "$ref": "#/components/schemas/KybText",
            "description": "Field label."
          },
          "input": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            },
            "description": "Keyboard and length hints for text input."
          },
          "phone": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            },
            "description": "Phone input settings, for a phone field."
          },
          "options": {
            "type": "array",
            "description": "Allowed values, for a select field.",
            "items": {
              "$ref": "#/components/schemas/KybFormOption"
            }
          },
          "rules": {
            "type": "array",
            "description": "Validation rules, checked in order.",
            "items": {
              "$ref": "#/components/schemas/KybFormRule"
            }
          },
          "payload": {
            "$ref": "#/components/schemas/KybFormPayload",
            "description": "Where the value goes in the submitted body."
          },
          "refetchOnChange": {
            "type": "string",
            "description": "When set, fetch the form again with this query parameter set to the new value whenever the field changes.",
            "example": "country"
          }
        }
      },
      "KybFormOption": {
        "type": "object",
        "description": "One allowed value of a select field.",
        "properties": {
          "value": {
            "type": "string",
            "description": "Value to submit.",
            "example": "CA"
          },
          "label": {
            "$ref": "#/components/schemas/KybText",
            "description": "Text to show for the value."
          }
        }
      },
      "KybFormPayload": {
        "type": "object",
        "description": "Where a field's value goes in the submitted body.",
        "properties": {
          "key": {
            "type": "string",
            "description": "Property name in the request body.",
            "example": "taxId"
          },
          "transforms": {
            "type": "array",
            "description": "Transforms to apply before submitting, in order: trim or e164.",
            "items": {
              "type": "string"
            }
          },
          "omitWhenEmpty": {
            "type": "boolean",
            "description": "Leave the property out when the value is empty."
          }
        }
      },
      "KybFormRule": {
        "type": "object",
        "description": "A validation rule.",
        "properties": {
          "kind": {
            "type": "string",
            "description": "Rule kind: required, pattern (regex must match) or requireAnyOf (one of fields must be set).",
            "example": "pattern"
          },
          "regex": {
            "type": "string",
            "description": "Regular expression, for a pattern rule."
          },
          "flags": {
            "type": "string",
            "description": "Regular expression flags, for a pattern rule."
          },
          "fields": {
            "type": "array",
            "description": "Field names, for a rule across fields.",
            "items": {
              "type": "string"
            }
          },
          "message": {
            "$ref": "#/components/schemas/KybText",
            "description": "Message to show when the rule fails."
          }
        }
      },
      "KybFormSection": {
        "type": "object",
        "description": "A group of fields.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Section identifier.",
            "example": "address"
          },
          "title": {
            "$ref": "#/components/schemas/KybText",
            "description": "Section title. Omitted for an untitled section."
          },
          "fields": {
            "type": "array",
            "description": "Fields, in display order.",
            "items": {
              "$ref": "#/components/schemas/KybFormField"
            }
          }
        }
      },
      "KybFormStep": {
        "type": "object",
        "description": "One screen of the form.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Step identifier.",
            "example": "business"
          },
          "title": {
            "$ref": "#/components/schemas/KybText",
            "description": "Step title."
          },
          "sections": {
            "type": "array",
            "description": "Sections, in display order.",
            "items": {
              "$ref": "#/components/schemas/KybFormSection"
            }
          }
        }
      },
      "KybFormSubmit": {
        "type": "object",
        "description": "How to submit the form.",
        "properties": {
          "endpoint": {
            "type": "string",
            "description": "Endpoint to call.",
            "example": "/omni/kyb"
          },
          "method": {
            "type": "string",
            "description": "HTTP method.",
            "example": "POST"
          },
          "static": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            },
            "description": "Properties to add to the body as they are."
          },
          "onSuccess": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            },
            "description": "What to do after a successful call."
          },
          "onFailure": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            },
            "description": "What to do after a failed call."
          }
        }
      },
      "KybFormUnsupportedModule": {
        "type": "object",
        "description": "A selected module that is not supported for the country.",
        "properties": {
          "module": {
            "type": "string",
            "description": "The module.",
            "enum": [
              "identity",
              "address",
              "statusEntityType",
              "personAssociation",
              "webPresence",
              "websiteAnalysis",
              "industryInfo",
              "financialIntelligence",
              "groupStructure"
            ]
          },
          "message": {
            "$ref": "#/components/schemas/KybText",
            "description": "Why it does not run."
          }
        }
      },
      "KybText": {
        "type": "object",
        "description": "A user-facing text. Translate key; show text when the key has no translation.",
        "properties": {
          "key": {
            "type": "string",
            "description": "Translation key.",
            "example": "kyb.fields.businessName.label"
          },
          "text": {
            "type": "string",
            "description": "English text, to show when key has no translation.",
            "example": "Business name"
          }
        }
      },
      "IdentityReuseDocumentDto": {
        "type": "object",
        "properties": {
          "documentId": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "countryCode": {
            "type": "string"
          },
          "documentNumber": {
            "type": "string"
          },
          "validatedAt": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "IdentityReuseDocumentsResponse": {
        "type": "object",
        "properties": {
          "documents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IdentityReuseDocumentDto"
            }
          }
        }
      },
      "SigningCeremonyUrlResponse": {
        "type": "object",
        "properties": {
          "signingCeremonyUrl": {
            "type": "string"
          }
        }
      },
      "FraudRiskDto": {
        "type": "object",
        "description": "Raw checkFraudRisk result from FraudRiskService (the FraudRisk entity persisted in the fraudrisks collection).",
        "properties": {
          "name": {
            "type": "string",
            "description": "Check name, always checkFraudRisk."
          },
          "severity": {
            "type": "string",
            "description": "Check severity: low / medium / high.",
            "enum": [
              "LOW",
              "MEDIUM",
              "HIGH"
            ]
          },
          "version": {
            "type": "string",
            "description": "Model version that produced the result."
          },
          "result": {
            "type": "number",
            "description": "Raw fraud-risk result value (full precision)."
          },
          "responseText": {
            "type": "string",
            "description": "Free-text explanation returned by the fraud-risk model."
          },
          "responseCategory": {
            "type": "string",
            "description": "Response category returned by the fraud-risk model."
          },
          "topNFraudFeatures": {
            "type": "array",
            "description": "Top N features that contributed towards a fraud classification.",
            "items": {
              "type": "string"
            }
          },
          "topNLegitFeatures": {
            "type": "array",
            "description": "Top N features that contributed towards a legitimate classification.",
            "items": {
              "type": "string"
            }
          },
          "topNFraudCodes": {
            "type": "array",
            "description": "Raw stable feature codes for topNFraudFeatures (same order), as sent by the model.",
            "items": {
              "type": "string"
            }
          },
          "topNLegitCodes": {
            "type": "array",
            "description": "Raw stable feature codes for topNLegitFeatures (same order), as sent by the model.",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "RawIdvCheckResultDto": {
        "type": "object",
        "description": "Raw id-validation-service check result with original naming preserved (no mapping to user-service key constants).",
        "properties": {
          "name": {
            "type": "string",
            "description": "Original id-validation-service check name, e.g. checkIdFaceTamper, checkIdScreenLiveness, deep_fraud."
          },
          "severity": {
            "type": "string",
            "description": "Check severity: low / medium / high.",
            "enum": [
              "low",
              "medium",
              "high"
            ]
          },
          "version": {
            "type": "string",
            "description": "Model version that produced the result."
          },
          "result": {
            "type": "number",
            "format": "float",
            "description": "Raw confidence/result value, Float in [0, 1]. Nullable when the check did not run."
          }
        }
      },
      "RawIdvResultsResponse": {
        "type": "object",
        "description": "Raw IDV results passthrough: per-check id-validation-service data with original naming, plus the fraud-risk result.",
        "properties": {
          "checkResults": {
            "type": "array",
            "description": "Raw id-validation-service check results. Empty when id-validation-service was not invoked for the interview.",
            "items": {
              "$ref": "#/components/schemas/RawIdvCheckResultDto"
            }
          },
          "fraudRisk": {
            "$ref": "#/components/schemas/FraudRiskDto",
            "description": "Raw checkFraudRisk result. Null when no FraudRisk was produced for the interview."
          }
        }
      },
      "RandomQandAListResponse": {
        "type": "object",
        "properties": {
          "questionAndAnswers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/QuestionAndAnswerWithId"
            }
          }
        }
      },
      "InterviewerInfoResponse": {
        "type": "object",
        "properties": {
          "interviewerName": {
            "type": "string",
            "description": "The name of the executive who is on a conference call with the user."
          },
          "apiKey": {
            "type": "integer",
            "format": "int32",
            "description": "Used for establishing a conference connection via OpenTok."
          },
          "interviewToken": {
            "type": "string",
            "description": "Used for establishing a conference connection via OpenTok."
          },
          "sessionId": {
            "type": "string",
            "description": "Used for establishing a conference connection via OpenTok."
          }
        }
      },
      "OcrDataResponsePacked": {
        "type": "object",
        "properties": {
          "ocrData": {
            "$ref": "#/components/schemas/OcrDataResponse"
          }
        }
      },
      "IdSummaryDocumentSideResult": {
        "type": "object",
        "properties": {
          "classification": {
            "type": "boolean"
          },
          "readability": {
            "type": "boolean"
          },
          "sharpness": {
            "type": "integer",
            "format": "int32"
          },
          "glare": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "IdSummaryResponse": {
        "type": "object",
        "properties": {
          "onlyFront": {
            "type": "boolean"
          },
          "addFrontResult": {
            "$ref": "#/components/schemas/IdSummaryDocumentSideResult"
          },
          "addBackResult": {
            "$ref": "#/components/schemas/IdSummaryDocumentSideResult"
          }
        }
      },
      "EmailResponse": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string"
          }
        }
      },
      "CustomFieldsResponse": {
        "type": "object",
        "properties": {
          "customFields": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            },
            "description": "Map<String, Object>. Map of custom fields with type that was inserted."
          }
        }
      },
      "ConferenceDetailsResponse": {
        "type": "object",
        "properties": {
          "conferenceStatus": {
            "type": "string",
            "enum": [
              "NO_CONFERENCE",
              "APPROVED",
              "REJECTED",
              "ABANDONED",
              "NEEDS_REVIEW",
              "REJECTED_BY_RISK",
              "COMPLETED"
            ]
          },
          "executiveId": {
            "type": "string"
          },
          "conferenceStartTime": {
            "type": "integer",
            "format": "int64",
            "description": "UTC timestamp"
          },
          "conferenceEndTime": {
            "type": "integer",
            "format": "int64",
            "description": "UTC timestamp"
          },
          "conferenceDuration": {
            "type": "integer",
            "format": "int64",
            "description": "Conference duration in milliseconds."
          },
          "conferenceTermAndConditionsAccepted": {
            "type": "boolean"
          },
          "creditBureauConsentGiven": {
            "type": "boolean"
          },
          "applicantDataConfirmed": {
            "type": "boolean"
          }
        }
      },
      "SessionRecordingDownloadResponse": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string"
          }
        }
      },
      "EkycDataResponse": {
        "type": "object",
        "properties": {
          "userData": {
            "$ref": "#/components/schemas/ExternalVerificationRequest"
          },
          "riskData": {
            "$ref": "#/components/schemas/PremiumExternalVerification"
          },
          "riskAddons": {
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PhoneProfileRiskAddonResponse"
                }
              ]
            }
          }
        }
      },
      "BusinessVerificationResultData": {
        "type": "object",
        "properties": {
          "businessName": {
            "type": "string"
          },
          "businessClassification": {
            "type": "string"
          },
          "addressVerification": {
            "type": "string"
          },
          "cityVerification": {
            "type": "string"
          },
          "postalCodeVerification": {
            "type": "string"
          },
          "stateVerification": {
            "type": "string"
          },
          "addressPropertyType": {
            "type": "string"
          },
          "addressDeliverability": {
            "type": "string"
          },
          "tinVerification": {
            "type": "string"
          },
          "uboNameMatch": {
            "type": "string"
          },
          "registrationStatus": {
            "type": "string",
            "enum": [
              "Active",
              "Inactive",
              "Unknown"
            ]
          },
          "entityType": {
            "$ref": "#/components/schemas/EntityTypeData"
          },
          "uboNameVerificationResults": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UboNameVerificationResultData"
            }
          },
          "directorsVerificationResults": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UboNameVerificationResultData"
            }
          },
          "people": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PeopleData"
            }
          },
          "verificationMessages": {
            "$ref": "#/components/schemas/VerificationMessages"
          }
        }
      },
      "EkybDataResponse": {
        "type": "object",
        "properties": {
          "requestData": {
            "$ref": "#/components/schemas/BusinessVerificationRequestData"
          },
          "verificationResult": {
            "$ref": "#/components/schemas/BusinessVerificationResultData"
          },
          "externalVerificationThirdPartyRequest": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "externalVerificationThirdPartyResponse": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "providerInteractions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProviderInteraction"
            }
          }
        }
      },
      "EntityTypeData": {
        "type": "object",
        "properties": {
          "entityType": {
            "type": "string"
          }
        }
      },
      "PeopleData": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "titles": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TitleData"
            }
          },
          "memberType": {
            "type": "string"
          }
        }
      },
      "ProviderInteraction": {
        "type": "object",
        "properties": {
          "providerName": {
            "type": "string",
            "enum": [
              "MIDDESK",
              "OPEN_CORPS_US",
              "OPEN_CORPS_CA",
              "SERPRO",
              "OPENDATA",
              "CREDITSAFE_UK",
              "CREDITSAFE_RO",
              "CREDITSAFE_IT",
              "CREDITSAFE_ES",
              "CREDITSAFE_FR",
              "CREDITSAFE_DE",
              "CREDITSAFE_AR",
              "CREDITSAFE_IE",
              "CREDITSAFE_JP",
              "CREDITSAFE_SE",
              "CREDITSAFE_NO",
              "CREDITSAFE_NL",
              "CREDITSAFE_VN",
              "CREDITSAFE_NG",
              "CREDITSAFE_CM",
              "CREDITSAFE_KE",
              "CREDITSAFE_MX",
              "CREDITSAFE_DK",
              "CREDITSAFE_BG",
              "CREDITSAFE_MT",
              "CREDITSAFE_LT",
              "CREDITSAFE_AU",
              "CREDITSAFE_GR",
              "CREDITSAFE_PT",
              "THE_KYB_NL",
              "THE_KYB_KM",
              "THE_KYB_TR",
              "THE_KYB_EG",
              "THE_KYB_AE",
              "THE_KYB_SA",
              "THE_KYB_CA",
              "NUBARIUM_MX",
              "ASIAVERIFY_CN",
              "ASIAVERIFY_IN",
              "ASIAVERIFY_HK",
              "MONO_NG",
              "IDENTIFY_AFRICA_KE",
              "IDMERIT_MX",
              "THE_KYB_SA_PREFILL",
              "THE_KYB_AE_PREFILL",
              "CREDITSAFE_AU_PREFILL",
              "CREDITSAFE_GB_PREFILL",
              "BASELAYER_US_PREFILL",
              "CREDITSAFE_IN_PREFILL",
              "CREDITSAFE_DE_PREFILL",
              "CREDITSAFE_ES_PREFILL",
              "CREDITSAFE_FR_PREFILL",
              "CREDITSAFE_IT_PREFILL",
              "CREDITSAFE_NL_PREFILL",
              "CREDITSAFE_GR_PREFILL",
              "CREDITSAFE_PT_PREFILL",
              "CREDITSAFE_BE_PREFILL",
              "CREDITSAFE_AT_PREFILL",
              "CREDITSAFE_IE_PREFILL"
            ]
          },
          "interactionType": {
            "type": "string",
            "enum": [
              "token_fetch",
              "verification",
              "business_classification",
              "entity_lookup",
              "prefill"
            ]
          },
          "timestamp": {
            "type": "string",
            "format": "date-time"
          },
          "externalVerificationThirdPartyRequest": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "externalVerificationThirdPartyResponse": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "status": {
            "type": "string",
            "enum": [
              "SUCCESS",
              "NO_RESULT",
              "DEFERRED"
            ]
          },
          "errorMessage": {
            "type": "string"
          }
        }
      },
      "TitleData": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          }
        }
      },
      "UboNameVerificationResultData": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "uboNameMatch": {
            "type": "string"
          },
          "matchId": {
            "type": "string"
          },
          "ownershipPercentage": {
            "type": "string"
          }
        }
      },
      "TrustGraphCheckResultB2BDto": {
        "type": "object",
        "properties": {
          "externalId": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "PASSED",
              "FAILED",
              "ERROR",
              "UNKNOWN"
            ]
          },
          "skipReason": {
            "type": "string",
            "enum": [
              "COMPLIANCE_RESTRICTED",
              "DOCUMENT_NOT_CHECKABLE",
              "DOCUMENT_QUALITY_INSUFFICIENT",
              "DOCUMENT_QUALITY_UNAVAILABLE",
              "UNKNOWN"
            ]
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrustGraphCategoryResultDto"
            }
          }
        }
      },
      "DeleteInterviewsConfigDto": {
        "type": "object",
        "description": "Configuration for cleaning interview",
        "properties": {
          "deletePiiDataOnly": {
            "type": "boolean",
            "default": "true",
            "description": "Boolean, optional. Flag indicating if this is partial delete, where only PII fields should be removed.\nDefault is true.\nNote: False is allowed to be used only if this organization has the required setting.\n"
          },
          "deletionMode": {
            "type": "string",
            "description": "Specifies the type of deletion to perform.",
            "enum": [
              "BIOMETRICS",
              "PII",
              "FULL"
            ],
            "example": "FULL"
          },
          "sendNotification": {
            "type": "boolean",
            "default": "false",
            "description": "Flag indicating to send a notification about a change interview status"
          },
          "relatedEntitiesToKeep": {
            "type": "array",
            "description": "List of related entities to be saved. Works only when deletePiiDataOnly=true",
            "items": {
              "type": "string",
              "enum": [
                "identities",
                "faceTemplates",
                "images",
                "stats",
                "chats",
                "deviceFingerPrints"
              ]
            },
            "oneOf": [
              {
                "type": "string",
                "enum": [
                  "identities",
                  "faceTemplates",
                  "images",
                  "stats",
                  "chats",
                  "deviceFingerPrints"
                ]
              }
            ]
          }
        }
      },
      "DeleteInterviewsFilterDto": {
        "type": "object",
        "description": "Filter for cleaning interview",
        "properties": {
          "ids": {
            "type": "array",
            "description": "List of identifiers interviews",
            "items": {
              "type": "string"
            }
          },
          "flowId": {
            "type": "string",
            "description": "Flow id, if passed, then delete all interviews related to this flow"
          },
          "externalId": {
            "type": "string",
            "description": "Specify which external-id."
          },
          "externalCustomerId": {
            "type": "string",
            "description": "Specify which external-customer-id."
          },
          "lastActiveDate": {
            "type": "string",
            "format": "date-time",
            "description": "To delete all interviews active before this date"
          }
        }
      },
      "DeleteInterviewsRequest": {
        "type": "object",
        "description": "Request for clean interviews",
        "properties": {
          "filter": {
            "$ref": "#/components/schemas/DeleteInterviewsFilterDto"
          },
          "config": {
            "$ref": "#/components/schemas/DeleteInterviewsConfigDto"
          }
        },
        "required": [
          "filter"
        ]
      }
    },
    "parameters": {
      "ApiVersion": {
        "name": "api-version",
        "in": "header",
        "required": true,
        "schema": {
          "type": "string",
          "default": "1.0"
        }
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "description": "Your api key. Request it from Incode support team",
        "name": "x-api-key",
        "in": "header"
      },
      "IncodeHardwareIdAuth": {
        "type": "apiKey",
        "description": "Session token. Created either via /omni/start or /executive/log-in",
        "name": "X-Incode-Hardware-Id",
        "in": "header"
      },
      "BearerAuth": {
        "type": "http",
        "description": "Bearer token.\n\nCreated via /oauth2/token on auth server, using [client_credentials](https://www.oauth.com/oauth2-servers/access-tokens/client-credentials) grant.\n\nThe client_id and client_secret params can be found in Default client credentials integration.\n",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  }
}