openapi: 3.0.3

info:
  title: Checkout.com - Identity Verification
  version: 1.0.0
  x-logo:
    url: "https://raw.githubusercontent.com/ubbleai/docs/main/cko_doc_logo.png"
  description: ""
 
servers:
  - url: https://api.ubble.ai

tags:
  - name: identity verifications
    description: Identity verification endpoints documentation.
  - name: ID document verifications
    description: API for ID document verification
  - name: AML verifications
    description: AML verification endpoints documentation.
  - name: applicants
    description: Applicant management endpoints documentation.
  - name: attempts
    description: Attempt management endpoints documentation.

x-tagGroups:
  - name: Endpoints documentation
    tags:
      - Applicants
      - Business applicants
      - Identity verifications
      - ID document verifications
      - Face authentications
      - AML verifications
      - Website verifications (Coming soon)
      - Bank document verifications (Coming soon)
      - Company document verifications (Coming soon)
      - Address document verifications (Coming soon)
      - Service status
paths:
  /health:
    get:
      tags:
        - Service status
      summary: Retrieve API health
      description: This endpoint allows you to get the health of our api, anything other than a 200 status code is not OK
      operationId: retrieve_api_health
      responses:
        "200":
          description: API is OK

  /v2/address-document-verifications:
    post:
      tags:
        - Address document verifications (Coming soon)
      summary: Create an Address Document Verification
      operationId: create_address_document_verification
      description: Creates an Address Document Verification
      requestBody:
        required: true
        content:
          application/json:
            examples:
              address_document_verification_creation_request_body_min:
                $ref: "#/components/examples/address_document_verification_creation_request_body_min"
              address_document_verification_creation_request_body_max:
                $ref: "#/components/examples/address_document_verification_creation_request_body_max"
            schema:
              $ref: "#/components/schemas/AddressDocumentVerificationInputPost"
      responses:
        "201":
          description: Address Document Verification created successfully
          content:
            application/json:
              examples:
                address_document_verification_creation_response_body:
                  $ref: "#/components/examples/address_document_verification_creation_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/AddressDocumentVerificationOutputPost"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity
        "500":
          description: Internal server error
        "503":
          description: Service unavailable

  /v2/address-document-verifications/{address_document_verification_id}:
    get:
      tags:
        - Address document verifications (Coming soon)
      summary: Retrieve an Address Document Verification
      description: This endpoint allows you to get the detailed results of an Address Document Verification
      operationId: retrieve_address_document_verification
      parameters:
        - name: address_document_verification_id
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/AddressDocumentVerificationId"
      responses:
        "200":
          description: Address Document Verification retrieved successfully
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/AddressDocumentVerificationOutputGet"
        "404":
          description: Address Document Verification not found
        "500":
          description: Internal server error

  /v2/address-document-verifications/{address_document_verification_id}/anonymize:
    post:
      tags:
        - Address document verifications (Coming soon)
      summary: Anonymize an Address Document Verification
      operationId: anonymize_address_document_verification
      description: Anonymize the personal data of an Address Document Verification with the specified ID.
      parameters:
        - name: address_document_verification_id
          in: path
          description: ID of the document verification to anonymize
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Address Document Verification anonymized
          content:
            application/json:
              examples:
                address_document_verification_anonymization_response_body:
                  $ref: "#/components/examples/address_document_verification_anonymization_response_body"
              schema:
                required: [applicant_id, user_journey_id]
                allOf:
                  - $ref: "#/components/schemas/AddressDocumentVerificationOutputAnonymize"
        "404":
          description: Address Document Verification not found
        "500":
          description: Internal server error

  /v2/address-document-verifications/{address_document_verification_id}/attempts:
    get:
      tags:
        - Address document verifications (Coming soon)
      summary: List Address Document Verification attempts
      operationId: list_attempts_address_document_verification
      description: |
        This endpoint allows you to list all attempts of an Address Document Verification.

        Attempts are returned ordered by creation date, newest first.

        The response is paginated (see [Pagination](#section/API-standards/Pagination) section).
        You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.
      parameters:
        - name: address_document_verification_id
          in: path
          description: ID of the document verification
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/skipParam"
        - $ref: "#/components/parameters/limitParam"
      responses:
        "200":
          description: Address Document Verification attempts retrieved successfully
          content:
            application/json:
              examples:
                address_document_verification_attempt_list_response_body:
                  $ref: "#/components/examples/address_document_verification_attempt_list_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/AddressDocumentVerificationAttemptOutputList"
        "404":
          description: The provided document verification ID is not valid
        "500":
          description: An error occurred while fetching the attempts
    post:
      tags:
        - Address document verifications (Coming soon)
      summary: Create an Address Document Verification attempt
      description: "This endpoint allows you to create an Address Document Verification attempt. It is possible when the Address Document Verification 
        is one of the following statuses: `created`, `retry_required`"
      operationId: create_address_document_verification_attempt
      parameters:
        - name: address_document_verification_id
          in: path
          description: ID of the document verification
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          multipart/form-data:
            examples:
              address_document_verification_attempt_creation_request_body_min:
                $ref: "#/components/examples/address_document_verification_attempt_creation_request_body_min"
              address_document_verification_attempt_creation_request_body_max:
                $ref: "#/components/examples/address_document_verification_attempt_creation_request_body_max"
            schema:
              $ref: "#/components/schemas/AddressDocumentVerificationAttemptInputPost"
      responses:
        "201":
          description: Address Document Verification attempt created
          content:
            application/json:
              examples:
                address_document_verification_attempt_creation_response_body:
                  $ref: "#/components/examples/address_document_verification_attempt_creation_response_body"
              schema:
                $ref: "#/components/schemas/AddressDocumentVerificationAttemptOutputPost"
        "403":
          description: The uploaded file was rejected by our file security checks
        "404":
          description: The provided Address Document Verification ID is not valid
        "409":
          description: The Address Document Verification is not in a valid state to create an attempt.
            The Address Document Verification status must be `created` or `retry_required`
        "500":
          description: An error occurred while creating the attempt

  /v2/address-document-verifications/{address_document_verification_id}/attempts/{attempt_id}:
    get:
      tags:
        - Address document verifications (Coming soon)
      summary: Retrieve an Address Document Verification attempt
      description: This endpoint allows you to retrieve the details for a given Address Document Verification attempt.
      operationId: fetch_attempts_address_document_verification
      parameters:
        - name: address_document_verification_id
          in: path
          description: ID of the document verification
          required: true
          schema:
            type: string
        - name: attempt_id
          in: path
          description: ID of the document verification attempt
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Address Document Verification attempt retrieved successfully
          content:
            application/json:
              examples:
                address_document_verification_attempt_get_response_body:
                  $ref: "#/components/examples/address_document_verification_attempt_get_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/AddressDocumentVerificationAttemptOutputGet"
        "404":
          description: The provided document verification attempt ID is not valid
        "500":
          description: An error occurred while fetching the attempt

  /v2/address-document-verifications/{address_document_verification_id}/attempts/{attempt_id}/assets:
    get:
      tags:
        - Address document verifications (Coming soon)
      summary: Retrieve an Address Document Verification attempt asset
      operationId: fetch_asset_address_document_verification_attempt
      description: |
        This endpoint allows you to retrieve the assets associated with an Address Document Verification.
        This includes the document image.

        The response is paginated (see [Pagination](#section/API-standards/Pagination) section).
        You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.
      parameters:
        - name: address_document_verification_id
          in: path
          description: ID of the Address Document Verification
          required: true
          schema:
            type: string
        - name: attempt_id
          in: path
          description: ID of the Address Document Verification attempt
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/skipParam"
        - $ref: "#/components/parameters/limitParam"
      responses:
        "200":
          description: Address Document Verification attempt asset retrieved successfully
          content:
            application/json:
              examples:
                address_document_verification_attempt_output_assets_response_body:
                  $ref: "#/components/examples/address_document_verification_attempt_output_assets_response_body"
              schema:
                $ref: "#/components/schemas/AddressDocumentVerificationAttemptAssetsOutput"

  /v2/address-document-verifications/{address_document_verification_id}/notify:
    post:
      tags:
        - Address document verifications (Coming soon)
      summary: Request webhook notification
      operationId: notify_address_document_verification
      description: This endpoint can be used to initiate a webhook call containing the latest event of an Address Document Verification
      parameters:
        - name: address_document_verification_id
          in: path
          description: ID of the document verification to notify
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                webhook_url:
                  type: string
                  format: uri
      responses:
        "204":
          description: Notification successfully requested

  /v2/address-document-verifications/{address_document_verification_id}/pdf-report:
    get:
      tags:
        - Address document verifications (Coming soon)
      summary: Retrieve PDF report of an Address Document Verification
      operationId: pdf_address_document_verification
      description: |
        This endpoint allows you to retrieve a PDF report of an Address Document Verification.

        Please note that the PDF report is only available for address document verifications that are
        in status `declined` and `approved` once you receive the `address_document_verification_report_created` event.
      parameters:
        - name: address_document_verification_id
          in: path
          description: ID of the Address Document Verification 
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Address Document Verification PDF report retrieved successfully
          content:
            application/json:
              examples:
                address_document_verification_pdf_report_response_body:
                  $ref: "#/components/examples/address_document_verification_pdf_report_response_body"
              schema:
                $ref: "#/components/schemas/AddressDocumentVerificationOutputPdfReport"
        "404":
          description: The PDF report is not available

  /v2/aml-verifications:
    post:
      tags:
        - AML verifications
      summary: Create an AML verification
      description: This endpoint allows you to create an AML verification. You should get a `201` response.
      operationId: create_aml_verification
      requestBody:
        required: true
        content:
          application/json:
            examples:
              Only required data:
                $ref: "#/components/examples/aml_verification_creation_request_body_min"
              All possible data:
                $ref: "#/components/examples/aml_verification_creation_request_body_max"
            schema:
              $ref: "#/components/schemas/AMLVerificationInputPost"
      responses:
        "201":
          description: AML verification created
          content:
            application/json:
              examples:
                aml_verification_response_body:
                  $ref: "#/components/examples/aml_verification_response_body"
              schema:
                required: [applicant_id]
                allOf:
                  - $ref: "#/components/schemas/AMLVerificationOutputPost"

  /v2/aml-verifications/{aml_verification_id}:
    get:
      tags:
        - AML verifications
      summary: Retrieve an AML verification
      description: This endpoint allows you to get the detailed results of an AML verification.
      operationId: retrieve_aml_verification
      parameters:
        - name: aml_verification_id
          required: true
          in: path
          description: ID of the AML verification
          schema:
            $ref: "#/components/schemas/AMLVerificationId"
      responses:
        "200":
          description: AML verification retrieved
          content:
            application/json:
              examples:
                aml_verification_response_body:
                  $ref: "#/components/examples/aml_verification_response_body"
              schema:
                required: [applicant_id]
                allOf:
                  - $ref: "#/components/schemas/AMLVerificationOutputGet"

  /v2/applicants:
    post:
      tags:
        - Applicants
      summary: Create an Applicant
      description: This section describes all endpoints related to applicants. It will enable you to create and manage applicant objects.
      operationId: create_applicant
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ApplicantInputPost"
            examples:
              All possible data:
                $ref: "#/components/examples/applicant_creation_request_body"

      responses:
        "201":
          description: Applicant successfully created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApplicantOutputPost"
              examples:
                Always replies:
                  $ref: "#/components/examples/applicant_response_body"
          links:
            RetrieveApplicantById:
              operationId: retrieve_applicant
              parameters:
                applicant_id: "$response.body#/id"
        "400":
          description: Bad request
          content:
            application/json:
              examples:
                Invalid phone number:
                  value:
                    {
                      "error_type": "request_invalid",
                      "error_codes": ["phone_number__invalid_format"],
                    }

  /v2/applicants/{applicant_id}:
    get:
      tags:
        - Applicants
      summary: Retrieve an Applicant
      description: Retrieve an Applicant
      operationId: retrieve_applicant
      parameters:
        - name: applicant_id
          required: true
          in: path
          description: ID of Applicant to return
          schema:
            $ref: "#/components/schemas/ApplicantId"
      responses:
        "200":
          description: applicant retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApplicantOutputGet"
              examples:
                Always replies:
                  $ref: "#/components/examples/applicant_response_body"
        "404":
          description: "Applicant not found"

    patch:
      tags:
        - Applicants
      summary: Update an Applicant
      description: Update an Applicant
      operationId: update_applicant
      parameters:
        - name: applicant_id
          required: true
          in: path
          description: ID of Applicant to return
          schema:
            $ref: "#/components/schemas/ApplicantId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ApplicantInputPatch"
            examples:
              All possible data:
                $ref: "#/components/examples/applicant_patch_request_body"
      responses:
        "200":
          description: applicant updated successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApplicantOutputPatch"
              examples:
                Always replies:
                  $ref: "#/components/examples/applicant_response_body"
        "404":
          description: Applicant not found
        "400":
          description: Bad request. One or more input parameters are invalid
        "500":
          description: Internal server error

  /v2/applicants/{applicant_id}/anonymize:
    post:
      tags:
        - Applicants
      summary: Anonymize an Applicant
      description: Anonymize the personal data of an applicant with the specified ID.
      operationId: anonymize_applicant
      parameters:
        - name: applicant_id
          in: path
          description: ID of the applicant to anonymize
          required: true
          schema:
            type: string
      responses:
        "200":
          description: applicant anonymized successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ApplicantOutputAnonymize"
              examples:
                Always replies:
                  $ref: "#/components/examples/applicant_response_body_anonymized"
        "404":
          description: Identity verification not found
        "400":
          description: Bad request. The applicant cannot be anonymized.
        "500":
          description: Internal server error

  /v2/bank-document-verifications:
    post:
      tags:
        - Bank document verifications (Coming soon)
      summary: Create a Bank Document Verification
      operationId: create_bank_document_verification
      description: Creates a Bank Document Verification
      requestBody:
        required: true
        content:
          application/json:
            examples:
              bank_document_verification_creation_request_body_min:
                $ref: "#/components/examples/bank_document_verification_creation_request_body_min"
              bank_document_verification_creation_request_body_max:
                $ref: "#/components/examples/bank_document_verification_creation_request_body_max"
            schema:
              $ref: "#/components/schemas/BankDocumentVerificationInputPost"
      responses:
        "201":
          description: Bank Document Verification created successfully
          content:
            application/json:
              examples:
                bank_document_verification_creation_response_body:
                  $ref: "#/components/examples/bank_document_verification_creation_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/BankDocumentVerificationOutputPost"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity
        "500":
          description: Internal server error
        "503":
          description: Service unavailable

  /v2/bank-document-verifications/{bank_document_verification_id}:
    get:
      tags:
        - Bank document verifications (Coming soon)
      summary: Retrieve a Bank Document Verification
      description: This endpoint allows you to get the detailed results of a Bank Document Verification
      operationId: retrieve_bank_document_verification
      parameters:
        - name: bank_document_verification_id
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/BankDocumentVerificationId"
      responses:
        "200":
          description: Bank Document Verification retrieved successfully
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/BankDocumentVerificationOutputGet"
        "404":
          description: Bank Document Verification not found
        "500":
          description: Internal server error

  /v2/bank-document-verifications/{bank_document_verification_id}/anonymize:
    post:
      tags:
        - Bank document verifications (Coming soon)
      summary: Anonymize a Bank Document Verification
      operationId: anonymize_bank_document_verification
      description: Anonymize the personal data of a Bank Document Verification with the specified ID.
      parameters:
        - name: bank_document_verification_id
          in: path
          description: ID of the document verification to anonymize
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Bank Document Verification anonymized
          content:
            application/json:
              examples:
                bank_document_verification_anonymization_response_body:
                  $ref: "#/components/examples/bank_document_verification_anonymization_response_body"
              schema:
                required: [applicant_id, user_journey_id]
                allOf:
                  - $ref: "#/components/schemas/BankDocumentVerificationOutputAnonymize"
        "404":
          description: Bank Document Verification not found
        "500":
          description: Internal server error

  /v2/bank-document-verifications/{bank_document_verification_id}/attempts:
    get:
      tags:
        - Bank document verifications (Coming soon)
      summary: List Bank Document Verification attempts
      operationId: list_attempts_bank_document_verification
      description: |
        This endpoint allows you to list all attempts of a Bank Document Verification.

        Attempts are returned ordered by creation date, newest first.

        The response is paginated (see [Pagination](#section/API-standards/Pagination) section).
        You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.
      parameters:
        - name: bank_document_verification_id
          in: path
          description: ID of the document verification
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/skipParam"
        - $ref: "#/components/parameters/limitParam"
      responses:
        "200":
          description: Bank Document Verification attempts retrieved successfully
          content:
            application/json:
              examples:
                bank_document_verification_attempt_list_response_body:
                  $ref: "#/components/examples/bank_document_verification_attempt_list_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/BankDocumentVerificationAttemptOutputList"
        "404":
          description: The provided document verification ID is not valid
        "500":
          description: An error occurred while fetching the attempts
    post:
      tags:
        - Bank document verifications (Coming soon)
      summary: Create a Bank Document Verification attempt
      description: "This endpoint allows you to create a Bank Document Verification attempt. It is possible when the Bank Document Verification 
        is one of the following statuses: `created`, `retry_required`"
      operationId: create_bank_document_verification_attempt
      parameters:
        - name: bank_document_verification_id
          in: path
          description: ID of the document verification
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          multipart/form-data:
            examples:
              bank_document_verification_attempt_creation_request_body_min:
                $ref: "#/components/examples/bank_document_verification_attempt_creation_request_body_min"
              bank_document_verification_attempt_creation_request_body_max:
                $ref: "#/components/examples/bank_document_verification_attempt_creation_request_body_max"
            schema:
              $ref: "#/components/schemas/BankDocumentVerificationAttemptInputPost"
      responses:
        "201":
          description: Bank Document Verification attempt created
          content:
            application/json:
              examples:
                bank_document_verification_attempt_creation_response_body:
                  $ref: "#/components/examples/bank_document_verification_attempt_creation_response_body"
              schema:
                $ref: "#/components/schemas/BankDocumentVerificationAttemptOutputPost"
        "403":
          description: The uploaded file was rejected by our file security checks
        "404":
          description: The provided Bank Document Verification ID is not valid
        "409":
          description: The Bank Document Verification is not in a valid state to create an attempt.
            The Bank Document Verification status must be `created` or `retry_required`
        "500":
          description: An error occurred while creating the attempt

  /v2/bank-document-verifications/{bank_document_verification_id}/attempts/{attempt_id}:
    get:
      tags:
        - Bank document verifications (Coming soon)
      summary: Retrieve a Bank Document Verification attempt
      description: This endpoint allows you to retrieve the details for a given Bank Document Verification attempt.
      operationId: fetch_attempts_bank_document_verification
      parameters:
        - name: bank_document_verification_id
          in: path
          description: ID of the document verification
          required: true
          schema:
            type: string
        - name: attempt_id
          in: path
          description: ID of the document verification attempt
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Bank Document Verification attempt retrieved successfully
          content:
            application/json:
              examples:
                bank_document_verification_attempt_get_response_body:
                  $ref: "#/components/examples/bank_document_verification_attempt_get_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/BankDocumentVerificationAttemptOutputGet"
        "404":
          description: The provided document verification attempt ID is not valid
        "500":
          description: An error occurred while fetching the attempt

  /v2/bank-document-verifications/{bank_document_verification_id}/attempts/{attempt_id}/assets:
    get:
      tags:
        - Bank document verifications (Coming soon)
      summary: Retrieve a Bank Document Verification attempt asset
      operationId: fetch_asset_bank_document_verification_attempt
      description: |
        This endpoint allows you to retrieve the assets associated with a Bank Document Verification.
        This includes the document image.

        The response is paginated (see [Pagination](#section/API-standards/Pagination) section).
        You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.
      parameters:
        - name: bank_document_verification_id
          in: path
          description: ID of the Bank Document Verification
          required: true
          schema:
            type: string
        - name: attempt_id
          in: path
          description: ID of the Bank Document Verification attempt
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/skipParam"
        - $ref: "#/components/parameters/limitParam"
      responses:
        "200":
          description: Bank Document Verification attempt asset retrieved successfully
          content:
            application/json:
              examples:
                bank_document_verification_attempt_output_assets_response_body:
                  $ref: "#/components/examples/bank_document_verification_attempt_output_assets_response_body"
              schema:
                $ref: "#/components/schemas/BankDocumentVerificationAttemptAssetsOutput"

  /v2/bank-document-verifications/{bank_document_verification_id}/notify:
    post:
      tags:
        - Bank document verifications (Coming soon)
      summary: Request webhook notification
      operationId: notify_bank_document_verification
      description: This endpoint can be used to initiate a webhook call containing the latest event of a Bank Document Verification
      parameters:
        - name: bank_document_verification_id
          in: path
          description: ID of the document verification to notify
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                webhook_url:
                  type: string
                  format: uri
      responses:
        "204":
          description: Notification successfully requested

  /v2/bank-document-verifications/{bank_document_verification_id}/pdf-report:
    get:
      tags:
        - Bank document verifications (Coming soon)
      summary: Retrieve PDF report of a Bank Document Verification
      operationId: pdf_bank_document_verification
      description: |
        This endpoint allows you to retrieve a PDF report of a Bank Document Verification.

        Please note that the PDF report is only available for bank document verifications that are
        in status `declined` and `approved` once you receive the `bank_document_verification_report_created` event.
      parameters:
        - name: bank_document_verification_id
          in: path
          description: ID of the Bank Document Verification 
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Bank Document Verification PDF report retrieved successfully
          content:
            application/json:
              examples:
                bank_document_verification_pdf_report_response_body:
                  $ref: "#/components/examples/bank_document_verification_pdf_report_response_body"
              schema:
                $ref: "#/components/schemas/BankDocumentVerificationOutputPdfReport"
        "404":
          description: The PDF report is not available

  /v2/business-applicants:
    post:
      tags:
        - Business applicants
      summary: Create a Business Applicant
      description: This section describes all endpoints related to business applicants. It will enable you to create and manage business applicant objects.
      operationId: create_business_applicant
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BusinessApplicantInputPost"
            examples:
              All possible data:
                $ref: "#/components/examples/business_applicant_creation_request_body"

      responses:
        "201":
          description: Business applicant successfully created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BusinessApplicantOutputPost"
              examples:
                Always replies:
                  $ref: "#/components/examples/business_applicant_response_body"
          links:
            RetrieveBusinessApplicantById:
              operationId: retrieve_business_applicant
              parameters:
                business_applicant_id: "$response.body#/id"
        "400":
          description: Bad request
          content:
            application/json:
              examples:
                Invalid request:
                  value:
                    {
                      "error_type": "request_invalid",
                      "error_codes": ["external_applicant_id__invalid"],
                    }

  /v2/business-applicants/{business_applicant_id}:
    get:
      tags:
        - Business applicants
      summary: Retrieve a Business Applicant
      description: Retrieve a Business Applicant
      operationId: retrieve_business_applicant
      parameters:
        - name: business_applicant_id
          required: true
          in: path
          description: ID of Business Applicant to return
          schema:
            $ref: "#/components/schemas/BusinessApplicantId"
      responses:
        "200":
          description: business applicant retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BusinessApplicantOutputGet"
              examples:
                Always replies:
                  $ref: "#/components/examples/business_applicant_response_body"
        "404":
          description: "Business applicant not found"

  /v2/company-document-verifications:
    post:
      tags:
        - Company document verifications (Coming soon)
      summary: Create a Company Document Verification
      operationId: create_company_document_verification
      description: Creates a Company Document Verification
      requestBody:
        required: true
        content:
          application/json:
            examples:
              company_document_verification_creation_request_body_min:
                $ref: "#/components/examples/company_document_verification_creation_request_body_min"
              company_document_verification_creation_request_body_max:
                $ref: "#/components/examples/company_document_verification_creation_request_body_max"
            schema:
              $ref: "#/components/schemas/CompanyDocumentVerificationInputPost"
      responses:
        "201":
          description: Company Document Verification created successfully
          content:
            application/json:
              examples:
                company_document_verification_creation_response_body:
                  $ref: "#/components/examples/company_document_verification_creation_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/CompanyDocumentVerificationOutputPost"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity
        "500":
          description: Internal server error
        "503":
          description: Service unavailable

  /v2/company-document-verifications/{company_document_verification_id}:
    get:
      tags:
        - Company document verifications (Coming soon)
      summary: Retrieve a Company Document Verification
      description: This endpoint allows you to get the detailed results of a Company Document Verification
      operationId: retrieve_company_document_verification
      parameters:
        - name: company_document_verification_id
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/CompanyDocumentVerificationId"
      responses:
        "200":
          description: Company Document Verification retrieved successfully
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/CompanyDocumentVerificationOutputGet"
        "404":
          description: Company Document Verification not found
        "500":
          description: Internal server error

  /v2/company-document-verifications/{company_document_verification_id}/anonymize:
    post:
      tags:
        - Company document verifications (Coming soon)
      summary: Anonymize a Company Document Verification
      operationId: anonymize_company_document_verification
      description: Anonymize the personal data of a Company Document Verification with the specified ID.
      parameters:
        - name: company_document_verification_id
          in: path
          description: ID of the document verification to anonymize
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Company Document Verification anonymized
          content:
            application/json:
              examples:
                company_document_verification_anonymization_response_body:
                  $ref: "#/components/examples/company_document_verification_anonymization_response_body"
              schema:
                required: [applicant_id, user_journey_id]
                allOf:
                  - $ref: "#/components/schemas/CompanyDocumentVerificationOutputAnonymize"
        "404":
          description: Company Document Verification not found
        "500":
          description: Internal server error

  /v2/company-document-verifications/{company_document_verification_id}/attempts:
    get:
      tags:
        - Company document verifications (Coming soon)
      summary: List Company Document Verification attempts
      operationId: list_attempts_company_document_verification
      description: |
        This endpoint allows you to list all attempts of a Company Document Verification.

        Attempts are returned ordered by creation date, newest first.

        The response is paginated (see [Pagination](#section/API-standards/Pagination) section).
        You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.
      parameters:
        - name: company_document_verification_id
          in: path
          description: ID of the document verification
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/skipParam"
        - $ref: "#/components/parameters/limitParam"
      responses:
        "200":
          description: Company Document Verification attempts retrieved successfully
          content:
            application/json:
              examples:
                company_document_verification_attempt_list_response_body:
                  $ref: "#/components/examples/company_document_verification_attempt_list_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/CompanyDocumentVerificationAttemptOutputList"
        "404":
          description: The provided document verification ID is not valid
        "500":
          description: An error occurred while fetching the attempts
    post:
      tags:
        - Company document verifications (Coming soon)
      summary: Create a Company Document Verification attempt
      description: "This endpoint allows you to create a Company Document Verification attempt. It is possible when the Company Document Verification 
        is one of the following statuses: `created`, `retry_required`"
      operationId: create_company_document_verification_attempt
      parameters:
        - name: company_document_verification_id
          in: path
          description: ID of the document verification
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          multipart/form-data:
            examples:
              company_document_verification_attempt_creation_request_body_min:
                $ref: "#/components/examples/company_document_verification_attempt_creation_request_body_min"
              company_document_verification_attempt_creation_request_body_max:
                $ref: "#/components/examples/company_document_verification_attempt_creation_request_body_max"
            schema:
              $ref: "#/components/schemas/CompanyDocumentVerificationAttemptInputPost"
      responses:
        "201":
          description: Company Document Verification attempt created
          content:
            application/json:
              examples:
                company_document_verification_attempt_creation_response_body:
                  $ref: "#/components/examples/company_document_verification_attempt_creation_response_body"
              schema:
                $ref: "#/components/schemas/CompanyDocumentVerificationAttemptOutputPost"
        "403":
          description: The uploaded file was rejected by our file security checks
        "404":
          description: The provided Company Document Verification ID is not valid
        "409":
          description: The Company Document Verification is not in a valid state to create an attempt.
            The Company Document Verification status must be `created` or `retry_required`
        "500":
          description: An error occurred while creating the attempt

  /v2/company-document-verifications/{company_document_verification_id}/attempts/{attempt_id}:
    get:
      tags:
        - Company document verifications (Coming soon)
      summary: Retrieve a Company Document Verification attempt
      description: This endpoint allows you to retrieve the details for a given Company Document Verification attempt.
      operationId: fetch_attempts_company_document_verification
      parameters:
        - name: company_document_verification_id
          in: path
          description: ID of the document verification
          required: true
          schema:
            type: string
        - name: attempt_id
          in: path
          description: ID of the document verification attempt
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Company Document Verification attempt retrieved successfully
          content:
            application/json:
              examples:
                company_document_verification_attempt_get_response_body:
                  $ref: "#/components/examples/company_document_verification_attempt_get_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/CompanyDocumentVerificationAttemptOutputGet"
        "404":
          description: The provided document verification attempt ID is not valid
        "500":
          description: An error occurred while fetching the attempt

  /v2/company-document-verifications/{company_document_verification_id}/attempts/{attempt_id}/assets:
    get:
      tags:
        - Company document verifications (Coming soon)
      summary: Retrieve a Company Document Verification attempt asset
      operationId: fetch_asset_company_document_verification_attempt
      description: |
        This endpoint allows you to retrieve the assets associated with a Company Document Verification.
        This includes the document image.

        The response is paginated (see [Pagination](#section/API-standards/Pagination) section).
        You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.
      parameters:
        - name: company_document_verification_id
          in: path
          description: ID of the Company Document Verification
          required: true
          schema:
            type: string
        - name: attempt_id
          in: path
          description: ID of the Company Document Verification attempt
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/skipParam"
        - $ref: "#/components/parameters/limitParam"
      responses:
        "200":
          description: Company Document Verification attempt asset retrieved successfully
          content:
            application/json:
              examples:
                company_document_verification_attempt_output_assets_response_body:
                  $ref: "#/components/examples/company_document_verification_attempt_output_assets_response_body"
              schema:
                $ref: "#/components/schemas/CompanyDocumentVerificationAttemptAssetsOutput"

  /v2/company-document-verifications/{company_document_verification_id}/notify:
    post:
      tags:
        - Company document verifications (Coming soon)
      summary: Request webhook notification
      operationId: notify_company_document_verification
      description: This endpoint can be used to initiate a webhook call containing the latest event of a Company Document Verification
      parameters:
        - name: company_document_verification_id
          in: path
          description: ID of the document verification to notify
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                webhook_url:
                  type: string
                  format: uri
      responses:
        "204":
          description: Notification successfully requested

  /v2/company-document-verifications/{company_document_verification_id}/pdf-report:
    get:
      tags:
        - Company document verifications (Coming soon)
      summary: Retrieve PDF report of a Company Document Verification
      operationId: pdf_company_document_verification
      description: |
        This endpoint allows you to retrieve a PDF report of a Company Document Verification.

        Please note that the PDF report is only available for company document verifications that are
        in status `declined` and `approved` once you receive the `company_document_verification_report_created` event.
      parameters:
        - name: company_document_verification_id
          in: path
          description: ID of the Company Document Verification 
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Company Document Verification PDF report retrieved successfully
          content:
            application/json:
              examples:
                company_document_verification_pdf_report_response_body:
                  $ref: "#/components/examples/company_document_verification_pdf_report_response_body"
              schema:
                $ref: "#/components/schemas/CompanyDocumentVerificationOutputPdfReport"
        "404":
          description: The PDF report is not available

  /v2/create-and-start-idv:
    post:
      tags:
        - Identity verifications
      summary: Create and start an identity verification
      description: This endpoint allows you to create and identity verification. You should get a `201` response and the identity verification resource containing the `_links/verification_url`.
      operationId: create_and_start_identity_verification
      requestBody:
        required: true
        content:
          application/json:
            examples:
              Only required data:
                $ref: "#/components/examples/identity_verification_creation_request_body_helper_min"
              All possible data:
                $ref: "#/components/examples/identity_verification_creation_request_body_helper_max"
              Use an existing applicant:
                $ref: "#/components/examples/identity_verification_creation_request_body_min_plus_aplt"
            schema:
              $ref: "#/components/schemas/IdentityVerificationInputHelper"
      responses:
        "201":
          description: Identity verification created
          content:
            application/json:
              examples:
                identity_verification_creation_response_body_helper:
                  $ref: "#/components/examples/identity_verification_creation_response_body_helper"
              schema:
                allOf:
                  - $ref: "#/components/schemas/IdentityVerificationOutputHelper"
      callbacks:
        statusChanged:
          "{$request.body#/webhook_url}":
            post:
              summary: Status update notification
              requestBody:
                required: true
                content:
                  application/json:
                    example:
                      {
                        "specversion": "2.0",
                        "type": "identity_verification_capture_completed",
                        "subject": "idv_5hxpdwegjcbujpth3wdo55d3vm",
                        "id": "evnt_5hxpdwegjcbujpth3wdo55d3vm",
                        "time": "2023-03-22T17:31:00Z",
                        "datacontenttype": "application/json",
                        "data":
                          {
                            "applicant_id": "aplt_5hxpdwegjcbujpth3wdo55d3vm",
                            "user_journey_id": "usj_5hxpdwegjcbujpth3wdo55d3vm",
                            "identity_verification_id": "idv_5hxpdwegjcbujpth3wdo55d3vm",
                            "status": "declined",
                            "response_codes":
                              [
                                {
                                  "code": 61310,
                                  "summary": "document_front_not_captured",
                                },
                                {
                                  "code": 62102,
                                  "summary": "document_not_accepted",
                                },
                              ],
                          },
                      }
                    schema:
                      $ref: "#/components/schemas/Event"
              responses:
                "200":
                  description: Your server returns this code if it accepts the callback.
                "201":
                  description: Your server returns this code if it accepts the callback.

  /v2/face-authentications:
    post:
      tags:
        - Face authentications
      summary: Create a face authentication
      description: This endpoint allows you to create a face authentication.
      operationId: create_face_authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/FaceAuthenticationInputPost"
      responses:
        "201":
          description: Face authentication created
          content:
            application/json:
              examples:
                face_authentication_creation_response_body:
                  $ref: "#/components/examples/face_authentication_creation_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/FaceAuthenticationOutputPost"
        "400":
          description: Bad request
        "500":
          description: Internal server error

  /v2/face-authentications/{face_authentication_id}:
    get:
      tags:
        - Face authentications
      summary: Retrieve a face authentication
      description: This endpoint allows you to get the detailed results of a face authentication.
      operationId: retrieve_face_authentication
      parameters:
        - name: face_authentication_id
          required: true
          in: path
          description: ID of the face authentication
          schema:
            $ref: "#/components/schemas/FaceAuthenticationId"
      responses:
        "200":
          description: Face authentication retrieved
          content:
            application/json:
              examples:
                face_authentication_creation_response_body:
                  $ref: "#/components/examples/face_authentication_creation_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/FaceAuthenticationOutputGet"
        "404":
          description: Face authentication not found
        "500":
          description: Internal server error

  /v2/face-authentications/{face_authentication_id}/anonymize:
    post:
      tags:
        - Face authentications
      summary: Anonymize a face authentication
      description: Anonymize the personal data of a face authentication with the specified ID.
      operationId: anonymize_face_authentication
      parameters:
        - name: face_authentication_id
          in: path
          description: ID of the face authentication to anonymize
          required: true
          schema:
            type: string

      responses:
        "200":
          description: Face authentication anonymization requested
          content:
            application/json:
              examples:
                face_authentication_anonymization_response_body:
                  $ref: "#/components/examples/face_authentication_anonymization_response_body"
              schema:
                required: [applicant_id, user_journey_id]
                allOf:
                  - $ref: "#/components/schemas/FaceAuthenticationOutputAnonymize"
        "404":
          description: Face authentication not found
        "400":
          description: Bad request. The face authentication cannot be anonymized.
        "500":
          description: Internal server error

  /v2/face-authentications/{face_authentication_id}/attempts:
    get:
      tags:
        - Face authentications
      summary: List attempts
      description: |
        This endpoint allows you to list all attempts of a face authentication.

        Attempts are returned ordered by creation date, newest first.

        The response is paginated (see [Pagination](#section/API-standards/Pagination) section).
        You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.
      operationId: list_attempts_face_authentication
      parameters:
        - name: face_authentication_id
          in: path
          description: ID of the face authentication
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/skipParam"
        - $ref: "#/components/parameters/limitParam"
      responses:
        "200":
          description: List attempts
          content:
            application/json:
              examples:
                face_authentication_attempt_list_response_body:
                  $ref: "#/components/examples/face_authentication_attempt_list_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/FaceAuthenticationAttemptResponseList"
        "404":
          description: The provided face authentication ID is not valid
        "500":
          description: An error occurred while fetching the attempts
    post:
      tags:
        - Face authentications
      summary: Create an attempt
      description: This endpoint allows you to create a new Attempt. It is possible when the face-authentication is in one of
        the following statuses `created`, `pending`, `capture_in_progress`, `retry_required`
      operationId: create_attempt_face_authentication
      parameters:
        - name: face_authentication_id
          in: path
          description: ID of the face authentication
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            examples:
              Minimal body:
                $ref: "#/components/examples/attempt_creation_request_body_min"
              All possible data:
                $ref: "#/components/examples/face_attempt_creation_request_body_max"
            schema:
              $ref: "#/components/schemas/FaceAuthenticationAttemptInputPost"
      responses:
        "201":
          description: Attempt created
          content:
            application/json:
              examples:
                face_authentication_attempt_creation_response_body:
                  $ref: "#/components/examples/face_authentication_attempt_creation_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/FaceAuthenticationAttemptOutputPost"
        "404":
          description: The provided face authentication ID is not valid
        "409":
          description: The current face authentication status does not allow the creation of a new attempt.
            The face authentication status must be either `created`, `pending`, `capture_in_progress`, or `retry_required`
        "500":
          description: An error occurred while creating the attempt

  /v2/face-authentications/{face_authentication_id}/attempts/{attempt_id}:
    get:
      tags:
        - Face authentications
      summary: Retrieve an attempt
      description: This endpoint allows you to retrieve the details for a given attempt
      operationId: fetch_attempts_face_authentication
      parameters:
        - name: face_authentication_id
          in: path
          description: ID of the face authentication
          required: true
          schema:
            type: string
        - name: attempt_id
          in: path
          description: ID of the attempt
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Attempt fetched
          content:
            application/json:
              examples:
                face_authentication_detail_response_body:
                  $ref: "#/components/examples/face_authentication_attempt_get_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/FaceAuthenticationAttemptOutputGet"
        "404":
          description: The provided face authentication ID or attempt ID is not valid
        "500":
          description: An error occurred while fetching the attempt

  /v2/face-authentications/{face_authentication_id}/attempts/{attempt_id}/assets:
    get:
      tags:
        - Face authentications
      summary: Retrieve attempt assets
      description: |
        Retrieves the assets associated with a face authentication attempt.
        This includes face images and videos captured during the verification process.
        Please note that videos are not exposed by default, contact your account manager to enable this feature.

        The response is paginated (see [Pagination](#section/API-standards/Pagination) section).
        You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.
      operationId: retrieve_face_authentication_attempt_assets
      parameters:
        - name: face_authentication_id
          in: path
          required: true
          schema:
            type: string
          description: The ID of the face authentication
        - name: attempt_id
          in: path
          required: true
          schema:
            type: string
          description: The ID of the attempt
        - $ref: "#/components/parameters/skipParam"
        - $ref: "#/components/parameters/limitParam"
      responses:
        '200':
          description: The assets were retrieved successfully
          content:
            application/json:
              examples:
                face_authentication_attempt_assets_response_body:
                  $ref: "#/components/examples/face_authentication_attempt_assets_response_body"
              schema:
                $ref: "#/components/schemas/FaceAuthenticationAttemptAssetsOutput"

  /v2/face-authentications/{face_authentication_id}/notify:
    post:
      tags:
        - Face authentications
      summary: Request webhook notification
      operationId: notify_face_authentication
      description: This endpoint can be used to initiate a webhook call containing the latest event of a face authentication.
      parameters:
        - name: face_authentication_id
          in: path
          description: ID of the face authentication to notify
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                webhook_url:
                  type: string
                  format: uri
      responses:
        "204":
          description: Notification successfully requested

  /v2/id-document-verifications:
    post:
      tags:
        - ID document verifications
      summary: Create an ID document verification
      operationId: create_id_document_verification
      description: Creates an ID document verification
      requestBody:
        required: true
        content:
          application/json:
            examples:
              id_document_verification_creation_request_body_min:
                $ref: "#/components/examples/id_document_verification_creation_request_body_min"
              id_document_verification_creation_request_body_max:
                $ref: "#/components/examples/id_document_verification_creation_request_body_max"
            schema:
              $ref: "#/components/schemas/IdDocumentVerificationInputPost"
      responses:
        "201":
          description: ID document verification created successfully
          content:
            application/json:
              examples:
                id_document_verification_creation_response_body:
                  $ref: "#/components/examples/id_document_verification_creation_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/IdDocumentVerificationOutputPost"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity
        "500":
          description: Internal server error
        "503":
          description: Service unavailable

  /v2/id-document-verifications/{id_document_verification_id}:
    get:
      tags:
        - ID document verifications
      summary: Retrieve an ID document verification
      description: This endpoint allows you to get the detailed results of an ID document verification
      operationId: retrieve_id_document_verification
      parameters:
        - name: id_document_verification_id
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/IdDocumentVerificationId"
      responses:
        "200":
          description: Document verification retrieved successfully
          content:
            application/json:
              examples:
                id_document_verification_creation_response_body:
                  $ref: "#/components/examples/id_document_verification_creation_response_body"
              schema:
                $ref: "#/components/schemas/IdDocumentVerificationOutputGet"
        "404":
          description: ID document verification not found
        "500":
          description: Internal server error

  /v2/id-document-verifications/{id_document_verification_id}/anonymize:
    post:
      tags:
        - ID document verifications
      summary: Anonymize an ID document verification
      operationId: anonymize_id_document_verification
      description: Anonymize the personal data of an ID document verification with the specified ID.
      parameters:
        - name: id_document_verification_id
          in: path
          description: ID of the document verification to anonymize
          required: true
          schema:
            type: string
      responses:
        "200":
          description: ID document verification anonymized
          content:
            application/json:
              examples:
                id_document_verification_anonymization_response_body:
                  $ref: "#/components/examples/id_document_verification_anonymization_response_body"
              schema:
                required: [applicant_id, user_journey_id]
                allOf:
                  - $ref: "#/components/schemas/IdDocumentVerificationOutputAnonymize"
        "404":
          description: ID document verification not found
        "500":
          description: Internal server error

  /v2/id-document-verifications/{id_document_verification_id}/attempts:
    get:
      tags:
        - ID document verifications
      summary: List ID document verification attempts
      operationId: list_attempts_id_document_verification
      description: |
        This endpoint allows you to list all attempts of an ID document verification.

        Attempts are returned ordered by creation date, newest first.

        The response is paginated (see [Pagination](#section/API-standards/Pagination) section).
        You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.
      parameters:
        - name: id_document_verification_id
          in: path
          description: ID of the document verification
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/skipParam"
        - $ref: "#/components/parameters/limitParam"
      responses:
        "200":
          description: ID document verification attempts retrieved successfully
          content:
            application/json:
              examples:
                id_document_verification_attempt_list_response_body:
                  $ref: "#/components/examples/id_document_verification_attempt_list_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/IdDocumentVerificationAttemptOutputList"
        "404":
          description: The provided document verification ID is not valid
        "500":
          description: An error occurred while fetching the attempts
    post:
      tags:
        - ID document verifications
      summary: Create an ID document verification attempt
      description: "This endpoint allows you to create an ID document verification attempt. It is possible when the ID document verification 
        is one of the following statuses: `created`, `retry_required`"
      operationId: create_id_document_verification_attempt
      parameters:
        - name: id_document_verification_id
          in: path
          description: ID of the document verification
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          multipart/form-data:
            examples:
              id_document_verification_attempt_creation_request_body_min:
                $ref: "#/components/examples/id_document_verification_attempt_creation_request_body_min"
              id_document_verification_attempt_creation_request_body_max:
                $ref: "#/components/examples/id_document_verification_attempt_creation_request_body_max"
            schema:
              $ref: "#/components/schemas/IdDocumentVerificationAttemptInputPost"
      responses:
        "201":
          description: ID document verification attempt created
          content:
            application/json:
              examples:
                id_document_verification_attempt_creation_response_body:
                  $ref: "#/components/examples/id_document_verification_attempt_creation_response_body"
              schema:
                $ref: "#/components/schemas/IdDocumentVerificationAttemptOutputPost"
        "403":
          description: The uploaded file was rejected by our file security checks
        "404":
          description: The provided ID document verification ID is not valid
        "409":
          description: The ID document verification is not in a valid state to create an attempt.
            The ID document verification status must be `created` or `retry_required`
        "500":
          description: An error occurred while creating the attempt

  /v2/id-document-verifications/{id_document_verification_id}/attempts/{attempt_id}:
    get:
      tags:
        - ID document verifications
      summary: Retrieve an ID document verification attempt
      description: This endpoint allows you to retrieve the details for a given ID document verification attempt
      operationId: fetch_attempts_id_document_verification
      parameters:
        - name: id_document_verification_id
          in: path
          description: ID of the document verification
          required: true
          schema:
            type: string
        - name: attempt_id
          in: path
          description: ID of the document verification attempt
          required: true
          schema:
            type: string
      responses:
        "200":
          description: ID document verification attempt retrieved successfully
          content:
            application/json:
              examples:
                id_document_verification_attempt_get_response_body:
                  $ref: "#/components/examples/id_document_verification_attempt_get_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/IdDocumentVerificationAttemptOutputGet"
        "404":
          description: The provided document verification attempt ID is not valid
        "500":
          description: An error occurred while fetching the attempt

  /v2/id-document-verifications/{id_document_verification_id}/attempts/{attempt_id}/assets:
    get:
      tags:
        - ID document verifications
      summary: Retrieve an ID document verification attempt asset
      operationId: fetch_asset_id_document_verification_attempt
      description: |
        This endpoint allows you to retrieve the assets associated with an ID document verification.
        This includes the document front image and the document back image.

        The response is paginated (see [Pagination](#section/API-standards/Pagination) section).
        You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.
      parameters:
        - name: id_document_verification_id
          in: path
          description: ID of the ID document verification
          required: true
          schema:
            type: string
        - name: attempt_id
          in: path
          description: ID of the ID document verification attempt
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/skipParam"
        - $ref: "#/components/parameters/limitParam"
      responses:
        "200":
          description: ID document verification attempt asset retrieved successfully
          content:
            application/json:
              examples:
                id_document_verification_attempt_output_assets_response_body:
                  $ref: "#/components/examples/id_document_verification_attempt_output_assets_response_body"
              schema:
                $ref: "#/components/schemas/IdDocumentVerificationAttemptAssetsOutput"

  /v2/id-document-verifications/{id_document_verification_id}/notify:
    post:
      tags:
        - ID document verifications
      summary: Request webhook notification
      operationId: notify_id_document_verification
      description: This endpoint can be used to initiate a webhook call containing the latest event of an ID document verification
      parameters:
        - name: id_document_verification_id
          in: path
          description: ID of the document verification to notify
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                webhook_url:
                  type: string
                  format: uri
      responses:
        "204":
          description: Notification successfully requested

  /v2/id-document-verifications/{id_document_verification_id}/pdf-report:
    get:
      tags:
        - ID document verifications
      summary: Retrieve PDF report of an ID document verification
      operationId: pdf_id_document_verification
      description: |
        This endpoint allows you to retrieve a PDF report of an ID document verification.

        Please note that the PDF report is only available for ID document verifications that are
        in status `declined` and `approved` once you receive the `id_document_verification_report_created` event.
      parameters:
        - name: id_document_verification_id
          in: path
          description: ID of the ID document verification 
          required: true
          schema:
            type: string
      responses:
        "200":
          description: ID document verification PDF report retrieved successfully
          content:
            application/json:
              examples:
                id_document_verification_pdf_report_response_body:
                  $ref: "#/components/examples/id_document_verification_pdf_report_response_body"
              schema:
                $ref: "#/components/schemas/IdDocumentVerificationOutputPdfReport"
        "404":
          description: The PDF report is not available

  /v2/identity-verifications:
    post:
      tags:
        - Identity verifications
      summary: Create an identity verification
      description: |
        Creates an identity verification.

        When this request is successful, you'll get a 201 response with the identity verification resource.
      operationId: create_identity_verification
      requestBody:
        required: true
        content:
          application/json:
            examples:
              Only required data:
                $ref: '#/components/examples/identity_verification_creation_request_body_min'
              All possible data:
                $ref: '#/components/examples/identity_verification_creation_request_body_max'
            schema:
              $ref: '#/components/schemas/IdentityVerificationInputPost'
      responses:
        '201':
          description: Identity verification created successfully
          content:
            application/json:
              examples:
                identity_verification_creation_response_body:
                  $ref: "#/components/examples/identity_verification_creation_response_body"
              schema:
                allOf:
                  - $ref: '#/components/schemas/IdentityVerificationOutputPost'
        '400':
          description: Bad request.
    # Not taken into account in interface testing
    #          content:
    #            application/json:
    #              example:
    #                $ref: '#/components/examples/idv_identity_verification_creation_request_invalid_body'
    #              schema:
    #                $ref: '#/components/schemas/ResponseError'
        '401':
          description: Unauthorized
        '422':
          description: Unprocessable entity
    # Not taken into account in interface testing
    #          content:
    #            application/json:
    #              example:
    #                $ref: '#/components/examples/idv_identity_verification_unprocessable_entity_body'
    #              schema:
    #                $ref: '#/components/schemas/ResponseError'
        '500':
          description: Internal server error.
        '503':
          description: Service unavailable

  /v2/identity-verifications/{identity_verification_id}:
    get:
      tags:
        - Identity verifications
      summary: Retrieve an identity verification
      description: This endpoint allows you to get the detailed results of an identity verification.
      operationId: retrieve_identity_verification
      parameters:
        - name: identity_verification_id
          required: true
          in: path
          description: ID of the identity verification
          schema:
            $ref: "#/components/schemas/IdentityVerificationId"
      responses:
        "200":
          description: Identity verification retrieved
          content:
            application/json:
              examples:
                identity_verification_response_body:
                  $ref: "#/components/examples/identity_verification_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/IdentityVerificationOutputGet"

  /v2/identity-verifications/{identity_verification_id}/anonymize:
    post:
      tags:
        - Identity verifications
      summary: Anonymize an identity verification
      description: Anonymize the personal data of an identity verification with the specified ID.
      operationId: anonymize_identity_verification
      parameters:
        - name: identity_verification_id
          in: path
          description: ID of the identity verification to anonymize
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Identity verification anonymized
          content:
            application/json:
              examples:
                identity_verification_anonymization_response_body:
                  $ref: "#/components/examples/identity_verification_anonymization_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/IdentityVerificationOutputAnonymize"
        "404":
          description: Identity verification not found
        "400":
          description: Bad request. The identity verification cannot be anonymized.
        "500":
          description: Internal server error

  /v2/identity-verifications/{identity_verification_id}/attempts:
    get:
      tags:
        - Identity verifications
      summary: List attempts
      description: |
        This endpoint allows you to list all attempts of a verification.

        Attempts are returned ordered by creation date, newest first.

        The response is paginated (see [Pagination](#section/API-standards/Pagination) section).
        You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.
      operationId: list_attempts
      parameters:
        - name: identity_verification_id
          in: path
          description: ID of the identity verification
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/skipParam"
        - $ref: "#/components/parameters/limitParam"
      responses:
        "200":
          description: List attempt
          content:
            application/json:
              examples:
                identity_verification_list_response_body:
                  $ref: "#/components/examples/identity_verification_attempt_list_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/IdentityVerificationAttemptOutputList"
        "404":
          description: The provided verification ID is not valid
        "500":
          description: An error occurred while fetching the attempts
    post:
      tags:
        - Identity verifications
      summary: Create an attempt
      description: This endpoint allows you to create a new Attempt. It is possible when the identity-verification is in one of
        the following statuses `created`, `pending`, `capture_in_progress`, `retry_required`
      operationId: create_attempt
      parameters:
        - name: identity_verification_id
          in: path
          description: ID of the identity verification
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            examples:
              Minimal body:
                $ref: "#/components/examples/attempt_creation_request_body_min"
              All possible data:
                $ref: "#/components/examples/identity_attempt_creation_request_body_max"
            schema:
              $ref: "#/components/schemas/IdentityVerificationAttemptInputPost"
      responses:
        "201":
          description: Attempt created
          content:
            application/json:
              examples:
                identity_verification_attempt_creation_response_body:
                  $ref: "#/components/examples/identity_verification_attempt_creation_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/IdentityVerificationAttemptOutputPost"
        "404":
          description: The provided verification ID is not valid
        "409":
          description: The current verification status does not allow the creation of a new attempt. The verification status must be either `created`, `pending`, `capture_in_progress`, or `retry_required`
        "500":
          description: An error occurred while creating the attempt

  /v2/identity-verifications/{identity_verification_id}/attempts/{attempt_id}:
    get:
      tags:
        - Identity verifications
      summary: Retrieve an attempt
      description: This endpoint allows you to retrieve the details for a given attempt
      operationId: fetch_attempts
      parameters:
        - name: identity_verification_id
          in: path
          description: ID of the identity verification
          required: true
          schema:
            type: string
        - name: attempt_id
          in: path
          description: ID of the attempt
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Attempt fetched
          content:
            application/json:
              examples:
                identity_verification_attempt_get_response_body:
                  $ref: "#/components/examples/identity_verification_attempt_get_response_body"
              schema:
                allOf:
                  - $ref: "#/components/schemas/IdentityVerificationAttemptOutputGet"
        "404":
          description: The provided verification ID or attempt ID is not valid
        "500":
          description: An error occurred while fetching the attempt

  /v2/identity-verifications/{identity_verification_id}/attempts/{attempt_id}/assets:
    get:
      tags:
        - Identity verifications
      summary: Retrieve attempt assets
      description: |
        Retrieves the assets associated with an identity verification attempt.
        This includes face images, videos, and document images captured during the verification process.
        Please note that videos are not exposed by default, contact your account manager to enable this feature.

        The response is paginated (see [Pagination](#section/API-standards/Pagination) section).
        You can navigate through pages using the `skip` and `limit` query parameters or by following the URLs in the `_links` object.
      operationId: retrieve_identity_verification_attempt_assets
      parameters:
        - name: identity_verification_id
          in: path
          required: true
          schema:
            type: string
          description: The ID of the identity verification
        - name: attempt_id
          in: path
          required: true
          schema:
            type: string
          description: The ID of the attempt
        - $ref: "#/components/parameters/skipParam"
        - $ref: "#/components/parameters/limitParam"
      responses:
        '200':
          description: The assets were retrieved successfully
          content:
            application/json:
              examples:
                identity_verification_attempt_assets_response_body:
                  $ref: "#/components/examples/identity_verification_attempt_assets_response_body"
              schema:
                $ref: "#/components/schemas/IdentityVerificationAttemptAssetsOutput"

  /v2/identity-verifications/{identity_verification_id}/notify:
    post:
      tags:
        - Identity verifications
      summary: Request webhook notification
      operationId: notify_identity_verification
      description: This endpoint can be used to initiate a webhook call containing the latest event of an identity verification.
      parameters:
        - name: identity_verification_id
          in: path
          description: ID of the identity verification to notify
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                webhook_url:
                  type: string
                  format: uri
      responses:
        "204":
          description: Notification successfully requested

  /v2/identity-verifications/{identity_verification_id}/pdf-report:
    get:
      tags:
        - Identity verifications
      summary: Retrieve PDF report of an identity verification
      description: |
        This endpoint allows you to retrieve a PDF report containing all the information of the identity verification.

        Please note that this report is only available for verifications in statuses `declined` and `approved` once you receive the `identity_verification_report_created` event.

      operationId: pdf_identity_verification
      parameters:
        - name: identity_verification_id
          in: path
          description: ID of the identity verification
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Operation success
          content:
            application/json:
              examples:
                identity_verification_pdf_response_body:
                  $ref: "#/components/examples/identity_verification_pdf_response_body"
              schema:
                required: [pdf_report]
                allOf:
                  - $ref: "#/components/schemas/IdentityVerificationOutputPdfReport"
        "404":
          description: The PDF is not available

  /v2/website-verifications:
    post:
      tags:
        - Website verifications (Coming soon)
      summary: Create a website verification
      operationId: create_website_verification
      description: Creates a website verification
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebsiteVerificationInputPost"
      responses:
        "201":
          description: Website verification created successfully
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/WebsiteVerificationOutputPost"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity
        "500":
          description: Internal server error
        "503":
          description: Service unavailable

  /v2/website-verifications/{website_verification_id}:
    get:
      tags:
        - Website verifications (Coming soon)
      summary: Retrieve a website verification
      description: This endpoint allows you to get the detailed results of a website verification
      operationId: retrieve_website_verification
      parameters:
        - name: website_verification_id
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/WebsiteVerificationId"
      responses:
        "200":
          description: Website verification retrieved successfully
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/WebsiteVerificationOutputGet"
        "404":
          description: Website verification not found
        "500":
          description: Internal server error

  /v2/website-verifications/{website_verification_id}/anonymize:
    post:
      tags:
        - Website verifications (Coming soon)
      summary: Anonymize a website verification
      operationId: anonymize_website_verification
      description: Anonymize the personal data of a website verification with the specified ID.
      parameters:
        - name: website_verification_id
          in: path
          description: ID of the website verification to anonymize
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Website verification anonymized
          content:
            application/json:
              schema:
                required: [applicant_id, user_journey_id, website_url]
                allOf:
                  - $ref: "#/components/schemas/WebsiteVerificationOutputAnonymize"
        "404":
          description: Website verification not found
        "500":
          description: Internal server error

  /v2/website-verifications/{website_verification_id}/notify:
    post:
      tags:
        - Website verifications (Coming soon)
      summary: Request webhook notification
      operationId: notify_website_verification
      description: This endpoint can be used to initiate a webhook call containing the latest event of a website verification
      parameters:
        - name: website_verification_id
          in: path
          description: ID of the website verification to notify
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                webhook_url:
                  type: string
                  format: uri
      responses:
        "204":
          description: Notification successfully requested

components:
  schemas:
    AMLVerificationBase:
      type: object
      allOf:
        - properties:
            webhook_url:
              type: string
              format: uri
            applicant_id:
              allOf:
                - $ref: "#/components/schemas/ApplicantId"
            search_parameters:
              $ref: "#/components/schemas/SearchParameters"
            monitored:
              type: boolean

    AMLVerificationId:
      type: string
      description: AML verification unique identifier.
      pattern: ^amlv_\w+$
      example: amlv_tkoi5db4hryu5cei5vwoabr7we

    AMLVerificationInputBase:
      type: object
      allOf:
        - $ref: "#/components/schemas/AMLVerificationBase"

    AMLVerificationInputPost:
      type: object
      required: [webhook_url, applicant_id, search_parameters]
      allOf:
        - $ref: "#/components/schemas/AMLVerificationInputBase"

    AMLVerificationLinks:
      type: object
      allOf:
        - $ref: "#/components/schemas/SelfLink"
        - $ref: "#/components/schemas/ApplicantLink"

    AMLVerificationOutputBase:
      type: object
      properties:
        status:
          allOf:
            - $ref: "#/components/schemas/AMLVerificationStatuses"
        _links:
          allOf:
            - $ref: "#/components/schemas/AMLVerificationLinks"
      allOf:
        - $ref: "#/components/schemas/AMLVerificationBase"

    AMLVerificationOutputGet:
      type: object
      required: [id, status, webhook_url, _links, applicant_id, search_parameters]
      properties:
        id:
          $ref: "#/components/schemas/AMLVerificationId"
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/AMLVerificationOutputBase"

    AMLVerificationOutputPost:
      type: object
      required: [id, status, webhook_url, _links, applicant_id, search_parameters]
      properties:
        id:
          $ref: "#/components/schemas/AMLVerificationId"
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/AMLVerificationOutputBase"

    AMLVerificationStatuses:
      type: string
      description: Status of the AML verification.
      enum:
        - created
        - screening_in_progress
        - approved
        - declined
        - review_required

    AccountTypes:
      type: string
      description: Type of account.
      enum:
        - checking
        - savings

    ActiveLink:
      type: object
      required: [verification_url]
      properties:
        verification_url:
          $ref: "#/components/schemas/HalLink"

    Address:
      type: object
      properties:
        address_line1:
          type: string
          maxLength: 250
        address_line2:
          type: string
          maxLength: 250
        city:
          type: string
          maxLength: 50
        state:
          type: string
          maxLength: 50
        zip:
          type: string
          maxLength: 50
        country:
          $ref: "#/components/schemas/CountryCodeIso2"

    AddressDocumentVerificationAttemptAsset:
      type: object
      required: [type, _links]
      properties:
        type:
          type: string
          description: Type of asset
          enum:
            - document
        _links:
          type: object
          properties:
            asset_url:
              type: object
              properties:
                href:
                  type: string
                  format: uri

    AddressDocumentVerificationAttemptAssetsOutput:
      type: object
      required: [total_count, skip, limit, _links, data]
      properties:
        data:
          type: array
          description: Array of Address Document Verification attempt assets for the current page
          minItems: 0
          items:
            $ref: "#/components/schemas/AddressDocumentVerificationAttemptAsset"
      allOf:
        - $ref: "#/components/schemas/BaseOutputList"

    AddressDocumentVerificationAttemptInputBase:
      type: object
      properties:
        document:
          type: string
          format: binary

    AddressDocumentVerificationAttemptInputPost:
      type: object
      required: [document]
      allOf:
        - $ref: "#/components/schemas/AddressDocumentVerificationAttemptInputBase"

    AddressDocumentVerificationAttemptOutputBase:
      type: object
      properties:
        id:
          type: string
        status:
          $ref: "#/components/schemas/AddressDocumentVerificationAttemptStates"
        response_codes:
          type: array
          minItems: 0
          items:
            $ref: "#/components/schemas/ResponseCodes"
        _links:
          $ref: "#/components/schemas/SelfLink"
      allOf:
        - $ref: "#/components/schemas/DatedObject"

    AddressDocumentVerificationAttemptOutputGet:
      type: object
      required: [id, status, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/AddressDocumentVerificationAttemptOutputBase"

    AddressDocumentVerificationAttemptOutputList:
      type: object
      required: [total_count, skip, limit, _links, data]
      properties:
        data:
          type: array
          description: Array of Address Document Verification attempts for the current page
          minItems: 0
          items:
            $ref: "#/components/schemas/AddressDocumentVerificationAttemptOutputGet"
      allOf:
        - $ref: "#/components/schemas/BaseOutputList"

    AddressDocumentVerificationAttemptOutputPost:
      type: object
      required: [id, status, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/AddressDocumentVerificationAttemptOutputBase"

    AddressDocumentVerificationAttemptStates:
      type: string
      description: Address Document Verification attempt state.
      enum:
        - quality_checks_in_progress
        - checks_in_progress
        - completed
        - quality_checks_aborted
        - checks_inconclusive
        - terminated

    AddressDocumentVerificationBase:
      type: object
      properties:
        user_journey_id:
          allOf:
            - $ref: "#/components/schemas/UserJourneyId"
        applicant_id:
          allOf:
            - $ref: "#/components/schemas/ApplicantId"
        webhook_url:
          type: string
          format: uri
        declared_data:
          $ref: "#/components/schemas/DeclaredData"

    AddressDocumentVerificationId:
      type: string
      description: Address Document Verification unique identifier.
      pattern: ^adv_\w+$
      example: adv_tkoi5db4hryu5cei5vwoabr7we

    AddressDocumentVerificationInputBase:
      type: object
      allOf:
        - $ref: "#/components/schemas/AddressDocumentVerificationBase"

    AddressDocumentVerificationInputPost:
      type: object
      required: [applicant_id, user_journey_id]
      allOf:
        - $ref: "#/components/schemas/AddressDocumentVerificationInputBase"

    AddressDocumentVerificationLinks:
      type: object
      allOf:
        - $ref: "#/components/schemas/SelfLink"

    AddressDocumentVerificationOutputAnonymize:
      type: object
      required: [id, status, applicant_id, user_journey_id, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/AddressDocumentVerificationOutputBase"

    AddressDocumentVerificationOutputBase:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/AddressDocumentVerificationId"
        status:
          $ref: "#/components/schemas/AddressDocumentVerificationStatus"
        response_codes:
          type: array
          items:
            $ref: "#/components/schemas/ResponseCodes"
        risk_labels:
          $ref: "#/components/schemas/RiskLabels"
        address_document:
          $ref: "#/components/schemas/ProofOfAddressDocument"
        _links:
          $ref: "#/components/schemas/AddressDocumentVerificationLinks"
      allOf:
        - $ref: "#/components/schemas/AddressDocumentVerificationBase"
        - $ref: "#/components/schemas/DatedObject"

    AddressDocumentVerificationOutputGet:
      type: object
      required: [id, status, applicant_id, response_codes, user_journey_id, _links]
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/AddressDocumentVerificationOutputBase"

    AddressDocumentVerificationOutputPdfReport:
      type: object
      required: [pdf_report]
      properties:
        pdf_report:
          type: string
          format: uri

    AddressDocumentVerificationOutputPost:
      type: object
      required: [id, status, applicant_id, response_codes, user_journey_id, _links]
      allOf:
        - $ref: "#/components/schemas/AddressDocumentVerificationOutputBase"

    AddressDocumentVerificationStatus:
      type: string
      description: Address Document Verification status.
      enum:
        - created
        - quality_checks_in_progress
        - checks_in_progress
        - approved
        - declined
        - retry_required
        - inconclusive

    ApplicantId:
      type: string
      description: Applicant unique identifier.
      pattern: ^aplt_\w+$
      example: aplt_tkoi5db4hryu5cei5vwoabr7we

    ApplicantInputBase:
      type: object
      allOf:
        - $ref: "#/components/schemas/BaseApplicant"

    ApplicantInputPatch:
      type: object
      properties:
        external_applicant_name:
          type: string
          example: "David Vincent"
        email:
          type: string
          format: email
          example: david.vincent@courriel.ml

    ApplicantInputPost:
      type: object
      allOf:
        - $ref: "#/components/schemas/ApplicantInputBase"

    ApplicantLink:
      type: object
      required: [applicant]
      properties:
        applicant:
          $ref: "#/components/schemas/HalLink"

    ApplicantOutputAnonymize:
      type: object
      required: [id]
      properties:
        id:
          allOf:
            - $ref: "#/components/schemas/ApplicantId"
      allOf:
        - $ref: "#/components/schemas/ApplicantsLinks"
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/ApplicantOutputBase"

    ApplicantOutputBase:
      type: object
      properties:
        id:
          allOf:
            - $ref: "#/components/schemas/ApplicantId"
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/BaseApplicant"
        - $ref: "#/components/schemas/ApplicantsLinks"

    ApplicantOutputGet:
      type: object
      required: [id]
      allOf:
        - $ref: "#/components/schemas/ApplicantOutputBase"

    ApplicantOutputPatch:
      type: object
      required: [id]
      allOf:
        - $ref: "#/components/schemas/ApplicantOutputBase"

    ApplicantOutputPost:
      type: object
      required: [id]
      allOf:
        - $ref: "#/components/schemas/ApplicantOutputBase"

    ApplicantsLinks:
      type: object
      required: [_links]
      properties:
        _links:
          allOf:
            - $ref: "#/components/schemas/SelfLink"

    AttemptLinks:
      type: object
      allOf:
        - $ref: "#/components/schemas/ActiveLink"
        - $ref: "#/components/schemas/SelfLink"

    AttemptStates:
      type: string
      description: States of an attempt.
      enum:
        - pending_redirection
        - capture_in_progress
        - checks_in_progress
        - completed
        - expired
        - capture_aborted
        - capture_refused
        - checks_inconclusive
        - terminated

    BankDocument:
      type: object
      properties:
        bank_account_number:
          type: string
          maxLength: 255
        bank_routing_number:
          type: string
          maxLength: 255
        account_type:
          $ref: "#/components/schemas/AccountTypes"
        company_name:
          type: string
          minLength: 2
          maxLength: 510
        bank_name:
          type: string
          minLength: 2
          maxLength: 510
        issue_date:
          type: string
          format: date
        document_type:
          $ref: "#/components/schemas/BankDocumentType"
        company_address:
          $ref: "#/components/schemas/Address"

    BankDocumentType:
      type: string
      description: Type of document.
      enum:
        - bank_statement
        - bank_letter
        - bank_check

    BankDocumentVerificationAttemptAsset:
      type: object
      required: [type, _links]
      properties:
        type:
          type: string
          description: Type of asset
          enum:
            - document
        _links:
          type: object
          properties:
            asset_url:
              type: object
              properties:
                href:
                  type: string
                  format: uri

    BankDocumentVerificationAttemptAssetsOutput:
      type: object
      required: [total_count, skip, limit, _links, data]
      properties:
        data:
          type: array
          description: Array of Bank Document Verification attempt assets for the current page
          minItems: 0
          items:
            $ref: "#/components/schemas/BankDocumentVerificationAttemptAsset"
      allOf:
        - $ref: "#/components/schemas/BaseOutputList"

    BankDocumentVerificationAttemptInputBase:
      type: object
      properties:
        document:
          type: string
          format: binary

    BankDocumentVerificationAttemptInputPost:
      type: object
      required: [document]
      allOf:
        - $ref: "#/components/schemas/BankDocumentVerificationAttemptInputBase"

    BankDocumentVerificationAttemptOutputBase:
      type: object
      properties:
        id:
          type: string
        status:
          $ref: "#/components/schemas/BankDocumentVerificationAttemptStates"
        response_codes:
          type: array
          minItems: 0
          items:
            $ref: "#/components/schemas/ResponseCodes"
        _links:
          $ref: "#/components/schemas/SelfLink"
      allOf:
        - $ref: "#/components/schemas/DatedObject"

    BankDocumentVerificationAttemptOutputGet:
      type: object
      required: [id, status, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/BankDocumentVerificationAttemptOutputBase"

    BankDocumentVerificationAttemptOutputList:
      type: object
      required: [total_count, skip, limit, _links, data]
      properties:
        data:
          type: array
          description: Array of Bank Document Verification attempts for the current page
          minItems: 0
          items:
            $ref: "#/components/schemas/BankDocumentVerificationAttemptOutputGet"
      allOf:
        - $ref: "#/components/schemas/BaseOutputList"

    BankDocumentVerificationAttemptOutputPost:
      type: object
      required: [id, status, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/BankDocumentVerificationAttemptOutputBase"

    BankDocumentVerificationAttemptStates:
      type: string
      description: Bank Document Verification attempt state.
      enum:
        - quality_checks_in_progress
        - checks_in_progress
        - completed
        - quality_checks_aborted
        - checks_inconclusive
        - terminated

    BankDocumentVerificationBase:
      type: object
      properties:
        user_journey_id:
          allOf:
            - $ref: "#/components/schemas/UserJourneyId"
        applicant_id:
          allOf:
            - $ref: "#/components/schemas/BusinessApplicantId"
        webhook_url:
          type: string
          format: uri
        declared_data:
          $ref: "#/components/schemas/BankDocumentVerificationDeclaredData"

    BankDocumentVerificationDeclaredData:
      type: object
      required: [registered_name, trading_name]
      properties:
        registered_name:
          type: string
          minLength: 2
          maxLength: 255
        trading_name:
          type: string
          minLength: 2
          maxLength: 255

    BankDocumentVerificationId:
      type: string
      description: Bank Document Verification unique identifier.
      pattern: ^bdv_\w+$
      example: bdv_tkoi5db4hryu5cei5vwoabr7we

    BankDocumentVerificationInputBase:
      type: object
      allOf:
        - $ref: "#/components/schemas/BankDocumentVerificationBase"

    BankDocumentVerificationInputPost:
      type: object
      required: [applicant_id, user_journey_id]
      allOf:
        - $ref: "#/components/schemas/BankDocumentVerificationInputBase"

    BankDocumentVerificationLinks:
      type: object
      allOf:
        - $ref: "#/components/schemas/SelfLink"

    BankDocumentVerificationOutputAnonymize:
      type: object
      required: [id, status, applicant_id, user_journey_id, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/BankDocumentVerificationOutputBase"

    BankDocumentVerificationOutputBase:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/BankDocumentVerificationId"
        status:
          $ref: "#/components/schemas/BankDocumentVerificationStatus"
        response_codes:
          type: array
          items:
            $ref: "#/components/schemas/ResponseCodes"
        risk_labels:
          $ref: "#/components/schemas/RiskLabels"
        bank_document:
          $ref: "#/components/schemas/BankDocument"
        _links:
          $ref: "#/components/schemas/BankDocumentVerificationLinks"
      allOf:
        - $ref: "#/components/schemas/BankDocumentVerificationBase"
        - $ref: "#/components/schemas/DatedObject"

    BankDocumentVerificationOutputGet:
      type: object
      required: [id, status, applicant_id, response_codes, user_journey_id, _links]
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/BankDocumentVerificationOutputBase"

    BankDocumentVerificationOutputPdfReport:
      type: object
      required: [pdf_report]
      properties:
        pdf_report:
          type: string
          format: uri

    BankDocumentVerificationOutputPost:
      type: object
      required: [id, status, applicant_id, response_codes, user_journey_id, _links]
      allOf:
        - $ref: "#/components/schemas/BankDocumentVerificationOutputBase"

    BankDocumentVerificationStatus:
      type: string
      description: Bank Document Verification status.
      enum:
        - created
        - quality_checks_in_progress
        - checks_in_progress
        - approved
        - declined
        - retry_required
        - inconclusive

    BaseApplicant:
      type: object
      properties:
        external_applicant_id:
          type: string
          example: "ext_osdfdfdb4hryu5cei5vwoabrk5k"
        external_applicant_name:
          type: string
          example: "David Vincent"
        email:
          type: string
          format: email
          example: david.vincent@courriel.ml

    BaseApplicantSessionInformation:
      type: object
      properties:
        ip_address:
          type: string
          description: Ip address of the applicant during the session
          example: "123:456:789:00"
        number_of_sessions:
          type: integer
          description: Number of sessions opened by user
          example: 3
        user_agent:
          type: string
          description: User session user agent
          example: "Mozilla/5.0 (Linux; Android 8.0.0; SM-G960F Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.84 Mobile Safari/537.36"
        initial_device:
          $ref: "#/components/schemas/InitialDevices"

    BaseBusinessApplicant:
      type: object
      properties:
        external_applicant_id:
          type: string
          example: "ext_business_osdfdfdb4hryu5cei5vwoabrk5k"

    BaseOutputList:
      type: object
      properties:
        total_count:
          type: integer
          description: Total number of items available across all pages
        skip:
          type: integer
          description: Number of items skipped (offset from the start)
        limit:
          type: integer
          description: Maximum number of items returned in this page
        _links:
          $ref: "#/components/schemas/ListLinks"

    BlankEnum:
      enum:
        - ''

    BusinessApplicantId:
      type: string
      description: Business Applicant unique identifier.
      pattern: ^bplt_\w+$
      example: bplt_tkoi5db4hryu5cei5vwoabr7we

    BusinessApplicantInputBase:
      type: object
      allOf:
        - $ref: "#/components/schemas/BaseBusinessApplicant"

    BusinessApplicantInputPost:
      type: object
      allOf:
        - $ref: "#/components/schemas/BusinessApplicantInputBase"

    BusinessApplicantOutputBase:
      type: object
      properties:
        id:
          allOf:
            - $ref: "#/components/schemas/BusinessApplicantId"
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/BaseBusinessApplicant"
        - $ref: "#/components/schemas/BusinessApplicantsLinks"

    BusinessApplicantOutputGet:
      type: object
      required: [id]
      allOf:
        - $ref: "#/components/schemas/BusinessApplicantOutputBase"

    BusinessApplicantOutputPost:
      type: object
      required: [id]
      allOf:
        - $ref: "#/components/schemas/BusinessApplicantOutputBase"

    BusinessApplicantsLinks:
      type: object
      required: [_links]
      properties:
        _links:
          allOf:
            - $ref: "#/components/schemas/SelfLink"

    CompanyDocument:
      type: object
      properties:
        company_number:
          type: string
          maxLength: 255
        company_name:
          type: string
          minLength: 2
          maxLength: 510
        registered_address:
          $ref: "#/components/schemas/Address"
        issue_date:
          type: string
          format: date
        registration_date:
          type: string
          format: date
        document_type:
          $ref: "#/components/schemas/CompanyDocumentType"

    CompanyDocumentType:
      type: string
      description: Type of document.
      enum:
        - ein_letter

    CompanyDocumentVerificationAttemptAsset:
      type: object
      required: [type, _links]
      properties:
        type:
          type: string
          description: Type of asset
          enum:
            - document
        _links:
          type: object
          properties:
            asset_url:
              type: object
              properties:
                href:
                  type: string
                  format: uri

    CompanyDocumentVerificationAttemptAssetsOutput:
      type: object
      required: [total_count, skip, limit, _links, data]
      properties:
        data:
          type: array
          description: Array of Company Document Verification attempt assets for the current page
          minItems: 0
          items:
            $ref: "#/components/schemas/CompanyDocumentVerificationAttemptAsset"
      allOf:
        - $ref: "#/components/schemas/BaseOutputList"

    CompanyDocumentVerificationAttemptInputBase:
      type: object
      properties:
        document:
          type: string
          format: binary

    CompanyDocumentVerificationAttemptInputPost:
      type: object
      required: [document]
      allOf:
        - $ref: "#/components/schemas/CompanyDocumentVerificationAttemptInputBase"

    CompanyDocumentVerificationAttemptOutputBase:
      type: object
      properties:
        id:
          type: string
        status:
          $ref: "#/components/schemas/CompanyDocumentVerificationAttemptStates"
        response_codes:
          type: array
          minItems: 0
          items:
            $ref: "#/components/schemas/ResponseCodes"
        _links:
          $ref: "#/components/schemas/SelfLink"
      allOf:
        - $ref: "#/components/schemas/DatedObject"

    CompanyDocumentVerificationAttemptOutputGet:
      type: object
      required: [id, status, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/CompanyDocumentVerificationAttemptOutputBase"

    CompanyDocumentVerificationAttemptOutputList:
      type: object
      required: [total_count, skip, limit, _links, data]
      properties:
        data:
          type: array
          description: Array of Company Document Verification attempts for the current page
          minItems: 0
          items:
            $ref: "#/components/schemas/CompanyDocumentVerificationAttemptOutputGet"
      allOf:
        - $ref: "#/components/schemas/BaseOutputList"

    CompanyDocumentVerificationAttemptOutputPost:
      type: object
      required: [id, status, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/CompanyDocumentVerificationAttemptOutputBase"

    CompanyDocumentVerificationAttemptStates:
      type: string
      description: Company Document Verification attempt state.
      enum:
        - quality_checks_in_progress
        - checks_in_progress
        - completed
        - quality_checks_aborted
        - checks_inconclusive
        - terminated

    CompanyDocumentVerificationBase:
      type: object
      properties:
        user_journey_id:
          allOf:
            - $ref: "#/components/schemas/UserJourneyId"
        applicant_id:
          allOf:
            - $ref: "#/components/schemas/BusinessApplicantId"
        webhook_url:
          type: string
          format: uri
        declared_data:
          $ref: "#/components/schemas/CompanyDocumentVerificationDeclaredData"

    CompanyDocumentVerificationDeclaredData:
      type: object
      required: [registered_name]
      properties:
        registered_name:
          type: string
          minLength: 2
          maxLength: 255

    CompanyDocumentVerificationId:
      type: string
      description: Company Document Verification unique identifier.
      pattern: ^cdv_\w+$
      example: cdv_tkoi5db4hryu5cei5vwoabr7we

    CompanyDocumentVerificationInputBase:
      type: object
      allOf:
        - $ref: "#/components/schemas/CompanyDocumentVerificationBase"

    CompanyDocumentVerificationInputPost:
      type: object
      required: [applicant_id, user_journey_id]
      allOf:
        - $ref: "#/components/schemas/CompanyDocumentVerificationInputBase"

    CompanyDocumentVerificationLinks:
      type: object
      allOf:
        - $ref: "#/components/schemas/SelfLink"

    CompanyDocumentVerificationOutputAnonymize:
      type: object
      required: [id, status, applicant_id, user_journey_id, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/CompanyDocumentVerificationOutputBase"

    CompanyDocumentVerificationOutputBase:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/CompanyDocumentVerificationId"
        status:
          $ref: "#/components/schemas/CompanyDocumentVerificationStatus"
        response_codes:
          type: array
          items:
            $ref: "#/components/schemas/ResponseCodes"
        risk_labels:
          $ref: "#/components/schemas/RiskLabels"
        company_document:
          $ref: "#/components/schemas/CompanyDocument"
        _links:
          $ref: "#/components/schemas/CompanyDocumentVerificationLinks"
      allOf:
        - $ref: "#/components/schemas/CompanyDocumentVerificationBase"
        - $ref: "#/components/schemas/DatedObject"

    CompanyDocumentVerificationOutputGet:
      type: object
      required: [id, status, applicant_id, response_codes, user_journey_id, _links]
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/CompanyDocumentVerificationOutputBase"

    CompanyDocumentVerificationOutputPdfReport:
      type: object
      required: [pdf_report]
      properties:
        pdf_report:
          type: string
          format: uri

    CompanyDocumentVerificationOutputPost:
      type: object
      required: [id, status, applicant_id, response_codes, user_journey_id, _links]
      allOf:
        - $ref: "#/components/schemas/CompanyDocumentVerificationOutputBase"

    CompanyDocumentVerificationStatus:
      type: string
      description: Company Document Verification status.
      enum:
        - created
        - quality_checks_in_progress
        - checks_in_progress
        - approved
        - declined
        - retry_required
        - inconclusive

    CountryCodeIso2:
      type: string
      format: ISO 3166-1 alpha-2
      pattern: ^[A-Za-z]{2}$
      example: US

    DatedObject:
      type: object
      required: [created_on, modified_on]
      properties:
        created_on:
          description: UTC Date time when the resource was created
          type: string
          format: date-time
          example: 2017-07-21T17:32:28Z
        modified_on:
          description: UTC Date time when the resource was modified
          type: string
          format: date-time
          example: 2017-07-21T17:40:32Z

    DeclaredData:
      type: object
      required: [name]
      properties:
        name:
          type: string
          minLength: 2
          maxLength: 255
        birth_date:
          type: string
          format: date

    DisclosureURLs:
      type: object
      description: URLs to disclosure pages found on the website
      properties:
        privacy_policy_url:
          type: string
          format: uri
          nullable: true
          description: URL to the privacy policy page
        terms_and_conditions_url:
          type: string
          format: uri
          nullable: true
          description: URL to the terms and conditions page
        refund_policy_url:
          type: string
          format: uri
          nullable: true
          description: URL to the refund policy page
        contact_us_url:
          type: string
          format: uri
          nullable: true
          description: URL to the contact us page

    Document:
      type: object
      properties:
        personal_number:
          type: string
          maxLength: 255
        tax_identification_number:
          type: string
          maxLength: 255
        document_type:
          $ref: "#/components/schemas/DocumentTypes"
        document_issuing_country:
          $ref: "#/components/schemas/CountryCodeIso2"
        permit_obtaining_date:
          type: string
          format: date
        permit_expiry_date:
          type: string
          format: date
        permit_type_detailed:
          type: string
          maxLength: 255
        permit_type_remarks:
          type: string
          maxLength: 255
        document_number:
          type: string
          maxLength: 255
        document_expiry_date:
          type: string
          format: date
        document_issue_date:
          type: string
          format: date
        document_issue_place:
          type: string
          maxLength: 255
        document_mrz:
          type: string
          pattern: ^([A-Z0-9<]{2}[A-Z0-9<]{1,38}[\n\r])+([A-Z0-9<]{2}[A-Z0-9<]{1,44}[\n\r])?([A-Z0-9<]{2}[A-Z0-9<]{1,44}[\n\r])?$
        front_image_signed_url:
          $ref: "#/components/schemas/PreSignedUrl"
        back_image_signed_url:
          $ref: "#/components/schemas/PreSignedUrl"
        signature_image_signed_url:
          $ref: "#/components/schemas/PreSignedUrl"
        full_name:
          type: string
          minLength: 2
          maxLength: 510
        first_names:
          type: string
          minLength: 1
          maxLength: 255
        last_name:
          type: string
          minLength: 1
          maxLength: 255
        last_name_at_birth:
          type: string
          minLength: 1
          maxLength: 255
        birth_date:
          type: string
          format: date
        birth_place:
          type: string
          minLength: 1
          maxLength: 255
        nationality:
          $ref: "#/components/schemas/CountryCodeIso2"
        gender:
          $ref: "#/components/schemas/Gender"
        address:
          type: string
          maxLength: 1000

    DocumentTypes:
      type: string
      description: Type of document.
      enum:
        - Driving licence
        - ID
        - Other
        - Passport
        - Residence Permit
        - Travel Document
        - Visa

    DomesticPhoneNumber:
      type: string
      format: domestic phone number
      pattern: ^\d{1,14}$
      example: "2068133616"

    Event:
      type: object
      required: [specversion, type, subject, id, time, datacontenttype, data]
      properties:
        specversion:
          type: string
          description: The version of the CloudEvents specification.
          example: "2.0"
        type:
          type: string
          description: The type of the CloudEvent.
          example: "identity_verification_capture_completed"
        subject:
          type: string
          description: The identifier of the subject of the event.
          example: "idv_5hxpdwegjcbujpth3wdo55d3vm"
        id:
          type: string
          description: The identifier of the event.
          example: "evnt_5hxpdwegjcbujpth3wdo55d3vm"
        time:
          type: string
          format: date-time
          description: The time when the event occurred.
          example: "2023-03-22T17:31:00Z"
        datacontenttype:
          type: string
          description: The content type of the data attribute.
          example: "application/json"
        data:
          type: object
          description: The event payload.
          example:
            {
              "applicant_id": "aplt_5hxpdwegjcbujpth3wdo55d3vm",
              "user_journey_id": "usj_5hxpdwegjcbujpth3wdo55d3vm",
              "identity_verification_id": "idv_5hxpdwegjcbujpth3wdo55d3vm",
              "status": "declined",
              "response_codes":
                [
                  { "code": 61310, "summary": "document_front_not_captured" },
                  { "code": 62102, "summary": "document_not_accepted" },
                ],
            }

    FaceAttemptBase:
      type: object
      properties:
        phone_number:
          $ref: "#/components/schemas/PhoneNumber"
        client_information:
          $ref: "#/components/schemas/FaceAttemptClientInformation"
        redirect_url:
          type: string
          format: uri
        mobile_handoff_url:
          type: string
          format: uri
          nullable: true
          maxLength: 512
          description: Optional. URL encoded in the QR code shown when the verification is opened on a desktop, so the end user can continue on their phone through your own flow. Defaults to the verification URL. Accepts https URLs and app deeplinks. Max 512 characters.

    FaceAttemptClientInformation:
      type: object
      properties:
        pre_selected_residence_country:
          $ref: "#/components/schemas/CountryCodeIso2"
        pre_selected_language:
          $ref: "#/components/schemas/LanguageCode"

    FaceAuthenticationApplicantSessionInformation:
      type: object
      allOf:
        - $ref: "#/components/schemas/BaseApplicantSessionInformation"

    FaceAuthenticationAttemptAssetOutput:
      type: object
      required: [ type, _links ]
      properties:
        type:
          type: string
          enum: [face_image, face_video]
        _links:
          required: [ asset_url ]
          type: object
          properties:
            asset_url:
              $ref: "#/components/schemas/HalLink"

    FaceAuthenticationAttemptAssetsOutput:
      type: object
      required: [total_count, skip, limit, _links, data]
      properties:
        data:
          type: array
          description: Array of face authentication attempt assets for the current page
          minItems: 0
          items:
            $ref: "#/components/schemas/FaceAuthenticationAttemptAssetOutput"
      allOf:
        - $ref: "#/components/schemas/BaseOutputList"

    FaceAuthenticationAttemptInputBase:
      type: object
      allOf:
        - $ref: "#/components/schemas/FaceAttemptBase"

    FaceAuthenticationAttemptInputPost:
      type: object
      required: [redirect_url]
      allOf:
        - $ref: "#/components/schemas/FaceAuthenticationAttemptInputBase"

    FaceAuthenticationAttemptOutputBase:
      type: object
      properties:
        id:
          type: string
        status:
          $ref: "#/components/schemas/AttemptStates"
        response_codes:
          type: array
          minItems: 0
          items:
            $ref: "#/components/schemas/ResponseCodes"
        applicant_session_information:
          $ref: "#/components/schemas/FaceAuthenticationApplicantSessionInformation"
        _links:
          allOf:
            - $ref: "#/components/schemas/AttemptLinks"
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/FaceAttemptBase"

    FaceAuthenticationAttemptOutputGet:
      type: object
      required: [id, status, redirect_url, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/FaceAuthenticationAttemptOutputBase"

    FaceAuthenticationAttemptOutputPost:
      type: object
      required: [id, status, redirect_url, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/FaceAuthenticationAttemptOutputBase"

    FaceAuthenticationAttemptResponseList:
      type: object
      required: [ total_count, skip, limit, _links, data ]
      properties:
        data:
          type: array
          description: Array of face authentication attempts for the current page
          minItems: 0
          items:
            $ref: "#/components/schemas/FaceAuthenticationAttemptOutputGet"
      allOf:
        - $ref: "#/components/schemas/BaseOutputList"

    FaceAuthenticationBase:
      type: object
      properties:
        user_journey_id:
          $ref: "#/components/schemas/UserJourneyId"
        applicant_id:
          $ref: "#/components/schemas/ApplicantId"
        webhook_url:
          type: string
          format: uri

    FaceAuthenticationId:
      type: string
      description: Face authentication unique identifier.
      pattern: ^fav_\w+$
      example: fav_tkoi5db4hryu5cei5vwoabr7we

    FaceAuthenticationInputBase:
      type: object
      allOf:
        - $ref: "#/components/schemas/FaceAuthenticationBase"

    FaceAuthenticationInputPost:
      type: object
      required: [webhook_url, applicant_id, user_journey_id]
      allOf:
        - $ref: "#/components/schemas/FaceAuthenticationInputBase"

    FaceAuthenticationLinks:
      type: object
      allOf:
        - $ref: "#/components/schemas/SelfLink"
        - $ref: "#/components/schemas/ApplicantLink"

    FaceAuthenticationOutputAnonymize:
      type: object
      required: [id, status, webhook_url, applicant_id, user_journey_id, response_codes, risk_labels, _links]
      properties:
        face:
          $ref: '#/components/schemas/VerificationFace'
      allOf:
        - $ref: "#/components/schemas/FaceAuthenticationOutputBase"

    FaceAuthenticationOutputBase:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/FaceAuthenticationId"
        status:
          $ref: "#/components/schemas/VerificationStatuses"
        response_codes:
          type: array
          items:
            $ref: '#/components/schemas/ResponseCodes'
        risk_labels:
          $ref: '#/components/schemas/RiskLabels'
        face:
          $ref: '#/components/schemas/VerificationFace'
        _links:
          $ref: "#/components/schemas/FaceAuthenticationLinks"
      allOf:
        - $ref: "#/components/schemas/FaceAuthenticationBase"
        - $ref: "#/components/schemas/DatedObject"

    FaceAuthenticationOutputGet:
      type: object
      required: [id, status, webhook_url, applicant_id, response_codes, risk_labels, user_journey_id, _links]
      allOf:
        - $ref: "#/components/schemas/FaceAuthenticationOutputBase"

    FaceAuthenticationOutputPost:
      type: object
      required: [id, status, webhook_url, applicant_id, response_codes, risk_labels, user_journey_id, _links]
      properties:
        face:
          $ref: '#/components/schemas/VerificationFace'
      allOf:
        - $ref: "#/components/schemas/FaceAuthenticationOutputBase"

    Gender:
      type: string
      description: Person gender.
      example: M
      enum:
        - M
        - F

    GenderA47Enum:
      enum:
        - M
        - F
        - NA
      type: string
      description: |-
        * `M` - M
        * `F` - F
        * `NA` - NA

    HalLink:
      type: object
      required: [href]
      properties:
        href:
          type: string
          format: uri

    IdDocumentVerificationAttemptAssetsOutput:
      type: object
      required: [total_count, skip, limit, _links, data]
      properties:
        data:
          type: array
          description: Array of ID document verification attempt assets for the current page
          minItems: 0
          items:
            $ref: "#/components/schemas/IdDocumentVerificationAttemptOutputAssetOutput"
      allOf:
        - $ref: "#/components/schemas/BaseOutputList"

    IdDocumentVerificationAttemptInputBase:
      type: object
      properties:
        document_front:
          type: string
          format: binary
        document_back:
          type: string
          format: binary

    IdDocumentVerificationAttemptInputPost:
      type: object
      required: [document_front]
      allOf:
        - $ref: "#/components/schemas/IdDocumentVerificationAttemptInputBase"

    IdDocumentVerificationAttemptOutputAssetOutput:
      type: object
      required: [type, _links]
      properties:
        type:
          type: string
          enum:
            - document_front_image
            - document_back_image
        _links:
          type: object
          properties:
            asset_url:
              type: object
              properties:
                href:
                  type: string
                  format: uri

    IdDocumentVerificationAttemptOutputBase:
      type: object
      properties:
        id:
          type: string
        status:
          $ref: "#/components/schemas/IdDocumentVerificationAttemptStates"
        response_codes:
          type: array
          minItems: 0
          items:
            $ref: "#/components/schemas/ResponseCodes"
        _links:
          $ref: "#/components/schemas/SelfLink"
      allOf:
        - $ref: "#/components/schemas/DatedObject"

    IdDocumentVerificationAttemptOutputGet:
      type: object
      required: [id, status, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/IdDocumentVerificationAttemptOutputBase"

    IdDocumentVerificationAttemptOutputList:
      type: object
      required: [total_count, skip, limit, _links, data]
      properties:
        data:
          type: array
          description: Array of ID document verification attempts for the current page
          minItems: 0
          items:
            $ref: "#/components/schemas/IdDocumentVerificationAttemptOutputGet"
      allOf:
        - $ref: "#/components/schemas/BaseOutputList"

    IdDocumentVerificationAttemptOutputPost:
      type: object
      required: [id, status, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/IdDocumentVerificationAttemptOutputBase"

    IdDocumentVerificationAttemptStates:
      type: string
      description: ID document verification attempt state.
      enum:
        - quality_checks_in_progress
        - checks_in_progress
        - completed
        - quality_checks_aborted
        - checks_inconclusive
        - terminated

    IdDocumentVerificationBase:
      type: object
      properties:
        user_journey_id:
          allOf:
            - $ref: "#/components/schemas/UserJourneyId"
        applicant_id:
          allOf:
            - $ref: "#/components/schemas/ApplicantId"
        declared_data:
          $ref: "#/components/schemas/DeclaredData"
        webhook_url:
          type: string
          format: uri

    IdDocumentVerificationId:
      type: string
      description: ID ocument verification unique identifier.
      pattern: ^iddv_\w+$
      example: iddv_tkoi5db4hryu5cei5vwoabr7we

    IdDocumentVerificationInputBase:
      type: object
      allOf:
        - $ref: "#/components/schemas/IdDocumentVerificationBase"

    IdDocumentVerificationInputPost:
      type: object
      required: [applicant_id, user_journey_id]
      allOf:
        - $ref: "#/components/schemas/IdDocumentVerificationInputBase"

    IdDocumentVerificationLinks:
      type: object
      allOf:
        - $ref: "#/components/schemas/SelfLink"
        - $ref: "#/components/schemas/ApplicantLink"

    IdDocumentVerificationOutputAnonymize:
      type: object
      required: [id, status, applicant_id, user_journey_id, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/IdDocumentVerificationOutputBase"

    IdDocumentVerificationOutputBase:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/IdDocumentVerificationId"
        status:
          $ref: "#/components/schemas/IdDocumentVerificationStatus"
        response_codes:
          type: array
          items:
            $ref: "#/components/schemas/ResponseCodes"
        document:
          $ref: "#/components/schemas/Document"
        _links:
          $ref: "#/components/schemas/IdDocumentVerificationLinks"
      allOf:
        - $ref: "#/components/schemas/IdDocumentVerificationBase"
        - $ref: "#/components/schemas/DatedObject"

    IdDocumentVerificationOutputGet:
      type: object
      required: [id, status, _links, applicant_id, response_codes, user_journey_id]
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/IdDocumentVerificationOutputBase"

    IdDocumentVerificationOutputPdfReport:
      type: object
      required: [pdf_report]
      properties:
        pdf_report:
          type: string
          format: uri

    IdDocumentVerificationOutputPost:
      type: object
      required: [id, status, applicant_id, response_codes, user_journey_id, _links]
      allOf:
        - $ref: "#/components/schemas/IdDocumentVerificationOutputBase"

    IdDocumentVerificationStatus:
      type: string
      description: ID document verification status.
      enum:
        - created
        - quality_checks_in_progress
        - checks_in_progress
        - approved
        - declined
        - retry_required
        - inconclusive

    IdentityAttemptBase:
      type: object
      properties:
        phone_number:
          $ref: "#/components/schemas/PhoneNumber"
        client_information:
          $ref: "#/components/schemas/IdentityClientInformation"
        redirect_url:
          type: string
          format: uri
        mobile_handoff_url:
          type: string
          format: uri
          nullable: true
          maxLength: 512
          description: Optional. URL encoded in the QR code shown when the verification is opened on a desktop, so the end user can continue on their phone through your own flow. Defaults to the verification URL. Accepts https URLs and app deeplinks. Max 512 characters.

    IdentityClientInformation:
      type: object
      properties:
        pre_selected_residence_country:
          $ref: "#/components/schemas/CountryCodeIso2"
        pre_selected_document_issuing_country:
          $ref: "#/components/schemas/CountryCodeIso2"
        pre_selected_document_type:
          $ref: "#/components/schemas/DocumentTypes"
        pre_selected_language:
          $ref: "#/components/schemas/LanguageCode"

    IdentityDeclaredData:
      type: object
      required: [name]
      properties:
        phone_number:
          $ref: "#/components/schemas/PhoneNumber"
        email:
          type: string
          format: email
          nullable: true
        address:
          $ref: "#/components/schemas/Address"
      allOf:
        - $ref: "#/components/schemas/DeclaredData"

    IdentityVerificationApplicantSessionInformation:
      type: object
      properties:
        selected_documents:
          description: Documents selected by the applicant in selection order
          type: array
          minItems: 0
          items:
            $ref: "#/components/schemas/SelectedDocument"
      allOf:
        - $ref: "#/components/schemas/BaseApplicantSessionInformation"

    IdentityVerificationAttemptAssetOutput:
      type: object
      required: [ type, _links ]
      properties:
        type:
          type: string
          enum: [face_image, face_video, document_front_image, document_back_image, document_back_image, document_front_video, document_signature_image, document_back_video, secondary_document_front_video, secondary_document_front_image, secondary_document_back_image, secondary_document_signature_image, secondary_document_back_video, secondary_document_front_video]
        _links:
          type: object
          required: [ asset_url ]
          properties:
            asset_url:
              $ref: "#/components/schemas/HalLink"

    IdentityVerificationAttemptAssetsOutput:
      type: object
      required: [total_count, skip, limit, _links, data]
      properties:
        data:
          type: array
          description: Array of identity verification attempt assets for the current page
          minItems: 0
          items:
            $ref: "#/components/schemas/IdentityVerificationAttemptAssetOutput"
      allOf:
        - $ref: "#/components/schemas/BaseOutputList"

    IdentityVerificationAttemptInputBase:
      type: object
      allOf:
        - $ref: "#/components/schemas/IdentityAttemptBase"

    IdentityVerificationAttemptInputPost:
      type: object
      required: [redirect_url]
      allOf:
        - $ref: "#/components/schemas/IdentityVerificationAttemptInputBase"

    IdentityVerificationAttemptOutputBase:
      type: object
      properties:
        id:
          type: string
        status:
          $ref: "#/components/schemas/AttemptStates"
        response_codes:
          type: array
          minItems: 0
          items:
            $ref: "#/components/schemas/ResponseCodes"
        applicant_session_information:
          $ref: "#/components/schemas/IdentityVerificationApplicantSessionInformation"
        _links:
          allOf:
            - $ref: "#/components/schemas/AttemptLinks"
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/IdentityAttemptBase"

    IdentityVerificationAttemptOutputGet:
      type: object
      required: [id, status, redirect_url, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/IdentityVerificationAttemptOutputBase"

    IdentityVerificationAttemptOutputList:
      type: object
      required: [total_count, skip, limit, _links, data]
      properties:
        data:
          type: array
          description: Array of identity verification attempts for the current page
          minItems: 0
          items:
            $ref: "#/components/schemas/IdentityVerificationAttemptOutputGet"
      allOf:
        - $ref: "#/components/schemas/BaseOutputList"

    IdentityVerificationAttemptOutputPost:
      type: object
      required: [id, status, redirect_url, response_codes, _links]
      allOf:
        - $ref: "#/components/schemas/IdentityVerificationAttemptOutputBase"

    IdentityVerificationBase:
      type: object
      properties:
        user_journey_id:
          allOf:
            - $ref: "#/components/schemas/UserJourneyId"
        applicant_id:
          allOf:
            - $ref: "#/components/schemas/ApplicantId"
        declared_data:
          $ref: "#/components/schemas/DeclaredData"
        webhook_url:
          type: string
          format: uri

    IdentityVerificationHelperLinks:
      type: object
      allOf:
        - $ref: "#/components/schemas/SelfLink"
        - $ref: "#/components/schemas/ApplicantLink"
        - $ref: "#/components/schemas/ActiveLink"

    IdentityVerificationId:
      type: string
      description: Identity verification unique identifier.
      pattern: ^idv_\w+$
      example: idv_tkoi5db4hryu5cei5vwoabr7we

    IdentityVerificationInputBase:
      type: object
      allOf:
          - $ref: "#/components/schemas/IdentityVerificationBase"

    IdentityVerificationInputHelper:
      type: object
      required: [declared_data, webhook_url, redirect_url]
      properties:
        declared_data:
          $ref: "#/components/schemas/IdentityDeclaredData"
        phone_number:
          $ref: "#/components/schemas/PhoneNumber"
        redirect_url:
          type: string
          format: uri
        mobile_handoff_url:
          type: string
          format: uri
          nullable: true
          maxLength: 512
          description: Optional. URL encoded in the QR code shown when the verification is opened on a desktop, so the end user can continue on their phone through your own flow. Defaults to the verification URL. Accepts https URLs and app deeplinks. Max 512 characters.
      allOf:
        - $ref: "#/components/schemas/IdentityVerificationInputBase"

    IdentityVerificationInputPost:
      type: object
      required: [declared_data, webhook_url, applicant_id]
      properties:
        declared_data:
          $ref: "#/components/schemas/IdentityDeclaredData"
      allOf:
        - $ref: "#/components/schemas/IdentityVerificationInputBase"

    IdentityVerificationLinks:
      type: object
      allOf:
        - $ref: "#/components/schemas/SelfLink"
        - $ref: "#/components/schemas/ApplicantLink"

    IdentityVerificationOutputAnonymize:
      type: object
      required: [id, status, webhook_url, _links, applicant_id, redirect_url, response_codes, risk_labels, user_journey_id, certifications]
      properties:
        id:
          $ref: "#/components/schemas/IdentityVerificationId"
        phone_number:
          $ref: "#/components/schemas/PhoneNumber"
        redirect_url:
          type: string
          format: uri
        _links:
          $ref: "#/components/schemas/IdentityVerificationLinks"
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/IdentityVerificationOutputBase"

    IdentityVerificationOutputBase:
      type: object
      properties:
        status:
          $ref: "#/components/schemas/VerificationStatuses"
        response_codes:
          type: array
          items:
            $ref: '#/components/schemas/ResponseCodes'
        verified_identity:
          $ref: '#/components/schemas/VerificationIdentity'
        documents:
          type: array
          items:
            $ref: "#/components/schemas/Document"
        face:
          $ref: '#/components/schemas/VerificationFace'
        verification_policy_version:
          type: string
          description: returned ONLY for certified verifications
        certifications:
          type: array
          description: The certifications associated with the identity verification.
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                  - diatf
                description: The certification type.
              data:
                type: object
                description: Certification data. The shape depends on `type`.
                properties:
                  gpg45_profile:
                    type: string
                    enum:
                      - M1A
                      - M1C
                      - H1A
                  level_of_confidence:
                    type: string
                    enum:
                      - medium
                      - high
                  right_to_work:
                    type: string
                    nullable: true
                    description: >-
                      Home Office right-to-work statement, issued when the document supports it (UK passport,
                      Irish passport or Irish passport card) at a medium or high level of confidence; `null`
                      otherwise.
        risk_labels:
          $ref: "#/components/schemas/RiskLabels"
      allOf:
        - $ref: "#/components/schemas/IdentityVerificationBase"

    IdentityVerificationOutputGet:
      type: object
      required: [id, declared_data, status, webhook_url, redirect_url, _links, applicant_id, response_codes, risk_labels, user_journey_id, certifications]
      properties:
        id:
          $ref: "#/components/schemas/IdentityVerificationId"
        declared_data:
          $ref: "#/components/schemas/IdentityDeclaredData"
        phone_number:
          $ref: "#/components/schemas/PhoneNumber"
        redirect_url:
          type: string
          format: uri
        _links:
          $ref: "#/components/schemas/IdentityVerificationLinks"
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/IdentityVerificationOutputBase"

    IdentityVerificationOutputHelper:
      type: object
      required: [id, declared_data, status, webhook_url, _links, response_codes, risk_labels, redirect_url, applicant_id, user_journey_id, certifications]
      properties:
        id:
          $ref: "#/components/schemas/IdentityVerificationId"
        declared_data:
          $ref: "#/components/schemas/IdentityDeclaredData"
        redirect_url:
          type: string
          format: uri
        phone_number:
          $ref: "#/components/schemas/PhoneNumber"
        _links:
          $ref: "#/components/schemas/IdentityVerificationHelperLinks"
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/IdentityVerificationOutputBase"

    IdentityVerificationOutputPdfReport:
      type: object
      properties:
        pdf_report:
          type: string
          format: uri

    IdentityVerificationOutputPost:
      type: object
      required: [id, declared_data, status, webhook_url, _links, response_codes, risk_labels, applicant_id, user_journey_id, certifications]
      properties:
        id:
          $ref: "#/components/schemas/IdentityVerificationId"
        declared_data:
          $ref: "#/components/schemas/IdentityDeclaredData"
        _links:
          $ref: "#/components/schemas/IdentityVerificationLinks"
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/IdentityVerificationOutputBase"

    InitialDevices:
      type: string
      description: Initial device which started the session
      enum:
        - mobile
        - desktop

    LanguageCode:
      type: string
      format: IETF BCP 47 language tag
      description: Language tag following IETF BCP 47 standard
      example: en-US

    ListLinks:
        type: object
        required: [self]
        properties:
          self:
            description: Link to the current page
            $ref: "#/components/schemas/HalLink"
          previous:
            description: Link to the previous page (null if on the first page)
            $ref: "#/components/schemas/HalLink"
          next:
            description: Link to the next page (null if on the last page)
            $ref: "#/components/schemas/HalLink"

    NullEnum:
      enum:
        - null

    PhoneNumber:
      type: object
      required: [country_code, number]
      properties:
        country_code:
          $ref: "#/components/schemas/PhonePrefix"
        number:
          $ref: "#/components/schemas/DomesticPhoneNumber"

    PhonePrefix:
      type: string
      format: international phone prefix
      pattern: ^\+(\d+)$
      example: "+33"

    PreSignedUrl:
      type: string
      format: uri
      description: Pre-signed URL
      example: https://storage-b.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/live_face/bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921946714.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163223Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=2b7d87fec4f11f0df949da7beade2519cf1a51ce70fe9cc1cf0470d73f5340e4

    ProofOfAddressDocument:
      type: object
      properties:
        document_type:
          type: string
        issuer:
          type: string
        full_names:
          type: array
          items:
            type: string
        address:
          $ref: "#/components/schemas/Address"
        issue_date:
          type: string
          format: date

    ResponseCode:
      type: integer
      description: The numeric code of the response code.
      minimum: 10000
      maximum: 69999

    ResponseCodes:
      type: object
      description: The code giving more details about the result.
      properties:
        code:
          $ref: "#/components/schemas/ResponseCode"
        summary:
          $ref: "#/components/schemas/ResponseSummary"
      required:
        - code
        - summary

    ResponseSummary:
      type: string
      description: A descriptive code of the response code.

    RiskLabel:
      type: string
      description: Risk assessment label.
      enum:
        - multiple_faces_detected
        - mcc_not_confident
        - risky_document_format
        - no_uk_footprint

    RiskLabels:
          type: array
          items:
            $ref: "#/components/schemas/RiskLabel"
          description: Risk assessment labels

    SearchParameters:
      type: object
      required: [configuration_identifier]
      description: ComplyAdvantage search inputs
      properties:
        configuration_identifier:
          type: string
          description: Configuration identifier
          example: "12345678-1234-1234-1234-123456789012"

    SelectedDocument:
      type: object
      description: The code giving more details about the result.
      properties:
        country:
          $ref: "#/components/schemas/CountryCodeIso2"
        document_type:
          $ref: "#/components/schemas/DocumentTypes"
      required:
        - country
        - document_type

    SelfLink:
      type: object
      required: [self]
      properties:
        self:
          $ref: "#/components/schemas/HalLink"

    UserJourneyId:
      type: string
      description: User journey unique identifier.
      pattern: ^usj_\w+$
      example: usj_tkoi5db4hryu5cei5vwoabr7we

    VerificationFace:
      type: object
      properties:
        image_signed_url:
          type: string
          nullable: true

    VerificationIdentity:
      type: object
      description: IdentitySerializer for our main Identity model
      properties:
        first_names:
          type: string
          nullable: true
        full_name:
          type: string
          nullable: true
        last_name:
          type: string
          nullable: true
        last_name_at_birth:
          type: string
          nullable: true
        birth_date:
          type: string
          format: date
          nullable: true
        birth_place:
          type: string
          nullable: true
          maxLength: 255
        nationality:
          type: string
        gender:
          type: string
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/GenderA47Enum'
            - $ref: '#/components/schemas/BlankEnum'
            - $ref: '#/components/schemas/NullEnum'

    VerificationStatuses:
      type: string
      description: Status of the verification.
      enum:
        - created
        - pending
        - capture_in_progress
        - checks_in_progress
        - approved
        - declined
        - retry_required
        - refused
        - inconclusive

    WebsiteVerificationBase:
      type: object
      properties:
        user_journey_id:
          allOf:
            - $ref: "#/components/schemas/UserJourneyId"
        applicant_id:
          allOf:
            - $ref: "#/components/schemas/BusinessApplicantId"
        webhook_url:
          type: string
          format: uri
        website_url:
          type: string
          format: uri
          maxLength: 1024
          description: URL of the website to be verified

    WebsiteVerificationId:
      type: string
      description: Website verification unique identifier.
      pattern: ^wbv_\w+$
      example: wbv_tkoi5db4hryu5cei5vwoabr7we

    WebsiteVerificationInputBase:
      type: object
      allOf:
        - $ref: "#/components/schemas/WebsiteVerificationBase"

    WebsiteVerificationInputPost:
      type: object
      required: [applicant_id, user_journey_id, website_url]
      allOf:
        - $ref: "#/components/schemas/WebsiteVerificationInputBase"

    WebsiteVerificationLinks:
      type: object
      allOf:
        - $ref: "#/components/schemas/SelfLink"
        - $ref: "#/components/schemas/ApplicantLink"

    WebsiteVerificationOutputAnonymize:
      type: object
      required: [id, status, applicant_id, response_codes, risk_labels, user_journey_id, website_url, _links]
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/WebsiteVerificationOutputBase"

    WebsiteVerificationOutputBase:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/WebsiteVerificationId"
        status:
          $ref: "#/components/schemas/WebsiteVerificationStatus"
        response_codes:
          type: array
          items:
            $ref: "#/components/schemas/ResponseCodes"
        risk_labels:
          $ref: "#/components/schemas/RiskLabels"
        website_data:
          $ref: "#/components/schemas/WebsiteVerificationResult"
        _links:
          $ref: "#/components/schemas/WebsiteVerificationLinks"
      allOf:
        - $ref: "#/components/schemas/WebsiteVerificationBase"
        - $ref: "#/components/schemas/DatedObject"

    WebsiteVerificationOutputGet:
      type: object
      required: [id, status, applicant_id, response_codes, risk_labels, user_journey_id, website_url, _links]
      allOf:
        - $ref: "#/components/schemas/DatedObject"
        - $ref: "#/components/schemas/WebsiteVerificationOutputBase"

    WebsiteVerificationOutputPost:
      type: object
      required: [id, status, applicant_id, response_codes, risk_labels, user_journey_id, website_url, _links]
      allOf:
        - $ref: "#/components/schemas/WebsiteVerificationOutputBase"

    WebsiteVerificationResult:
      type: object
      properties:
        legal_name:
          type: string
          description: Legal name of the company
        country_of_incorporation:
          $ref: "#/components/schemas/CountryCodeIso2"
          description: Country of incorporation of the company
        mccs:
          type: array
          items:
            type: string
          description: MCCs of the company
        alternative_mccs:
          type: array
          items:
            type: string
          description: Alternative MCCs of the company
        mcc_rationale:
          type: string
          description: Rationale for the MCCs
        risky_activities:
          type: array
          items:
            type: string
          description: Risky activities of the company
        legal_address:
          $ref: "#/components/schemas/Address"
        disclosure_urls:
          $ref: "#/components/schemas/DisclosureURLs"
        registration_date:
          type: string
          format: date
          nullable: true
          description: The registration date of the domain

    WebsiteVerificationStatus:
      type: string
      description: Status of the website verification.
      enum:
        - initial_status
        - created
        - checks_in_progress
        - approved
        - declined
        - inconclusive

  parameters:
    limitParam:
      name: limit
      in: query
      description: Maximum number of items to return per page
      required: false
      schema:
        type: integer
        minimum: 1
        default: 10

    skipParam:
      name: skip
      in: query
      description: Number of items to skip (offset)
      required: false
      schema:
        type: integer
        minimum: 0
        default: 0

  examples:
    address_document_verification_anonymization_response_body:
      value:
        id: adv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        status: created
        response_codes: []
        webhook_url: "https://my.api/events/"
        _links:
          self:
            href: "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we"

    address_document_verification_attempt_creation_request_body_max:
      value:
        document: |
          data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA…

    address_document_verification_attempt_creation_request_body_min:
      value:
        document: |
          data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…

    address_document_verification_attempt_creation_response_body:
      value:
        id: adv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        status: completed
        response_codes: []
        _links:
          self:
            href: "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adv_attempt_123"

    address_document_verification_attempt_get_response_body:
      value:
        id: adv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        status: completed
        response_codes: []
        _links:
          self:
            href: "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adv_attempt_123"

    address_document_verification_attempt_list_response_body:
      value:
        total_count: 2  
        skip: 10
        limit: 10
        data:
        - id: adv_tkoi5db4hryu5cei5vwoabr7we
          created_on: 2017-07-21T17:32:28Z
          modified_on: 2017-07-21T17:40:32Z
          status: completed
          response_codes: []
          _links:
            self:
              href: "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adv_attempt_123"
        _links:
          self:
            href: "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts"
          next:
            href: "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
          previous:
            href: "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."

    address_document_verification_attempt_output_assets_response_body:
      value:
        total_count: 1
        skip: 10
        limit: 10
        _links:
          self:
            href: "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adv_attempt_123/assets"
          next:
            href: "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adv_attempt_123/assets/..."
          previous:
            href: "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adv_attempt_123/assets/..."
        data:
        - type: document
          _links:
            asset_url:
              href: "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we/attempts/adv_attempt_123/assets/document"

    address_document_verification_creation_request_body_max:
      value:
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        declared_data:
          name: Acme Corporation
        webhook_url: https://my.api/events/

    address_document_verification_creation_request_body_min:
      value:
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        declared_data:
          name: Acme Corporation

    address_document_verification_creation_response_body:
      value:
        id: adv_tkoi5db4hryu5cei5vwoabr7we
        created_on: "2017-07-21T17:32:28Z"
        modified_on: "2017-07-21T17:40:32Z"
        user_journey_id: "usj_tkoi5db4hryu5cei5vwoabr7we"
        applicant_id: "aplt_tkoi5db4hryu5cei5vwoabr7we"
        status: created
        response_codes: []
        declared_data:
          name: "Acme Corporation"
        address_document:
          type: "Utility Bill"
          full_name: "Acme Corporation"
          address:
            address_line1: "123 Main St"
            address_line2: "Suite 100"
            city: "New York"
            state: "NY"
            zip: "10001"
            country: "US"
          issue_date: 2023-01-15
        webhook_url: "https://my.api/events/"
        _links:
          self:
            href: "https://api.ubble.ai/v2/address-document-verifications/adv_tkoi5db4hryu5cei5vwoabr7we"

    address_document_verification_pdf_report_response_body:
      value:
        pdf_report: https://www.example.com/reports/adv_123.pdf

    aml_verification_creation_request_body_max:
      value:
        search_parameters:
          configuration_identifier: 011e5c14-2222-738c-8852-dfdbbe53f233
        webhook_url: https://my.api/events/
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        monitored: false

    aml_verification_creation_request_body_min:
      value:
        search_parameters:
          configuration_identifier: 011e5c14-2222-738c-8852-dfdbbe53f233
        webhook_url: https://my.api/events/
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we

    aml_verification_response_body:
      value:
        id: amlv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        status: created
        webhook_url: https://my.api/events/
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        search_parameters:
          configuration_identifier: 8eb79430-c014-41e5-be73-2c2c091322b8
        monitored: false
        _links:
          self:
            href: "https://api.ubble.ai/v2/aml-verifications/amlv_tkoi5db4hryu5cei5vwoabr7we"
          applicant:
            href: "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"

    applicant_creation_request_body:
      value:
        external_applicant_id: ext_osdfdfdb4hryu5cei5vwoabrk5k
        external_applicant_name: David Vincent
        email: david.vincent@courriel.ml

    applicant_patch_request_body:
      value:
        external_applicant_name: David Vincent
        email: david.vincent@courriel.ml

    applicant_response_body:
      value:
        id: aplt_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        external_applicant_id: ext_osdfdfdb4hryu5cei5vwoabrk5k
        external_applicant_name: David Vincent
        email: david.vincent@courriel.ml
        _links:
          self:
            href: https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we

    applicant_response_body_anonymized:
      value:
        id: aplt_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        external_applicant_id: ext_osdfdfdb4hryu5cei5vwoabrk5k
        external_applicant_name: David Vincent
        _links:
          self:
            href: https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we

    attempt_creation_request_body_min:
      value:
        redirect_url: https://myweb.site?query-param=hello

    bank_document_verification_anonymization_response_body:
      value:
        id: bdv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: bplt_tkoi5db4hryu5cei5vwoabr7we
        status: created
        response_codes: []
        webhook_url: "https://my.api/events/"
        _links:
          self:
            href: "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we"

    bank_document_verification_attempt_creation_request_body_max:
      value:
        document: |
          data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA…

    bank_document_verification_attempt_creation_request_body_min:
      value:
        document: |
          data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…

    bank_document_verification_attempt_creation_response_body:
      value:
        id: bdv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        status: completed
        response_codes: []
        _links:
          self:
            href: "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123"

    bank_document_verification_attempt_get_response_body:
      value:
        id: bdv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        status: completed
        response_codes: []
        _links:
          self:
            href: "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123"

    bank_document_verification_attempt_list_response_body:
      value:
        total_count: 2  
        skip: 10
        limit: 10
        data:
        - id: bdv_tkoi5db4hryu5cei5vwoabr7we
          created_on: 2017-07-21T17:32:28Z
          modified_on: 2017-07-21T17:40:32Z
          status: completed
          response_codes: []
          _links:
            self:
              href: "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123"
        _links:
          self:
            href: "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts"
          next:
            href: "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
          previous:
            href: "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."

    bank_document_verification_attempt_output_assets_response_body:
      value:
        total_count: 1
        skip: 10
        limit: 10
        _links:
          self:
            href: "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123/assets"
          next:
            href: "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123/assets/..."
          previous:
            href: "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123/assets/..."
        data:
        - type: document
          _links:
            asset_url:
              href: "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we/attempts/bdv_attempt_123/assets/document"

    bank_document_verification_creation_request_body_max:
      value:
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: bplt_tkoi5db4hryu5cei5vwoabr7we
        declared_data:
          registered_name: Acme Corporation
          trading_name: Acme Corp
        webhook_url: https://my.api/events/

    bank_document_verification_creation_request_body_min:
      value:
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: bplt_tkoi5db4hryu5cei5vwoabr7we
        declared_data:
          registered_name: Acme Corporation
          trading_name: Acme Corp

    bank_document_verification_creation_response_body:
      value:
        id: bdv_tkoi5db4hryu5cei5vwoabr7we
        created_on: "2017-07-21T17:32:28Z"
        modified_on: "2017-07-21T17:40:32Z"
        user_journey_id: "usj_tkoi5db4hryu5cei5vwoabr7we"
        applicant_id: "bplt_tkoi5db4hryu5cei5vwoabr7we"
        status: created
        response_codes: []
        declared_data:
          registered_name: "Acme Corporation"
          trading_name: "Acme Corp"
        bank_document:
          bank_account_number: "1234567890"
          bank_routing_number: "987654321"
          account_type: checking
          legal_name: Acme Corporation
          bank_name: First National Bank
          issue_date: 2023-01-15
          document_type: bank_statement
        webhook_url: "https://my.api/events/"
        _links:
          self:
            href: "https://api.ubble.ai/v2/bank-document-verifications/bdv_tkoi5db4hryu5cei5vwoabr7we"

    bank_document_verification_pdf_report_response_body:
      value:
        pdf_report: https://www.example.com/reports/bdv_123.pdf

    business_applicant_creation_request_body:
      value:
        external_applicant_id: ext_business_osdfdfdb4hryu5cei5vwoabrk5k

    business_applicant_response_body:
      value:
        id: bplt_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        external_applicant_id: ext_business_osdfdfdb4hryu5cei5vwoabrk5k
        _links:
          self:
            href: https://api.ubble.ai/v2/business-applicants/bplt_tkoi5db4hryu5cei5vwoabr7we

    company_document_verification_anonymization_response_body:
      value:
        id: cdv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: bplt_tkoi5db4hryu5cei5vwoabr7we
        status: created
        response_codes: []
        webhook_url: "https://my.api/events/"
        _links:
          self:
            href: "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we"

    company_document_verification_attempt_creation_request_body_max:
      value:
        document: |
          data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA…

    company_document_verification_attempt_creation_request_body_min:
      value:
        document: |
          data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…

    company_document_verification_attempt_creation_response_body:
      value:
        id: cdv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        status: completed
        response_codes: []
        _links:
          self:
            href: "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123"

    company_document_verification_attempt_get_response_body:
      value:
        id: cdv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        status: completed
        response_codes: []
        _links:
          self:
            href: "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123"

    company_document_verification_attempt_list_response_body:
      value:
        total_count: 2  
        skip: 10
        limit: 10
        data:
        - id: cdv_tkoi5db4hryu5cei5vwoabr7we
          created_on: 2017-07-21T17:32:28Z
          modified_on: 2017-07-21T17:40:32Z
          status: completed
          response_codes: []
          _links:
            self:
              href: "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123"
        _links:
          self:
            href: "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts"
          next:
            href: "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
          previous:
            href: "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."

    company_document_verification_attempt_output_assets_response_body:
      value:
        total_count: 1
        skip: 10
        limit: 10
        _links:
          self:
            href: "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123/assets"
          next:
            href: "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123/assets/..."
          previous:
            href: "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123/assets/..."
        data:
        - type: document
          _links:
            asset_url:
              href: "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we/attempts/cdv_attempt_123/assets/document"

    company_document_verification_creation_request_body_max:
      value:
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: bplt_tkoi5db4hryu5cei5vwoabr7we
        declared_data:
          registered_name: Acme Corporation
        webhook_url: https://my.api/events/

    company_document_verification_creation_request_body_min:
      value:
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: bplt_tkoi5db4hryu5cei5vwoabr7we
        declared_data:
          registered_name: Acme Corporation

    company_document_verification_creation_response_body:
      value:
        id: cdv_tkoi5db4hryu5cei5vwoabr7we
        created_on: "2017-07-21T17:32:28Z"
        modified_on: "2017-07-21T17:40:32Z"
        user_journey_id: "usj_tkoi5db4hryu5cei5vwoabr7we"
        applicant_id: "bplt_tkoi5db4hryu5cei5vwoabr7we"
        status: created
        response_codes: []
        declared_data:
          registered_name: Acme Corporation
        company_document:
          company_number: "12-3456789"
          registered_name: Acme Corporation
          legal_address:
            address_line1: "123 Main St"
            city: "New York"
            state: "NY"
            zip: "10001"
            country: "US"
          issue_date: 2023-01-15
          registration_date: 2020-05-10
          document_type: ein_letter
        webhook_url: "https://my.api/events/"
        _links:
          self:
            href: "https://api.ubble.ai/v2/company-document-verifications/cdv_tkoi5db4hryu5cei5vwoabr7we"

    company_document_verification_pdf_report_response_body:
      value:
        pdf_report: https://www.example.com/reports/cdv_123.pdf

    face_attempt_creation_request_body_max:
      value:
        phone_number:
          country_code: "+1"
          number: "2068133616"
        client_information:
          pre_selected_residence_country: "FR"
        redirect_url: https://myweb.site?query-param=hello
        mobile_handoff_url: https://myweb.site/continue-on-mobile?session=a1b2c3

    face_authentication_anonymization_response_body:
      value:
        id: fav_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        status: declined
        response_codes:
          - { "code": 62403, "summary": "consent_unclear" }
          - { "code": 61402, "summary": "face_video_lighting_issue" }
        risk_labels:
          - multiple_faces_detected
        webhook_url: https://my.api/events/
        _links:
          self:
            href: "https://api.ubble.ai/v2/face-authentications/face_tkoi5db4hryu5cei5vwoabr7we"
          applicant:
            href: "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"

    face_authentication_attempt_assets_response_body:
      value:
        data:
          - _links:
              asset_url:
                href: "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
            type: "face_image"
          - _links:
              asset_url:
                href: "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
            type: "face_video"
        _links:
          self:
            href: "https://api.ubble.ai/api/v2/face-authentications/fau_116kcr6z00h62kzvf4hw2twb3b/attempts/fatp_116kcr6z00h62kzvf4hw2twb3d/assets"

        limit: 10
        skip: 0
        total_count: 2

    face_authentication_attempt_creation_response_body:
      value:
        id: "fatp_tkoi5db4hryu5cei5vwoabrPoQ"
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        status: "pending_redirection"
        response_codes: []
        phone_number:
          country_code: "+1"
          number: "2068133616"
        client_information:
          pre_selected_residence_country: "FR"
        redirect_url: https://myweb.site?query-param=hello
        mobile_handoff_url: https://myweb.site/continue-on-mobile?session=a1b2c3
        _links:
          self:
            href: "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we/attempts/fatp_tkoi5db4hryu5cei5vwoabr7we"
          verification_url:
            href: "https://id.ubble.ai/4hryu5cei5/"

    face_authentication_attempt_get_response_body:
      value:
        id: "fatp_tkoi5db4hryu5cei5vwoabrPoQ"
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        phone_number:
          country_code: "+1"
          number: "2068133616"
        redirect_url: "https://myweb.site?query-param=hello"
        status: "checks_in_progress"
        response_codes: [ ]
        client_information:
          pre_selected_residence_country: FR
        applicant_session_information:
          ip_address: "123.123.123.01"
        _links:
          self:
            href: "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we/attempts/fatp_tkoi5db4hryu5cei5vwoabr7we"
          verification_url:
            href: "https://id.ubble.ai/4hryu5cei5/"

    face_authentication_attempt_list_response_body:
      value:
        total_count: 2
        skip: 10
        limit: 10
        data:
          - id: "fatp_tkoi5db4hryu5cei5vwoabrPoQ"
            created_on: 2017-07-21T17:32:28Z
            modified_on: 2017-07-21T17:40:32Z
            status: "checks_in_progress"
            response_codes: []
            phone_number:
              country_code: "+1"
              number: "2068133616"
            redirect_url: "https://myweb.site?query-param=hello"
            client_information:
              pre_selected_residence_country: "FR"
            applicant_session_information:
              ip_address: "123.123.123.01"
            _links:
              verification_url:
                href: "https://id.ubble.ai/4hryu5cei5/"
              self:
                href: "https://api.ubble.ai/face-authentications/4hryu5cei5/fatp_tkoi5db4hryu5cei5vwoabrPoQ"
          - id: "fatp_tkoi5db4hryu5cei5vwoabriom"
            created_on: 2017-07-21T16:30:28Z
            modified_on: 2017-07-21T16:32:32Z
            status: "checks_inconclusive"
            response_codes:
              - code: 61402
                summary: "face_video_lighting_issue"
            phone_number:
              country_code: "+1"
              number: "2068133616"
            redirect_url: "https://myweb.site?query-param=hello"
            client_information:
              pre_selected_residence_country: "FR"
            applicant_session_information:
              ip_address: "123.123.123.01"
            _links:
              self:
                href: "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we/attempts/fatp_tkoi5db4hryu5cei5vwoabr7we"
              verification_url:
                href: "https://id.ubble.ai/4hryu5clik/"
        _links:
          self:
            href: "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=10&limit=10"
          next:
            href: "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=20&limit=10"
          previous:
            href: "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=0&limit=10"

    face_authentication_creation_response_body:
      value:
        id: fav_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        status: declined
        response_codes:
          - { "code": 62403, "summary": "consent_unclear" }
          - { "code": 61402, "summary": "face_video_lighting_issue" }
        risk_labels:
          - multiple_faces_detected
        face:
          image_signed_url: https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/live_face/bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921946714.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163223Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=2b7d87fec4f11f0df949da7beade2519cf1a51ce70fe9cc1cf0470d73f5340e4
        webhook_url: https://my.api/events/
        _links:
          self:
            href: "https://api.ubble.ai/v2/face-authentications/fav_tkoi5db4hryu5cei5vwoabr7we"
          applicant:
            href: "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"

    id_document_verification_anonymization_response_body:
      value:
        id: iddv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        status: created
        response_codes: []
        webhook_url: "https://my.api/events/"
        _links:
          self:
            href: "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we"
          applicant:
            href: "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"

    id_document_verification_attempt_creation_request_body_max:
      value:
        document_front: |
          data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA…
        document_back: |
          data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA…

    id_document_verification_attempt_creation_request_body_min:
      value:
        document_front: |
          data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…

    id_document_verification_attempt_creation_response_body:
      value:
        id: iddv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        status: completed
        response_codes: []
        _links:
          self:
            href: "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we"

    id_document_verification_attempt_get_response_body:
      value:
        id: iddv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        status: completed
        response_codes: []
        _links:
          self:
            href: "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we"

    id_document_verification_attempt_list_response_body:
      value:
        total_count: 2  
        skip: 10
        limit: 10
        data:
        - id: iddv_tkoi5db4hryu5cei5vwoabr7we
          created_on: 2017-07-21T17:32:28Z
          modified_on: 2017-07-21T17:40:32Z
          status: completed
          response_codes: []
          _links:
            self:
              href: "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we"
        _links:
          self:
            href: "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts"
          next:
            href: "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
          previous:
            href: "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."

    id_document_verification_attempt_output_assets_response_body:
      value:
        total_count: 2
        skip: 10
        limit: 10
        _links:
          self:
            href: "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts"
          next:
            href: "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
          previous:
            href: "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/attempts/..."
        data:
        - type: document_front_image
          _links:
            asset_url:
              href: "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we/assets/document_front_image"

    id_document_verification_creation_request_body_max:
      value:
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        declared_data:
          name: David Vincent
        webhook_url: https://my.api/events/

    id_document_verification_creation_request_body_min:
      value:
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        declared_data:
          name: David Vincent

    id_document_verification_creation_response_body:
      value:
        id: iddv_tkoi5db4hryu5cei5vwoabr7we
        created_on: "2017-07-21T17:32:28Z"
        modified_on: "2017-07-21T17:40:32Z"
        user_journey_id: "usj_tkoi5db4hryu5cei5vwoabr7we"
        applicant_id: "aplt_tkoi5db4hryu5cei5vwoabr7we"
        status: created
        response_codes: []
        declared_data:
          name: "David Vincent"
        document:
          full_name: David Vincent
          birth_date: 1934-10-02
          document_type: ID
          document_issuing_country: US
          front_image_signed_url: https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555
        webhook_url: "https://my.api/events/"
        _links:
          self:
            href: "https://api.ubble.ai/v2/id-document-verifications/iddv_tkoi5db4hryu5cei5vwoabr7we"
          applicant:
            href: "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"

    id_document_verification_pdf_report_response_body:
      value:
        pdf_report: https://www.example.com/reports/iddv_123.pdf

    identity_attempt_creation_request_body_max:
      value:
        phone_number:
          country_code: "+1"
          number: "2068133616"
        client_information:
          pre_selected_residence_country: "FR"
          pre_selected_document_issuing_country: FR
          pre_selected_document_type: ID
        redirect_url: https://myweb.site?query-param=hello
        mobile_handoff_url: https://myweb.site/continue-on-mobile?session=a1b2c3

    identity_verification_anonymization_response_body:
      value:
        id: idv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        status: pending
        response_codes: []
        risk_labels:
          - multiple_faces_detected
        phone_number:
          country_code: '+1'
          number: '5555550102'
        documents: []
        webhook_url: https://my.api/events/
        redirect_url: https://myweb.site?query-param=hello
        _links:
          self:
            href: "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we"
          applicant:
            href: "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"

    identity_verification_attempt_assets_response_body:
      value:
        data:
          - _links:
              asset_url:
                href: "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
            type: "face_image"
          - _links:
              asset_url:
                href: "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
            type: "face_video"
          - _links:
              asset_url:
                href: "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
            type: "document_front_image"
          - _links:
              asset_url:
                href: "https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555"
            type: "document_front_video"
        _links:
          self:
            href: "https://api.ubble.ai/api/v2/face-authentications/fau_116kcr6z00h62kzvf4hw2twb3b/attempts/fatp_116kcr6z00h62kzvf4hw2twb3d/assets"

        limit: 10
        skip: 0
        total_count: 4

    identity_verification_attempt_creation_response_body:
      value:
        id: "iatp_tkoi5db4hryu5cei5vwoabrPoQ"
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        status: completed
        response_codes: []
        phone_number:
          country_code: "+1"
          number: "2068133616"
        client_information:
          pre_selected_residence_country: "FR"
          pre_selected_document_issuing_country: FR
          pre_selected_document_type: ID
        redirect_url: https://myweb.site?query-param=hello
        mobile_handoff_url: https://myweb.site/continue-on-mobile?session=a1b2c3
        applicant_session_information:
          ip_address: 33.333.333.33
        _links:
          self:
            href: "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we/attempts/iatp_idv_tkoi5db4hryu5cei5vwoabr7we"
          verification_url:
            href: "https://id.ubble.ai/4hryu5cei5/"

    identity_verification_attempt_get_response_body:
      value:
        id: "iatp_tkoi5db4hryu5cei5vwoabrPoQ"
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        phone_number:
          country_code: "+1"
          number: "2068133616"
        redirect_url: "https://myweb.site?query-param=hello"
        status: "checks_in_progress"
        response_codes: []
        client_information:
          pre_selected_residence_country: FR
          pre_selected_document_issuing_country: FR
          pre_selected_document_type: ID
        applicant_session_information:
          ip_address: "123.123.123.01"
          selected_documents:
            - country: "FR"
              document_type: "Passport"
        _links:
          self:
            href: "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we/attempts/iatp_idv_tkoi5db4hryu5cei5vwoabr7we"
          verification_url:
            href: "https://id.ubble.ai/4hryu5cei5/"

    identity_verification_attempt_list_response_body:
      value:
        total_count: 2
        skip: 10
        limit: 10
        data:
          - id: "iatp_tkoi5db4hryu5cei5vwoabrPoQ"
            created_on: 2017-07-21T17:32:28Z
            modified_on: 2017-07-21T17:40:32Z
            status: "checks_in_progress"
            response_codes: []
            phone_number:
              country_code: "+1"
              number: "2068133616"
            redirect_url: "https://myweb.site?query-param=hello"
            client_information:
              pre_selected_residence_country: "FR"
              pre_selected_document_issuing_country: FR
              pre_selected_document_type: ID
            applicant_session_information:
              ip_address: "123.123.123.01"
            _links:
              self:
                href: "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we/attempts/iatp_idv_tkoi5db4hryu5cei5vwoabr7we"
              verification_url:
                href: "https://id.ubble.ai/4hryu5cei5/"
        _links:
          self:
            href: "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=10&limit=10"
          next:
            href: "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=20&limit=10"
          previous:
            href: "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we/attempts?skip=0&limit=10"

    identity_verification_creation_request_body_helper_max:
      value:
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        declared_data:
          name: John Smith
        phone_number:
          country_code: '+1'
          number: '5555550102'
        redirect_url: https://example.com?query-param=hello
        mobile_handoff_url: https://example.com/continue-on-mobile?session=a1b2c3
        webhook_url: https://my.api/events/

    identity_verification_creation_request_body_helper_min:
      value:
        declared_data:
          name: David Vincent
        webhook_url: https://my.api/events/
        redirect_url: https://myweb.site?query-param=hello

    identity_verification_creation_request_body_max:
      value:
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        declared_data:
          name: David Vincent
        webhook_url: https://my.api/events/

    identity_verification_creation_request_body_min:
      value:
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        declared_data:
          name: John Smith
        webhook_url: "https://my.api/events/"

    identity_verification_creation_request_body_min_plus_aplt:
      value:
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        declared_data:
          name: David Vincent
        webhook_url: https://my.api/events/
        redirect_url: https://myweb.site?query-param=hello

    identity_verification_creation_response_body:
      value:
        id: "idv_tkoi5db4hryu5cei5vwoabr7we"
        created_on: "2017-07-21T17:32:28Z"
        modified_on: "2017-07-21T17:40:32Z"
        user_journey_id: "usj_tkoi5db4hryu5cei5vwoabr7we"
        applicant_id: "aplt_tkoi5db4hryu5cei5vwoabr7we"
        status: "created"
        response_codes: []
        risk_labels: []
        declared_data:
          name: "David Vincent"
        documents: []
        webhook_url: "https://my.api/events/"
        _links:
          self:
            href: "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we"
          applicant:
            href: "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"

    identity_verification_creation_response_body_helper:
      value:
        id: idv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        status: pending
        response_codes: []
        risk_labels: []
        declared_data:
          name: David Vincent
        documents: []
        webhook_url: https://my.api/events/
        redirect_url: https://myweb.site?query-param=hello
        _links:
          self:
            href: "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we"
          applicant:
            href: "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
          verification_url:
            href: "https://id.ubble.ai/4hryu5cei5/"

    identity_verification_pdf_response_body:
      value:
        pdf_report: https://www.example.com/reports/idv_123.pdf

    identity_verification_response_body:
      value:
        id: idv_tkoi5db4hryu5cei5vwoabr7we
        created_on: 2017-07-21T17:32:28Z
        modified_on: 2017-07-21T17:40:32Z
        user_journey_id: usj_tkoi5db4hryu5cei5vwoabr7we
        applicant_id: aplt_tkoi5db4hryu5cei5vwoabr7we
        status: declined
        response_codes:
          - { "code": 61310, "summary": "document_front_not_captured" }
          - { "code": 62102, "summary": "document_not_accepted" }
        risk_labels:
          - multiple_faces_detected
        verified_identity:
          full_name: David Vincent
          birth_date: 1934-10-02
        certifications:
          - type: diatf
            data:
              gpg45_profile: H1A
              level_of_confidence: high
              right_to_work: >-
                This identity has been verified to a Medium Level of Confidence in accordance with GPG45 standards. The document presented is a valid British/Irish passport, which confirms the holder’s statutory Right to Work in the United Kingdom.
        declared_data:
          name: David Vincent
        documents:
          - full_name: David Vincent
            birth_date: 1934-10-02
            document_type: ID
            document_issuing_country: US
            front_image_signed_url: https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/tight_crops/FRA-I5-Front-bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921906596.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163228Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=87d8467ab92cbad7c00171af28e613d495f3ff441ce0ea59dd013d68abc50555
        face:
          image_signed_url: https://storage-b.env.ubble.ai/ubble-ai/NDYOOVHGZPAQ/a54b3393-f02a-47c9-a9c5-2f6ee73560e1/bb603e2f-5de9-40f2-9631-8285a33c24c0/live_face/bb603e2f-5de9-40f2-9631-8285a33c24c0-1679921946714.png?response-content-type=image%2Fpng&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=V9jgOdpOdeVSFTkA4ZsG%2F20230327%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230327T163223Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=2b7d87fec4f11f0df949da7beade2519cf1a51ce70fe9cc1cf0470d73f5340e4
        phone_number:
          country_code: "+1"
          number: "2068133616"
        webhook_url: https://my.api/events/
        redirect_url: https://myweb.site?query-param=hello
        _links:
          self:
            href: "https://api.ubble.ai/v2/identity-verifications/idv_tkoi5db4hryu5cei5vwoabr7we"
          applicant:
            href: "https://api.ubble.ai/v2/applicants/aplt_tkoi5db4hryu5cei5vwoabr7we"
          verification_url:
            href: "https://id.ubble.ai/4hryu5cei5/"